@vttforge/core / SheetRegistration

Interface: SheetRegistration

Properties

canBeDefault?

readonly optional canBeDefault?: boolean

Allow a user to choose this sheet as their default. Defaults to true.

---

canConfigure?

readonly optional canConfigure?: boolean

Offer this sheet in the sheet configuration dialog. Defaults to true.

---

document

readonly document: SheetDocumentKind

The document the sheet is for.

---

id

readonly id: string

Stable name for this sheet, unique within the package.

It becomes the second half of the key Foundry persists, so treat it the way you treat a database column name: pick it once and keep it. Renaming it later loses the sheet choice of every document already using it.

---

label?

readonly optional label?: string

Localization key for the name shown in the sheet picker.

---

makeDefault?

readonly optional makeDefault?: boolean

Make this the default sheet for the listed types.

---

sheet

readonly sheet: unknown

The sheet class.

---

types?

readonly optional types?: readonly string[]

Document sub-types the sheet applies to. Omit to offer it for every type.

A module registering a sheet for its own sub-type must pass the prefixed key: moduleSubType(id, 'pdf'), not 'pdf'.