@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
53 lines (23 loc) • 1.84 kB
Markdown
# kol-modal
<!-- Auto Generated Below -->
## Overview
https://en.wikipedia.org/wiki/Modal_window
## Properties
| Property | Attribute | Description | Type | Default |
| --------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | ----------- |
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
| `_on` | -- | Defines the modal callback functions. | `undefined` \| `({ onClose?: (() => void)` \| `undefined; })` | `undefined` |
| `_variant` | `_variant` | Defines the variant of the modal. | `"blank"` \| `"card"` \| `undefined` | `'blank'` |
| `_width` | `_width` | Defines the width of the modal. (max-width: 100%) | `string` \| `undefined` | `'100%'` |
## Methods
### `closeModal() => Promise<void>`
#### Returns
Type: `Promise<void>`
### `openModal() => Promise<void>`
#### Returns
Type: `Promise<void>`
## Slots
| Slot | Description |
| ---- | --------------------- |
| | The modal's contents. |
----------------------------------------------