flagpack - npm Package Compare versions

Comparing version 0.4.2 to 0.5.0

package.json

		{
		"name": "flagpack",
		"version": "0.4.2",
		"version": "0.5.0",
		"description": "A lightweight flag icon toolkit for the web",
		@@ -5,0 +5,0 @@ "main": "builder.js",

README.md

		@@ -1,1 +0,73 @@
		# Flag Pack
		# Flagpack
		####_A lightweight flag icon toolkit for the web_

		![Flagpack Screenshot](https://flag.pk/og.jpg)

		[visit site](https://flag.pk/world)


		## Install
		flagpack can be installed with npm.

		```
		npm install flagpack
		```
		## Use in your project

		### CSS
		you can import the built css file directly into your project. this will include all the css classes & flag icons.

		### examples

		Default flag: `bo` is the country code (Bolivia is used for the examples).

		`<span class="fp bo"></span>`

		medium:

		`<span class="fp fp-md bo"></span>`

		large:

		`<span class="fp fp-lg bo"></span>`

		rounded:

		`<span class="fp fp-rounded bo"></span>`


		_[visit the flag.pk](https://flag.pk/world) to quickly copy your countries code for you project._

		### SASS
		Flagpack is built with SASS (SCSS). There are a few variables that are `!default` so that you can override them easily.

		Set custom prefix: Set the class prefix (the default is `fp`).

		```
		$fp-prefix: 'fp' !default;
		```

		Set default icon size: This will also mofify the `fp-md` & `fp-lg` sizes.

		```
		$fp-size: 1em !default;

		```
		Flag SVG path: You will always need to override this if you are going to use the sass files.

		```
		$fp-path: '../flags/' !default;
		```

		Countries: If you would like to include only a few countries you can override this variable. Just Include the country codes you want.

		```
		$fp-countries: 'ad', 'ae', 'af', 'ag', 'ai', 'al', 'am', 'ao', 'ar', 'as', 'at', 'au', 'aw', 'ax', 'az', 'ba', 'bb', 'bd', 'be', 'bf', 'bg', 'bh', 'bi', 'bj', 'bl', 'bm', 'bn', 'bo', 'bq', 'br', 'bs', 'bt', 'bv', 'bw', 'by', 'bz', 'ca', 'cc', 'cd', 'cf', 'cg', 'ch', 'ci', 'ck', 'cl', 'cm', 'cn', 'co', 'cr', 'cu', 'cv', 'cw', 'cx', 'cy', 'cz', 'de', 'dj', 'dk', 'dm', 'do', 'dz', 'ec', 'ee', 'eg', 'eh', 'er', 'es', 'et', 'eu', 'fi', 'fj', 'fk', 'fm', 'fo', 'fr', 'ga', 'gb-eng', 'gb-nir', 'gb-sct', 'gb-wls', 'gb-zet', 'gb', 'gd', 'ge', 'gf', 'gg', 'gh', 'gi', 'gl', 'gm', 'gn', 'gp', 'gq', 'gr', 'gs', 'gt', 'gu', 'gw', 'gy', 'hk', 'hm', 'hn', 'hr', 'ht', 'hu', 'id', 'ie', 'il', 'im', 'in', 'io', 'iq', 'ir', 'is', 'it', 'je', 'jm', 'jo', 'jp', 'ke', 'kg', 'kh', 'ki', 'km', 'kn', 'kp', 'kr', 'kw', 'ky', 'kz', 'la', 'lb', 'lc', 'lgbt', 'li', 'lk', 'lr', 'ls', 'lt', 'lu', 'lv', 'ly', 'ma', 'mc', 'md', 'me', 'mf', 'mg', 'mh', 'mk', 'ml', 'mm', 'mn', 'mo', 'mp', 'mq', 'mr', 'ms', 'mt', 'mu', 'mv', 'mw', 'mx', 'my', 'mz', 'na', 'nc', 'ne', 'nf', 'ng', 'ni', 'nl', 'no', 'np', 'nr', 'nu', 'nz', 'om', 'pa', 'pe', 'pf', 'pg', 'ph', 'pk', 'pl', 'pm', 'pn', 'pr', 'ps', 'pt', 'pw', 'py', 'qa', 're', 'ro', 'rs', 'ru', 'rw', 'sa', 'sb', 'sc', 'sd', 'se', 'sg', 'sh', 'si', 'sj', 'sk', 'sl', 'sm', 'sn', 'so', 'sr', 'ss', 'st', 'sv', 'sx', 'sy', 'sz', 'tc', 'td', 'tf', 'tg', 'th', 'tj', 'tk', 'tl', 'tm', 'tn', 'to', 'tr', 'tt', 'tv', 'tw', 'tz', 'ua', 'ug', 'um', 'us', 'uy', 'uz', 'va', 'vc', 've', 'vg', 'vi', 'vn', 'vu', 'wf', 'ws', 'xk', 'ye', 'yt', 'za', 'zm', 'zw' !default;

		```
		## Why use this library?
		Most flag libraries out there either use low quality png files or overly complex svg flag images. flagpack is around `62kb gzipped` this is including all the svgs and css, making it about 20x smaller than `flag-icon-css`

		## Special thanks

		Special thanks to [flagkit](https://github.com/madebybowtie/FlagKit) for the best collection of svg flags out there!

flagpack - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics