@gridui/panel 1.0.0 → 1.0.2

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
@@ -2,42 +2,29 @@
2
2
 
3
3
  Layout family. Public API: `ContentPanel`, `ContentPanelProps`, `HeadingPanel`, `HeadingPanelProps`.
4
4
 
5
- Import components from `@gridui/panel` and load `@gridui/panel/styles.css` after Theme.
6
- Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.
7
-
8
- See [component ownership](../../docs/component-ownership.md) and [release history](.changeset/history/).
9
-
10
- ## Content geometry and native semantics
11
-
12
- `@gridui/grid` owns local geometry and page frames. `Row` declares gap,
13
- row gap, wrapping, alignment, and start/between justification. `ActionNavigation` from `@gridui/action-navigation`
14
- preserves a native navigation landmark for wrapping action links. `ContentPanel`
15
- accepts responsive block and inline padding and neutral/brand tone. An enclosing
16
- Grid, Split, or frame owns its structural boundary. `HeadingPanel` composes a
17
- heading and decorative artwork through Grid's Split;
18
- `FeatureLink` keeps its required identity and optional category, description,
19
- and destination slots inside one native anchor. Omitted, empty, or false slots
20
- add no wrapper, spacing, or separator. FeatureIdentity, FeatureDomain, and
21
- FeatureAction render identity, domain text, and icon/action content without requiring consumer
22
- knowledge of their CSS classes. Applications supply the destination and accent seed.
23
- Controls' `BrandLink` provides compact, standard, and large header sizes.
24
- Data's `RailProfile` owns vertical
25
- identity presentation while its caller owns the account state and action.
26
- `FrameHero` requires only its primary content. `artworkLabel`, `note`, and
27
- `noteLabel` are optional; omitted content adds no caption or note region. A note
28
- without a label spans the full width. A note label appears only with a note.
29
- Data's `Steps` preserves native list semantics. Expandable sections use the shared
30
- [Controls Disclosure](../../docs/component-ownership.md).
31
- Public typography classes (`gridui-wordmark`, `gridui-copy`, `gridui-note`,
32
- `gridui-error`, and `gridui-status`) belong to the theme. Applications may configure theme
33
- variables and content measures; do not copy their geometry into application CSS.
34
-
35
- `FrameHeader` exposes `wrap`, `gap`, and `justify`; consumers must not select its internal
36
- chrome element. `FrameFooter.contentLayout` and `signatureAppearance` control
37
- footer layout and signature treatment. `FrameSection.paddingInline` and
38
- `paddingBlock` control inner padding while its edges stay with the frame.
39
- `PageFrame.mainGutterStart` scopes responsive gutter overrides to
40
- main without affecting the header or footer. `GridItem.align` aligns contained
41
- controls. `Stack` supports full width, a maximum content measure, and start
42
- padding. These props are consumed by the UI library rather than forwarded to DOM.
5
+ Import components from `@gridui/panel` and load `@gridui/panel/styles.css` after Theme
6
+ and Grid styles. Applications own routes, labels, state persistence, and branding.
43
7
 
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-layout/panel/.changeset/history).
9
+
10
+ ## ContentPanel
11
+
12
+ ContentPanel preserves a native div and forwards its props and ref. `padding`
13
+ defaults to spacing token 24; `paddingInline` and `paddingBlock` independently
14
+ override it. These values accept scalar or responsive spacing. An explicit
15
+ caller style overrides the corresponding generated custom property. `tone`
16
+ accepts `neutral` or `brand`, with neutral as the default.
17
+
18
+ The panel owns content spacing and presentation. An enclosing Grid, Split, or
19
+ frame owns structural boundaries. Use their public props rather than selecting
20
+ private descendants. See [composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/docs/usage/composition.md).
21
+
22
+ ## HeadingPanel
23
+
24
+ HeadingPanel composes its children and required decorative `artwork` through
25
+ Grid's Split. The artwork region is hidden from assistive technology and includes
26
+ a FrameTexture. Keep essential information in the children and avoid interactive
27
+ controls in decorative artwork. Native div props and refs remain available.
28
+
29
+ Each component's private styles live in its matching `src/` directory. The public
30
+ stylesheet imports both owners; internal paths and CSS classes are not public APIs.
package/dist/index.js CHANGED
@@ -3,7 +3,7 @@ import { cn } from "@gridui/style-utils";
3
3
  import { cva } from "class-variance-authority";
