@gridui/grid 2.3.5 → 3.0.0

package/docs/reference/frame-header.md

@@ -0,0 +1,84 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameHeader
+
+Compose FrameHeader with SiteNavigation inside the same @gridui/grid component family.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameHeader } 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-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.
+
+## 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<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### padding
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``{
+        base: 16,
+        sm: 24,
+    }``
+
+### wrap
+
+``boolean | undefined`` · Optional
+
+Default: ``true``
+
+### gap
+
+``Space | undefined`` · Optional
+
+Default: ``16``
+
+### justify
+
+``"start" | "between" | undefined`` · Optional
+
+Default: ``"between"``
+

package/docs/reference/frame-rail-group.md

@@ -0,0 +1,68 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameRailGroup
+
+Public FrameRailGroup component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameRailGroup } 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.
+
+## 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
+
+Default: ``{
+        base: 0,
+        sm: 32,
+    }``
+

package/docs/reference/frame-rail.md

@@ -0,0 +1,61 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameRail
+
+Public FrameRail component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameRail } 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.
+
+## 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.
+
+### placement
+
+``"start" | "sticky-bottom" | undefined`` · Optional
+
+Default: ``"start"``
+

package/docs/reference/frame-region-row.md

@@ -0,0 +1,67 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameRegionRow
+
+Public FrameRegionRow component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameRegionRow } 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.
+
+## 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.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+
+### contentInset
+
+``string | number | undefined`` · Optional
+
+Default: ``0``
+

package/docs/reference/frame-region.md

@@ -0,0 +1,67 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameRegion
+
+Public FrameRegion component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameRegion } 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.
+
+## 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.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+
+### edge
+
+``"none" | "left" | "right" | "both" | undefined`` · Optional
+
+Default: ``"none"``
+

package/docs/reference/frame-section.md

@@ -0,0 +1,97 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameSection
+
+Creates a section within the shared page frame and its boundary system. Use it to compose aligned page regions.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameSection } 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/frame-section.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<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onBlur
+
+``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onChange
+
+``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onSubmit
+
+``(event: SubmitEvent<HTMLElement>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### onClick
+
+``(event: MouseEvent<HTMLElement, MouseEvent>): void`` · Optional
+
+Called when the corresponding interaction occurs; inspect the arguments in Actions.
+
+### boundary
+
+``FrameBoundaryStyle | undefined`` · Optional
+
+Default: ``"line"``
+
+### tone
+
+``FrameTone | undefined`` · Optional
+
+Default: ``"neutral"``
+
+### decoration
+
+``FrameDecorationStyle | undefined`` · Optional
+
+### texture
+
+``FrameTextureStyle | undefined`` · Optional
+
+Default: ``"none"``
+
+### edges
+
+``"none" | "frame" | undefined`` · Optional
+
+Default: ``"frame"``
+
+### paddingInline
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``0``
+
+### paddingBlock
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``0``
+

package/docs/reference/frame-sections.md

@@ -0,0 +1,55 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameSections
+
+Public FrameSections component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameSections } 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.
+
+## 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.
+

package/docs/reference/frame-texture.md

@@ -0,0 +1,23 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# FrameTexture
+
+Public FrameTexture component from @gridui/grid. See the package guide for its composition contract.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { FrameTexture } 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.
+
+## 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.
+
+### texture
+
+``FrameTextureStyle`` · Required
+

package/docs/reference/grid-item.md

@@ -0,0 +1,79 @@
+<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
+# GridItem
+
+Compose GridItem with RadioGroup inside the same @gridui/grid component family.
+
+Import from ``@gridui/grid`` and load Theme before this family's stylesheet.
+
+```tsx
+import { GridItem } 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-core/radio-group/stories/radio-group.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.
+
+### asChild
+
+``boolean | undefined`` · Optional
+
+Default: ``false``
+
+### span
+
+``Responsive<Span> | undefined`` · Optional
+
+Default: ``1``
+
+### padding
+
+``Responsive<Space> | undefined`` · Optional
+
+Default: ``0``
+
+### align
+
+``"center" | "end" | undefined`` · Optional
+

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``
+