TLPage

Extends BaseRecord<'page', TLPageId>.

A page within a tldraw document. Pages are containers for shapes and provide a way to organize content into separate canvases. Each document can have multiple pages, and users can navigate between them.

Pages have a name for identification, an index for ordering, and can store custom metadata.

interface TLPage extends BaseRecord<'page', TLPageId> {}

Example

const page: TLPage = {
  id: 'page:page1',
  typeName: 'page',
  name: 'Page 1',
  index: 'a1',
  meta: { description: 'Main design page' },
}

Properties

readonly id: Id

index: IndexKey

meta: JsonObject

name: string

readonly typeName: TypeName