UNPKG

iso-3166-1-flags-sprite-generator

Version:

iso-3166-1 country flags css sprite generator

github.com/bameyrick/iso-3166-1-flags-sprite-generator

bameyrick/iso-3166-1-flags-sprite-generator

77 lines (56 loc) • 4.28 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# ISO-3166-1 Flags Generator Generate a css sprite for iso-3166-1 country flags [![GitHub release](https://img.shields.io/github/release/bameyrick/iso-3166-1-flags-sprite-generator.svg)](https://github.com/bameyrick/iso-3166-1-flags-sprite-generator/releases) [![Build Status](https://travis-ci.com/bameyrick/iso-3166-1-flags-sprite-generator.svg?branch=main)](https://travis-ci.com/github/bameyrick/iso-3166-1-flags-sprite-generator) [![codecov](https://codecov.io/gh/bameyrick/iso-3166-1-flags-sprite-generator/branch/main/graph/badge.svg)](https://codecov.io/gh/bameyrick/iso-3166-1-flags-sprite-generator) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/db81c43235c14f0db58a66dc07f161cc)](https://www.codacy.com/manual/bameyrick/iso-3166-1-flags-sprite-generator) - [ISO-3166-1 Flags Generator](#iso-3166-1-flags-generator) - [Install](#install) - [npm](#npm) - [yarn](#yarn) - [Documentation](#documentation) - [Usage](#usage) - [Options](#options) - [Available options](#available-options) ## Install You can install via npm or yarn. ### npm ```bash npm install --save iso-3166-1-flags-sprite-generator ``` ### yarn ```bash yarn add iso-3166-1-flags-sprite-generator ``` ## Documentation This documentation is written in TypeScript, however this library works fine in vanilla JavaScript too. ## Usage ```typescript import createFlagSprite from 'iso-3166-1-flags-sprite-generator'; async function myFn(): Promise<void> { await createFlagSprite('assets/img', 'styles'); } ``` ## Options Options can be provided to the method as the third argument ```typescript import createFlagSprite from 'iso-3166-1-flags-sprite-generator'; async function myFn(): Promise<void> { await createFlagSprite('assets/img', 'styles', { width: 120, center: false }); } ``` ### Available options | Option | Type | description | Default value | | ----------------- | ------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------- | | center | boolean | Whether to center the flag horizontally | true | | classPrefix | string | Prefix for css classes | flag | | cssFileName | string | Name for the generated css file | flags | | demo | boolean | Whether to create a demo file | true | | demoDestination | string | Destination for the demo html file. Will have no affect if demo is set to false | flags-demo | | dimensionsClasses | boolean | Whether to add dimensions classes | false | | dimensionsSuffix | string | Suffix for dimensions classes | dims | | lowecaseAlpha2 | boolean | Whether to set the alpha2 code in the css classnames to lowercase | false | | spriteFileName | string | Name for the generated sprite png file | flag-sprite | | spriteUrl | string | Background url for the sprite (excluding the file name) | same as provided sprite destination | | width | number | Maximum width of the flags. Note, all flags will be the same height but not necessarily the same width | 60 | | silent | boolean | Whether to suppress logging | false |