Skip to content

krosti/world-flag-polymer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<world-flag>

Polymer component who aims standarize i18n information.

Maintined by Fernando Cea @krosti LinkedIn

Contributors: Karl Groves

Demo

Check it live!

Install

Install the component using Bower:

$ bower install world-flag-polymer --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/world-flag-polymer/dist/world-flag.html">
  3. Start using it!

    <world-flag></world-flag>

Options

Attribute Options Default Description
language string en Standard i18n short-name
languageLong string English Long, human readable name of the language
icon boolean true Icon visibility
size string 'small, medium, large' '' Icon size
type boolean '' Icon display style

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  1. Install Node

  2. Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  3. Install local dependencies:

    $ bower install && npm install
  4. To test your project, start the development server and open http://localhost:8000.

    $ grunt server
  5. To build the distribution files before releasing a new version.

    $ grunt build
  6. To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License -