Share SVG icon resources between custom elements.

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

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

<nebula-icons>

Share SVG icons resources between custom elements.

  • Compatible with Polymer Custom Iconset Generator
  • Define custom iconsets and share them between custom elements
  • SVG tags are rendered into Light DOM for easy styling

Installation

$ bower install -S arsnebula/nebula-icons

Usage

Import the element.

<link rel="import" href="/bower_components/nebula-icons/nebula-icons.html">

Define your iconsets once, anywhere in your application. Each iconset is defined by a unique name.

<nebula-iconset name="custom" size="24">
  <svg>
    <defs>
      <g id="add"><path d="M19 13h-6v6h-2v-6H5v-2h6V5h2v6h6v2z"></path></g>
    </defs>
  </svg>
</nebula-iconset>

Render icons anywhere in your application. Icons are accessed with a compount key formatted as [iconset]:[id].

<nebula-icon icon="custom:add"></nebula-icon>

Style the icon using CSS variables or standard CSS properties.

<style>
  nebula-icon {
    --nebula-icon-size: 48px;
    color: darkred;
  }
</style>

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

Install

Link to this version
ImportedReleased 20 May 2017ISC License
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (2.0.0)
Browser Compatibility
Install with
bower install --save arsnebula/nebula-icons"#2.0.1"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.0.1

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0