@gridui/drawer 1.1.6 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/drawer-panel/drawer-panel.d.ts +3 -6
- package/dist/drawer-surface/drawer-surface.d.ts +2 -2
- package/dist/index.js +21 -19
- package/dist/index.js.map +3 -3
- package/dist/shared/drawer-panel-options.d.ts +12 -0
- package/dist/styles.css +46 -46
- package/docs/catalog.json +16 -2
- package/docs/reference/README.md +14 -0
- package/docs/reference/drawer-body.md +57 -0
- package/docs/reference/drawer-close-button.md +101 -0
- package/docs/reference/drawer-close.md +61 -0
- package/docs/reference/drawer-description.md +61 -0
- package/docs/reference/drawer-footer.md +57 -0
- package/docs/reference/drawer-header.md +57 -0
- package/docs/reference/drawer-panel.md +131 -0
- package/docs/reference/drawer-surface.md +120 -0
- package/docs/reference/drawer-title.md +61 -0
- package/docs/reference/drawer-trigger.md +61 -0
- package/docs/reference/drawer.md +49 -0
- package/package.json +5 -5
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerCloseButton
|
|
3
|
+
|
|
4
|
+
Compose DrawerCloseButton with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerCloseButton } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### size
|
|
59
|
+
|
|
60
|
+
``"small" | "standard" | "large" | "extra-large" | null | undefined`` · Optional
|
|
61
|
+
|
|
62
|
+
Default: ``"small"``
|
|
63
|
+
|
|
64
|
+
Component size preset.
|
|
65
|
+
|
|
66
|
+
### iconMotion
|
|
67
|
+
|
|
68
|
+
``"none" | "outward" | null | undefined`` · Optional
|
|
69
|
+
|
|
70
|
+
### variant
|
|
71
|
+
|
|
72
|
+
``"text" | "primary" | "secondary" | "quiet" | "highlight" | "underlined" | null | undefined`` · Optional
|
|
73
|
+
|
|
74
|
+
Visual variant.
|
|
75
|
+
|
|
76
|
+
### layout
|
|
77
|
+
|
|
78
|
+
``"cell" | "standard" | "icon" | "entry" | "rail" | "divided" | null | undefined`` · Optional
|
|
79
|
+
|
|
80
|
+
Layout within the containing region.
|
|
81
|
+
|
|
82
|
+
### startIcon
|
|
83
|
+
|
|
84
|
+
``ReactNode`` · Optional
|
|
85
|
+
|
|
86
|
+
### startIconLayout
|
|
87
|
+
|
|
88
|
+
``"divided" | "inline" | undefined`` · Optional
|
|
89
|
+
|
|
90
|
+
### startIconSize
|
|
91
|
+
|
|
92
|
+
``"standard" | "large" | "extra-large" | undefined`` · Optional
|
|
93
|
+
|
|
94
|
+
### endIcon
|
|
95
|
+
|
|
96
|
+
``ReactNode`` · Optional
|
|
97
|
+
|
|
98
|
+
### loading
|
|
99
|
+
|
|
100
|
+
``boolean | undefined`` · Optional
|
|
101
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerClose
|
|
3
|
+
|
|
4
|
+
Compose DrawerClose with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerClose } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLButtonElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### asChild
|
|
59
|
+
|
|
60
|
+
``boolean | undefined`` · Optional
|
|
61
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerDescription
|
|
3
|
+
|
|
4
|
+
Compose DrawerDescription with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerDescription } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLParagraphElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLParagraphElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLParagraphElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLParagraphElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLParagraphElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### asChild
|
|
59
|
+
|
|
60
|
+
``boolean | undefined`` · Optional
|
|
61
|
+
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerFooter
|
|
3
|
+
|
|
4
|
+
Compose DrawerFooter with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerFooter } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerHeader
|
|
3
|
+
|
|
4
|
+
Compose DrawerHeader with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerHeader } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerPanel
|
|
3
|
+
|
|
4
|
+
Compose DrawerPanel with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerPanel } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### forceMount
|
|
23
|
+
|
|
24
|
+
``true | undefined`` · Optional
|
|
25
|
+
|
|
26
|
+
Used to force mounting when more control is needed. Useful when
|
|
27
|
+
controlling animation with React animation libraries.
|
|
28
|
+
|
|
29
|
+
### children
|
|
30
|
+
|
|
31
|
+
``ReactNode`` · Optional
|
|
32
|
+
|
|
33
|
+
Content rendered inside the component.
|
|
34
|
+
|
|
35
|
+
### onFocus
|
|
36
|
+
|
|
37
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
38
|
+
|
|
39
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
40
|
+
|
|
41
|
+
### onBlur
|
|
42
|
+
|
|
43
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
44
|
+
|
|
45
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
46
|
+
|
|
47
|
+
### onChange
|
|
48
|
+
|
|
49
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
50
|
+
|
|
51
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
52
|
+
|
|
53
|
+
### onSubmit
|
|
54
|
+
|
|
55
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
56
|
+
|
|
57
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
58
|
+
|
|
59
|
+
### onClick
|
|
60
|
+
|
|
61
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
62
|
+
|
|
63
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
64
|
+
|
|
65
|
+
### asChild
|
|
66
|
+
|
|
67
|
+
``boolean | undefined`` · Optional
|
|
68
|
+
|
|
69
|
+
### deferPointerDownOutside
|
|
70
|
+
|
|
71
|
+
``boolean | undefined`` · Optional
|
|
72
|
+
|
|
73
|
+
When `true`, a `'pointerdown'` event outside of the layered element will
|
|
74
|
+
wait for the interaction's click event before dispatching, allowing
|
|
75
|
+
third-party code to stop propagation of later events and cancel dismissal.
|
|
76
|
+
|
|
77
|
+
### onEscapeKeyDown
|
|
78
|
+
|
|
79
|
+
``(event: KeyboardEvent): void`` · Optional
|
|
80
|
+
|
|
81
|
+
Event handler called when the escape key is down.
|
|
82
|
+
Can be prevented.
|
|
83
|
+
|
|
84
|
+
### onPointerDownOutside
|
|
85
|
+
|
|
86
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
|
|
87
|
+
|
|
88
|
+
Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`.
|
|
89
|
+
Can be prevented.
|
|
90
|
+
|
|
91
|
+
### onFocusOutside
|
|
92
|
+
|
|
93
|
+
``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
94
|
+
|
|
95
|
+
Event handler called when the focus moves outside of the `DismissableLayer`.
|
|
96
|
+
Can be prevented.
|
|
97
|
+
|
|
98
|
+
### onInteractOutside
|
|
99
|
+
|
|
100
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
101
|
+
|
|
102
|
+
Event handler called when an interaction happens outside the `DismissableLayer`.
|
|
103
|
+
Specifically, when a `pointerdown` event happens outside or focus moves outside of it.
|
|
104
|
+
Can be prevented.
|
|
105
|
+
|
|
106
|
+
### onOpenAutoFocus
|
|
107
|
+
|
|
108
|
+
``(event: Event): void`` · Optional
|
|
109
|
+
|
|
110
|
+
Event handler called when auto-focusing on open.
|
|
111
|
+
Can be prevented.
|
|
112
|
+
|
|
113
|
+
### onCloseAutoFocus
|
|
114
|
+
|
|
115
|
+
``(event: Event): void`` · Optional
|
|
116
|
+
|
|
117
|
+
Event handler called when auto-focusing on close.
|
|
118
|
+
Can be prevented.
|
|
119
|
+
|
|
120
|
+
### side
|
|
121
|
+
|
|
122
|
+
``"start" | "end" | "left" | "right" | undefined`` · Optional
|
|
123
|
+
|
|
124
|
+
Default: ``"end"``
|
|
125
|
+
|
|
126
|
+
### portal
|
|
127
|
+
|
|
128
|
+
``boolean | undefined`` · Optional
|
|
129
|
+
|
|
130
|
+
Default: ``true``
|
|
131
|
+
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerSurface
|
|
3
|
+
|
|
4
|
+
Compose DrawerSurface with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerSurface } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### asChild
|
|
59
|
+
|
|
60
|
+
``boolean | undefined`` · Optional
|
|
61
|
+
|
|
62
|
+
Default: ``false``
|
|
63
|
+
|
|
64
|
+
### deferPointerDownOutside
|
|
65
|
+
|
|
66
|
+
``boolean | undefined`` · Optional
|
|
67
|
+
|
|
68
|
+
When `true`, a `'pointerdown'` event outside of the layered element will
|
|
69
|
+
wait for the interaction's click event before dispatching, allowing
|
|
70
|
+
third-party code to stop propagation of later events and cancel dismissal.
|
|
71
|
+
|
|
72
|
+
### onEscapeKeyDown
|
|
73
|
+
|
|
74
|
+
``(event: KeyboardEvent): void`` · Optional
|
|
75
|
+
|
|
76
|
+
Event handler called when the escape key is down.
|
|
77
|
+
Can be prevented.
|
|
78
|
+
|
|
79
|
+
### onPointerDownOutside
|
|
80
|
+
|
|
81
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
|
|
82
|
+
|
|
83
|
+
Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`.
|
|
84
|
+
Can be prevented.
|
|
85
|
+
|
|
86
|
+
### onFocusOutside
|
|
87
|
+
|
|
88
|
+
``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
89
|
+
|
|
90
|
+
Event handler called when the focus moves outside of the `DismissableLayer`.
|
|
91
|
+
Can be prevented.
|
|
92
|
+
|
|
93
|
+
### onInteractOutside
|
|
94
|
+
|
|
95
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
96
|
+
|
|
97
|
+
Event handler called when an interaction happens outside the `DismissableLayer`.
|
|
98
|
+
Specifically, when a `pointerdown` event happens outside or focus moves outside of it.
|
|
99
|
+
Can be prevented.
|
|
100
|
+
|
|
101
|
+
### onOpenAutoFocus
|
|
102
|
+
|
|
103
|
+
``(event: Event): void`` · Optional
|
|
104
|
+
|
|
105
|
+
Event handler called when auto-focusing on open.
|
|
106
|
+
Can be prevented.
|
|
107
|
+
|
|
108
|
+
### onCloseAutoFocus
|
|
109
|
+
|
|
110
|
+
``(event: Event): void`` · Optional
|
|
111
|
+
|
|
112
|
+
Event handler called when auto-focusing on close.
|
|
113
|
+
Can be prevented.
|
|
114
|
+
|
|
115
|
+
### side
|
|
116
|
+
|
|
117
|
+
``"start" | "end" | "left" | "right" | undefined`` · Optional
|
|
118
|
+
|
|
119
|
+
Default: ``"end"``
|
|
120
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DrawerTitle
|
|
3
|
+
|
|
4
|
+
Compose DrawerTitle with Drawer inside the same @gridui/drawer component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/drawer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DrawerTitle } from "@gridui/drawer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/drawer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/drawer/stories/drawer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLHeadingElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLHeadingElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLHeadingElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLHeadingElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLHeadingElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### asChild
|
|
59
|
+
|
|
60
|
+
``boolean | undefined`` · Optional
|
|
61
|
+
|