canvas
Declare one editing canvas: its canvas-bar `label` (required), then the composed pages it presents, in display order on that canvas.
Declare one editing canvas: its canvas-bar label (required), then the
composed pages it presents, in display order on that canvas. Pages are
artifact structure; canvases are editing-surface structure — what appears
together on one app-editor canvas. Explicit canvases must partition the
template’s pages: every page on exactly one canvas, none empty. Artifact
order stays composePages order regardless of canvas grouping. Omit
canvases on defineTemplate for the per-class default: website → one
canvas per page, labeled by the page’s label; image/document → one canvas
holding all pages, labeled by the template’s name.
Import from @homepages/template-kit.
Signature
Section titled “Signature”function canvas(label: string, pages: readonly ComposedPage[]): AuthoredCanvasParameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
label |
string |
required | |
pages |
readonly ComposedPage[] |
required |
Returns
Section titled “Returns”AuthoredCanvas
See also
Section titled “See also”composeCanvasescomposePagescomposeSectionsdefineTemplateorgsForScopepagevisibilityForScopeAuthoredCanvasAuthoredTemplateComposeEntryDefineTemplateCommonPageOptionsRoutedPageSectionInstanceHandleSiteInstanceSlotRefUnroutedPageAuthoredPageComposedCanvasComposedCanvasesComposedPageComposedPagesDefineTemplateInputTemplateScope