TLDeepLinkOptions • tldraw Docs

Table of contents

interface TLDeepLinkOptions {}

Properties

optional

The debounce time in ms for updating the url.

debounceMs?: number

optional

The name of the url search param to use for the deep link.

Defaults to 'd'

param?: string

optional

Should return the current deep link target. Defaults to returning the current page and viewport position.

Name	Description
`editor`	`Editor`

TLDeepLink

optional

Should return the current url to augment with a deep link query parameter. If you supply this function, you must also supply an onChange function.

Name	Description
`editor`	`Editor`

string | URL

optional

This is fired when the URL is updated.

If not supplied, the default behavior is to update window.location.

Name	Description
`url`	`URL` the updated URL
`editor`	`Editor`

void