@gridui/navigation-flyout 0.0.0-stage → 1.0.0
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 +20 -2
- package/dist/index.d.ts +20 -0
- package/dist/index.js +185 -0
- package/dist/index.js.map +7 -0
- package/dist/navigation-flyout/navigation-flyout.d.ts +10 -0
- package/dist/navigation-flyout-content/navigation-flyout-content.d.ts +12 -0
- package/dist/navigation-flyout-item/navigation-flyout-item.d.ts +10 -0
- package/dist/navigation-flyout-link/navigation-flyout-link.d.ts +10 -0
- package/dist/navigation-flyout-list/navigation-flyout-list.d.ts +10 -0
- package/dist/navigation-flyout-trigger/navigation-flyout-trigger.d.ts +10 -0
- package/dist/navigation-flyout-viewport/navigation-flyout-viewport.d.ts +10 -0
- package/dist/styled.js +3 -0
- package/dist/styles.css +297 -0
- package/dist/styles.local.css +100 -0
- package/docs/catalog.json +101 -0
- package/docs/reference/README.md +10 -0
- package/docs/reference/navigation-flyout-content.md +102 -0
- package/docs/reference/navigation-flyout-item.md +67 -0
- package/docs/reference/navigation-flyout-link.md +71 -0
- package/docs/reference/navigation-flyout-list.md +61 -0
- package/docs/reference/navigation-flyout-trigger.md +61 -0
- package/docs/reference/navigation-flyout-viewport.md +51 -0
- package/docs/reference/navigation-flyout.md +106 -0
- package/package.json +55 -3
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/*! tailwindcss v4.3.5 | MIT License | https://tailwindcss.com */
|
|
2
|
+
@layer theme, base, components, utilities;
|
|
3
|
+
@layer utilities;
|
|
4
|
+
@layer components {
|
|
5
|
+
.gridui-navigation-flyout {
|
|
6
|
+
position: relative;
|
|
7
|
+
min-inline-size: 0;
|
|
8
|
+
--gridui-navigation-flyout-offset: var(--gridui-space-8);
|
|
9
|
+
--gridui-navigation-flyout-duration: calc(var(--gridui-motion-duration-quick) * var(--gridui-motion-factor, 1));
|
|
10
|
+
}
|
|
11
|
+
.gridui-navigation-flyout-list {
|
|
12
|
+
display: flex;
|
|
13
|
+
flex-wrap: wrap;
|
|
14
|
+
align-items: center;
|
|
15
|
+
gap: var(--gridui-space-4);
|
|
16
|
+
margin: 0;
|
|
17
|
+
padding: 0;
|
|
18
|
+
list-style: none;
|
|
19
|
+
}
|
|
20
|
+
.gridui-navigation-flyout-link {
|
|
21
|
+
color: var(--gridui-foreground);
|
|
22
|
+
text-decoration: none;
|
|
23
|
+
}
|
|
24
|
+
.gridui-navigation-flyout-trigger, .gridui-navigation-flyout-list > li > .gridui-navigation-flyout-link {
|
|
25
|
+
position: relative;
|
|
26
|
+
display: inline-flex;
|
|
27
|
+
align-items: center;
|
|
28
|
+
justify-content: center;
|
|
29
|
+
gap: var(--gridui-space-8);
|
|
30
|
+
min-block-size: max(var(--gridui-control-min-height-medium), var(--gridui-target-min-size));
|
|
31
|
+
padding: var(--gridui-space-8) var(--gridui-space-16);
|
|
32
|
+
border: 1px solid transparent;
|
|
33
|
+
border-radius: var(--gridui-control-radius);
|
|
34
|
+
background: transparent;
|
|
35
|
+
color: var(--gridui-foreground);
|
|
36
|
+
font: var(--gridui-type-ui);
|
|
37
|
+
font-family: var(--gridui-font-body);
|
|
38
|
+
letter-spacing: normal;
|
|
39
|
+
white-space: nowrap;
|
|
40
|
+
}
|
|
41
|
+
.gridui-navigation-flyout-trigger[data-state="open"], .gridui-navigation-flyout-list > li > .gridui-navigation-flyout-link[aria-current="page"] {
|
|
42
|
+
background: var(--gridui-selection-background);
|
|
43
|
+
}
|
|
44
|
+
.gridui-navigation-flyout-chevron {
|
|
45
|
+
flex: none;
|
|
46
|
+
inline-size: var(--gridui-icon-size);
|
|
47
|
+
block-size: var(--gridui-icon-size);
|
|
48
|
+
transition: transform var(--gridui-navigation-flyout-duration) var(--gridui-motion-ease-out);
|
|
49
|
+
}
|
|
50
|
+
.gridui-navigation-flyout-trigger[data-state="open"] .gridui-navigation-flyout-chevron {
|
|
51
|
+
transform: rotate(180deg);
|
|
52
|
+
}
|
|
53
|
+
.gridui-navigation-flyout-anchor {
|
|
54
|
+
position: absolute;
|
|
55
|
+
inset-block-start: 100%;
|
|
56
|
+
inset-inline-start: 0;
|
|
57
|
+
z-index: var(--gridui-z-popover);
|
|
58
|
+
padding-block-start: var(--gridui-navigation-flyout-offset);
|
|
59
|
+
--gridui-navigation-flyout-max-width: max(0px, calc(var(--gridui-navigation-flyout-available-width, 100dvw) - var(--gridui-page-gutter) - 2px));
|
|
60
|
+
--gridui-navigation-flyout-max-height: max(0px, calc(var(--gridui-navigation-flyout-available-height, 100dvh) - var(--gridui-navigation-flyout-offset) - var(--gridui-page-gutter) - 2px));
|
|
61
|
+
}
|
|
62
|
+
.gridui-navigation-flyout-viewport {
|
|
63
|
+
position: relative;
|
|
64
|
+
z-index: var(--gridui-z-popover);
|
|
65
|
+
box-sizing: content-box;
|
|
66
|
+
inline-size: min(var(--radix-navigation-menu-viewport-width, 0px), var(--gridui-navigation-flyout-max-width));
|
|
67
|
+
block-size: min(var(--radix-navigation-menu-viewport-height, 0px), var(--gridui-navigation-flyout-max-height));
|
|
68
|
+
overflow: clip;
|
|
69
|
+
transition: inline-size var(--gridui-navigation-flyout-duration) var(--gridui-motion-ease-out), block-size var(--gridui-navigation-flyout-duration) var(--gridui-motion-ease-out);
|
|
70
|
+
}
|
|
71
|
+
.gridui-navigation-flyout-content {
|
|
72
|
+
position: absolute;
|
|
73
|
+
inset-block-start: 0;
|
|
74
|
+
inset-inline-start: 0;
|
|
75
|
+
box-sizing: border-box;
|
|
76
|
+
inline-size: min(var(--gridui-navigation-flyout-content-width, 40rem), var(--gridui-navigation-flyout-max-width));
|
|
77
|
+
max-block-size: var(--gridui-navigation-flyout-max-height);
|
|
78
|
+
overflow: auto;
|
|
79
|
+
overscroll-behavior: contain;
|
|
80
|
+
}
|
|
81
|
+
.gridui-navigation-flyout-content[data-motion^="from-"] {
|
|
82
|
+
animation: gridui-navigation-flyout-enter var(--gridui-navigation-flyout-duration) var(--gridui-motion-ease-out);
|
|
83
|
+
}
|
|
84
|
+
.gridui-navigation-flyout-content[data-motion="from-start"] {
|
|
85
|
+
--gridui-navigation-flyout-enter-x: calc(-1 * var(--gridui-space-8));
|
|
86
|
+
}
|
|
87
|
+
.gridui-navigation-flyout-content[data-motion="from-end"] {
|
|
88
|
+
--gridui-navigation-flyout-enter-x: var(--gridui-space-8);
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
@keyframes gridui-navigation-flyout-enter {
|
|
92
|
+
from {
|
|
93
|
+
opacity: 0;
|
|
94
|
+
transform: translateX(var(--gridui-navigation-flyout-enter-x));
|
|
95
|
+
}
|
|
96
|
+
to {
|
|
97
|
+
opacity: 1;
|
|
98
|
+
transform: translateX(0);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": 1,
|
|
3
|
+
"name": "@gridui/navigation-flyout",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"category": "navigation",
|
|
6
|
+
"description": "GridUI React shared flyout for site navigation",
|
|
7
|
+
"usage": "Horizontal site navigation with a shared floating viewport. Use it when several triggers reveal different groups of destinations in one place. It does not depend on Popover and is not an action menu.",
|
|
8
|
+
"documentation": [
|
|
9
|
+
"README.md",
|
|
10
|
+
"docs/reference/README.md",
|
|
11
|
+
"docs/reference/navigation-flyout-content.md",
|
|
12
|
+
"docs/reference/navigation-flyout-item.md",
|
|
13
|
+
"docs/reference/navigation-flyout-link.md",
|
|
14
|
+
"docs/reference/navigation-flyout-list.md",
|
|
15
|
+
"docs/reference/navigation-flyout-trigger.md",
|
|
16
|
+
"docs/reference/navigation-flyout-viewport.md",
|
|
17
|
+
"docs/reference/navigation-flyout.md"
|
|
18
|
+
],
|
|
19
|
+
"exports": [
|
|
20
|
+
{
|
|
21
|
+
"name": "NavigationFlyout",
|
|
22
|
+
"kind": "component",
|
|
23
|
+
"importPath": "@gridui/navigation-flyout"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"name": "NavigationFlyoutContent",
|
|
27
|
+
"kind": "component",
|
|
28
|
+
"importPath": "@gridui/navigation-flyout"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"name": "NavigationFlyoutContentProps",
|
|
32
|
+
"kind": "type",
|
|
33
|
+
"importPath": "@gridui/navigation-flyout"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "NavigationFlyoutItem",
|
|
37
|
+
"kind": "component",
|
|
38
|
+
"importPath": "@gridui/navigation-flyout"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "NavigationFlyoutItemProps",
|
|
42
|
+
"kind": "type",
|
|
43
|
+
"importPath": "@gridui/navigation-flyout"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "NavigationFlyoutLink",
|
|
47
|
+
"kind": "component",
|
|
48
|
+
"importPath": "@gridui/navigation-flyout"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "NavigationFlyoutLinkProps",
|
|
52
|
+
"kind": "type",
|
|
53
|
+
"importPath": "@gridui/navigation-flyout"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "NavigationFlyoutList",
|
|
57
|
+
"kind": "component",
|
|
58
|
+
"importPath": "@gridui/navigation-flyout"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "NavigationFlyoutListProps",
|
|
62
|
+
"kind": "type",
|
|
63
|
+
"importPath": "@gridui/navigation-flyout"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "NavigationFlyoutProps",
|
|
67
|
+
"kind": "type",
|
|
68
|
+
"importPath": "@gridui/navigation-flyout"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "NavigationFlyoutTrigger",
|
|
72
|
+
"kind": "component",
|
|
73
|
+
"importPath": "@gridui/navigation-flyout"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "NavigationFlyoutTriggerProps",
|
|
77
|
+
"kind": "type",
|
|
78
|
+
"importPath": "@gridui/navigation-flyout"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "NavigationFlyoutViewport",
|
|
82
|
+
"kind": "component",
|
|
83
|
+
"importPath": "@gridui/navigation-flyout"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "NavigationFlyoutViewportProps",
|
|
87
|
+
"kind": "type",
|
|
88
|
+
"importPath": "@gridui/navigation-flyout"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"styles": [
|
|
92
|
+
"@gridui/theme/styles.css",
|
|
93
|
+
"@gridui/overlay/styles.css",
|
|
94
|
+
"@gridui/navigation-flyout/styles.css"
|
|
95
|
+
],
|
|
96
|
+
"styledImport": "@gridui/navigation-flyout/styled",
|
|
97
|
+
"examples": [
|
|
98
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/getting-started.mdx",
|
|
99
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.stories.tsx"
|
|
100
|
+
]
|
|
101
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<!-- Generated by pnpm docs:storybook. -->
|
|
2
|
+
# Component reference
|
|
3
|
+
|
|
4
|
+
- [NavigationFlyout](navigation-flyout.md)
|
|
5
|
+
- [NavigationFlyoutContent](navigation-flyout-content.md)
|
|
6
|
+
- [NavigationFlyoutItem](navigation-flyout-item.md)
|
|
7
|
+
- [NavigationFlyoutLink](navigation-flyout-link.md)
|
|
8
|
+
- [NavigationFlyoutList](navigation-flyout-list.md)
|
|
9
|
+
- [NavigationFlyoutTrigger](navigation-flyout-trigger.md)
|
|
10
|
+
- [NavigationFlyoutViewport](navigation-flyout-viewport.md)
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# NavigationFlyoutContent
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutContent with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutContent } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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
|
+
### deferPointerDownOutside
|
|
63
|
+
|
|
64
|
+
``boolean | undefined`` · Optional
|
|
65
|
+
|
|
66
|
+
When `true`, a `'pointerdown'` event outside of the layered element will
|
|
67
|
+
wait for the interaction's click event before dispatching, allowing
|
|
68
|
+
third-party code to stop propagation of later events and cancel dismissal.
|
|
69
|
+
|
|
70
|
+
### onEscapeKeyDown
|
|
71
|
+
|
|
72
|
+
``(event: KeyboardEvent): void`` · Optional
|
|
73
|
+
|
|
74
|
+
Event handler called when the escape key is down.
|
|
75
|
+
Can be prevented.
|
|
76
|
+
|
|
77
|
+
### onPointerDownOutside
|
|
78
|
+
|
|
79
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }>): void`` · Optional
|
|
80
|
+
|
|
81
|
+
Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`.
|
|
82
|
+
Can be prevented.
|
|
83
|
+
|
|
84
|
+
### onFocusOutside
|
|
85
|
+
|
|
86
|
+
``(event: CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
87
|
+
|
|
88
|
+
Event handler called when the focus moves outside of the `DismissableLayer`.
|
|
89
|
+
Can be prevented.
|
|
90
|
+
|
|
91
|
+
### onInteractOutside
|
|
92
|
+
|
|
93
|
+
``(event: CustomEvent<{ originalEvent: PointerEvent; }> | CustomEvent<{ originalEvent: FocusEvent; }>): void`` · Optional
|
|
94
|
+
|
|
95
|
+
Event handler called when an interaction happens outside the `DismissableLayer`.
|
|
96
|
+
Specifically, when a `pointerdown` event happens outside or focus moves outside of it.
|
|
97
|
+
Can be prevented.
|
|
98
|
+
|
|
99
|
+
### width
|
|
100
|
+
|
|
101
|
+
``string | number | undefined`` · Optional
|
|
102
|
+
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# NavigationFlyoutItem
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutItem with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutItem } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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
|
+
### value
|
|
23
|
+
|
|
24
|
+
``string | undefined`` · Optional
|
|
25
|
+
|
|
26
|
+
Controlled value. Pair with the corresponding change callback.
|
|
27
|
+
|
|
28
|
+
### children
|
|
29
|
+
|
|
30
|
+
``ReactNode`` · Optional
|
|
31
|
+
|
|
32
|
+
Content rendered inside the component.
|
|
33
|
+
|
|
34
|
+
### onFocus
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLLIElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onBlur
|
|
41
|
+
|
|
42
|
+
``(event: FocusEvent<HTMLLIElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onChange
|
|
47
|
+
|
|
48
|
+
``(event: ChangeEvent<HTMLLIElement, Element>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onSubmit
|
|
53
|
+
|
|
54
|
+
``(event: SubmitEvent<HTMLLIElement>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### onClick
|
|
59
|
+
|
|
60
|
+
``(event: MouseEvent<HTMLLIElement, MouseEvent>): void`` · Optional
|
|
61
|
+
|
|
62
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
63
|
+
|
|
64
|
+
### asChild
|
|
65
|
+
|
|
66
|
+
``boolean | undefined`` · Optional
|
|
67
|
+
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# NavigationFlyoutLink
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutLink with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutLink } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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
|
+
### active
|
|
23
|
+
|
|
24
|
+
``boolean | undefined`` · Optional
|
|
25
|
+
|
|
26
|
+
### onSelect
|
|
27
|
+
|
|
28
|
+
``(event: Event): void`` · Optional
|
|
29
|
+
|
|
30
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
31
|
+
|
|
32
|
+
### children
|
|
33
|
+
|
|
34
|
+
``ReactNode`` · Optional
|
|
35
|
+
|
|
36
|
+
Content rendered inside the component.
|
|
37
|
+
|
|
38
|
+
### onFocus
|
|
39
|
+
|
|
40
|
+
``(event: FocusEvent<HTMLAnchorElement, Element>): void`` · Optional
|
|
41
|
+
|
|
42
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
43
|
+
|
|
44
|
+
### onBlur
|
|
45
|
+
|
|
46
|
+
``(event: FocusEvent<HTMLAnchorElement, Element>): void`` · Optional
|
|
47
|
+
|
|
48
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
49
|
+
|
|
50
|
+
### onChange
|
|
51
|
+
|
|
52
|
+
``(event: ChangeEvent<HTMLAnchorElement, Element>): void`` · Optional
|
|
53
|
+
|
|
54
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
55
|
+
|
|
56
|
+
### onSubmit
|
|
57
|
+
|
|
58
|
+
``(event: SubmitEvent<HTMLAnchorElement>): void`` · Optional
|
|
59
|
+
|
|
60
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
61
|
+
|
|
62
|
+
### onClick
|
|
63
|
+
|
|
64
|
+
``(event: MouseEvent<HTMLAnchorElement, MouseEvent>): void`` · Optional
|
|
65
|
+
|
|
66
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
67
|
+
|
|
68
|
+
### asChild
|
|
69
|
+
|
|
70
|
+
``boolean | undefined`` · Optional
|
|
71
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# NavigationFlyoutList
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutList with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutList } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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<HTMLUListElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLUListElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLUListElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLUListElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLUListElement, 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
|
+
# NavigationFlyoutTrigger
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutTrigger with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutTrigger } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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,51 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# NavigationFlyoutViewport
|
|
3
|
+
|
|
4
|
+
Compose NavigationFlyoutViewport with NavigationFlyout inside the same @gridui/navigation-flyout component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { NavigationFlyoutViewport } from "@gridui/navigation-flyout";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/navigation-flyout/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-flyout/stories/navigation-flyout.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
|
+
### onFocus
|
|
23
|
+
|
|
24
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
25
|
+
|
|
26
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
27
|
+
|
|
28
|
+
### onBlur
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onChange
|
|
35
|
+
|
|
36
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onSubmit
|
|
41
|
+
|
|
42
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onClick
|
|
47
|
+
|
|
48
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|