nebula-icon-button

A web component to display an icon or icon toggle button.

View larger

Close

[ This description is mirrored from README.md at github.com/arsnebula/nebula-icon-button on 2019-05-10 ]

<nebula-icon-button>

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

Installation

$ bower install -S arsnebula/nebula-icon-button

Getting Started

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 click event.

<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 change event.

<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.

Contributing

We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:

• Give us a Star on GitHub from either webcomponents.org or directly on GitHub.

• 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:

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

Change Log

See CHANGELOG

License

See LICENSE

Links

• Issue tracker
• License
• Online Demo
• Documentation
• GitHub Homepage
• View on GitHub

Compatibility