4
4
  var contentPanelStyles = cva(cn(
5
5
  "gridui-content-panel",
6
- "data-[tone='brand']:bg-brand-tint"
6
+ "gridui-u-data-[tone='brand']:bg-brand-tint"
7
7
  ));
8
8
 
9
9
  // src/content-panel/content-panel.tsx
@@ -40,15 +40,15 @@ import { cn as cn3 } from "@gridui/style-utils";
40
40
  import { cva as cva2 } from "class-variance-authority";
41
41
  var headingPanelStyles = cva2(cn3(
42
42
  "gridui-heading-panel",
43
- "[&_h1]:flex [&_h1]:items-center [&_h1]:p-gridui-24 [&_h1]:bg-background",
44
- "min-[40rem]:[&_h1]:py-gridui-32 min-[40rem]:[&_h1]:px-gridui-48"
43
+ "gridui-u-[&_h1]:flex gridui-u-[&_h1]:items-center gridui-u-[&_h1]:p-gridui-24 gridui-u-[&_h1]:bg-background",
44
+ "gridui-u-min-[40rem]:[&_h1]:py-gridui-32 gridui-u-min-[40rem]:[&_h1]:px-gridui-48"
45
45
  ));
46
46
  var headingArtworkStyles = cva2(cn3(
47
47
  "gridui-heading-artwork",
48
- "relative isolate grid min-h-28 place-items-center bg-[color-mix(in_srgb,var(--gridui-brand-art)_3%,transparent)]",
49
- "[&_svg]:w-19 [&_svg]:h-19",
50
- "min-[40rem]:min-h-40",
51
- "min-[40rem]:[&_svg]:w-28 min-[40rem]:[&_svg]:h-28"
48
+ "gridui-u-relative gridui-u-isolate gridui-u-grid gridui-u-min-h-28 gridui-u-place-items-center gridui-u-bg-[color-mix(in_srgb,var(--gridui-brand-art)_3%,transparent)]",
49
+ "gridui-u-[&_svg]:w-19 gridui-u-[&_svg]:h-19",
50
+ "gridui-u-min-[40rem]:min-h-40",
51
+ "gridui-u-min-[40rem]:[&_svg]:w-28 gridui-u-min-[40rem]:[&_svg]:h-28"
52
52
  ));
53
53
 
54
54
  // src/heading-panel/heading-panel.tsx
