clay-icon

Clay Icon Component

Usage no npm install needed!

<script type="module">
  import clayIcon from 'https://cdn.skypack.dev/clay-icon';
</script>

README

clay-icon

A Metal Clay component for rendering SVG icons and third-party icon fonts. For third-party fonts, make sure the font file and css are included on the page.

Rendering Clay SVG Icons:

new metal.ClayIcon({
    spritemap: '/path/to/the/spritemap.svg',
    symbol: 'plus'
});

Rendering Clay Font Awesome Icons

new metal.ClayIcon({
    elementClasses: 'clay-fa icon-plus'
});

Rendering Glyphicons:

new metal.ClayIcon({
    elementClasses: 'glyphicon glyphicon-plus'
});

Rendering Font Awesome 4 Icons:

new metal.ClayIcon({
    elementClasses: 'fa fa-plus'
});

Setup

  1. See metal-clay-components/README.md

  2. Build the code:

npm run build
  1. Watch task:
npm run watch

Contribute

We'd love to get contributions from you! Please, check our Contributing Guidelines to see how you can help us improve.