Navigated to /docs/ui/components/spacer

Spacer

Decorative token-sized empty space along the block or inline axis.

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.

TSX
tsximport { Spacer } from "@tavojs/ui/spacer";

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/spacer.

When to use

Use it when

Use Spacer for an explicit semantic spacing break when a parent gap or margin cannot express the intended rhythm.

Choose something else when

Prefer Stack, Inline, Flex, or Grid gap for repeated layout spacing. SplitPane is unrelated: it creates two content regions with a responsive ratio.

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.

Spacer example

TSXCreate: src/components/examples/SpacerExample1.tsx
tsximport { Spacer } from "@tavojs/ui/spacer";

export function SpacerExample1() {
  return (
    <>
      <Spacer size="lg" />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

PropTypeDefaultDescription
classNamestring

Optional class hook applied to the public root element owned by the component.
sizeResponsiveValue<"xs" | "sm" | "md" | "lg" | "xl">

Configures size for this component.
axis"block" | "inline"

Configures axis for this component.

Complete TypeScript API

Import from @tavojs/ui/spacer. Published exports: Spacer, SpacerProps.

SpacerProps

PropertyTypeRequiredDescription
childrenChild

No

Inherited children attribute accepted by Spacer.

classNamestring

No

Optional class hook applied to the public root element owned by the component.

sxSx

No

Inherited sx attribute accepted by Spacer.

idstring

No

Inherited id attribute accepted by Spacer.

rolestring

No

Inherited role attribute accepted by Spacer.

styleRecord<string, unknown>

No

Inherited style attribute accepted by Spacer.

titlestring

No

Inherited title attribute accepted by Spacer.

tabIndexnumber

No

Inherited tabIndex attribute accepted by Spacer.

hiddenboolean

No

Inherited hidden attribute accepted by Spacer.

disabledboolean

No

Inherited disabled attribute accepted by Spacer.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by Spacer.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by Spacer.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by Spacer.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by Spacer.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by Spacer.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by Spacer.

sizeResponsiveValue<SpacerSize>

No

Configures size for this component.

axis"block" | "inline"

No

Configures axis for this component.

State ownership and DOM target

ConcernContract
StateNo component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM targetPublic passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Prefer Stack, Inline, Flex, or Grid gap for repeated layout spacing. SplitPane is unrelated: it creates two content regions with a responsive ratio.

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

ContractCurrent value
Maturitystable
Categorylayout
Component import@tavojs/ui/spacer
Explicit CSS import@tavojs/ui/css/spacer
PreviewInteractive preview available on this page