package/dist/index.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../src/content-panel/style.ts", "../src/content-panel/content-panel.tsx", "../src/heading-panel/style.ts", "../src/heading-panel/heading-panel.tsx"],
4
- "sourcesContent": ["/**\n * @author WMXPY\n * @package Panel\n * @namespace ContentPanel\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const contentPanelStyles = cva(cn(\n \"gridui-content-panel\",\n \"data-[tone='brand']:bg-brand-tint\",\n));\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace ContentPanel\n * @description Content Panel\n */\n\nimport { contentPanelStyles } from \"./style\";\nimport { cn } from \"@gridui/style-utils\";\nimport { type Responsive, type Space, spacingVariables } from \"@gridui/style-utils/responsive\";\nimport type { ComponentPropsWithRef, FC } from \"react\";\n\nexport type ContentPanelProps = ComponentPropsWithRef<\"div\"> & {\n readonly padding?: Responsive<Space>;\n readonly paddingInline?: Responsive<Space>;\n readonly paddingBlock?: Responsive<Space>;\n readonly tone?: \"neutral\" | \"brand\";\n};\n\nexport const ContentPanel: FC<ContentPanelProps> = (props: ContentPanelProps) => {\n const {\n padding = 24,\n paddingInline = padding,\n paddingBlock = padding,\n tone = \"neutral\",\n className,\n style,\n ...restProps\n } = props;\n return (<div\n {...restProps}\n className={cn(contentPanelStyles(), className)}\n data-tone={tone}\n style={{\n ...spacingVariables(\"panel-inline\", paddingInline),\n ...spacingVariables(\"panel-block\", paddingBlock),\n ...style,\n }}\n />);\n};\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace HeadingPanel\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const headingPanelStyles = cva(cn(\n \"gridui-heading-panel\",\n \"[&_h1]:flex [&_h1]:items-center [&_h1]:p-gridui-24 [&_h1]:bg-background\",\n \"min-[40rem]:[&_h1]:py-gridui-32 min-[40rem]:[&_h1]:px-gridui-48\",\n));\n\nexport const headingArtworkStyles = cva(cn(\n \"gridui-heading-artwork\",\n \"relative isolate grid min-h-28 place-items-center bg-[color-mix(in_srgb,var(--gridui-brand-art)_3%,transparent)]\",\n \"[&_svg]:w-19 [&_svg]:h-19\",\n \"min-[40rem]:min-h-40\",\n \"min-[40rem]:[&_svg]:w-28 min-[40rem]:[&_svg]:h-28\",\n));\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace HeadingPanel\n * @description Heading Panel\n */\n\nimport { headingArtworkStyles, headingPanelStyles } from \"./style\";\nimport { FrameTexture, Split } from \"@gridui/grid\";\nimport { cn } from \"@gridui/style-utils\";\nimport type { ComponentPropsWithRef, FC, ReactNode } from \"react\";\n\nexport type HeadingPanelProps = ComponentPropsWithRef<\"div\"> & {\n readonly artwork: ReactNode;\n};\n\nexport const HeadingPanel: FC<HeadingPanelProps> = (props: HeadingPanelProps) => {\n const { artwork, children, className, ...restProps } = props;\n return (<Split\n {...restProps}\n className={cn(headingPanelStyles(), className)}\n >\n <div\n className=\"gridui-heading-copy\"\n >\n {children}\n </div>\n <div\n className={cn(headingArtworkStyles())}\n aria-hidden=\"true\"\n >\n <FrameTexture\n texture=\"grid\"\n />\n {artwork}\n </div>\n </Split>);\n};\n"],
4
+ "sourcesContent": ["/**\n * @author WMXPY\n * @package Panel\n * @namespace ContentPanel\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const contentPanelStyles = cva(cn(\n \"gridui-content-panel\",\n \"gridui-u-data-[tone='brand']:bg-brand-tint\",\n));\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace ContentPanel\n * @description Content Panel\n */\n\nimport { contentPanelStyles } from \"./style\";\nimport { cn } from \"@gridui/style-utils\";\nimport { type Responsive, type Space, spacingVariables } from \"@gridui/style-utils/responsive\";\nimport type { ComponentPropsWithRef, FC } from \"react\";\n\nexport type ContentPanelProps = ComponentPropsWithRef<\"div\"> & {\n readonly padding?: Responsive<Space>;\n readonly paddingInline?: Responsive<Space>;\n readonly paddingBlock?: Responsive<Space>;\n readonly tone?: \"neutral\" | \"brand\";\n};\n\nexport const ContentPanel: FC<ContentPanelProps> = (props: ContentPanelProps) => {\n const {\n padding = 24,\n paddingInline = padding,\n paddingBlock = padding,\n tone = \"neutral\",\n className,\n style,\n ...restProps\n } = props;\n return (<div\n {...restProps}\n className={cn(contentPanelStyles(), className)}\n data-tone={tone}\n style={{\n ...spacingVariables(\"panel-inline\", paddingInline),\n ...spacingVariables(\"panel-block\", paddingBlock),\n ...style,\n }}\n />);\n};\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace HeadingPanel\n * @description Style\n */\n\nimport { cn } from \"@gridui/style-utils\";\nimport { cva } from \"class-variance-authority\";\n\nexport const headingPanelStyles = cva(cn(\n \"gridui-heading-panel\",\n \"gridui-u-[&_h1]:flex gridui-u-[&_h1]:items-center gridui-u-[&_h1]:p-gridui-24 gridui-u-[&_h1]:bg-background\",\n \"gridui-u-min-[40rem]:[&_h1]:py-gridui-32 gridui-u-min-[40rem]:[&_h1]:px-gridui-48\",\n));\n\nexport const headingArtworkStyles = cva(cn(\n \"gridui-heading-artwork\",\n \"gridui-u-relative gridui-u-isolate gridui-u-grid gridui-u-min-h-28 gridui-u-place-items-center gridui-u-bg-[color-mix(in_srgb,var(--gridui-brand-art)_3%,transparent)]\",\n \"gridui-u-[&_svg]:w-19 gridui-u-[&_svg]:h-19\",\n \"gridui-u-min-[40rem]:min-h-40\",\n \"gridui-u-min-[40rem]:[&_svg]:w-28 gridui-u-min-[40rem]:[&_svg]:h-28\",\n));\n", "/**\n * @author WMXPY\n * @package Panel\n * @namespace HeadingPanel\n * @description Heading Panel\n */\n\nimport { headingArtworkStyles, headingPanelStyles } from \"./style\";\nimport { FrameTexture, Split } from \"@gridui/grid\";\nimport { cn } from \"@gridui/style-utils\";\nimport type { ComponentPropsWithRef, FC, ReactNode } from \"react\";\n\nexport type HeadingPanelProps = ComponentPropsWithRef<\"div\"> & {\n readonly artwork: ReactNode;\n};\n\nexport const HeadingPanel: FC<HeadingPanelProps> = (props: HeadingPanelProps) => {\n const { artwork, children, className, ...restProps } = props;\n return (<Split\n {...restProps}\n className={cn(headingPanelStyles(), className)}\n >\n <div\n className=\"gridui-heading-copy\"\n >\n {children}\n </div>\n <div\n className={cn(headingArtworkStyles())}\n aria-hidden=\"true\"\n >\n <FrameTexture\n texture=\"grid\"\n />\n {artwork}\n </div>\n </Split>);\n};\n"],
5
5
  "mappings": ";AAOA,SAAS,UAAU;AACnB,SAAS,WAAW;AAEb,IAAM,qBAAqB,IAAI;AAAA,EAClC;AAAA,EACA;AACJ,CAAC;;;ACLD,SAAS,MAAAA,WAAU;AACnB,SAAsC,wBAAwB;AAoBlD;AAVL,IAAM,eAAsC,CAAC,UAA6B;AAC7E,QAAM;AAAA,IACF,UAAU;AAAA,IACV,gBAAgB;AAAA,IAChB,eAAe;AAAA,IACf,OAAO;AAAA,IACP;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACP,IAAI;AACJ,SAAQ;AAAA,IAAC;AAAA;AAAA,MACJ,GAAG;AAAA,MACJ,WAAWA,IAAG,mBAAmB,GAAG,SAAS;AAAA,MAC7C,aAAW;AAAA,MACX,OAAO;AAAA,QACH,GAAG,iBAAiB,gBAAgB,aAAa;AAAA,QACjD,GAAG,iBAAiB,eAAe,YAAY;AAAA,QAC/C,GAAG;AAAA,MACP;AAAA;AAAA,EACJ;AACJ;;;AChCA,SAAS,MAAAC,WAAU;AACnB,SAAS,OAAAC,YAAW;AAEb,IAAM,qBAAqBA,KAAID;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AACJ,CAAC;AAEM,IAAM,uBAAuBC,KAAID;AAAA,EACpC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ,CAAC;;;ACdD,SAAS,cAAc,aAAa;AACpC,SAAS,MAAAE,WAAU;AAaX,gBAAAC,MAKA,YALA;AAND,IAAM,eAAsC,CAAC,UAA6B;AAC7E,QAAM,EAAE,SAAS,UAAU,WAAW,GAAG,UAAU,IAAI;AACvD,SAAQ;AAAA,IAAC;AAAA;AAAA,MACJ,GAAG;AAAA,MACJ,WAAWD,IAAG,mBAAmB,GAAG,SAAS;AAAA,MAE7C;AAAA,wBAAAC;AAAA,UAAC;AAAA;AAAA,YACG,WAAU;AAAA,YAET;AAAA;AAAA,QACL;AAAA,QACA;AAAA,UAAC;AAAA;AAAA,YACG,WAAWD,IAAG,qBAAqB,CAAC;AAAA,YACpC,eAAY;AAAA,YAEZ;AAAA,8BAAAC;AAAA,gBAAC;AAAA;AAAA,kBACG,SAAQ;AAAA;AAAA,cACZ;AAAA,cACC;AAAA;AAAA;AAAA,QACL;AAAA;AAAA;AAAA,EACJ;AACJ;",
