/collapse-selector

Polymer Web Component to manage a list of selectable elements which can collapse per category.

Primary LanguageHTML

<collapse-selector>

Polymer Web Component to manage a list of selectable elements which can collapse per category. As implied in the name, it is using <core-collapse> and extending <core-selector>.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install collapse-selector --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/collapse-selector/dist/my-element.html">
  3. Start using it!

    <collapse-selector></collapse-selector>

Options

Coming soon...

Attribute Options Default Description
foo string bar Lorem ipsum dolor.

Methods

Method Parameters Returns Description
unicorn() None. Nothing. Magic stuff appears.

Development

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

  • Install Bower & Grunt:

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

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

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

    $ grunt build
  • 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