Skip to content

Sheet ​

Sheet is a panel that comes up from the bottom of a narrow screen.

When to use ​

Use it for a panel that sits beside the stage on a wide screen, such as the details of a selection, when the screen is too narrow. The user chooses how much of the screen it takes.

Props ​

PropDefaultDescription
stagehalfThe height: peek, half or full (bindable)
stagesall threeThe heights offered, lowest first
onstageCalled when the height changes
closablefalseBelow the lowest height, it closes
oncloseCalled when it closes
panefalseThe content is a panel with its own head
labelThe accessible name of the sheet
nameTells several sheets apart (data-sheet)
zThe stacking order; the sheet layer by default
headThe head, which does not shrink (a snippet)
footThe foot, a Footer (a snippet)
childrenrequiredThe content, which scrolls
inlinefalseIn the flow, for documentation

Contract ​

It is placed absolutely at the bottom of its frame, which must be a positioned element, with the panel surface and a strong line along its top. The order inside is fixed: a handle gap-md high (a bar of two lines), the head, the content and the foot; only the content shrinks and scrolls, and it has no padding. peek is as high as the handle and the head, half is the content's height up to half the frame (a taller content scrolls there, inside the panel with pane, through a wrapper of the application as tall as its place too) and full all of the frame. A press on the handle steps up through the heights and returns to the lowest; ArrowUp and ArrowDown on the handle step up and down; a drag follows the pointer and snaps to the nearest height on release. A drag that ends above the height it started from never snaps to a lower one, nor one that ends below it to a higher one, and the click that ends a drag does not step. With closable, a drag well below the lowest height, or ArrowDown there, closes it. The handle's name is the sheetHeight message.

Example ​

Sheet

Released under the Apache-2.0 license.