UNPKG

@public-ui/components

Version:

Contains all web components that belong to KoliBri - The accessible HTML-Standard.

public-ui.github.io

public-ui/kolibri

77 lines (37 loc) • 3.56 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# kol-drawer <!-- Auto Generated Below --> ## Properties | Property | Attribute | Description | Type | Default | | --------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | `_align` | `_align` | Defines the visual orientation of the component. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `undefined` | | `_hasCloser` | `_has-closer` | Defines whether the element can be closed. | `boolean \| undefined` | `false` | | `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` | | `_level` | `_level` | Defines which H-level from 1-6 the heading has. 0 specifies no heading and is shown as bold text. | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| undefined` | `0` | | `_on` | -- | Specifies the EventCallback function to be called when the drawer is closing. | `undefined \| ({ onCancel?: ((event: Event) => void) \| undefined; onClose?: (() => void) \| undefined; onToggle?: ((open: boolean) => void) \| undefined; })` | `undefined` | | `_open` | `_open` | Opens/expands the element when truthy, closes/collapses when falsy. | `boolean \| undefined` | `undefined` | ## Methods ### `close() => Promise<void>` Closes the drawer. #### Returns Type: `Promise<void>` ### `open() => Promise<void>` <span class="text-red-500">**[DEPRECATED]**</span> Use show() or showModal() instead.<br/><br/>Opens the drawer. #### Returns Type: `Promise<void>` ### `show(modal?: boolean) => Promise<void>` Opens the drawer. Pass true to open as a modal drawer. #### Parameters | Name | Type | Description | | ------- | --------- | ----------- | | `modal` | `boolean` | | #### Returns Type: `Promise<void>` ### `showModal() => Promise<void>` Opens the drawer as a modal. #### Returns Type: `Promise<void>` ## Slots | Slot | Description | | ---- | ---------------------- | | | The Content of drawer. | ----------------------------------------------