11bbc5fff5
* feat: migrated the navigation metadata from inline MD title decorations to frontmatter * fix: fixed frontmatter metadate for api-table MDs * fix: fixed frontmatter eslint issue
105 lines
2.8 KiB
Markdown
105 lines
2.8 KiB
Markdown
---
|
||
parts:
|
||
- Icon
|
||
- Use Cases
|
||
title: 'Icon: Use Cases'
|
||
eleventyNavigation:
|
||
key: 'Icon: Use Cases'
|
||
order: 20
|
||
parent: Icon
|
||
title: Use Cases
|
||
---
|
||
|
||
# Icon: Use Cases
|
||
|
||
```js script
|
||
import { html } from '@mdjs/mdjs-preview';
|
||
import { icons } from '@lion/ui/icon.js';
|
||
import './assets/iconset-bugs.js';
|
||
import './assets/iconset-misc.js';
|
||
import * as spaceSet from './assets/iconset-space.js';
|
||
|
||
import '@lion/ui/define/lion-icon.js';
|
||
|
||
icons.addIconResolver('lion', (iconset, name) => {
|
||
switch (iconset) {
|
||
case 'bugs':
|
||
return import('./assets/iconset-bugs.js').then(module => module[name]);
|
||
case 'space':
|
||
return import('./assets/iconset-space.js').then(module => module[name]);
|
||
case 'misc':
|
||
return import('./assets/iconset-misc.js').then(module => module[name]);
|
||
default:
|
||
throw new Error(`Unknown iconset ${iconset}`);
|
||
}
|
||
});
|
||
```
|
||
|
||
## Icon sets
|
||
|
||
Icons are displayed using icon sets. These are collections of icons, lazily loaded on demand for performance.
|
||
See the [system documentation](../../fundamentals/systems/icon/overview.md) to learn more about icon sets.
|
||
|
||
```js preview-story
|
||
export const iconSets = () => html`
|
||
${Object.keys(spaceSet).map(
|
||
name => html`
|
||
<style>
|
||
.demo-icon__container {
|
||
display: inline-flex;
|
||
position: relative;
|
||
flex-grow: 1;
|
||
flex-direction: column;
|
||
align-items: center;
|
||
width: 80px;
|
||
height: 80px;
|
||
padding: 4px;
|
||
}
|
||
.demo-icon__name {
|
||
font-size: 10px;
|
||
}
|
||
</style>
|
||
<div class="demo-icon__container">
|
||
<lion-icon icon-id="lion:space:${name}" aria-label="${name}"></lion-icon>
|
||
<span class="demo-icon__name">${name}</span>
|
||
</div>
|
||
`,
|
||
)}
|
||
`;
|
||
```
|
||
|
||
If for some reason you don't want to lazy load icons, you can still import and use them
|
||
synchronously.
|
||
|
||
## Accessibility
|
||
|
||
It is recommended to add an `aria-label` to provide information to visually impaired users:
|
||
|
||
A `lion-icon` without an `aria-label` attribute will be automatically given an `aria-hidden` attribute.
|
||
|
||
```js preview-story
|
||
export const accessibleLabel = () => html`
|
||
<lion-icon icon-id="lion:misc:arrowLeft" aria-label="Pointing left"></lion-icon>
|
||
`;
|
||
```
|
||
|
||
## Styling
|
||
|
||
By default, a `lion-icon` will be `1em` × `1em` (the current line-height).
|
||
|
||
`lion-icon` uses SVGs and may be styled with CSS, including using CSS properties such as `fill`:
|
||
|
||
```js preview-story
|
||
export const Styling = () => html`
|
||
<style>
|
||
.demo-icon {
|
||
width: 160px;
|
||
height: 160px;
|
||
fill: blue;
|
||
}
|
||
</style>
|
||
<lion-icon icon-id="lion:bugs:bug02" aria-label="Bug" class="demo-icon"></lion-icon>
|
||
`;
|
||
```
|
||
|
||
See [SVG and CSS](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/SVG_and_CSS) on MDN web docs for more information.
|