@gridui/brand-link 1.0.4 → 1.0.6
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/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/dist/styles.css +20 -20
- package/docs/catalog.json +9 -4
- package/docs/reference/README.md +4 -0
- package/docs/reference/brand-link.md +65 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -6,3 +6,5 @@ Import components from `@gridui/brand-link` and load `@gridui/brand-link/styles.
|
|
|
6
6
|
Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.
|
|
7
7
|
|
|
8
8
|
See [component ownership](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/docs/component-ownership.md) and [release history](https://github.com/sudo-ui/GridUI-React-Monorepo/tree/main/packages-core/brand-link/.changeset/history).
|
|
9
|
+
|
|
10
|
+
[Component reference](docs/reference/README.md) contains focused API pages for each public component.
|
package/dist/index.js
CHANGED
|
@@ -3,12 +3,12 @@ import { cn } from "@gridui/style-utils";
|
|
|
3
3
|
import { cva } from "class-variance-authority";
|
|
4
4
|
var brandLinkStyles = cva(cn(
|
|
5
5
|
"gridui-brand-link",
|
|
6
|
-
"gridui-u-inline-flex gridui-u-shrink-0 gridui-u-items-center gridui-u-gap-gridui-8 gridui-u-whitespace-nowrap gridui-u-text-foreground gridui-u-font-brand gridui-u-font-medium gridui-u-no-underline",
|
|
7
|
-
"gridui-u-data-[size='compact']:text-[1.1875rem] gridui-u-data-[size='compact']:leading-[1.2] gridui-u-data-[size='compact']:tracking-[-0.02em]",
|
|
8
|
-
"gridui-u-data-[size='standard']:text-[1.375rem] gridui-u-data-[size='standard']:tracking-[-0.04em]",
|
|
9
|
-
"gridui-u-data-[size='large']:text-[1.5rem] gridui-u-data-[size='large']:tracking-[-0.04em]",
|
|
10
|
-
"gridui-u-[@media(max-width:23.999rem)]:data-[size='standard']:text-[1.125rem]",
|
|
11
|
-
"gridui-u-[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:w-gridui-32 gridui-u-[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:h-gridui-32"
|
|
6
|
+
"gridui-u-brand-link--inline-flex gridui-u-brand-link--shrink-0 gridui-u-brand-link--items-center gridui-u-brand-link--gap-gridui-8 gridui-u-brand-link--whitespace-nowrap gridui-u-brand-link--text-foreground gridui-u-brand-link--font-brand gridui-u-brand-link--font-medium gridui-u-brand-link--no-underline",
|
|
7
|
+
"gridui-u-brand-link--data-[size='compact']:text-[1.1875rem] gridui-u-brand-link--data-[size='compact']:leading-[1.2] gridui-u-brand-link--data-[size='compact']:tracking-[-0.02em]",
|
|
8
|
+
"gridui-u-brand-link--data-[size='standard']:text-[1.375rem] gridui-u-brand-link--data-[size='standard']:tracking-[-0.04em]",
|
|
9
|
+
"gridui-u-brand-link--data-[size='large']:text-[1.5rem] gridui-u-brand-link--data-[size='large']:tracking-[-0.04em]",
|
|
10
|
+
"gridui-u-brand-link--[@media(max-width:23.999rem)]:data-[size='standard']:text-[1.125rem]",
|
|
11
|
+
"gridui-u-brand-link--[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:w-gridui-32 gridui-u-brand-link--[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:h-gridui-32"
|
|
12
12
|
));
|
|
13
13
|
|
|
14
14
|
// src/brand-link/brand-link.tsx
|
package/dist/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/brand-link/style.ts", "../src/brand-link/brand-link.tsx"],
|
|
4
|
-
"sourcesContent": ["/**\n * @author WMXPY\n * @package Brand Link\n * @namespace BrandLink\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const brandLinkStyles = cva(cn(\n \"gridui-brand-link\",\n \"gridui-u-inline-flex gridui-u-shrink-0 gridui-u-items-center gridui-u-gap-gridui-8 gridui-u-whitespace-nowrap gridui-u-text-foreground gridui-u-font-brand gridui-u-font-medium gridui-u-no-underline\",\n \"gridui-u-data-[size='compact']:text-[1.1875rem] gridui-u-data-[size='compact']:leading-[1.2] gridui-u-data-[size='compact']:tracking-[-0.02em]\",\n \"gridui-u-data-[size='standard']:text-[1.375rem] gridui-u-data-[size='standard']:tracking-[-0.04em]\",\n \"gridui-u-data-[size='large']:text-[1.5rem] gridui-u-data-[size='large']:tracking-[-0.04em]\",\n \"gridui-u-[@media(max-width:23.999rem)]:data-[size='standard']:text-[1.125rem]\",\n \"gridui-u-[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:w-gridui-32 gridui-u-[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:h-gridui-32\",\n));\n", "/**\n * @author WMXPY\n * @package Brand Link\n * @namespace BrandLink\n * @description Brand Link\n */\n\nimport { brandLinkStyles } from \"./style\";\nimport { cn } from \"@gridui/style-utils\";\nimport type { ComponentPropsWithRef, FC } from \"react\";\n\nexport type BrandLinkProps = ComponentPropsWithRef<\"a\"> & {\n readonly size?: \"compact\" | \"standard\" | \"large\";\n};\n\nexport const BrandLink: FC<BrandLinkProps> = (props: BrandLinkProps) => {\n const { size = \"standard\", className, ...restProps } = props;\n return (<a\n {...restProps}\n className={cn(brandLinkStyles(), className)}\n data-size={size}\n />);\n};\n"],
|
|
4
|
+
"sourcesContent": ["/**\n * @author WMXPY\n * @package Brand Link\n * @namespace BrandLink\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const brandLinkStyles = cva(cn(\n \"gridui-brand-link\",\n \"gridui-u-brand-link--inline-flex gridui-u-brand-link--shrink-0 gridui-u-brand-link--items-center gridui-u-brand-link--gap-gridui-8 gridui-u-brand-link--whitespace-nowrap gridui-u-brand-link--text-foreground gridui-u-brand-link--font-brand gridui-u-brand-link--font-medium gridui-u-brand-link--no-underline\",\n \"gridui-u-brand-link--data-[size='compact']:text-[1.1875rem] gridui-u-brand-link--data-[size='compact']:leading-[1.2] gridui-u-brand-link--data-[size='compact']:tracking-[-0.02em]\",\n \"gridui-u-brand-link--data-[size='standard']:text-[1.375rem] gridui-u-brand-link--data-[size='standard']:tracking-[-0.04em]\",\n \"gridui-u-brand-link--data-[size='large']:text-[1.5rem] gridui-u-brand-link--data-[size='large']:tracking-[-0.04em]\",\n \"gridui-u-brand-link--[@media(max-width:23.999rem)]:data-[size='standard']:text-[1.125rem]\",\n \"gridui-u-brand-link--[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:w-gridui-32 gridui-u-brand-link--[@media(max-width:23.999rem)]:[&[data-size='standard']_svg]:h-gridui-32\",\n));\n", "/**\n * @author WMXPY\n * @package Brand Link\n * @namespace BrandLink\n * @description Brand Link\n */\n\nimport { brandLinkStyles } from \"./style\";\nimport { cn } from \"@gridui/style-utils\";\nimport type { ComponentPropsWithRef, FC } from \"react\";\n\nexport type BrandLinkProps = ComponentPropsWithRef<\"a\"> & {\n readonly size?: \"compact\" | \"standard\" | \"large\";\n};\n\nexport const BrandLink: FC<BrandLinkProps> = (props: BrandLinkProps) => {\n const { size = \"standard\", className, ...restProps } = props;\n return (<a\n {...restProps}\n className={cn(brandLinkStyles(), className)}\n data-size={size}\n />);\n};\n"],
|
|
5
5
|
"mappings": ";AAOA,SAAS,UAAU;AACnB,SAAS,WAAW;AAEb,IAAM,kBAAkB,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ,CAAC;;;ACVD,SAAS,MAAAA,WAAU;AASP;AAFL,IAAM,YAAgC,CAAC,UAA0B;AACpE,QAAM,EAAE,OAAO,YAAY,WAAW,GAAG,UAAU,IAAI;AACvD,SAAQ;AAAA,IAAC;AAAA;AAAA,MACJ,GAAG;AAAA,MACJ,WAAWA,IAAG,gBAAgB,GAAG,SAAS;AAAA,MAC1C,aAAW;AAAA;AAAA,EACf;AACJ;",
|
|
6
6
|
"names": ["cn"]
|
|
7
7
|
}
|
package/dist/styles.css
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! tailwindcss v4.3.
|
|
1
|
+
/*! tailwindcss v4.3.5 | MIT License | https://tailwindcss.com */
|
|
2
2
|
@layer properties;
|
|
3
3
|
@layer theme, base, components, utilities;
|
|
4
4
|
@layer theme {
|
|
@@ -7,67 +7,67 @@
|
|
|
7
7
|
}
|
|
8
8
|
}
|
|
9
9
|
@layer utilities {
|
|
10
|
-
.gridui-u-inline-flex {
|
|
10
|
+
.gridui-u-brand-link--inline-flex {
|
|
11
11
|
display: inline-flex;
|
|
12
12
|
}
|
|
13
|
-
.gridui-u-shrink-0 {
|
|
13
|
+
.gridui-u-brand-link--shrink-0 {
|
|
14
14
|
flex-shrink: 0;
|
|
15
15
|
}
|
|
16
|
-
.gridui-u-items-center {
|
|
16
|
+
.gridui-u-brand-link--items-center {
|
|
17
17
|
align-items: center;
|
|
18
18
|
}
|
|
19
|
-
.gridui-u-gap-gridui-8 {
|
|
19
|
+
.gridui-u-brand-link--gap-gridui-8 {
|
|
20
20
|
gap: var(--gridui-space-8);
|
|
21
21
|
}
|
|
22
|
-
.gridui-u-font-brand {
|
|
22
|
+
.gridui-u-brand-link--font-brand {
|
|
23
23
|
font-family: var(--gridui-font-brand);
|
|
24
24
|
}
|
|
25
|
-
.gridui-u-font-medium {
|
|
25
|
+
.gridui-u-brand-link--font-medium {
|
|
26
26
|
--tw-font-weight: var(--font-weight-medium);
|
|
27
27
|
font-weight: var(--font-weight-medium);
|
|
28
28
|
}
|
|
29
|
-
.gridui-u-whitespace-nowrap {
|
|
29
|
+
.gridui-u-brand-link--whitespace-nowrap {
|
|
30
30
|
white-space: nowrap;
|
|
31
31
|
}
|
|
32
|
-
.gridui-u-text-foreground {
|
|
32
|
+
.gridui-u-brand-link--text-foreground {
|
|
33
33
|
color: var(--gridui-foreground);
|
|
34
34
|
}
|
|
35
|
-
.gridui-u-no-underline {
|
|
35
|
+
.gridui-u-brand-link--no-underline {
|
|
36
36
|
text-decoration-line: none;
|
|
37
37
|
}
|
|
38
|
-
.gridui-u-data-\[size\=\'compact\'\]\:text-\[1\.1875rem\][data-size='compact'] {
|
|
38
|
+
.gridui-u-brand-link--data-\[size\=\'compact\'\]\:text-\[1\.1875rem\][data-size='compact'] {
|
|
39
39
|
font-size: 1.1875rem;
|
|
40
40
|
}
|
|
41
|
-
.gridui-u-data-\[size\=\'compact\'\]\:leading-\[1\.2\][data-size='compact'] {
|
|
41
|
+
.gridui-u-brand-link--data-\[size\=\'compact\'\]\:leading-\[1\.2\][data-size='compact'] {
|
|
42
42
|
--tw-leading: 1.2;
|
|
43
43
|
line-height: 1.2;
|
|
44
44
|
}
|
|
45
|
-
.gridui-u-data-\[size\=\'compact\'\]\:tracking-\[-0\.02em\][data-size='compact'] {
|
|
45
|
+
.gridui-u-brand-link--data-\[size\=\'compact\'\]\:tracking-\[-0\.02em\][data-size='compact'] {
|
|
46
46
|
--tw-tracking: -0.02em;
|
|
47
47
|
letter-spacing: -0.02em;
|
|
48
48
|
}
|
|
49
|
-
.gridui-u-data-\[size\=\'large\'\]\:text-\[1\.5rem\][data-size='large'] {
|
|
49
|
+
.gridui-u-brand-link--data-\[size\=\'large\'\]\:text-\[1\.5rem\][data-size='large'] {
|
|
50
50
|
font-size: 1.5rem;
|
|
51
51
|
}
|
|
52
|
-
.gridui-u-data-\[size\=\'large\'\]\:tracking-\[-0\.04em\][data-size='large'] {
|
|
52
|
+
.gridui-u-brand-link--data-\[size\=\'large\'\]\:tracking-\[-0\.04em\][data-size='large'] {
|
|
53
53
|
--tw-tracking: -0.04em;
|
|
54
54
|
letter-spacing: -0.04em;
|
|
55
55
|
}
|
|
56
|
-
.gridui-u-data-\[size\=\'standard\'\]\:text-\[1\.375rem\][data-size='standard'] {
|
|
56
|
+
.gridui-u-brand-link--data-\[size\=\'standard\'\]\:text-\[1\.375rem\][data-size='standard'] {
|
|
57
57
|
font-size: 1.375rem;
|
|
58
58
|
}
|
|
59
|
-
.gridui-u-data-\[size\=\'standard\'\]\:tracking-\[-0\.04em\][data-size='standard'] {
|
|
59
|
+
.gridui-u-brand-link--data-\[size\=\'standard\'\]\:tracking-\[-0\.04em\][data-size='standard'] {
|
|
60
60
|
--tw-tracking: -0.04em;
|
|
61
61
|
letter-spacing: -0.04em;
|
|
62
62
|
}
|
|
63
63
|
@media (max-width:23.999rem) {
|
|
64
|
-
.gridui-u
|
|
64
|
+
.gridui-u-brand-link--\[\@media\(max-width\:23\.999rem\)\]\:data-\[size\=\'standard\'\]\:text-\[1\.125rem\][data-size='standard'] {
|
|
65
65
|
font-size: 1.125rem;
|
|
66
66
|
}
|
|
67
|
-
.gridui-u
|
|
67
|
+
.gridui-u-brand-link--\[\@media\(max-width\:23\.999rem\)\]\:\[\&\[data-size\=\'standard\'\]_svg\]\:h-gridui-32[data-size='standard'] svg {
|
|
68
68
|
height: var(--gridui-space-32);
|
|
69
69
|
}
|
|
70
|
-
.gridui-u
|
|
70
|
+
.gridui-u-brand-link--\[\@media\(max-width\:23\.999rem\)\]\:\[\&\[data-size\=\'standard\'\]_svg\]\:w-gridui-32[data-size='standard'] svg {
|
|
71
71
|
width: var(--gridui-space-32);
|
|
72
72
|
}
|
|
73
73
|
}
|
package/docs/catalog.json
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/brand-link",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.6",
|
|
5
5
|
"category": "core",
|
|
6
6
|
"description": "GridUI React brand link",
|
|
7
|
-
"usage": "
|
|
7
|
+
"usage": "Component reference contains focused API pages for each public component.",
|
|
8
8
|
"documentation": [
|
|
9
|
-
"README.md"
|
|
9
|
+
"README.md",
|
|
10
|
+
"docs/reference/README.md",
|
|
11
|
+
"docs/reference/brand-link.md"
|
|
10
12
|
],
|
|
11
13
|
"exports": [
|
|
12
14
|
{
|
|
@@ -24,5 +26,8 @@
|
|
|
24
26
|
"@gridui/theme/styles.css",
|
|
25
27
|
"@gridui/brand-link/styles.css"
|
|
26
28
|
],
|
|
27
|
-
"examples": [
|
|
29
|
+
"examples": [
|
|
30
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/brand-link/stories/brand-navigation.mdx",
|
|
31
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/brand-link/stories/brand-link.stories.tsx"
|
|
32
|
+
]
|
|
28
33
|
}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# BrandLink
|
|
3
|
+
|
|
4
|
+
Presents a brand name or mark as a navigation link. Use it in headers, footers, or other places that lead back to the site home.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/brand-link`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { BrandLink } from "@gridui/brand-link";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/brand-link/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/brand-link/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/brand-link/stories/brand-link.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<HTMLAnchorElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLAnchorElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLAnchorElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLAnchorElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLAnchorElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### size
|
|
59
|
+
|
|
60
|
+
``"standard" | "large" | "compact" | undefined`` · Optional
|
|
61
|
+
|
|
62
|
+
Default: ``"standard"``
|
|
63
|
+
|
|
64
|
+
Component size preset.
|
|
65
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/brand-link",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.6",
|
|
4
4
|
"description": "GridUI React brand link",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
@@ -27,13 +27,14 @@
|
|
|
27
27
|
"react-dom": "^19.2.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@gridui/style-utils": "^
|
|
30
|
+
"@gridui/style-utils": "^4.0.0",
|
|
31
31
|
"@gridui/theme": "^2.5.3",
|
|
32
32
|
"class-variance-authority": "0.7.1"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@gridui-internal/configuration": "0.0.0-internal",
|
|
36
36
|
"@jest/globals": "30.5.2",
|
|
37
|
+
"@storybook/react-vite": "10.6.6",
|
|
37
38
|
"@types/jest": "30.0.0",
|
|
38
39
|
"@types/node": "26.6.6",
|
|
39
40
|
"@types/react": "19.3.0",
|