Table of contents

A renderered SVG image of a Tldraw snapshot.

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

Properties

Extends TLSvgOptions.

background

from TLSvgOptions
background?: boolean

bindingUtils

Additional binding utils to use.

bindingUtils?: readonly TLAnyBindingUtilConstructor[]

bounds

from TLSvgOptions
bounds?: Box

darkMode

from TLSvgOptions
darkMode?: boolean

format

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

format?: 'png' | 'svg'

licenseKey

The license key.

licenseKey?: string

padding

from TLSvgOptions
padding?: number

pageId

The page to display. Defaults to the first page.

pageId?: TLPageId

preserveAspectRatio

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

scale

from TLSvgOptions
scale?: number

shapeUtils

Additional shape utils to use.

shapeUtils?: readonly TLAnyShapeUtilConstructor[]

snapshot

The snapshot to display.

snapshot: Partial<TLEditorSnapshot> | TLStoreSnapshot

TldrawHandlesTldrawScribble