mirror of
https://github.com/directus/directus.git
synced 2026-02-01 17:15:00 -05:00
c2e7c85bbd
* 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>
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
# Notice
|
|
|
|
Render a small notice to warn of something or to give tips on how to use things.
|
|
|
|
```html
|
|
<v-notice>I'm a notice!</v-notice>
|
|
```
|
|
|
|
## Reference
|
|
|
|
#### Props
|
|
|
|
| Prop | Description | Default | Type |
|
|
| -------- | ------------------------------------------------------------------ | ---------- | ---------------------------------------------------------- |
|
|
| `type` | One of `info`, `success`, `warning`, `danger` | `'normal'` | `'normal' or 'info' or 'success' or 'warning' or 'danger'` |
|
|
| `icon` | Custom icon name, or false if you want to hide the icon completely | `null` | `[String, Boolean]` |
|
|
| `center` | Render notice content centered | `false` | `Boolean` |
|
|
|
|
#### CSS Variables
|
|
|
|
| Variable | Default |
|
|
| ----------------------------- | --------------------------- |
|
|
| `--v-notice-color` | `var(--foreground-subdued)` |
|
|
| `--v-notice-background-color` | `var(--background-subdued)` |
|
|
| `--v-notice-icon-color` | `var(--foreground-subdued)` |
|
|
|
|
#### Slots
|
|
|
|
| Slot | Description | Data |
|
|
| --------- | ------------------------------------ | ---- |
|
|
| _default_ | Whatever should be inside the notice | |
|