ayo/lion

History

CircleCI b4a086cd9a chore: release new versions - @lion/ajax@0.1.13 - @lion/button@0.1.45 - @lion/calendar@0.1.41 - @lion/checkbox-group@0.1.41 - @lion/checkbox@0.1.38 - @lion/choice-input@0.2.15 - @lion/core@0.1.10 - @lion/field@0.1.35 - @lion/fieldset@0.1.37 - @lion/form-system@0.0.43 - @lion/form@0.1.40 - @lion/icon@0.2.2 - @lion/input-amount@0.1.38 - @lion/input-date@0.1.37 - @lion/input-datepicker@0.1.44 - @lion/input-email@0.1.37 - @lion/input-iban@0.1.38 - @lion/input@0.1.37 - @lion/localize@0.4.6 - @lion/overlays@0.3.8 - @lion/popup@0.2.21 - @lion/radio-group@0.1.41 - @lion/radio@0.1.38 - @lion/select@0.1.35 - @lion/steps@0.1.11 - @lion/textarea@0.1.38 - @lion/tooltip@0.2.21 - @lion/validate@0.2.19		2019-07-23 15:02:24 +00:00
..
src	feat(icon): enforce icon security using tagged templates	2019-07-01 17:48:05 +02:00
stories	chore(icon): remove misleading story	2019-07-02 14:03:35 +02:00
test	feat(icon): enforce icon security using tagged templates	2019-07-01 17:48:05 +02:00
CHANGELOG.md	chore: release new versions	2019-07-23 15:02:24 +00:00
index.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
lion-icon.js	feat: release inital public lion version	2019-04-26 10:37:57 +02:00
package.json	chore: release new versions	2019-07-23 15:02:24 +00:00
README.md	feat(icon): enforce icon security using tagged templates	2019-07-01 17:48:05 +02:00

Icon

A web component for displaying icons.

How to use

npm i --save @lion/icon

import '@lion/icon/lion-icon.js';

Include the import for both the custom element the icons you want:

<script type="module">
  import 'lion-icon/lion-icon.js';
  import bugSvg from '../icons/bug.svg.js';
</script>

Use it in your lit-html template:

<lion-icon .svg=${bugSvg}></lion-icon>

Icon file is an ES module with an extension .svg.js which exports a function like this:

// bug.svg.js
export default tag => tag`
  <svg focusable="false" ...>...</svg>
`;

Make sure you have focusable="false" in the icon file to prevent bugs in IE/Edge when the icon appears in tab-order.

You may add an aria-label to provide information to visually impaired users:

<lion-icon .svg=${arrowLeftSvg} aria-label="Pointing left"></lion-icon>

A lion-icon without an aria-label attribute will be automatically be given an aria-hidden attribute.

By default, a lion-icon will be 1em × 1em (the current line-height).

A lion-icon may be styled like a regular HTML element:

<style>
  lion-icon.big {
    width: 3rem;
    height: 3rem;
  }
</style>

lion-icon uses SVGs and may be styled with CSS, using CSS properties such as fill and stroke:

<style>
  lion-icon.strong {
    fill: azure;
    stroke: lightsteelblue;
  }
</style>
<lion-icon .icon=${arrowSvg} class="strong"></lion-icon>

See SVG and CSS on MDN web docs for more information.