A web component to display an icon or icon toggle button.
[ This description is mirrored from README.md at github.com/arsnebula/nebula-icon-button on 2019-05-10 ]
A customizable icon or icon toggle button.
- Supports standard and toggle modes
- Easily customized using CSS and configurable icons
- Supports WAI-ARIA authoring practices for a11y
$ bower install -S arsnebula/nebula-icon-button
Import the package.
<link rel="import" href="/bower_components/nebula-icon-button/nebula-icon-button.html">
Add a standard button. Set the
icon property to an icon resource. Listen for a
<nebula-icon-button icon="icons:bookmark" on-click="_onClick"> My Icon Button </nebula-icon-button>
To create a toggle button, enable the
toggle property, and set the
activeIcon property to an icon resource displayed when the button is pressed. Listen for a
click, or a
<nebula-icon-button icon="icons:bookmark-border" active-icon="icons:bookmark" on-change="_onChange" toggle> My Icon Toggle Button </nebula-icon-button>
The icon properties require a key to a shared icon resource. For more information see nebula-icons.
For more information, see the API Reference documentation.
We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:
Submit a feature request, or a defect report on the Issues List.
Become a Patreon. It takes a lot of time and effort to develop, document, test and support the elements in our Nebula Essentials collection. Your financial contribution will help ensure that our entire collection continues to grow and improve.
If you are a developer, and are interested in making a code contribution, consider opening an issue first to describe the change, and discuss with the core repository maintainers. Once you are ready, prepare a pull request:
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.
- ISC License
- Polymer 2.0+
- Polymer 1.0+ in 2.0.0
- Browser Independent