@gridui/site-navigation 1.1.7 → 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 CHANGED
@@ -16,7 +16,7 @@ preferences, desktop content, and optional mobile content/footer slots.
16
16
  ResponsiveNavigation owns desktop/mobile switching. Menu owns content-neutral
17
17
  navigation parts. Drawer owns modal focus management, scroll locking, start/end
18
18
  placement, dismissal, and its header/body/footer parts. The independent Popover
19
- family owns desktop hover intent. SiteHeader supplies a separate frame shell
19
+ family owns desktop hover intent. FrameHeader supplies a separate frame shell
20
20
  with caller-owned branding.
21
21
 
22
22
  Set `columns={1}` on a MenuGrid passed as mobile content; the composition does
@@ -28,10 +28,10 @@ preferences form one compact group at the far end, use an application utility
28
28
  class that disables the root's default flex growth:
29
29
 
30
30
  ```tsx
31
- <SiteHeader justify="between" gap={16} padding={{ base: 24, lg: 32 }}>
31
+ <FrameHeader justify="between" gap={16} padding={{ base: 24, lg: 32 }}>
32
32
  <BrandLink href="/">Product</BrandLink>
33
33
  <SiteNavigation className="flex-none" {...localizedNavigation} />
34
- </SiteHeader>
34
+ </FrameHeader>
35
35
  ```
36
36
 
37
37
  Without that class, the navigation keeps its existing flexible width, placing
@@ -67,3 +67,5 @@ normal trigger restoration. It does not cancel navigation or drawer dismissal.
67
67
  Caller-owned `mobileContent`, `mobilePreferences`, and `mobileFooter` slots retain
68
68
  their own activation policy. Compose their controls with public Drawer parts
69
69
  when they should dismiss the panel.
70
+
71
+ [Component reference](docs/reference/README.md) contains focused API pages for each public component.
package/docs/catalog.json CHANGED
@@ -1,12 +1,14 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "name": "@gridui/site-navigation",
4
- "version": "1.1.7",
4
+ "version": "1.1.8",
5
5
  "category": "landing",
6
6
  "description": "GridUI React site navigation",
7
7
  "usage": "SiteNavigation combines `@gridui/responsive-navigation`, `@gridui/menu`, `@gridui/drawer`, and `@gridui/button`. Applications supply links, localized labels, preferences, desktop content, and optional mobile content/footer slots.",
8
8
  "documentation": [
9
- "README.md"
9
+ "README.md",
10
+ "docs/reference/README.md",
11
+ "docs/reference/site-navigation.md"
10
12
  ],
11
13
  "exports": [
12
14
  {
@@ -36,6 +38,8 @@
36
38
  "@gridui/site-navigation/styles.css"
37
39
  ],
38
40
  "examples": [
41
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-landing/site-navigation/stories/mobile-navigation.mdx",
42
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-landing/site-navigation/stories/site-navigation.mdx",
39
43
  "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-landing/site-navigation/stories/site-navigation.stories.tsx"
40
44
  ]
41
45
  }
@@ -0,0 +1,4 @@
1
+ <!-- Generated by pnpm docs:storybook. -->
2
+ # Component reference
3
+
4
+ - [SiteNavigation](site-navigation.md)
@@ -0,0 +1,71 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # SiteNavigation
3
+
4
+ Composes public-site branding and navigation across viewport sizes. Applications supply links, actions, and preference choices.
5
+
6
+ Import from ``@gridui/site-navigation`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { SiteNavigation } from "@gridui/site-navigation";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/site-navigation/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-landing/site-navigation/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-landing/site-navigation/stories/site-navigation.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
+ ### label
23
+
24
+ ``string`` · Required
25
+
26
+ ### links
27
+
28
+ ``readonly SiteNavigationLink[]`` · Required
29
+
30
+ ### preferences
31
+
32
+ ``ReactNode`` · Required
33
+
34
+ ### desktopContent
35
+
36
+ ``ReactNode`` · Optional
37
+
38
+ ### menuLabel
39
+
40
+ ``string`` · Required
41
+
42
+ ### closeLabel
43
+
44
+ ``string`` · Required
45
+
46
+ ### settingsLabel
47
+
48
+ ``string`` · Required
49
+
50
+ ### mobilePreferences
51
+
52
+ ``ReactNode`` · Required
53
+
54
+ ### mobileContent
55
+
56
+ ``ReactNode`` · Optional
57
+
58
+ ### mobileFooter
59
+
60
+ ``ReactNode`` · Optional
61
+
62
+ ### onMobileCloseAutoFocus
63
+
64
+ ``(event: Event): void`` · Optional
65
+
66
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
67
+
68
+ ### className
69
+
70
+ ``string | undefined`` · Optional
71
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gridui/site-navigation",
3
- "version": "1.1.7",
3
+ "version": "1.1.8",
4
4
  "description": "GridUI React site navigation",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",
@@ -27,21 +27,21 @@
27
27
  "react-dom": "^19.2.0"
28
28
  },
29
29
  "dependencies": {
30
- "@gridui/button": "^4.0.0",
31
- "@gridui/drawer": "^1.1.7",
30
+ "@gridui/button": "^4.1.0",
31
+ "@gridui/drawer": "^1.1.8",
32
32
  "@gridui/interaction": "^1.2.1",
33
- "@gridui/menu": "^3.0.0",
34
- "@gridui/responsive-navigation": "^1.1.6",
35
- "@gridui/style-utils": "^3.0.0",
33
+ "@gridui/menu": "^4.0.0",
34
+ "@gridui/responsive-navigation": "^1.1.7",
35
+ "@gridui/style-utils": "^4.0.0",
36
36
  "@gridui/theme": "^2.5.3",
37
37
  "class-variance-authority": "0.7.1",
38
38
  "lucide-react": "1.70.0"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@gridui-internal/configuration": "0.0.0-internal",
42
- "@gridui/brand-link": "1.0.5",
43
- "@gridui/grid": "2.3.6",
44
- "@gridui/preferences": "1.0.8",
42
+ "@gridui/brand-link": "1.0.6",
43
+ "@gridui/grid": "3.0.0",
44
+ "@gridui/preferences": "1.0.9",
45
45
  "@jest/globals": "30.5.2",
46
46
  "@storybook/react-vite": "10.6.6",
47
47
  "@types/jest": "30.0.0",