@gridui/grid 2.3.6 → 3.0.0

package/docs/reference/grid.md

@@ -0,0 +1,91 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# Grid
+
+Arranges content in responsive rows and columns with shared boundary rules. Use it when neighboring regions need aligned tracks and seams.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { Grid } from "@gridui/grid";
+import "@gridui/theme/styles.css";
+import "@gridui/grid/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/stories/grid.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode | (ReactNode & ReactElement<unknown, string | JSXElementConstructor<any>>)`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### columns
+
+``"auto" | Responsive<GridColumns> | undefined`` · Optional
+
+Default: ``1``
+
+### minItemWidth
+
+``Responsive<string | number> | undefined`` · Optional
+
+### frame
+
+``"none" | "all" | "internal" | undefined`` · Optional
+
+Default: ``"none"``
+
+### gap
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``16``
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+
+### fillLastRow
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+

package/docs/reference/page-frame.md

@@ -0,0 +1,89 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# PageFrame
+
+Defines the outer frame for a page and its structural regions. Use it as the basis for layouts that share aligned content and rails.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { PageFrame } from "@gridui/grid";
+import "@gridui/theme/styles.css";
+import "@gridui/grid/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/stories/page-frame.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### rail
+
+``ReactNode`` · Optional
+
+### railWidth
+
+``Responsive<Space> | undefined`` · Optional
+
+### width
+
+``ContainerWidth | undefined`` · Optional
+
+Default: ``"standard"``
+
+### header
+
+``ReactNode`` · Optional
+
+### footer
+
+``ReactNode`` · Optional
+
+### railScope
+
+``"main" | "page" | undefined`` · Optional
+
+Default: ``"page"``
+
+### mainGutterStart
+
+``Responsive<Space> | undefined`` · Optional
+

package/docs/reference/row.md

@@ -0,0 +1,93 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# Row
+
+Arranges related content horizontally with consistent alignment and spacing. Use it for compact groups of controls or information.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { Row } from "@gridui/grid";
+import "@gridui/theme/styles.css";
+import "@gridui/grid/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/stories/row.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### gap
+
+``Space | undefined`` · Optional
+
+Default: ``16``
+
+### rowGap
+
+``Space | undefined`` · Optional
+
+Default: ``gap``
+
+### align
+
+``"center" | "end" | "stretch" | "baseline" | undefined`` · Optional
+
+Default: ``"stretch"``
+
+### justify
+
+``"start" | "between" | undefined`` · Optional
+
+Default: ``"start"``
+
+### wrap
+
+``boolean | undefined`` · Optional
+
+Default: ``true``
+
+### inline
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+

package/docs/reference/split.md

@@ -0,0 +1,75 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# Split
+
+Separates a linear sequence of regions. Use responsive direction and seams when a sidebar and content stack on narrow screens.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { Split } from "@gridui/grid";
+import "@gridui/theme/styles.css";
+import "@gridui/grid/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/stories/split.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### direction
+
+``Responsive<SplitDirection> | undefined`` · Optional
+
+Default: ``"row"``
+
+### order
+
+``"logical" | "physical" | undefined`` · Optional
+
+Default: ``"logical"``
+
+### seam
+
+``Responsive<"line" | "none"> | undefined`` · Optional
+
+Default: ``"line"``
+

package/docs/reference/stack.md

@@ -0,0 +1,75 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# Stack
+
+Combines containers, rows, and stacks to arrange page content. It shows how the layout primitives work together without owning application behavior.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { Stack } from "@gridui/grid";
+import "@gridui/theme/styles.css";
+import "@gridui/grid/styles.css";
+```
+
+Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/README.md) for shared behavior and stylesheet dependencies.
+
+The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-layout/grid/stories/primitives.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
+
+## API
+
+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.
+
+### children
+
+``ReactNode`` · Optional
+
+Content rendered inside the component.
+
+### onFocus
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### gap
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``16``
+
+### width
+
+``"full" | undefined`` · Optional
+
+### maxWidth
+
+``Property.MaxWidth<string | number> | undefined`` · Optional
+
+### paddingStart
+
+``Space | undefined`` · Optional
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gridui/grid",
-  "version": "2.3.6",
+  "version": "3.0.0",
   "description": "GridUI React grid",
   "license": "UNLICENSED",
   "type": "module",
@@ -23,7 +23,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@gridui/style-utils": "^3.0.0",
+    "@gridui/style-utils": "^4.0.0",
     "@gridui/theme": "^2.5.3",
     "@radix-ui/react-slot": "1.5.0",
     "class-variance-authority": "0.7.1"