Grid
Responsive grid primitive with column and item sizing controls.
Preview
A live, theme-aware example rendered with the published component.
Loading preview…
Import
Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.
tsximport { Grid } from "@tavojs/ui/grid";The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/grid.
When to use
Use it when
Choose something else when
Examples
These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.
Grid example
tsximport { Grid } from "@tavojs/ui/grid";
import { Card } from "@tavojs/ui";
export function GridExample1() {
return (
<>
<Grid minItemWidth="18rem" spacing="lg"><Card title="Platform">Shared services</Card><Card title="Product">Customer features</Card></Grid>
</>
);
}Common props and defaults
A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
columns | ResponsiveValue<number> | — | Configures columns for this component. |
minItemWidth | ResponsiveValue<string> | — | Configures minItemWidth for this component. |
spacing | ResponsiveValue<Spacing> | — | Configures spacing for this component. |
align | ResponsiveValue<"start" | "center" | "end" | "stretch"> | — | Configures align for this component. |
Complete TypeScript API
Import from @tavojs/ui/grid. Published exports: Grid, GridProps.
GridProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by Grid. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by Grid. |
id | string | No | Inherited id attribute accepted by Grid. |
role | string | No | Inherited role attribute accepted by Grid. |
style | Record<string, unknown> | No | Inherited style attribute accepted by Grid. |
title | string | No | Inherited title attribute accepted by Grid. |
tabIndex | number | No | Inherited tabIndex attribute accepted by Grid. |
hidden | boolean | No | Inherited hidden attribute accepted by Grid. |
disabled | boolean | No | Inherited disabled attribute accepted by Grid. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by Grid. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by Grid. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by Grid. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by Grid. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by Grid. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by Grid. |
columns | ResponsiveValue<number> | No | Configures columns for this component. |
minItemWidth | ResponsiveValue<string> | No | Configures minItemWidth for this component. |
spacing | ResponsiveValue<Spacing> | No | Configures spacing for this component. |
align | ResponsiveValue<"start" | "center" | "end" | "stretch"> | No | Configures align for this component. |
State ownership and DOM target
| Concern | Contract |
|---|---|
| State | No component state contract is exposed; the application owns the rendered content and surrounding behavior. |
| DOM target | Public passthrough props target the component root. Treat nested elements and private class names as implementation details. |
Anatomy and related components
Limitations
Avoid Grid when for interactive form state; combine with form, feedback, or data components instead.
Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.
Accessibility
Layout primitives are semantic-neutral unless a component prop selects an element role.
Choose semantic elements such as main, nav, aside, or section when the region has document meaning.
Keep heading order and landmark labels app-owned.
Component status
| Contract | Current value |
|---|---|
| Maturity | stable |
| Category | layout |
| Component import | @tavojs/ui/grid |
| Explicit CSS import | @tavojs/ui/css/grid |
| Preview | Interactive preview available on this page |