lion/docs/components/icon/overview.md
Pavlik Kiselev 11bbc5fff5
feat: migrated the navigation metadata from inline MD title decorations to frontmatter
* 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
2025-03-19 10:08:22 +01:00

52 lines
1.1 KiB
Markdown

---
parts:
- Icon
- Overview
title: 'Icon: Overview'
eleventyNavigation:
key: 'Icon: Overview'
order: 10
parent: Icon
title: Overview
---
# Icon: Overview
A web component for displaying icons.
```js script
import { html } from '@mdjs/mdjs-preview';
import { icons } from '@lion/ui/icon.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}`);
}
});
```
```js preview-story
export const main = () => html`
<lion-icon icon-id="lion:space:alienSpaceship" style="width: 50px; height: 50px;"></lion-icon>
`;
```
## Installation
```bash
npm i --save @lion/ui
```
```js
import { LionIcon } from '@lion/ui/icon.js';
// or
import '@lion/ui/define/lion-icon.js';
```