TLDeepLinkOptions

interface TLDeepLinkOptions {}

Properties

The debounce time in ms for updating the url.

debounceMs?: number;

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

Defaults to 'd'

param?: string;

Methods

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

Parameters

Editor;

Returns

TLDeepLink;

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.

Parameters

Editor;

Returns

string | URL;

This is fired when the URL is updated.

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

Parameters

URL;

Editor;

Returns

void;