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

24 lines
955 B
Markdown
Raw Normal View History

<!--THIS FILE IS AUTO GENERATED. This file is generated from JSDoc comments in lib/core/addon/components/chevron.js. To make changes, first edit that file and run "yarn gen-story-md chevron" to re-generate the content.-->
## Chevron
`Chevron` components render `Icon` with one of the `chevron-` glyphs.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [direction] | <code>String</code> | <code>&quot;right&quot;</code> | the direction the chevron icon points. Accepted values are "right", "down", "left", "up". |
| [isButton] | <code>String</code> | <code>false</code> | if true, adjusts the CSS classes to push the icon closer to the right of a button. |
**Example**
```js
<Chevron @direction="up" />
```
**See**
- [Uses of Chevron](https://github.com/hashicorp/vault/search?l=Handlebars&q=Chevron+OR+chevron)
- [Chevron Source Code](https://github.com/hashicorp/vault/blob/main/ui/lib/core/addon/components/chevron.js)
---