6
6
  "names": ["cn", "cn", "cva", "cn", "jsx"]
7
7
  }
package/dist/styles.css CHANGED
@@ -6,66 +6,66 @@
6
6
  }
7
7
  }
8
8
  @layer utilities {
9
- .relative {
9
+ .gridui-u-relative {
10
10
  position: relative;
11
11
  }
12
- .isolate {
12
+ .gridui-u-isolate {
13
13
  isolation: isolate;
14
14
  }
15
- .grid {
15
+ .gridui-u-grid {
16
16
  display: grid;
17
17
  }
18
- .min-h-28 {
18
+ .gridui-u-min-h-28 {
19
19
  min-height: calc(var(--spacing) * 28);
20
20
  }
21
- .place-items-center {
21
+ .gridui-u-place-items-center {
22
22
  place-items: center;
23
23
  }
24
- .bg-\[color-mix\(in_srgb\,var\(--gridui-brand-art\)_3\%\,transparent\)\] {
24
+ .gridui-u-bg-\[color-mix\(in_srgb\,var\(--gridui-brand-art\)_3\%\,transparent\)\] {
25
25
  background-color: var(--gridui-brand-art);
26
26
  @supports (color: color-mix(in lab, red, red)) {
27
27
  background-color: color-mix(in srgb,var(--gridui-brand-art) 3%,transparent);
28
28
  }
29
29
  }
30
- .data-\[tone\=\'brand\'\]\:bg-brand-tint[data-tone='brand'] {
30
+ .gridui-u-data-\[tone\=\'brand\'\]\:bg-brand-tint[data-tone='brand'] {
31
31
  background-color: var(--gridui-brand-tint);
32
32
  }
33
33
  @media (width >= 40rem) {
34
- .min-\[40rem\]\:min-h-40 {
34
+ .gridui-u-min-\[40rem\]\:min-h-40 {
35
35
  min-height: calc(var(--spacing) * 40);
36
36
  }
37
37
  }
38
- .\[\&_h1\]\:flex h1 {
38
+ .gridui-u-\[\&_h1\]\:flex h1 {
39
39
  display: flex;
40
40
  }
41
- .\[\&_h1\]\:items-center h1 {
41
+ .gridui-u-\[\&_h1\]\:items-center h1 {
42
42
  align-items: center;
43
43
  }
44
- .\[\&_h1\]\:bg-background h1 {
44
+ .gridui-u-\[\&_h1\]\:bg-background h1 {
45
45
  background-color: var(--gridui-background);
46
46
  }
47
- .\[\&_h1\]\:p-gridui-24 h1 {
47
+ .gridui-u-\[\&_h1\]\:p-gridui-24 h1 {
48
48
  padding: var(--gridui-space-24);
49
49
  }
50
50
  @media (width >= 40rem) {
51
- .min-\[40rem\]\:\[\&_h1\]\:px-gridui-48 h1 {
51
+ .gridui-u-min-\[40rem\]\:\[\&_h1\]\:px-gridui-48 h1 {
52
52
  padding-inline: var(--gridui-space-48);
53
53
  }
54
- .min-\[40rem\]\:\[\&_h1\]\:py-gridui-32 h1 {
54
+ .gridui-u-min-\[40rem\]\:\[\&_h1\]\:py-gridui-32 h1 {
55
55
  padding-block: var(--gridui-space-32);
56
56
  }
57
57
  }
58
- .\[\&_svg\]\:h-19 svg {
58
+ .gridui-u-\[\&_svg\]\:h-19 svg {
59
59
  height: calc(var(--spacing) * 19);
60
60
  }
61
- .\[\&_svg\]\:w-19 svg {
61
+ .gridui-u-\[\&_svg\]\:w-19 svg {
62
62
  width: calc(var(--spacing) * 19);
63
63
  }
64
64
  @media (width >= 40rem) {
65
- .min-\[40rem\]\:\[\&_svg\]\:h-28 svg {
65
+ .gridui-u-min-\[40rem\]\:\[\&_svg\]\:h-28 svg {
66
66
  height: calc(var(--spacing) * 28);
67
67
  }
68
- .min-\[40rem\]\:\[\&_svg\]\:w-28 svg {
68
+ .gridui-u-min-\[40rem\]\:\[\&_svg\]\:w-28 svg {
69
69
  width: calc(var(--spacing) * 28);
70
70
  }
71
71
  }
@@ -78,13 +78,15 @@
78
78
  .gridui-heading-artwork {
79
79
  flex: 0 0 100px;
80
80
  }
81
- .gridui-content-panel {
82
- padding: var(--gridui-panel-block) var(--gridui-panel-inline);
83
- }
84
81
  @media (min-width: 40rem) {
85
82
  .gridui-heading-artwork {
86
83
  flex-basis: 220px;
87
84
  }
85
+ }
86
+ .gridui-content-panel {
87
+ padding: var(--gridui-panel-block) var(--gridui-panel-inline);
88
+ }
89
+ @media (min-width: 40rem) {
88
90
  .gridui-content-panel {
89
91
  padding: var(--gridui-panel-block-md) var(--gridui-panel-inline-md);
90
92
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gridui/panel",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "GridUI React panel",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",
@@ -26,16 +26,18 @@
26
26
  "react-dom": "^19.2.0"
27
27
  },
28
28
  "dependencies": {
29
- "@gridui/grid": "^2.1.4",
30
- "@gridui/style-utils": "^2.1.2",
31
- "@gridui/theme": "^2.1.2",
29
+ "@gridui/grid": "^2.3.1",
30
+ "@gridui/style-utils": "^2.1.4",
31
+ "@gridui/theme": "^2.3.2",
32
32
  "class-variance-authority": "0.7.1"
33
33
  },
34
34
  "devDependencies": {
35
- "@gridui-internal/configuration": "0.0.0",
35
+ "@gridui-internal/configuration": "0.0.0-internal",
36
+ "@gridui/steps": "1.0.4",
36
37
  "@jest/globals": "30.5.2",
38
+ "@storybook/react-vite": "10.6.5",
37
39
  "@types/jest": "30.0.0",
38
- "@types/node": "26.6.5",
40
+ "@types/node": "26.6.6",
39
41
  "@types/react": "19.3.0",
40
42
  "@types/react-dom": "19.3.0",
41
43
  "jest": "30.5.2",