Files
directus/docs/reference/app/components/v-dialog.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

44 lines
1.4 KiB
Markdown

# Dialog
Renders an overlay with a flex slot rendering whatever content you pass.
```html
<v-dialog>
<v-sheet>
<h2>Are you sure you want to delete this item?</h2>
<v-button>No</v-button>
<v-button>Yes</v-button>
</v-sheet>
</v-dialog>
```
## Reference
#### Props
| Prop | Description | Default | Type |
| ------------ | --------------------------------------------------- | ----------- | --------- |
| `persistent` | Disable closing by clicking on the side | `false` | `Boolean` |
| `active` | Can be used in combination with `v-model` | `undefined` | `Boolean` |
| `placement` | Display it either in the `center` or to the `right` | `'center'` | `String` |
#### Slots
| Slot | Description | Data |
| ----------- | --------------------------------------------- | ---- |
| _default_ | Whatever should be rendered inside the dialog | |
| `activator` | Insert an activator for the dialog | |
#### Events
| Event | Description | Value |
| -------- | ----------------------- | --------- |
| `toggle` | Change the active state | `boolean` |
| `esc` | Escape has been pressed | `boolean` |
#### CSS Variables
| Variable | Default |
| -------------------- | ------- |
| `--v-dialog-z-index` | `100` |