Files
directus/docs/reference/app/components/v-info.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

34 lines
1.3 KiB
Markdown

# Info
Renders a stylized informational placard. It's similar in `v-notice` in it's use case.
```html
<v-info icon="person" title="User Not Found" type="warning">We couldn't find the user you're looking for.</v-info>
```
## Reference
#### Props
| Prop | Description | Default | Type |
| --------- | --------------------------------------------- | -------- | ---------------------------------------------- |
| `title`\* | The title to display in the info | | `String` |
| `icon` | What icon to render above the title | `'box'` | `String` |
| `type` | One of `info`, `success`, `warning`, `danger` | `'info'` | `'info' or 'success' or 'warning' or 'danger'` |
| `center` | Display the info centered | `false` | `Boolean` |
#### Events
n/a
#### Slots
| Slot | Description | Data |
| --------- | ------------------------------------------------------------ | ---- |
| _default_ | Default content area. Is rendered within a styled `<p>` tag. | |
| `append` | After the main body copy. Can be used to inject buttons etc. | |
#### CSS Variables
n/a