Stack
Vertical layout primitive with token-backed gap options.
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 { Stack } from "@tavojs/ui/stack";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/stack.
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.
Stack example
tsximport { Stack } from "@tavojs/ui/stack";
import { Text, Link } from "@tavojs/ui";
export function StackExample1() {
return (
<>
<Stack gap="lg"><Text as="h2" variant="h2">Account</Text><Text>Manage your profile and preferences.</Text><Link href="/settings">Open settings</Link></Stack>
</>
);
}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. |
as | string | Component<Record<string, unknown>> | — | Changes the rendered root element or component while preserving Tavo.js UI styling and public props. |
gap | "none" | "sm" | "md" | "lg" | — | Configures gap for this component. |
Complete TypeScript API
Import from @tavojs/ui/stack. Published exports: Stack, StackProps.
StackProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by Stack. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by Stack. |
id | string | No | Inherited id attribute accepted by Stack. |
role | string | No | Inherited role attribute accepted by Stack. |
style | Record<string, unknown> | No | Inherited style attribute accepted by Stack. |
title | string | No | Inherited title attribute accepted by Stack. |
tabIndex | number | No | Inherited tabIndex attribute accepted by Stack. |
hidden | boolean | No | Inherited hidden attribute accepted by Stack. |
disabled | boolean | No | Inherited disabled attribute accepted by Stack. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by Stack. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by Stack. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by Stack. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by Stack. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by Stack. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by Stack. |
as | PolymorphicAs | No | Changes the rendered root element or component while preserving Tavo.js UI styling and public props. |
gap | ResponsiveValue<Gap> | No | Configures gap 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 | The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there. |
Anatomy and related components
Limitations
Avoid Stack 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/stack |
| Explicit CSS import | @tavojs/ui/css/stack |
| Preview | Interactive preview available on this page |