Navigated to /docs/ui/components/section

Section

Page section wrapper with title, description, and actions.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX
tsximport { Section } from "@tavojs/ui/section";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/section.

When to use

Use it when

Use `Section` for page sections with optional heading, description, and actions

Choose something else when

Avoid Section when for interactive form state; combine with form, feedback, or data components instead.

Examples

Section example

TSX
tsximport { Section } from "@tavojs/ui/section";

export function SectionExample1() {
  return (
    <>
      <Section title="Latest" description="Recent updates">...</Section>
      <Section title="Related settings" titleSize="h3">...</Section>
    </>
  );
}

Common props and defaults

PropTypeDefaultDescription
classNamestring

Optional class hook applied to the public root element owned by the component.
asstring | Component<Record<string, unknown>>

Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
eyebrowChild

Configures eyebrow for this component.
titleChild

Configures title for this component.
titleSize"h1" | "h2" | "h3" | "h4" | "h5" | "h6"

Configures titleSize for this component.
descriptionChild

Configures description for this component.
actionsChild

Configures actions for this component.
spacingResponsiveValue<Spacing>

Configures spacing for this component.

Complete TypeScript API

Import from @tavojs/ui/section. Published exports: Section, SectionProps, SectionTitleSize.

SectionProps

PropertyTypeRequiredDescription
childrenChild

No

Inherited children attribute accepted by Section.

classNamestring

No

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

sxSx

No

Inherited sx attribute accepted by Section.

idstring

No

Inherited id attribute accepted by Section.

rolestring

No

Inherited role attribute accepted by Section.

styleRecord<string, unknown>

No

Inherited style attribute accepted by Section.

titlestring & Child

No

Configures title for this component.

tabIndexnumber

No

Inherited tabIndex attribute accepted by Section.

hiddenboolean

No

Inherited hidden attribute accepted by Section.

disabledboolean

No

Inherited disabled attribute accepted by Section.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by Section.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by Section.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by Section.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by Section.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by Section.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by Section.

asPolymorphicAs

No

Changes the rendered root element or component while preserving Tavo.js UI styling and public props.

eyebrowChild

No

Configures eyebrow for this component.

titleSizeSectionTitleSize

No

Configures titleSize for this component.

descriptionChild

No

Configures description for this component.

actionsChild

No

Configures actions for this component.

spacingResponsiveValue<Spacing>

No

Configures spacing 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 targetThe public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

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

Limitations

Avoid Section 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

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