IGridProps
interface
Layout
Props contract for OrigamGrid — a declarative CSS Grid container. Covers track templates (columns/rows), gap, areas, auto-flow, alignment, and all standard visual surfaces (color, border, elevation, dimension).
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- columnsTGridTracks'auto'
- Track template for the inline axis (grid-template-columns). Accepts a number (repeat N 1fr), a raw CSS string, or an array of track sizes.
- rowsTGridTracks'auto'
- Track template for the block axis (grid-template-rows). Same shapes as columns.
- gapTGridGapSize | string | number'md'
- Both-axis gap. Accepts a size token (xs/sm/md/lg/xl), a CSS length string, or a number (px).
- columnGapTGridGapSize | string | number
- Inline-axis gap override. Takes precedence over gap on the column axis.
- rowGapTGridGapSize | string | number
- Block-axis gap override. Takes precedence over gap on the row axis.
- areasstring | ReadonlyArray<string>
- grid-template-areas. Pass a string[] (one row per entry) or a raw CSS string.
- autoFlowTGridAutoFlow'row'
- grid-auto-flow. Controls how implicit tracks are placed when items have no explicit area.
- autoColumnsstring
- grid-auto-columns sizes for implicit columns. Free-form CSS.
- autoRowsstring
- grid-auto-rows sizes for implicit rows. Free-form CSS.
- alignItemsTGridPlaceItems'stretch'
- align-items — block-axis alignment of grid items inside their cells.
- justifyItemsTGridPlaceItems'stretch'
- justify-items — inline-axis alignment of grid items inside their cells.
- alignContentTGridPlaceContent
- align-content — block-axis alignment of the whole grid inside its container.
- justifyContentTGridPlaceContent
- justify-content — inline-axis alignment of the whole grid inside its container.
- inlinebooleanfalse
- Toggles display: inline-grid instead of display: grid.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Responsive 3-column grid with named areas