open-vault/ui/lib/core/stories/icon.md

23 lines
726 B
Markdown
Raw Normal View History

<!--THIS FILE IS AUTO GENERATED. This file is generated from JSDoc comments in lib/core/addon/components/icon.js. To make changes, first edit that file and run "yarn gen-story-md icon" to re-generate the content.-->
## Icon
`Icon` components are glyphs used to indicate important information.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| glyph | <code>String</code> | <code></code> | The name of the SVG to render inline. |
**Example**
```js
<Icon @glyph="cancel-square-outline" />
```
**See**
- [Uses of Icon](https://github.com/hashicorp/vault/search?l=Handlebars&q=Icon+OR+icon)
- [Icon Source Code](https://github.com/hashicorp/vault/blob/master/ui/lib/core/addon/components/icon.js)
---