Sheet

Temporary modal panel that slides from a viewport edge with backdrop, focus containment, and dismissal.

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

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

When to use

Use it when

Use Sheet for a temporary settings, filter, detail, or mobile-navigation workflow that should overlay the current page.

Choose something else when

Use Sidebar for persistent navigation that participates in page layout. A Sheet is modal and temporary; a Sidebar is structural and continuously visible.

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.

Sheet example

TSXCreate: src/components/examples/SheetExample1.tsx

tsximport { createTavo } from "@tavojs/core";
import { Sheet } from "@tavojs/ui/sheet";
import { Button, Text, Field, Select } from "@tavojs/ui";

type State = { open: boolean };

export const SheetExample1 = createTavo<Record<string, never>, State>({
  model: () => ({ open: false }),
  view: ({ state, model }) => (
    <>
      <Button id="filters-trigger" onClick={() => model.set("open", true)}>Open filters</Button>
      {state.open ? <Sheet open onClose={() => {
        model.set("open", false);
        document.getElementById("filters-trigger")?.focus();
      }}>
        <Sheet.Content open aria-label="Filters"
          use={(content: HTMLElement) => { content.focus(); }}
          onClose={() => {
            model.set("open", false);
            document.getElementById("filters-trigger")?.focus();
          }}
        >
          <Text as="h2" variant="h2">Project filters</Text>
          <Sheet.Close onClick={() => {
            model.set("open", false);
            document.getElementById("filters-trigger")?.focus();
          }} />
          <Field id="filter-status" label="Status"><Select><option>All projects</option><option>Active</option></Select></Field>
        </Sheet.Content>
      </Sheet> : null}
    </>
  )
});

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.
`tone`	`Tone`	—	Semantic tone where status messaging is supported. Applies to Sheet.
`open`	`boolean`	—	Controlled visibility state for overlay-style components when supported. Applies to Sheet.
`children`	`Child`	—	Feedback message or overlay content. Applies to Sheet.

Complete TypeScript API

Import from @tavojs/ui/sheet. Published exports: Sheet, SheetClose, SheetCloseProps, SheetContent, SheetContentProps, SheetProps, SheetRoot, SheetSide, SheetTrigger.

`SheetProps`

Property	Type	Required	Description
`children`	`Child`	No	Feedback message or overlay content. Applies to Sheet.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Sheet.
`id`	`string`	No	Inherited id attribute accepted by Sheet.
`role`	`string`	No	Inherited role attribute accepted by Sheet.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Sheet.
`title`	`string`	No	Inherited title attribute accepted by Sheet.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Sheet.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Sheet.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Sheet.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Sheet.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Sheet.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Sheet.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Sheet.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Sheet.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Sheet.
`open`	`boolean`	No	Controlled visibility state for overlay-style components when supported. Applies to Sheet.
`side`	`SheetSide`	No	Inherited side attribute accepted by Sheet.
`onClose`	`() => void`	No	Inherited onClose attribute accepted by Sheet.
`labelledBy`	`string`	No	Inherited labelledBy attribute accepted by Sheet.

`SheetContentProps`

Property	Type	Required	Description
`children`	`Child`	No	Feedback message or overlay content. Applies to Sheet.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Sheet.
`id`	`string`	No	Inherited id attribute accepted by Sheet.
`role`	`string`	No	Inherited role attribute accepted by Sheet.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Sheet.
`title`	`string`	No	Inherited title attribute accepted by Sheet.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Sheet.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Sheet.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Sheet.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Sheet.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Sheet.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Sheet.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Sheet.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Sheet.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Sheet.
`side`	`SheetSide`	No	Inherited side attribute accepted by Sheet.
`open`	`boolean`	No	Controlled visibility state for overlay-style components when supported. Applies to Sheet.
`onClose`	`() => void`	No	Inherited onClose attribute accepted by Sheet.
`labelledBy`	`string`	No	Inherited labelledBy attribute accepted by Sheet.

`SheetCloseProps`

Property	Type	Required	Description
`children`	`Child`	No	Feedback message or overlay content. Applies to Sheet.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Sheet.
`id`	`string`	No	Inherited id attribute accepted by Sheet.
`role`	`string`	No	Inherited role attribute accepted by Sheet.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Sheet.
`title`	`string`	No	Inherited title attribute accepted by Sheet.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Sheet.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Sheet.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Sheet.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Sheet.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Sheet.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Sheet.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Sheet.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Sheet.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Sheet.
`label`	`Child`	No	Inherited label attribute accepted by Sheet.

State ownership and DOM target

Concern	Contract
State	Use open to supply rendered state. Update it through the documented callback or native event handler.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

Public compound members: Root, Trigger, Content, Close

Limitations

Use Sidebar for persistent navigation that participates in page layout. A Sheet is modal and temporary; a Sidebar is structural and continuously visible.

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

Feedback components should announce status changes and manage focus only when the component owns that behavior.

Use Dialog, Sheet, or FocusTrap for modal workflows.
Use Toast or native live-region semantics for dynamic announcements.
Make dismiss and escape behavior clear for overlays.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/sheet`
Explicit CSS import	`@tavojs/ui/css/sheet`
Preview	Interactive preview available on this page