@gridui/navigation-links 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 CHANGED
@@ -1,3 +1,22 @@
1
- # Temporary Holding Version
1
+ # @gridui/navigation-links
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Arrange related destinations in a named native navigation landmark. Links stay on one line by default. Set `wrap` to allow additional rows when space is limited.
4
+
5
+ ```tsx
6
+ import { NavigationLinks } from "@gridui/navigation-links";
7
+ import "@gridui/theme/styles.css";
8
+ import "@gridui/navigation-links/styles.css";
9
+
10
+ <NavigationLinks aria-label="Project" wrap>
11
+ <a href="/overview" aria-current="page">Overview</a>
12
+ <a href="/activity">Activity</a>
13
+ </NavigationLinks>
14
+ ```
15
+
16
+ Use `@gridui/navigation-links/styled` for automatic family styles. Direct child anchors receive the navigation item presentation. Apply `navigationItemStyles()` to a direct child trigger to give it the same presentation.
17
+
18
+ ## Sizing and density
19
+
20
+ Choose `small`, `medium` (default), or `large` with `size`. Items with an explicit control size keep that size. The component follows the shared motion policy.
21
+
22
+ See the [component reference](docs/reference/README.md) and [release history](https://github.com/sudo-ui/GridUI-React-Monorepo/tree/main/packages-navigation/navigation-links/.changeset/history).
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @author WMXPY
3
+ * @package Navigation Links
4
+ * @namespace Root
5
+ * @description Index
6
+ */
7
+ export type { NavigationLinksProps } from "./navigation-links/navigation-links";
8
+ export { NavigationLinks } from "./navigation-links/navigation-links";
9
+ export { navigationItemStyles } from "./navigation-links/style";
package/dist/index.js ADDED
@@ -0,0 +1,35 @@
1
+ // src/navigation-links/navigation-links.tsx
2
+ import { useMotionStyle } from "@gridui/motion/policy";
3
+ import { cn } from "@gridui/style-utils";
4
+ import { jsx } from "react/jsx-runtime";
5
+ var NavigationLinks = (props) => {
6
+ const motionStyle = useMotionStyle();
7
+ const { className, size = "medium", style, wrap = false, ...restProps } = props;
8
+ return /* @__PURE__ */ jsx(
9
+ "nav",
10
+ {
11
+ ...restProps,
12
+ "data-size": size,
13
+ "data-wrap": wrap || void 0,
14
+ className: cn("gridui-navigation-links gridui-u-navigation-links--flex gridui-u-navigation-links--items-center gridui-u-navigation-links--gap-gridui-4 gridui-u-navigation-links--type-ui", className),
15
+ style: { ...style, ...motionStyle }
16
+ }
17
+ );
18
+ };
19
+
20
+ // src/navigation-links/style.ts
21
+ import { cva } from "class-variance-authority";
22
+ var navigationItemStyles = cva("gridui-navigation-item", {
23
+ variants: {
24
+ size: {
25
+ small: "gridui-navigation-item-small",
26
+ medium: "gridui-navigation-item-medium",
27
+ large: "gridui-navigation-item-large"
28
+ }
29
+ }
30
+ });
31
+ export {
32
+ NavigationLinks,
33
+ navigationItemStyles
34
+ };
35
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../src/navigation-links/navigation-links.tsx", "../src/navigation-links/style.ts"],
4
+ "sourcesContent": ["/**\n * @author WMXPY\n * @package Navigation Links\n * @namespace NavigationLinks\n * @description Navigation Links\n */\n\nimport type { Size } from \"@gridui/theme\";\nimport { useMotionStyle } from \"@gridui/motion/policy\";\nimport { cn } from \"@gridui/style-utils\";\nimport type { ComponentPropsWithRef, FC } from \"react\";\n\nexport type NavigationLinksProps = ComponentPropsWithRef<\"nav\"> & {\n readonly size?: Size;\n readonly wrap?: boolean;\n};\n\nexport const NavigationLinks: FC<NavigationLinksProps> = (props: NavigationLinksProps) => {\n const motionStyle = useMotionStyle();\n const { className, size = \"medium\", style, wrap = false, ...restProps } = props;\n return (<nav\n {...restProps}\n data-size={size}\n data-wrap={wrap || undefined}\n className={cn(\"gridui-navigation-links gridui-u-navigation-links--flex gridui-u-navigation-links--items-center gridui-u-navigation-links--gap-gridui-4 gridui-u-navigation-links--type-ui\", className)}\n style={{ ...style, ...motionStyle }}\n />\n );\n};\n", "/**\n * @author WMXPY\n * @package Navigation Links\n * @namespace NavigationLinks\n * @description Style\n */\n\nimport { cva } from \"class-variance-authority\";\n\nexport const navigationItemStyles = cva(\"gridui-navigation-item\", {\n variants: {\n size: {\n small: \"gridui-navigation-item-small\",\n medium: \"gridui-navigation-item-medium\",\n large: \"gridui-navigation-item-large\",\n },\n },\n});\n"],
5
+ "mappings": ";AAQA,SAAS,sBAAsB;AAC/B,SAAS,UAAU;AAWP;AAHL,IAAM,kBAA4C,CAAC,UAAgC;AACtF,QAAM,cAAc,eAAe;AACnC,QAAM,EAAE,WAAW,OAAO,UAAU,OAAO,OAAO,OAAO,GAAG,UAAU,IAAI;AAC1E,SAAQ;AAAA,IAAC;AAAA;AAAA,MACJ,GAAG;AAAA,MACJ,aAAW;AAAA,MACX,aAAW,QAAQ;AAAA,MACnB,WAAW,GAAG,8KAA8K,SAAS;AAAA,MACrM,OAAO,EAAE,GAAG,OAAO,GAAG,YAAY;AAAA;AAAA,EACtC;AAEJ;;;ACrBA,SAAS,WAAW;AAEb,IAAM,uBAAuB,IAAI,0BAA0B;AAAA,EAC9D,UAAU;AAAA,IACN,MAAM;AAAA,MACF,OAAO;AAAA,MACP,QAAQ;AAAA,MACR,OAAO;AAAA,IACX;AAAA,EACJ;AACJ,CAAC;",
6
+ "names": []
7
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * @author WMXPY
3
+ * @package Navigation Links
4
+ * @namespace NavigationLinks
5
+ * @description Navigation Links
6
+ */
7
+ import type { Size } from "@gridui/theme";
8
+ import type { ComponentPropsWithRef, FC } from "react";
9
+ export type NavigationLinksProps = ComponentPropsWithRef<"nav"> & {
10
+ readonly size?: Size;
11
+ readonly wrap?: boolean;
12
+ };
13
+ export declare const NavigationLinks: FC<NavigationLinksProps>;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @author WMXPY
3
+ * @package Navigation Links
4
+ * @namespace NavigationLinks
5
+ * @description Style
6
+ */
7
+ export declare const navigationItemStyles: (props?: ({
8
+ size?: "small" | "medium" | "large" | null | undefined;
9
+ } & import("class-variance-authority/types").ClassProp) | undefined) => string;
package/dist/styled.js ADDED
@@ -0,0 +1,2 @@
1
+ import "./styles.local.css";
2
+ export * from "./index.js";
@@ -0,0 +1,73 @@
1
+ /*! tailwindcss v4.3.5 | MIT License | https://tailwindcss.com */
2
+ @layer theme, base, components, utilities;
3
+ @layer utilities {
4
+ .gridui-u-navigation-links--flex {
5
+ display: flex;
6
+ }
7
+ .gridui-u-navigation-links--items-center {
8
+ align-items: center;
9
+ }
10
+ .gridui-u-navigation-links--gap-gridui-4 {
11
+ gap: var(--gridui-space-4);
12
+ }
13
+ .gridui-u-navigation-links--type-ui {
14
+ font: var(--gridui-type-ui);
15
+ font-family: var(--gridui-font-body);
16
+ letter-spacing: normal;
17
+ }
18
+ }
19
+ @layer components {
20
+ .gridui-navigation-links, .gridui-navigation-item-medium {
21
+ --gridui-navigation-min: max(var(--gridui-control-min-height-medium), var(--gridui-target-min-size));
22
+ --gridui-navigation-inline: var(--gridui-space-16);
23
+ --gridui-navigation-block: var(--gridui-space-8);
24
+ }
25
+ .gridui-navigation-links[data-size="small"], .gridui-navigation-item-small {
26
+ --gridui-navigation-min: max(var(--gridui-control-min-height-small), var(--gridui-target-min-size));
27
+ --gridui-navigation-inline: var(--gridui-space-8);
28
+ --gridui-navigation-block: var(--gridui-space-4);
29
+ }
30
+ .gridui-navigation-links[data-size="large"], .gridui-navigation-item-large {
31
+ --gridui-navigation-min: max(var(--gridui-control-min-height-large), var(--gridui-target-min-size));
32
+ --gridui-navigation-inline: var(--gridui-space-24);
33
+ --gridui-navigation-block: var(--gridui-space-8);
34
+ }
35
+ .gridui-navigation-links[data-wrap] {
36
+ flex-wrap: wrap;
37
+ }
38
+ .gridui-navigation-links > .gridui-navigation-item:not([data-size-explicit]) {
39
+ min-inline-size: var(--gridui-navigation-min);
40
+ }
41
+ }
42
+ @layer utilities {
43
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):not([data-size-explicit]) {
44
+ display: inline-flex;
45
+ min-height: var(--gridui-navigation-min);
46
+ align-items: center;
47
+ justify-content: center;
48
+ gap: var(--gridui-space-8);
49
+ padding-block: var(--gridui-navigation-block);
50
+ padding-inline: var(--gridui-navigation-inline);
51
+ border: 1px solid transparent;
52
+ border-radius: var(--gridui-control-radius);
53
+ background-color: transparent;
54
+ color: var(--gridui-foreground);
55
+ font: var(--gridui-type-ui);
56
+ font-family: var(--gridui-font-body);
57
+ letter-spacing: normal;
58
+ text-decoration-line: none;
59
+ white-space: nowrap;
60
+ transition-property: var(--gridui-motion-transition, color, background-color, border-color, text-decoration-color, fill, stroke);
61
+ transition-duration: calc(var(--gridui-motion-duration-quick) * var(--gridui-motion-factor, 1));
62
+ transition-timing-function: var(--gridui-motion-ease-out);
63
+ }
64
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):is([aria-current="page"], [aria-current="true"]) {
65
+ background-color: var(--gridui-selection-background);
66
+ color: var(--gridui-foreground);
67
+ }
68
+ @media (prefers-reduced-motion: reduce) {
69
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):not([data-size-explicit]) {
70
+ transition-property: none;
71
+ }
72
+ }
73
+ }
@@ -0,0 +1,73 @@
1
+ /*! tailwindcss v4.3.5 | MIT License | https://tailwindcss.com */
2
+ @layer theme, base, components, utilities;
3
+ @layer utilities {
4
+ .gridui-u-navigation-links--flex {
5
+ display: flex;
6
+ }
7
+ .gridui-u-navigation-links--items-center {
8
+ align-items: center;
9
+ }
10
+ .gridui-u-navigation-links--gap-gridui-4 {
11
+ gap: var(--gridui-space-4);
12
+ }
13
+ .gridui-u-navigation-links--type-ui {
14
+ font: var(--gridui-type-ui);
15
+ font-family: var(--gridui-font-body);
16
+ letter-spacing: normal;
17
+ }
18
+ }
19
+ @layer components {
20
+ .gridui-navigation-links, .gridui-navigation-item-medium {
21
+ --gridui-navigation-min: max(var(--gridui-control-min-height-medium), var(--gridui-target-min-size));
22
+ --gridui-navigation-inline: var(--gridui-space-16);
23
+ --gridui-navigation-block: var(--gridui-space-8);
24
+ }
25
+ .gridui-navigation-links[data-size="small"], .gridui-navigation-item-small {
26
+ --gridui-navigation-min: max(var(--gridui-control-min-height-small), var(--gridui-target-min-size));
27
+ --gridui-navigation-inline: var(--gridui-space-8);
28
+ --gridui-navigation-block: var(--gridui-space-4);
29
+ }
30
+ .gridui-navigation-links[data-size="large"], .gridui-navigation-item-large {
31
+ --gridui-navigation-min: max(var(--gridui-control-min-height-large), var(--gridui-target-min-size));
32
+ --gridui-navigation-inline: var(--gridui-space-24);
33
+ --gridui-navigation-block: var(--gridui-space-8);
34
+ }
35
+ .gridui-navigation-links[data-wrap] {
36
+ flex-wrap: wrap;
37
+ }
38
+ .gridui-navigation-links > .gridui-navigation-item:not([data-size-explicit]) {
39
+ min-inline-size: var(--gridui-navigation-min);
40
+ }
41
+ }
42
+ @layer utilities {
43
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):not([data-size-explicit]) {
44
+ display: inline-flex;
45
+ min-height: var(--gridui-navigation-min);
46
+ align-items: center;
47
+ justify-content: center;
48
+ gap: var(--gridui-space-8);
49
+ padding-block: var(--gridui-navigation-block);
50
+ padding-inline: var(--gridui-navigation-inline);
51
+ border: 1px solid transparent;
52
+ border-radius: var(--gridui-control-radius);
53
+ background-color: transparent;
54
+ color: var(--gridui-foreground);
55
+ font: var(--gridui-type-ui);
56
+ font-family: var(--gridui-font-body);
57
+ letter-spacing: normal;
58
+ text-decoration-line: none;
59
+ white-space: nowrap;
60
+ transition-property: var(--gridui-motion-transition, color, background-color, border-color, text-decoration-color, fill, stroke);
61
+ transition-duration: calc(var(--gridui-motion-duration-quick) * var(--gridui-motion-factor, 1));
62
+ transition-timing-function: var(--gridui-motion-ease-out);
63
+ }
64
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):is([aria-current="page"], [aria-current="true"]) {
65
+ background-color: var(--gridui-selection-background);
66
+ color: var(--gridui-foreground);
67
+ }
68
+ @media (prefers-reduced-motion: reduce) {
69
+ .gridui-navigation-links > :is(a, .gridui-navigation-item):not([data-size-explicit]) {
70
+ transition-property: none;
71
+ }
72
+ }
73
+ }
@@ -0,0 +1,40 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "name": "@gridui/navigation-links",
4
+ "version": "1.0.0",
5
+ "category": "navigation",
6
+ "description": "GridUI React horizontal navigation links",
7
+ "usage": "Arrange related destinations in a named native navigation landmark. Links stay on one line by default. Set `wrap` to allow additional rows when space is limited.",
8
+ "documentation": [
9
+ "README.md",
10
+ "docs/reference/README.md",
11
+ "docs/reference/navigation-links.md"
12
+ ],
13
+ "exports": [
14
+ {
15
+ "name": "navigationItemStyles",
16
+ "kind": "value",
17
+ "importPath": "@gridui/navigation-links"
18
+ },
19
+ {
20
+ "name": "NavigationLinks",
21
+ "kind": "component",
22
+ "importPath": "@gridui/navigation-links"
23
+ },
24
+ {
25
+ "name": "NavigationLinksProps",
26
+ "kind": "type",
27
+ "importPath": "@gridui/navigation-links"
28
+ }
29
+ ],
30
+ "styles": [
31
+ "@gridui/theme/styles.css",
32
+ "@gridui/navigation-links/styles.css"
33
+ ],
34
+ "styledImport": "@gridui/navigation-links/styled",
35
+ "examples": [
36
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-links/stories/getting-started.mdx",
37
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-links/stories/secondary-navigation.mdx",
38
+ "https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-links/stories/navigation-links.stories.tsx"
39
+ ]
40
+ }
@@ -0,0 +1,4 @@
1
+ <!-- Generated by pnpm docs:storybook. -->
2
+ # Component reference
3
+
4
+ - [NavigationLinks](navigation-links.md)
@@ -0,0 +1,71 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # NavigationLinks
3
+
4
+ Arranges native navigation links at a shared control size. Set wrap to let links flow onto another line.
5
+
6
+ Import from ``@gridui/navigation-links`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { NavigationLinks } from "@gridui/navigation-links";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/navigation-links/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-navigation/navigation-links/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-links/stories/navigation-links.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<HTMLElement, Element>): void`` · Optional
31
+
32
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
33
+
34
+ ### onBlur
35
+
36
+ ``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
37
+
38
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
39
+
40
+ ### onChange
41
+
42
+ ``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
43
+
44
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
45
+
46
+ ### onSubmit
47
+
48
+ ``(event: SubmitEvent<HTMLElement>): void`` · Optional
49
+
50
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
51
+
52
+ ### onClick
53
+
54
+ ``(event: MouseEvent<HTMLElement, MouseEvent>): void`` · Optional
55
+
56
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
57
+
58
+ ### size
59
+
60
+ ``Size | undefined`` · Optional
61
+
62
+ Default: ``"medium"``
63
+
64
+ Component size preset.
65
+
66
+ ### wrap
67
+
68
+ ``boolean | undefined`` · Optional
69
+
70
+ Default: ``false``
71
+
package/package.json CHANGED
@@ -1,6 +1,54 @@
1
1
  {
2
2
  "name": "@gridui/navigation-links",
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 horizontal navigation links",
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/motion": "^1.0.4",
36
+ "@gridui/style-utils": "^4.1.0",
37
+ "@gridui/theme": "^5.1.0",
38
+ "class-variance-authority": "0.7.1"
39
+ },
40
+ "devDependencies": {
41
+ "@gridui-internal/configuration": "0.0.0-internal",
42
+ "@storybook/react-vite": "10.6.7",
43
+ "@types/node": "26.6.6",
44
+ "@types/react": "19.3.0",
45
+ "@types/react-dom": "19.3.0",
46
+ "react": "19.3.1",
47
+ "react-dom": "19.3.1",
48
+ "typescript": "6.0.3"
49
+ },
50
+ "scripts": {
51
+ "build": "node ../../scripts/compilation/package.ts",
52
+ "compile": "tsc --project tsconfig.json"
53
+ }
6
54
  }