@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.
@@ -0,0 +1,106 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # NavigationFlyout
3
+
4
+ Coordinates multiple site navigation triggers in one shared flyout.
5
+
6
+ Import from ``@gridui/navigation-flyout`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { NavigationFlyout } 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
+ ### defaultValue
29
+
30
+ ``string | undefined`` · Optional
31
+
32
+ Initial uncontrolled value. Reset the story after changing it.
33
+
34
+ ### dir
35
+
36
+ ``("ltr" | "rtl") | undefined`` · Optional
37
+
38
+ ### onFocus
39
+
40
+ ``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
41
+
42
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
43
+
44
+ ### onBlur
45
+
46
+ ``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
47
+
48
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
49
+
50
+ ### onChange
51
+
52
+ ``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
53
+
54
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
55
+
56
+ ### onSubmit
57
+
58
+ ``(event: SubmitEvent<HTMLElement>): void`` · Optional
59
+
60
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
61
+
62
+ ### onClick
63
+
64
+ ``(event: MouseEvent<HTMLElement, 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
+
72
+ ### value
73
+
74
+ ``string | undefined`` · Optional
75
+
76
+ Controlled value. Pair with the corresponding change callback.
77
+
78
+ ### onValueChange
79
+
80
+ ``(value: string): void`` · Optional
81
+
82
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
83
+
84
+ ### activationMode
85
+
86
+ ``("manual" | "automatic") | undefined`` · Optional
87
+
88
+ Whether an item is activated automatically or manually.
89
+ - `"automatic"`: hovering or focusing a trigger opens its item, and moving
90
+ away closes it after a short delay.
91
+ - `"manual"`: clicking a trigger toggles the item; hover and focus are ignored
92
+
93
+ ### delayDuration
94
+
95
+ ``number | undefined`` · Optional
96
+
97
+ The duration from when the pointer enters the trigger until the tooltip
98
+ gets opened. When `activationMode` is `manual`, this prop is ignored.
99
+
100
+ ### skipDelayDuration
101
+
102
+ ``number | undefined`` · Optional
103
+
104
+ How much time a user has to enter another trigger without incurring a delay
105
+ again. When `activationMode` is `manual`, this prop is ignored.
106
+
package/package.json CHANGED
@@ -1,6 +1,58 @@
1
1
  {
2
2
  "name": "@gridui/navigation-flyout",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "1.0.0",
4
+ "description": "GridUI React shared flyout for site navigation",
5
+ "license": "UNLICENSED",
6
+ "type": "module",
7
+ "files": [
8
+ "dist",
9
+ "README.md",
10
+ "docs"
11
+ ],
12
+ "sideEffects": [
13
+ "**/*.css",
14
+ "./dist/styled.js"
15
+ ],
16
+ "exports": {
17
+ ".": {
18
+ "types": "./dist/index.d.ts",
19
+ "import": "./dist/index.js"
20
+ },
21
+ "./styles.css": "./dist/styles.css",
22
+ "./styled": {
23
+ "types": "./dist/index.d.ts",
24
+ "import": "./dist/styled.js"
25
+ }
26
+ },
27
+ "publishConfig": {
28
+ "access": "public"
29
+ },
30
+ "peerDependencies": {
31
+ "react": "^19.2.0",
32
+ "react-dom": "^19.2.0"
33
+ },
34
+ "dependencies": {
35
+ "@gridui/interaction": "^1.3.0",
36
+ "@gridui/motion": "^1.0.4",
37
+ "@gridui/overlay": "^2.5.1",
38
+ "@gridui/style-utils": "^4.1.0",
39
+ "@gridui/theme": "^5.1.0",
40
+ "@radix-ui/react-compose-refs": "1.1.5",
41
+ "@radix-ui/react-navigation-menu": "1.4.1",
42
+ "lucide-react": "1.73.0"
43
+ },
44
+ "devDependencies": {
45
+ "@gridui-internal/configuration": "0.0.0-internal",
46
+ "@storybook/react-vite": "10.6.7",
47
+ "@types/node": "26.6.6",
48
+ "@types/react": "19.3.0",
49
+ "@types/react-dom": "19.3.0",
50
+ "react": "19.3.1",
51
+ "react-dom": "19.3.1",
52
+ "typescript": "6.0.3"
53
+ },
54
+ "scripts": {
55
+ "build": "node ../../scripts/compilation/package.ts",
56
+ "compile": "tsc --project tsconfig.json"
57
+ }
6
58
  }