Skip to content

Function: Modal()

Call Signature

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

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

Modal container — full-screen overlay UI.

Parameters

ParameterType
contentChildBlock[]

Returns

Block

Examples

ts
Modal([
  HeaderBar({title: 'Welcome to the Matterway SDK', description: 'This is a sample welcome message.'}),
  Group([InputField({name: 'firstName', label: 'First name', defaultValue: 'Jane'})]),
]);
ts
Modal({overlay: true}, [
  HeaderBar({title: 'Welcome to the Matterway SDK'}),
  Group([InputField({name: 'firstName', label: 'First name'})]),
]);

Call Signature

ts
function Modal(options: ModalProps, content: ChildBlock[]): Block;

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

Modal container — full-screen overlay UI.

Parameters

ParameterType
optionsModalProps
contentChildBlock[]

Returns

Block

Examples

ts
Modal([
  HeaderBar({title: 'Welcome to the Matterway SDK', description: 'This is a sample welcome message.'}),
  Group([InputField({name: 'firstName', label: 'First name', defaultValue: 'Jane'})]),
]);
ts
Modal({overlay: true}, [
  HeaderBar({title: 'Welcome to the Matterway SDK'}),
  Group([InputField({name: 'firstName', label: 'First name'})]),
]);

Matterway Assistant SDK Documentation