Directory

← Back

nebula-icon-button

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

Author

Rating

Popularity

<100

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

Published on webcomponents.org Polymer Version Sauce Labs Build Status Gitter Chat Become a Patreon

<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

Compatibility

(Loading compatibility data...)

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.

Version

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-focus-behavior#arsnebula/nebula-focus-behavior#^2.0.0
  • nebula-button-behavior#arsnebula/nebula-button-behavior#^2.0.0
  • nebula-icons#arsnebula/nebula-icons#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0
Released
2017-05-18
Maturity
IMPORTED
License
ISC License

Compatibility

Framework
Polymer 2.0+
Polymer 1.0+ in 2.0.0
Browser
Browser Independent

nebula-icon-button - Vaadin Add-on Directory

A web component to display an icon or icon toggle button. nebula-icon-button - Vaadin Add-on Directory
**[ This description is mirrored from README.md at [github.com/arsnebula/nebula-icon-button](https://github.com//arsnebula/nebula-icon-button/blob/v2.0.1/README.md) on 2019-05-10 ]** [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-green.svg)](https://www.webcomponents.org/element/arsnebula/nebula-icon-button) [![Polymer Version](https://img.shields.io/badge/polymer-v2-blue.svg)](https://www.polymer-project.org) [![Sauce Labs Build Status](https://img.shields.io/badge/saucelabs-passing-red.svg)](https://saucelabs.com/beta/builds/0af0f1688aad49c5bf3c7778127c67d2) [![Gitter Chat](https://badges.gitter.im/org.png)](https://gitter.im/arsnebula/webcomponents) [![Become a Patreon](https://img.shields.io/badge/patreon-support_us-orange.svg)](https://www.patreon.com/arsnebula) # \ A customizable icon or icon toggle button. * Supports standard and toggle modes * Easily customized using CSS and configurable icons * Supports [WAI-ARIA](https://www.w3.org/TR/wai-aria-practices-1.1/#button) authoring practices for **a11y** ## Installation ```sh $ bower install -S arsnebula/nebula-icon-button ``` ## Getting Started Import the package. ```html ``` Add a standard button. Set the `icon` property to an icon resource. Listen for a `click` event. ```html My 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. ```html My Icon Toggle Button ``` > The icon properties require a key to a shared icon resource. For more information see [nebula-icons](https://www.webcomponents.org/element/arsnebula/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](https://www.webcomponents.org/element/arsnebula/nebula-element-mixin) or directly on [GitHub](https://github.com/arsnebula/nebula-element-mixin). * Submit a feature request, or a defect report on the [Issues List](https://www.webcomponents.org/element/arsnebula/nebula-element-mixin/issues). * Become a [Patreon](https://www.patreon.com/arsnebula). It takes a lot of time and effort to develop, document, test and support the elements in our [Nebula Essentials](https://www.webcomponents.org/collection/arsnebula/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](/CHANGELOG.md) ## License See [LICENSE](/LICENSE.md)
Online