tldraw SDK

Table of contents

A renderered SVG image of a Tldraw snapshot.

<TldrawImage
  snapshot={snapshot}
  pageId={pageId}
  background={false}
  darkMode={true}
  bounds={new Box(0, 0, 600, 400)}
  scale={1}
/>

Properties

optional

background?: boolean

optional

Additional binding utils to use.

bindingUtils?: readonly TLAnyBindingUtilConstructor[]

optional

bounds?: Box

optional

darkMode?: boolean

optional

The image format to use. Defaults to 'svg'.

format?: 'png' | 'svg'

optional

The license key.

licenseKey?: string

optional

padding?: number

optional

The page to display. Defaults to the first page.

pageId?: TLPageId

optional

preserveAspectRatio?: React.SVGAttributes<SVGSVGElement>['preserveAspectRatio']

optional

scale?: number

optional

Additional shape utils to use.

shapeUtils?: readonly TLAnyShapeUtilConstructor[]

The snapshot to display.

snapshot: Partial<TLEditorSnapshot> | TLStoreSnapshot