mflorence99 / mflo-world-flag

Polymer Element: Display World Flag by ISO 3166-1 Code

Polymer Element: Display World Flag by ISO 3166-1 Code

Link
Demo	For an interactive demo
Test	To run the unit tests
Docs	For the generated JSDocs
Info	For more information on my Polymer elements
	bower install --save mflo-world-flag

The demo and test pages are hosted by surge. This is a great service I highly recommend you check out. The pages and associated code are automatically pushed to surge using its CLI during the build process. Awesome!

How to Use

The element uses an iso2 property to set the country of the flag to be displayed. The encoding is ISO 3166-1 alpha-2, with the convenience that it is interpreted case-insensitive.

<mflo-world-flag iso2="gb">
</mflo-world-flag>

The country code can be set programmatically:

var flag = document.querySelector("mflo-world-flag#the-right-one");
flag.iso2 = "de";

An iso3 property is also supported. The encoding is ISO 3166-1 alpha-3, with the convenience that it is interpreted case-insensitive.

How to Style

Style mflo-world-flag as required by defining --mflo-world-flag-theme as show below. The flag icons have a nominal dimension of 48px and should not normally be shown at a larger size.

mflo-world-flag {
  --mflo-world-flag-theme: {
    width: 24px;
  };
}

If you are styling mflo-world-flag from the local DOM, be sure to use custom-style to enclose your CSS. A simple <style> tag will not work, as discussed in the Polymer documentation under Custom element for document styling.

<style is="custom-style">
  mflo-world-flag { ... }
</style>

Author

Mark Florence ([email protected]).

MIT License

© 2015 Mark Florence [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Resources

• Visit the author website.
• Follow @mflo999 on Twitter for updates.