Skip to content

Function: SheetModal()

Call Signature

ts
function SheetModal(content: ChildBlock[]): Block;

Defined in: src/renderer/blocks/index.ts:1740

Experimental

SheetModal — side-panel modal that slides in from any viewport edge. Sibling-level container like Modal: render alongside Bubble, not inside one. Named to avoid collision with the existing Sheet (spreadsheet viewer).

Parameters

ParameterType
contentChildBlock[]

Returns

Block

Examples

ts
SheetModal([
  InputField({name: 'firstName', label: 'First name'}),
  InputField({name: 'lastName', label: 'Last name'}),
]);
ts
SheetModal(
  {
    name: 'filtersOpen',
    side: 'right',
    title: 'Filters',
    description: 'Refine the result set',
    actions: [
      {key: 'cancel', label: 'Cancel', variant: 'outline'},
      {key: 'apply', label: 'Apply filters'},
    ],
  },
  [Text({content: 'Filter controls go here.'})],
);

Call Signature

ts
function SheetModal(options: SheetModalProps, content: ChildBlock[]): Block;

Defined in: src/renderer/blocks/index.ts:1741

Experimental

SheetModal — side-panel modal that slides in from any viewport edge. Sibling-level container like Modal: render alongside Bubble, not inside one. Named to avoid collision with the existing Sheet (spreadsheet viewer).

Parameters

ParameterType
optionsSheetModalProps
contentChildBlock[]

Returns

Block

Examples

ts
SheetModal([
  InputField({name: 'firstName', label: 'First name'}),
  InputField({name: 'lastName', label: 'Last name'}),
]);
ts
SheetModal(
  {
    name: 'filtersOpen',
    side: 'right',
    title: 'Filters',
    description: 'Refine the result set',
    actions: [
      {key: 'cancel', label: 'Cancel', variant: 'outline'},
      {key: 'apply', label: 'Apply filters'},
    ],
  },
  [Text({content: 'Filter controls go here.'})],
);

Matterway Assistant SDK Documentation