Sheet

A panel that slides in from any edge of the window.

Sheet rendered by Tarve Sheet rendered by Tarve
Native render. The live version loads when this comes into view.

Import

import { Sheet } from "@tarve/core";

Usage

Sheet.tsx
import { Button, Sheet, Switch } from "@tarve/core";

let open = true;
let compact = false;

<>
  <Button variant="outline" onClick={() => (open = true)}>
    Preferences
  </Button>
  <Sheet
    open={open}
    side="right"
    title="Preferences"
    onOpenChange={(next) => {
      open = next;
    }}
  >
    <Switch label="Compact mode" checked={compact} onCheckedChange={(value) => (compact = value)} />
  </Sheet>
</>

Props

PropTypeDefault
open required boolean—
closeOnEscape booleantrue
closeOnOverlay booleantrue
description string—
footer Child—
onOpenChange (open: boolean) => void—
showClose booleantrue
side SheetSide"right"
size Style["width"]400
title string—

Common props

Shared by every component. See descriptions →

childrenclassclassNamehighlightidkeymotionFromonHighlightonPasteonPointerLeaveonPointerMoveonSizeonTransitionEndrovingGroupstyle

Types

SheetSide
type SheetSide = "left" | "right" | "top" | "bottom";