Skip to content

Home > @unseenco/backstage-core > ISheet > props

ISheet.props() method

Declares props scoped to the sheet (not a scene object). The returned handle behaves like a sheet object for props, value, onValuesChange, and Studio editing, but is hidden from ISheet.getObjects() and the outline.

Sheet props are shared across all sequence variants (static and sequenced).

Signature:

typescript
props<Props extends UnknownShorthandCompoundProps>(config: Props, options?: ISheetPropsOptions): ISheetObject<Props>;

Parameters

ParameterTypeDescription
configProps
optionsISheetPropsOptions

Returns:

ISheetObject<Props>