Module: sheet/Sheet

Components to build Sheets. These are sidebar-like dialogs that
can be placed on the four sides of the screen (left, right, top, bottom).

Source:
See:

Members

(static, constant) Sheet :object

The root component, provides state to it's children.

Type:
  • object
Source:

(static, constant) SheetContent :object

The sheet content area. Pleace your content here.

Type:
  • object
Properties:
Name Type Attributes Default Description
side 'left' | 'right' | 'top' | 'bottom' <optional>
right

the default variants to place the sheet on the screen

Source:

(static, constant) SheetDescription :object

An optional styled description

Type:
  • object
Source:

(static, constant) SheetFooter :object

An optional styled footer

Type:
  • object
Source:

(static, constant) SheetHeader :object

An optional styles header

Type:
  • object
Source:

(static, constant) SheetTitle :object

An optional styled title

Type:
  • object
Source:

(static, constant) SheetTrigger :object

The trigger component. Place any element with type="button" inside
which triggers the sheet on click.

Type:
  • object
Source:

Type Definitions

SheetState

Properties:
Name Type Description
open boolean

mounting state

visible boolean

visibility state

static boolean

whether clicking backdrop hides dialog (false) or not (true)

scroll boolean

whether content can be scrolled

uid string

a random unique id for this instance to prefix id attriubutes

Source: