Shell

Application shell with optional header and sidebar regions.

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 { Shell } from "@tavojs/ui/shell";

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

When to use

Use it when

Use `Shell` for app frames

Choose something else when

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

Examples

Shell example

TSX

tsximport { Shell } from "@tavojs/ui/shell";
import { AppBar, Sidebar } from "@tavojs/ui";

export function ShellExample1() {
  return (
    <>
      <Shell header={<AppBar />} sidebar={<Sidebar />}>Content</Shell>
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`sidebar`	`Child`	—	Configures sidebar for this component.
`header`	`Child`	—	Configures header for this component.
`rail`	`"left" \| "right"`	—	Configures rail for this component.

Complete TypeScript API

Import from @tavojs/ui/shell. Published exports: Shell, ShellProps.

`ShellProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Shell.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Shell.
`id`	`string`	No	Inherited id attribute accepted by Shell.
`role`	`string`	No	Inherited role attribute accepted by Shell.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Shell.
`title`	`string`	No	Inherited title attribute accepted by Shell.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Shell.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Shell.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Shell.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Shell.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Shell.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Shell.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Shell.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Shell.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Shell.
`sidebar`	`import("/Users/hrach/Documents/Projects/Codex/tavo-ui-monorepo/node_modules/@tavojs/core/dist/jsx").Child`	No	Configures sidebar for this component.
`header`	`import("/Users/hrach/Documents/Projects/Codex/tavo-ui-monorepo/node_modules/@tavojs/core/dist/jsx").Child`	No	Configures header for this component.
`rail`	`"left" \| "right"`	No	Configures rail 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

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

Limitations

Avoid Shell 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/shell`
Explicit CSS import	`@tavojs/ui/css/shell`
Preview	Interactive preview available on this page