Skip to content

Home > @unseenco/backstage-core > IProject > sheet

IProject.sheet() method

Creates a Sheet under the project (overload with explicit instanceId).

Signature:

typescript
sheet(sheetId: string, instanceId: string, opts?: ISheetOptions): ISheet;

Parameters

ParameterTypeDescription
sheetIdstringSheets are identified by their sheetId, which must be a string longer than 3 characters
instanceIdstringInstance id when creating multiple instances of the same sheet
optsISheetOptionsSheet options such as { visible: false }, sequenceMode, or gsap

Returns:

ISheet

The newly created Sheet