PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/apps/docs/api/tldraw.api.json
Steve Ruiz 29044867dd
Add docs (#2470) 
This PR adds the docs app back into the tldraw monorepo.

## Deploying

We'll want to update our deploy script to update the SOURCE_SHA to the
newest release sha... and then deploy the docs pulling api.json files
from that release. We _could_ update the docs on every push to main, but
we don't have to unless something has changed. Right now there's no
automated deployments from this repo.

## Side effects

To make this one work, I needed to update the lock file. This might be
ok (new year new lock file), and everything builds as expected, though
we may want to spend some time with our scripts to be sure that things
are all good.

I also updated our prettier installation, which decided to add trailing
commas to every generic type. Which is, I suppose, [correct
behavior](https://github.com/prettier/prettier-vscode/issues/955)? But
that caused diffs in every file, which is unfortunate.

### Change Type

- [x] `internal` — Any other changes that don't affect the published
package[^2]
2024-01-15 12:33:15 +00:00

22193 lines
558 KiB
JSON
Raw Blame History

{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.35.4",
"schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"noStandardTags": true,
"tagDefinitions": [
{
"tagName": "@alpha",
"syntaxKind": "modifier"
},
{
"tagName": "@beta",
"syntaxKind": "modifier"
},
{
"tagName": "@defaultValue",
"syntaxKind": "block"
},
{
"tagName": "@decorator",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@deprecated",
"syntaxKind": "block"
},
{
"tagName": "@eventProperty",
"syntaxKind": "modifier"
},
{
"tagName": "@example",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@experimental",
"syntaxKind": "modifier"
},
{
"tagName": "@inheritDoc",
"syntaxKind": "inline"
},
{
"tagName": "@internal",
"syntaxKind": "modifier"
},
{
"tagName": "@label",
"syntaxKind": "inline"
},
{
"tagName": "@link",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@override",
"syntaxKind": "modifier"
},
{
"tagName": "@packageDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@param",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@privateRemarks",
"syntaxKind": "block"
},
{
"tagName": "@public",
"syntaxKind": "modifier"
},
{
"tagName": "@readonly",
"syntaxKind": "modifier"
},
{
"tagName": "@remarks",
"syntaxKind": "block"
},
{
"tagName": "@returns",
"syntaxKind": "block"
},
{
"tagName": "@sealed",
"syntaxKind": "modifier"
},
{
"tagName": "@see",
"syntaxKind": "block"
},
{
"tagName": "@throws",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@typeParam",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@virtual",
"syntaxKind": "modifier"
},
{
"tagName": "@betaDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@internalRemarks",
"syntaxKind": "block"
},
{
"tagName": "@preapproved",
"syntaxKind": "modifier"
}
],
"supportForTags": {
"@alpha": true,
"@beta": true,
"@defaultValue": true,
"@decorator": true,
"@deprecated": true,
"@eventProperty": true,
"@example": true,
"@experimental": true,
"@inheritDoc": true,
"@internal": true,
"@label": true,
"@link": true,
"@override": true,
"@packageDocumentation": true,
"@param": true,
"@privateRemarks": true,
"@public": true,
"@readonly": true,
"@remarks": true,
"@returns": true,
"@sealed": true,
"@see": true,
"@throws": true,
"@typeParam": true,
"@virtual": true,
"@betaDocumentation": true,
"@internalRemarks": true,
"@preapproved": true
},
"reportUnsupportedHtmlElements": false
}
},
"kind": "Package",
"canonicalReference": "@tldraw/tldraw!",
"docComment": "",
"name": "@tldraw/tldraw",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@tldraw/tldraw!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ArrowShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/arrow/ArrowShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "ArrowShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ArrowShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/arrow/ArrowShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "ArrowShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#canBind:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canBind: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canBind",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#canSnap:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canSnap: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canSnap",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#getCanvasSvgDefs:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getCanvasSvgDefs(): "
},
{
"kind": "Reference",
"text": "TLShapeUtilCanvasSvgDef",
"canonicalReference": "@tldraw/editor!TLShapeUtilCanvasSvgDef:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getCanvasSvgDefs"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Group2d",
"canonicalReference": "@tldraw/editor!Group2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#getHandles:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getHandles(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLHandle",
"canonicalReference": "@tldraw/tlschema!TLHandle:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getHandles"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#hideResizeHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideResizeHandles: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideResizeHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#hideRotateHandle:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideRotateHandle: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideRotateHandle",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#hideSelectionBoundsBg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsBg: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsBg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onDoubleClickHandle:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClickHandle: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ", handle: "
},
{
"kind": "Reference",
"text": "TLHandle",
"canonicalReference": "@tldraw/tlschema!TLHandle:interface"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "TLShapePartial",
"canonicalReference": "@tldraw/tlschema!TLShapePartial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": "> | void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClickHandle",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 10
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onEditEnd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEditEnd: "
},
{
"kind": "Reference",
"text": "TLOnEditEndHandler",
"canonicalReference": "@tldraw/editor!TLOnEditEndHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEditEnd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onHandleChange:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onHandleChange: "
},
{
"kind": "Reference",
"text": "TLOnHandleChangeHandler",
"canonicalReference": "@tldraw/editor!TLOnHandleChangeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onHandleChange",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onTranslate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onTranslate?: "
},
{
"kind": "Reference",
"text": "TLOnTranslateHandler",
"canonicalReference": "@tldraw/editor!TLOnTranslateHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onTranslate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#onTranslateStart:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onTranslateStart: "
},
{
"kind": "Reference",
"text": "TLOnTranslateStartHandler",
"canonicalReference": "@tldraw/editor!TLOnTranslateStartHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onTranslateStart",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n labelColor: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n fill: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"none\" | \"pattern\" | \"semi\" | \"solid\">;\n dash: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"dashed\" | \"dotted\" | \"draw\" | \"solid\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n arrowheadStart: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"arrow\" | \"bar\" | \"diamond\" | \"dot\" | \"inverted\" | \"none\" | \"pipe\" | \"square\" | \"triangle\">;\n arrowheadEnd: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"arrow\" | \"bar\" | \"diamond\" | \"dot\" | \"inverted\" | \"none\" | \"pipe\" | \"square\" | \"triangle\">;\n font: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"draw\" | \"mono\" | \"sans\" | \"serif\">;\n start: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "UnionValidator",
"canonicalReference": "@tldraw/validate!UnionValidator:class"
},
{
"kind": "Content",
"text": "<\"type\", {\n binding: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ObjectValidator",
"canonicalReference": "@tldraw/validate!ObjectValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"binding\";\n boundShapeId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n normalizedAnchor: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": ";\n isExact: boolean;\n isPrecise: boolean;\n }>;\n point: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ObjectValidator",
"canonicalReference": "@tldraw/validate!ObjectValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"point\";\n x: number;\n y: number;\n }>;\n }, never>;\n end: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "UnionValidator",
"canonicalReference": "@tldraw/validate!UnionValidator:class"
},
{
"kind": "Content",
"text": "<\"type\", {\n binding: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ObjectValidator",
"canonicalReference": "@tldraw/validate!ObjectValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"binding\";\n boundShapeId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n normalizedAnchor: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": ";\n isExact: boolean;\n isPrecise: boolean;\n }>;\n point: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ObjectValidator",
"canonicalReference": "@tldraw/validate!ObjectValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"point\";\n x: number;\n y: number;\n }>;\n }, never>;\n bend: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n text: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 42
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLArrowShape",
"canonicalReference": "@tldraw/tlschema!TLArrowShape:type"
},
{
"kind": "Content",
"text": ", ctx: "
},
{
"kind": "Reference",
"text": "SvgExportContext",
"canonicalReference": "@tldraw/editor!SvgExportContext:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ArrowShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"arrow\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class BookmarkShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/bookmark/BookmarkShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "BookmarkShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#canResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canResize: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#onBeforeCreate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeCreate?: "
},
{
"kind": "Reference",
"text": "TLOnBeforeCreateHandler",
"canonicalReference": "@tldraw/editor!TLOnBeforeCreateHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onBeforeCreate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil#onBeforeUpdate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeUpdate?: "
},
{
"kind": "Reference",
"text": "TLOnBeforeUpdateHandler",
"canonicalReference": "@tldraw/editor!TLOnBeforeUpdateHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLBookmarkShape",
"canonicalReference": "@tldraw/tlschema!TLBookmarkShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onBeforeUpdate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n w: "
},
{
"kind": "Reference",
"text": "T.Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: "
},
{
"kind": "Reference",
"text": "T.Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n assetId: "
},
{
"kind": "Reference",
"text": "T.Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<null | "
},
{
"kind": "Reference",
"text": "TLAssetId",
"canonicalReference": "@tldraw/tlschema!TLAssetId:type"
},
{
"kind": "Content",
"text": ">;\n url: "
},
{
"kind": "Reference",
"text": "T.Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 12
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!BookmarkShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"bookmark\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!BreakPointProvider:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function BreakPointProvider({ forceMobile, children, }: "
},
{
"kind": "Content",
"text": "{\n forceMobile?: boolean;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/.tsbuild-api/lib/ui/hooks/useBreakpoint.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ forceMobile, children, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "BreakPointProvider"
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!Button:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "Button: "
},
{
"kind": "Reference",
"text": "React.ForwardRefExoticComponent",
"canonicalReference": "@types/react!React.ForwardRefExoticComponent:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiButtonProps",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps:interface"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "React.RefAttributes",
"canonicalReference": "@types/react!React.RefAttributes:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLButtonElement",
"canonicalReference": "!HTMLButtonElement:interface"
},
{
"kind": "Content",
"text": ">>"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Button.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "Button",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 9
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!compactMenuItems:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function compactMenuItems<T>(arr: "
},
{
"kind": "Content",
"text": "T[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<T, false | null | undefined>[]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "arr",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "compactMenuItems"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!containBoxSize:function(1)",
"docComment": "/**\n * Contains the size within the given box size\n *\n * @param originalSize - The size of the asset\n *\n * @param containBoxSize - The container size\n *\n * @returns Adjusted size\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function containBoxSize(originalSize: "
},
{
"kind": "Reference",
"text": "BoxWidthHeight",
"canonicalReference": "@tldraw/tldraw!~BoxWidthHeight:type"
},
{
"kind": "Content",
"text": ", containBoxSize: "
},
{
"kind": "Reference",
"text": "BoxWidthHeight",
"canonicalReference": "@tldraw/tldraw!~BoxWidthHeight:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "BoxWidthHeight",
"canonicalReference": "@tldraw/tldraw!~BoxWidthHeight:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/assets/assets.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "originalSize",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "containBoxSize",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"name": "containBoxSize"
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!ContextMenu:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ContextMenu: "
},
{
"kind": "Content",
"text": "({ children }: {\n children: any;\n}) => "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/ContextMenu.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "ContextMenu",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!copyAs:function(1)",
"docComment": "/**\n * Copy the given shapes to the clipboard.\n *\n * @param editor - The editor instance.\n *\n * @param ids - The ids of the shapes to copy.\n *\n * @param format - The format to copy as.\n *\n * @param opts - Options for the copy.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function copyAs(editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", ids: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", format?: "
},
{
"kind": "Reference",
"text": "TLCopyType",
"canonicalReference": "@tldraw/tldraw!~TLCopyType:type"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLSvgOptions",
"canonicalReference": "@tldraw/editor!TLSvgOptions:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/export/copyAs.ts",
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "editor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ids",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false
},
{
"parameterName": "format",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"isOptional": true
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
},
"isOptional": true
}
],
"name": "copyAs"
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!DEFAULT_ACCEPTED_IMG_TYPE:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "DEFAULT_ACCEPTED_IMG_TYPE: "
},
{
"kind": "Content",
"text": "string[]"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/assets/assets.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "DEFAULT_ACCEPTED_IMG_TYPE",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!DEFAULT_ACCEPTED_VID_TYPE:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "DEFAULT_ACCEPTED_VID_TYPE: "
},
{
"kind": "Content",
"text": "string[]"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/assets/assets.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "DEFAULT_ACCEPTED_VID_TYPE",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!defaultShapeTools:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "defaultShapeTools: "
},
{
"kind": "Content",
"text": "(typeof "
},
{
"kind": "Reference",
"text": "ArrowShapeTool",
"canonicalReference": "@tldraw/tldraw!ArrowShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "DrawShapeTool",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "FrameShapeTool",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "GeoShapeTool",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "LineShapeTool",
"canonicalReference": "@tldraw/tldraw!LineShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "NoteShapeTool",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "TextShapeTool",
"canonicalReference": "@tldraw/tldraw!TextShapeTool:class"
},
{
"kind": "Content",
"text": ")[]"
}
],
"fileUrlPath": "packages/tldraw/src/lib/defaultShapeTools.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "defaultShapeTools",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 16
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!defaultShapeUtils:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "defaultShapeUtils: "
},
{
"kind": "Reference",
"text": "TLAnyShapeUtilConstructor",
"canonicalReference": "@tldraw/editor!TLAnyShapeUtilConstructor:type"
},
{
"kind": "Content",
"text": "[]"
}
],
"fileUrlPath": "packages/tldraw/src/lib/defaultShapeUtils.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "defaultShapeUtils",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!defaultTools:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "defaultTools: "
},
{
"kind": "Content",
"text": "(typeof "
},
{
"kind": "Reference",
"text": "EraserTool",
"canonicalReference": "@tldraw/tldraw!EraserTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "HandTool",
"canonicalReference": "@tldraw/tldraw!HandTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "LaserTool",
"canonicalReference": "@tldraw/tldraw!LaserTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "SelectTool",
"canonicalReference": "@tldraw/tldraw!SelectTool:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "ZoomTool",
"canonicalReference": "@tldraw/tldraw!ZoomTool:class"
},
{
"kind": "Content",
"text": ")[]"
}
],
"fileUrlPath": "packages/tldraw/src/lib/defaultTools.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "defaultTools",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 12
}
},
{
"kind": "Namespace",
"canonicalReference": "@tldraw/tldraw!Dialog:namespace",
"docComment": "",
"excerptTokens": [],
"fileUrlPath": "packages/tldraw/src/index.ts",
"releaseTag": "None",
"name": "Dialog",
"preserveMemberOrder": false,
"members": [
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Dialog.Body:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Body({ className, children, style, }: "
},
{
"kind": "Content",
"text": "{\n className?: string;\n children: any;\n style?: "
},
{
"kind": "Reference",
"text": "React.CSSProperties",
"canonicalReference": "@types/react!React.CSSProperties:interface"
},
{
"kind": "Content",
"text": ";\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Dialog.tsx",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ className, children, style, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isOptional": false
}
],
"name": "Body"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Dialog.CloseButton:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function CloseButton(): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Dialog.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "CloseButton"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Dialog.Footer:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Footer({ className, children }: "
},
{
"kind": "Content",
"text": "{\n className?: string;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Dialog.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ className, children }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Footer"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Dialog.Header:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Header({ className, children }: "
},
{
"kind": "Content",
"text": "{\n className?: string;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/.tsbuild-api/lib/ui/components/primitives/Dialog.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ className, children }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Header"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Dialog.Title:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Title({ className, children }: "
},
{
"kind": "Content",
"text": "{\n className?: string;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Dialog.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ className, children }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Title"
}
]
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!downsizeImage:function(1)",
"docComment": "/**\n * Resize an image Blob to be smaller than it is currently.\n *\n * @param image - The image Blob.\n *\n * @param width - The desired width.\n *\n * @param height - The desired height.\n *\n * @param opts - Options for the image.\n *\n * @example\n * ```ts\n * const image = await (await fetch('/image.jpg')).blob()\n * const size = await getImageSize(image)\n * const resizedImage = await downsizeImage(image, size.w / 2, size.h / 2, { type: \"image/jpeg\", quality: 0.92 })\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function downsizeImage(blob: "
},
{
"kind": "Reference",
"text": "Blob",
"canonicalReference": "!Blob:interface"
},
{
"kind": "Content",
"text": ", width: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", height: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Content",
"text": "{\n type?: string | undefined;\n quality?: number | undefined;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Blob",
"canonicalReference": "!Blob:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/assets/assets.ts",
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "blob",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "width",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "height",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"isOptional": true
}
],
"name": "downsizeImage"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class DrawShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/draw/DrawShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "DrawShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Drawing",
"canonicalReference": "@tldraw/tldraw!~Drawing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_2:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool#onExit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onExit: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onExit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class DrawShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/draw/DrawShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "DrawShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#expandSelectionOutlinePx:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "expandSelectionOutlinePx(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "expandSelectionOutlinePx"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#getCanvasSvgDefs:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getCanvasSvgDefs(): "
},
{
"kind": "Reference",
"text": "TLShapeUtilCanvasSvgDef",
"canonicalReference": "@tldraw/editor!TLShapeUtilCanvasSvgDef:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getCanvasSvgDefs"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Circle2d",
"canonicalReference": "@tldraw/editor!Circle2d:class"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Polyline2d",
"canonicalReference": "@tldraw/editor!Polyline2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#hideResizeHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideResizeHandles: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideResizeHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#hideRotateHandle:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideRotateHandle: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideRotateHandle",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n fill: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"none\" | \"pattern\" | \"semi\" | \"solid\">;\n dash: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"dashed\" | \"dotted\" | \"draw\" | \"solid\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n segments: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ArrayOfValidator",
"canonicalReference": "@tldraw/validate!ArrayOfValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"free\" | \"straight\";\n points: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": "[];\n }>;\n isComplete: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n isClosed: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n isPen: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 20
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLDrawShape",
"canonicalReference": "@tldraw/tlschema!TLDrawShape:type"
},
{
"kind": "Content",
"text": ", ctx: "
},
{
"kind": "Reference",
"text": "SvgExportContext",
"canonicalReference": "@tldraw/editor!SvgExportContext:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!DrawShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"draw\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Namespace",
"canonicalReference": "@tldraw/tldraw!DropdownMenu:namespace",
"docComment": "",
"excerptTokens": [],
"fileUrlPath": "packages/tldraw/src/index.ts",
"releaseTag": "None",
"name": "DropdownMenu",
"preserveMemberOrder": false,
"members": [
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.CheckboxItem:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function CheckboxItem({ children, onSelect, ...rest }: "
},
{
"kind": "Reference",
"text": "DropdownMenuCheckboxItemProps",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ children, onSelect, ...rest }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "CheckboxItem"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Content:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Content({ side, align, sideOffset, alignOffset, children, }: "
},
{
"kind": "Content",
"text": "{\n children: any;\n alignOffset?: number;\n sideOffset?: number;\n align?: 'center' | 'end' | 'start';\n side?: 'bottom' | 'left' | 'right' | 'top';\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ side, align, sideOffset, alignOffset, children, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Content"
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface DropdownMenuCheckboxItemProps "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"releaseTag": "Public",
"name": "DropdownMenuCheckboxItemProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps#checked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "checked?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "checked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps#children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "children: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps#disabled:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "disabled?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "disabled",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps#onSelect:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onSelect?: "
},
{
"kind": "Content",
"text": "(e: "
},
{
"kind": "Reference",
"text": "Event",
"canonicalReference": "!Event:interface"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onSelect",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps#title:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "title: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "title",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuItemProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface DropdownMenuItemProps extends "
},
{
"kind": "Reference",
"text": "TLUiButtonProps",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"releaseTag": "Public",
"name": "DropdownMenuItemProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuItemProps#noClose:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "noClose?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "noClose",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Group:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Group({ children, size, }: "
},
{
"kind": "Content",
"text": "{\n children: any;\n size?: 'medium' | 'small' | 'tiny' | 'wide';\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ children, size, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Group"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Indicator:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Indicator(): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "Indicator"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Item:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Item({ noClose, ...props }: "
},
{
"kind": "Reference",
"text": "DropdownMenuItemProps",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuItemProps:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ noClose, ...props }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Item"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.RadioItem:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function RadioItem({ children, onSelect, ...rest }: "
},
{
"kind": "Reference",
"text": "DropdownMenuCheckboxItemProps",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.DropdownMenuCheckboxItemProps:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ children, onSelect, ...rest }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "RadioItem"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Root:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Root({ id, children, modal, debugOpen, }: "
},
{
"kind": "Content",
"text": "{\n id: string;\n children: any;\n modal?: boolean;\n debugOpen?: boolean;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ id, children, modal, debugOpen, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Root"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Sub:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Sub({ id, children }: "
},
{
"kind": "Content",
"text": "{\n id: string;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ id, children }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Sub"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.SubContent:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function SubContent({ alignOffset, sideOffset, children, }: "
},
{
"kind": "Content",
"text": "{\n alignOffset?: number;\n sideOffset?: number;\n children: any;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ alignOffset, sideOffset, children, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "SubContent"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.SubTrigger:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function SubTrigger({ label, 'data-testid': testId, 'data-direction': dataDirection, }: "
},
{
"kind": "Content",
"text": "{\n label: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": ";\n 'data-testid'?: string;\n 'data-direction'?: 'left' | 'right';\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ label, 'data-testid': testId, 'data-direction': dataDirection, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isOptional": false
}
],
"name": "SubTrigger"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!DropdownMenu.Trigger:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Trigger({ children, 'data-testid': testId, }: "
},
{
"kind": "Content",
"text": "{\n children: any;\n 'data-testid'?: string;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/DropdownMenu.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ children, 'data-testid': testId, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Trigger"
}
]
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class EmbedShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/embed/EmbedShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "EmbedShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#canEditInReadOnly:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEditInReadOnly: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEditInReadOnly",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#canResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canResize: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#canUnmount:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canUnmount: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canUnmount",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#isAspectRatioLocked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isAspectRatioLocked: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "isAspectRatioLocked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLEmbedShape",
"canonicalReference": "@tldraw/tlschema!TLEmbedShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n url: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EmbedShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"embed\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!EraserTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class EraserTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/tools/EraserTool/EraserTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "EraserTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EraserTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Erasing",
"canonicalReference": "@tldraw/tldraw!~Erasing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_7:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_6:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EraserTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EraserTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!EraserTool#onEnter:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEnter: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEnter",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!EventsProviderProps:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type EventsProviderProps = "
},
{
"kind": "Content",
"text": "{\n onEvent?: "
},
{
"kind": "Reference",
"text": "TLUiEventHandler",
"canonicalReference": "@tldraw/tldraw!TLUiEventHandler:type"
},
{
"kind": "Content",
"text": ";\n children: any;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"releaseTag": "Public",
"name": "EventsProviderProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!exportAs:function(1)",
"docComment": "/**\n * Export the given shapes as files.\n *\n * @param editor - The editor instance.\n *\n * @param ids - The ids of the shapes to export.\n *\n * @param format - The format to export as.\n *\n * @param opts - Options for the export.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function exportAs(editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", ids: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", format?: "
},
{
"kind": "Reference",
"text": "TLExportType",
"canonicalReference": "@tldraw/tldraw!~TLExportType:type"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLSvgOptions",
"canonicalReference": "@tldraw/editor!TLSvgOptions:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/export/exportAs.ts",
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "editor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ids",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false
},
{
"parameterName": "format",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"isOptional": true
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
},
"isOptional": true
}
],
"name": "exportAs"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!findMenuItem:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function findMenuItem(menu: "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ", path: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLUiCustomMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiCustomMenuItem:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuGroup",
"canonicalReference": "@tldraw/tldraw!TLUiMenuGroup:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiMenuItem:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiSubMenu",
"canonicalReference": "@tldraw/tldraw!TLUiSubMenu:type"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "menu",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "path",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"name": "findMenuItem"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!fitFrameToContent:function(1)",
"docComment": "/**\n * Fit a frame to its content.\n *\n * @param id - Id of the frame you wish to fit to content.\n *\n * @param editor - tlraw editor instance.\n *\n * @param opts - Options for fitting the frame.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function fitFrameToContent(editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", id: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Content",
"text": "{\n padding: number;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/frames/frames.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "editor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"name": "fitFrameToContent"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class FrameShapeTool extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeTool",
"canonicalReference": "@tldraw/editor!BaseBoxShapeTool:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/frame/FrameShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "FrameShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool#onCreate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onCreate: "
},
{
"kind": "Content",
"text": "(shape: null | "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onCreate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class FrameShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/frame/FrameShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "FrameShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#canBind:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canBind: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canBind",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#canDropShapes:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canDropShapes: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": ", _shapes: "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": "[]) => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canDropShapes",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#canReceiveNewChildrenOfType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canReceiveNewChildrenOfType: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": ", _type: "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": "['type']) => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canReceiveNewChildrenOfType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Geometry2d",
"canonicalReference": "@tldraw/editor!Geometry2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#onDragShapesOut:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDragShapesOut: "
},
{
"kind": "Content",
"text": "(_shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": ", shapes: "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": "[]) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDragShapesOut",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#onDragShapesOver:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDragShapesOver: "
},
{
"kind": "Content",
"text": "(frame: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": ", shapes: "
},
{
"kind": "Reference",
"text": "TLShape",
"canonicalReference": "@tldraw/tlschema!TLShape:type"
},
{
"kind": "Content",
"text": "[]) => {\n shouldHint: boolean;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDragShapesOver",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#onResizeEnd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResizeEnd: "
},
{
"kind": "Reference",
"text": "TLOnResizeEndHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeEndHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResizeEnd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n name: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#providesBackgroundForChildren:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "providesBackgroundForChildren(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "providesBackgroundForChildren"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLFrameShape",
"canonicalReference": "@tldraw/tlschema!TLFrameShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SVGElement",
"canonicalReference": "!SVGElement:interface"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "SVGElement",
"canonicalReference": "!SVGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 8
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!FrameShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"frame\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class GeoShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/geo/GeoShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "GeoShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_3:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_2:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class GeoShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/geo/GeoShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "GeoShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#getCanvasSvgDefs:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getCanvasSvgDefs(): "
},
{
"kind": "Reference",
"text": "TLShapeUtilCanvasSvgDef",
"canonicalReference": "@tldraw/editor!TLShapeUtilCanvasSvgDef:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getCanvasSvgDefs"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Geometry2d",
"canonicalReference": "@tldraw/editor!Geometry2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#onBeforeCreate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeCreate: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ") => {\n props: {\n growY: number;\n geo: \"arrow-down\" | \"arrow-left\" | \"arrow-right\" | \"arrow-up\" | \"check-box\" | \"cloud\" | \"diamond\" | \"ellipse\" | \"hexagon\" | \"octagon\" | \"oval\" | \"pentagon\" | \"rectangle\" | \"rhombus-2\" | \"rhombus\" | \"star\" | \"trapezoid\" | \"triangle\" | \"x-box\";\n labelColor: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n fill: \"none\" | \"pattern\" | \"semi\" | \"solid\";\n dash: \"dashed\" | \"dotted\" | \"draw\" | \"solid\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n verticalAlign: \"end\" | \"middle\" | \"start\";\n url: string;\n w: number;\n h: number;\n text: string;\n };\n type: \"geo\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeCreate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 10
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#onBeforeUpdate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeUpdate: "
},
{
"kind": "Content",
"text": "(prev: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ", next: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ") => {\n props: {\n growY: number;\n geo: \"arrow-down\" | \"arrow-left\" | \"arrow-right\" | \"arrow-up\" | \"check-box\" | \"cloud\" | \"diamond\" | \"ellipse\" | \"hexagon\" | \"octagon\" | \"oval\" | \"pentagon\" | \"rectangle\" | \"rhombus-2\" | \"rhombus\" | \"star\" | \"trapezoid\" | \"triangle\" | \"x-box\";\n labelColor: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n fill: \"none\" | \"pattern\" | \"semi\" | \"solid\";\n dash: \"dashed\" | \"dotted\" | \"draw\" | \"solid\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n verticalAlign: \"end\" | \"middle\" | \"start\";\n url: string;\n w: number;\n h: number;\n text: string;\n };\n type: \"geo\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeUpdate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 12
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#onDoubleClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClick: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ") => {\n props: {\n geo: \"check-box\";\n };\n type: \"geo\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | {\n props: {\n geo: \"rectangle\";\n };\n type: \"geo\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 16
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#onEditEnd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEditEnd: "
},
{
"kind": "Reference",
"text": "TLOnEditEndHandler",
"canonicalReference": "@tldraw/editor!TLOnEditEndHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEditEnd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n geo: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"arrow-down\" | \"arrow-left\" | \"arrow-right\" | \"arrow-up\" | \"check-box\" | \"cloud\" | \"diamond\" | \"ellipse\" | \"hexagon\" | \"octagon\" | \"oval\" | \"pentagon\" | \"rectangle\" | \"rhombus-2\" | \"rhombus\" | \"star\" | \"trapezoid\" | \"triangle\" | \"x-box\">;\n labelColor: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n fill: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"none\" | \"pattern\" | \"semi\" | \"solid\">;\n dash: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"dashed\" | \"dotted\" | \"draw\" | \"solid\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n font: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"draw\" | \"mono\" | \"sans\" | \"serif\">;\n align: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\">;\n verticalAlign: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"end\" | \"middle\" | \"start\">;\n url: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n growY: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n text: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 30
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLGeoShape",
"canonicalReference": "@tldraw/tlschema!TLGeoShape:type"
},
{
"kind": "Content",
"text": ", ctx: "
},
{
"kind": "Reference",
"text": "SvgExportContext",
"canonicalReference": "@tldraw/editor!SvgExportContext:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGElement",
"canonicalReference": "!SVGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!GeoShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"geo\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!getEmbedInfo:function(1)",
"docComment": "/**\n * Tests whether an URL supports embedding and returns the result. If we encounter an error, we return undefined.\n *\n * @param inputUrl - The URL to match\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getEmbedInfo(inputUrl: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLEmbedResult",
"canonicalReference": "@tldraw/tldraw!~TLEmbedResult:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/embeds/embeds.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "inputUrl",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "getEmbedInfo"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!getSvgAsImage:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getSvgAsImage(svg: "
},
{
"kind": "Reference",
"text": "SVGElement",
"canonicalReference": "!SVGElement:interface"
},
{
"kind": "Content",
"text": ", isSafari: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ", options: "
},
{
"kind": "Content",
"text": "{\n type: 'jpeg' | 'png' | 'webp';\n quality: number;\n scale: number;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Blob",
"canonicalReference": "!Blob:interface"
},
{
"kind": "Content",
"text": " | null>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/export/export.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "svg",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "isSafari",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
}
],
"name": "getSvgAsImage"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!HandTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class HandTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/tools/HandTool/HandTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "HandTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Dragging",
"canonicalReference": "@tldraw/tldraw!~Dragging:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_8:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_7:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool#onDoubleClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClick: "
},
{
"kind": "Reference",
"text": "TLClickEvent",
"canonicalReference": "@tldraw/editor!TLClickEvent:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool#onQuadrupleClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onQuadrupleClick: "
},
{
"kind": "Reference",
"text": "TLClickEvent",
"canonicalReference": "@tldraw/editor!TLClickEvent:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onQuadrupleClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HandTool#onTripleClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onTripleClick: "
},
{
"kind": "Reference",
"text": "TLClickEvent",
"canonicalReference": "@tldraw/editor!TLClickEvent:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onTripleClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class HighlightShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/highlight/HighlightShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "HighlightShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Drawing",
"canonicalReference": "@tldraw/tldraw!~Drawing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_2:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool#onExit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onExit: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onExit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class HighlightShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/highlight/HighlightShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "HighlightShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#backgroundComponent:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "backgroundComponent(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "backgroundComponent"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Circle2d",
"canonicalReference": "@tldraw/editor!Circle2d:class"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Polygon2d",
"canonicalReference": "@tldraw/editor!Polygon2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#hideResizeHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideResizeHandles: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideResizeHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#hideRotateHandle:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideRotateHandle: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideRotateHandle",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n segments: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "ArrayOfValidator",
"canonicalReference": "@tldraw/validate!ArrayOfValidator:class"
},
{
"kind": "Content",
"text": "<{\n type: \"free\" | \"straight\";\n points: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": "[];\n }>;\n isComplete: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n isPen: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 14
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#toBackgroundSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toBackgroundSvg(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGPathElement",
"canonicalReference": "!SVGPathElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toBackgroundSvg"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLHighlightShape",
"canonicalReference": "@tldraw/tlschema!TLHighlightShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGPathElement",
"canonicalReference": "!SVGPathElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!HighlightShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"highlight\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!Icon:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "Icon: "
},
{
"kind": "Content",
"text": "import(\"react\")."
},
{
"kind": "Reference",
"text": "NamedExoticComponent",
"canonicalReference": "@types/react!React.NamedExoticComponent:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiIconProps",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Icon.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "Icon",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ImageShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/image/ImageShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "ImageShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#canCrop:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canCrop: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canCrop",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#isAspectRatioLocked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isAspectRatioLocked: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "isAspectRatioLocked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#onDoubleClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClick: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#onDoubleClickEdge:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClickEdge: "
},
{
"kind": "Reference",
"text": "TLOnDoubleClickHandler",
"canonicalReference": "@tldraw/editor!TLOnDoubleClickHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClickEdge",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n playing: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n url: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n assetId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLAssetId",
"canonicalReference": "@tldraw/tlschema!TLAssetId:type"
},
{
"kind": "Content",
"text": " | null>;\n crop: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<{\n topLeft: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": ";\n bottomRight: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "VecModel",
"canonicalReference": "@tldraw/tlschema!VecModel:interface"
},
{
"kind": "Content",
"text": ";\n } | null>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 20
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLImageShape",
"canonicalReference": "@tldraw/tlschema!TLImageShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ImageShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"image\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!Input:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "Input: "
},
{
"kind": "Reference",
"text": "React.ForwardRefExoticComponent",
"canonicalReference": "@types/react!React.ForwardRefExoticComponent:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiInputProps",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps:interface"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "React.RefAttributes",
"canonicalReference": "@types/react!React.RefAttributes:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLInputElement",
"canonicalReference": "!HTMLInputElement:interface"
},
{
"kind": "Content",
"text": ">>"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Input.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "Input",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 9
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!isGifAnimated:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function isGifAnimated(file: "
},
{
"kind": "Reference",
"text": "Blob",
"canonicalReference": "!Blob:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<boolean>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/assets/assets.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "file",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "isGifAnimated"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!LaserTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class LaserTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/tools/LaserTool/LaserTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "LaserTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LaserTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_9:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Lasering",
"canonicalReference": "@tldraw/tldraw!~Lasering:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LaserTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LaserTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LaserTool#onEnter:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEnter: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEnter",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!LineShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class LineShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/line/LineShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "LineShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_4:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_3:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class LineShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/line/LineShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "LineShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "CubicSpline2d",
"canonicalReference": "@tldraw/editor!CubicSpline2d:class"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Polyline2d",
"canonicalReference": "@tldraw/editor!Polyline2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#getHandles:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getHandles(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLHandle",
"canonicalReference": "@tldraw/tlschema!TLHandle:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getHandles"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#getOutlineSegments:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getOutlineSegments(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Vec",
"canonicalReference": "@tldraw/editor!Vec:class"
},
{
"kind": "Content",
"text": "[][]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getOutlineSegments"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#hideResizeHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideResizeHandles: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideResizeHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#hideRotateHandle:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideRotateHandle: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideRotateHandle",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#hideSelectionBoundsBg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsBg: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsBg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#onHandleChange:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onHandleChange: "
},
{
"kind": "Reference",
"text": "TLOnHandleChangeHandler",
"canonicalReference": "@tldraw/editor!TLOnHandleChangeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onHandleChange",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n dash: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"dashed\" | \"dotted\" | \"draw\" | \"solid\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n spline: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"cubic\" | \"line\">;\n handles: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "DictValidator",
"canonicalReference": "@tldraw/validate!DictValidator:class"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLHandle",
"canonicalReference": "@tldraw/tlschema!TLHandle:interface"
},
{
"kind": "Content",
"text": ">;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 14
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLLineShape",
"canonicalReference": "@tldraw/tlschema!TLLineShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!LineShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"line\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!menuCustom:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function menuCustom(id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<{\n readonlyOk: boolean;\n disabled: boolean;\n}>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: \"custom\";\n disabled: boolean;\n readonlyOk: boolean;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": true
}
],
"name": "menuCustom"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!menuGroup:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function menuGroup(id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", ...children: "
},
{
"kind": "Content",
"text": "(false | "
},
{
"kind": "Reference",
"text": "TLUiMenuChild",
"canonicalReference": "@tldraw/tldraw!TLUiMenuChild:type"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "null | "
},
{
"kind": "Reference",
"text": "TLUiMenuGroup",
"canonicalReference": "@tldraw/tldraw!TLUiMenuGroup:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "children",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"isOptional": false
}
],
"name": "menuGroup"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!menuItem:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function menuItem(actionItem: "
},
{
"kind": "Reference",
"text": "TLUiActionItem",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiToolItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem:interface"
},
{
"kind": "Content",
"text": ", opts?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<{\n checked: boolean;\n disabled: boolean;\n}>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLUiMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiMenuItem:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "actionItem",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"isOptional": true
}
],
"name": "menuItem"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!menuSubmenu:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function menuSubmenu(id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", label: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": ", ...children: "
},
{
"kind": "Content",
"text": "(false | "
},
{
"kind": "Reference",
"text": "TLUiMenuChild",
"canonicalReference": "@tldraw/tldraw!TLUiMenuChild:type"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "null | "
},
{
"kind": "Reference",
"text": "TLUiSubMenu",
"canonicalReference": "@tldraw/tldraw!TLUiSubMenu:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "label",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 8
},
"isOptional": false
},
{
"parameterName": "children",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 12
},
"isOptional": false
}
],
"name": "menuSubmenu"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class NoteShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/note/NoteShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "NoteShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_5:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_4:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class NoteShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/note/NoteShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "NoteShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Rectangle2d",
"canonicalReference": "@tldraw/editor!Rectangle2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#getHeight:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getHeight(shape: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getHeight"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#hideResizeHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideResizeHandles: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideResizeHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#hideSelectionBoundsFg:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideSelectionBoundsFg: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideSelectionBoundsFg",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#onBeforeCreate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeCreate: "
},
{
"kind": "Content",
"text": "(next: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ") => {\n props: {\n growY: number;\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n verticalAlign: \"end\" | \"middle\" | \"start\";\n url: string;\n text: string;\n };\n type: \"note\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeCreate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 10
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#onBeforeUpdate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeUpdate: "
},
{
"kind": "Content",
"text": "(prev: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ", next: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ") => {\n props: {\n growY: number;\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n verticalAlign: \"end\" | \"middle\" | \"start\";\n url: string;\n text: string;\n };\n type: \"note\";\n x: number;\n y: number;\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeUpdate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 12
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#onEditEnd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEditEnd: "
},
{
"kind": "Reference",
"text": "TLOnEditEndHandler",
"canonicalReference": "@tldraw/editor!TLOnEditEndHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEditEnd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n font: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"draw\" | \"mono\" | \"sans\" | \"serif\">;\n align: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\">;\n verticalAlign: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"end\" | \"middle\" | \"start\">;\n growY: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n url: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n text: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 18
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLNoteShape",
"canonicalReference": "@tldraw/tlschema!TLNoteShape:type"
},
{
"kind": "Content",
"text": ", ctx: "
},
{
"kind": "Reference",
"text": "SvgExportContext",
"canonicalReference": "@tldraw/editor!SvgExportContext:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!NoteShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"note\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!OfflineIndicator:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function OfflineIndicator(): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/.tsbuild-api/lib/ui/components/OfflineIndicator/OfflineIndicator.d.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "OfflineIndicator"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!parseTldrawJsonFile:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function parseTldrawJsonFile({ json, schema, }: "
},
{
"kind": "Content",
"text": "{\n schema: "
},
{
"kind": "Reference",
"text": "TLSchema",
"canonicalReference": "@tldraw/tlschema!TLSchema:type"
},
{
"kind": "Content",
"text": ";\n json: string;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Result",
"canonicalReference": "@tldraw/utils!Result:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLStore",
"canonicalReference": "@tldraw/tlschema!TLStore:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "TldrawFileParseError",
"canonicalReference": "@tldraw/tldraw!~TldrawFileParseError:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/tldr/file.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ json, schema, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isOptional": false
}
],
"name": "parseTldrawJsonFile"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!removeFrame:function(1)",
"docComment": "/**\n * Remove a frame.\n *\n * @param editor - tlraw editor instance.\n *\n * @param ids - Ids of the frames you wish to remove.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function removeFrame(editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", ids: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/frames/frames.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "editor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ids",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false
}
],
"name": "removeFrame"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!SelectTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class SelectTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/tools/SelectTool/SelectTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "SelectTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!SelectTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Brushing",
"canonicalReference": "@tldraw/tldraw!~Brushing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Crop",
"canonicalReference": "@tldraw/tldraw!~Crop:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Cropping",
"canonicalReference": "@tldraw/tldraw!~Cropping:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "DraggingHandle",
"canonicalReference": "@tldraw/tldraw!~DraggingHandle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "EditingShape",
"canonicalReference": "@tldraw/tldraw!~EditingShape:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_11:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingCanvas",
"canonicalReference": "@tldraw/tldraw!~PointingCanvas:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingCropHandle",
"canonicalReference": "@tldraw/tldraw!~PointingCropHandle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingHandle",
"canonicalReference": "@tldraw/tldraw!~PointingHandle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingResizeHandle",
"canonicalReference": "@tldraw/tldraw!~PointingResizeHandle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingRotateHandle",
"canonicalReference": "@tldraw/tldraw!~PointingRotateHandle:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingSelection",
"canonicalReference": "@tldraw/tldraw!~PointingSelection:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "PointingShape",
"canonicalReference": "@tldraw/tldraw!~PointingShape:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Resizing",
"canonicalReference": "@tldraw/tldraw!~Resizing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Rotating",
"canonicalReference": "@tldraw/tldraw!~Rotating:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "ScribbleBrushing",
"canonicalReference": "@tldraw/tldraw!~ScribbleBrushing:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Translating",
"canonicalReference": "@tldraw/tldraw!~Translating:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 36
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!SelectTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!SelectTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!SelectTool#onExit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onExit: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onExit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!serializeTldrawJson:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function serializeTldrawJson(store: "
},
{
"kind": "Reference",
"text": "TLStore",
"canonicalReference": "@tldraw/tlschema!TLStore:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/tldr/file.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "store",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "serializeTldrawJson"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!serializeTldrawJsonBlob:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function serializeTldrawJsonBlob(store: "
},
{
"kind": "Reference",
"text": "TLStore",
"canonicalReference": "@tldraw/tlschema!TLStore:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Blob",
"canonicalReference": "!Blob:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/tldr/file.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "store",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "serializeTldrawJsonBlob"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!setDefaultEditorAssetUrls:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function setDefaultEditorAssetUrls(assetUrls: "
},
{
"kind": "Reference",
"text": "TLEditorAssetUrls",
"canonicalReference": "@tldraw/tldraw!~TLEditorAssetUrls:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/static-assets/assetUrls.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "assetUrls",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "setDefaultEditorAssetUrls"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!TextShapeTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class TextShapeTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/text/TextShapeTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "TextShapeTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_6:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_5:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeTool#shapeType:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shapeType: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "shapeType",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class TextShapeUtil extends "
},
{
"kind": "Reference",
"text": "ShapeUtil",
"canonicalReference": "@tldraw/editor!ShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/text/TextShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "TextShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#getGeometry:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getGeometry(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Rectangle2d",
"canonicalReference": "@tldraw/editor!Rectangle2d:class"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getGeometry"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#getMinDimensions:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getMinDimensions(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "{\n height: number;\n width: number;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "getMinDimensions"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#isAspectRatioLocked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isAspectRatioLocked: "
},
{
"kind": "Reference",
"text": "TLShapeUtilFlag",
"canonicalReference": "@tldraw/editor!TLShapeUtilFlag:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "isAspectRatioLocked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#onBeforeCreate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeCreate: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ") => {\n x: number;\n y: number;\n type: \"text\";\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n props: {\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n w: number;\n text: string;\n scale: number;\n autoSize: boolean;\n };\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeCreate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 10
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#onBeforeUpdate:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBeforeUpdate: "
},
{
"kind": "Content",
"text": "(prev: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ", next: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ") => {\n x: number;\n y: number;\n props: {\n w: number;\n color: \"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\";\n size: \"l\" | \"m\" | \"s\" | \"xl\";\n font: \"draw\" | \"mono\" | \"sans\" | \"serif\";\n align: \"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\";\n text: string;\n scale: number;\n autoSize: boolean;\n };\n type: \"text\";\n rotation: number;\n index: string;\n parentId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLParentId",
"canonicalReference": "@tldraw/tlschema!TLParentId:type"
},
{
"kind": "Content",
"text": ";\n isLocked: boolean;\n opacity: number;\n meta: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "JsonObject",
"canonicalReference": "@tldraw/utils!JsonObject:type"
},
{
"kind": "Content",
"text": ";\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n typeName: \"shape\";\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onBeforeUpdate",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 12
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#onDoubleClickEdge:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onDoubleClickEdge: "
},
{
"kind": "Content",
"text": "(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ") => {\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n type: \"text\";\n props: {\n autoSize: boolean;\n scale?: undefined;\n };\n } | {\n id: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": ";\n type: \"text\";\n props: {\n scale: number;\n autoSize?: undefined;\n };\n } | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onDoubleClickEdge",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#onEditEnd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEditEnd: "
},
{
"kind": "Reference",
"text": "TLOnEditEndHandler",
"canonicalReference": "@tldraw/editor!TLOnEditEndHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEditEnd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#onResize:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onResize: "
},
{
"kind": "Reference",
"text": "TLOnResizeHandler",
"canonicalReference": "@tldraw/editor!TLOnResizeHandler:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onResize",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n color: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"black\" | \"blue\" | \"green\" | \"grey\" | \"light-blue\" | \"light-green\" | \"light-red\" | \"light-violet\" | \"orange\" | \"red\" | \"violet\" | \"yellow\">;\n size: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"l\" | \"m\" | \"s\" | \"xl\">;\n font: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"draw\" | \"mono\" | \"sans\" | \"serif\">;\n align: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "EnumStyleProp",
"canonicalReference": "@tldraw/tlschema!EnumStyleProp:class"
},
{
"kind": "Content",
"text": "<\"end-legacy\" | \"end\" | \"middle-legacy\" | \"middle\" | \"start-legacy\" | \"start\">;\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n text: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n scale: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n autoSize: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 18
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLTextShape",
"canonicalReference": "@tldraw/tlschema!TLTextShape:type"
},
{
"kind": "Content",
"text": ", ctx: "
},
{
"kind": "Reference",
"text": "SvgExportContext",
"canonicalReference": "@tldraw/editor!SvgExportContext:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!TextShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"text\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TLDRAW_FILE_EXTENSION:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TLDRAW_FILE_EXTENSION: "
},
{
"kind": "Content",
"text": "\".tldr\""
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/tldr/file.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "TLDRAW_FILE_EXTENSION",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!Tldraw:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function Tldraw(props: "
},
{
"kind": "Reference",
"text": "TldrawProps",
"canonicalReference": "@tldraw/tldraw!TldrawProps:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/Tldraw.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "Tldraw"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandles:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function TldrawCropHandles({ size, width, height, hideAlternateHandles, }: "
},
{
"kind": "Reference",
"text": "TldrawCropHandlesProps",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawCropHandles.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ size, width, height, hideAlternateHandles, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "TldrawCropHandles"
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TldrawCropHandlesProps "
}
],
"fileUrlPath": "packages/tldraw/.tsbuild-api/lib/canvas/TldrawCropHandles.d.ts",
"releaseTag": "Public",
"name": "TldrawCropHandlesProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps#height:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "height: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawCropHandles.tsx",
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "height",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps#hideAlternateHandles:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "hideAlternateHandles: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawCropHandles.tsx",
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "hideAlternateHandles",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps#size:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "size: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawCropHandles.tsx",
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "size",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawCropHandlesProps#width:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "width: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawCropHandles.tsx",
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "width",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TldrawFile:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TldrawFile "
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/tldr/file.ts",
"releaseTag": "Public",
"name": "TldrawFile",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawFile#records:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "records: "
},
{
"kind": "Reference",
"text": "UnknownRecord",
"canonicalReference": "@tldraw/store!UnknownRecord:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "records",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawFile#schema:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "schema: "
},
{
"kind": "Reference",
"text": "SerializedSchema",
"canonicalReference": "@tldraw/store!SerializedSchema:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "schema",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawFile#tldrawFileFormatVersion:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "tldrawFileFormatVersion: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "tldrawFileFormatVersion",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawHandles:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawHandles: "
},
{
"kind": "Reference",
"text": "TLHandlesComponent",
"canonicalReference": "@tldraw/editor!TLHandlesComponent:type"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawHandles.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawHandles",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawHoveredShapeIndicator:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawHoveredShapeIndicator: "
},
{
"kind": "Reference",
"text": "TLHoveredShapeIndicatorComponent",
"canonicalReference": "@tldraw/editor!TLHoveredShapeIndicatorComponent:type"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawHoveredShapeIndicator.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawHoveredShapeIndicator",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TldrawProps:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TldrawProps = "
},
{
"kind": "Reference",
"text": "TldrawEditorBaseProps",
"canonicalReference": "@tldraw/editor!TldrawEditorBaseProps:interface"
},
{
"kind": "Content",
"text": " & ({\n store: "
},
{
"kind": "Reference",
"text": "TLStore",
"canonicalReference": "@tldraw/tlschema!TLStore:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLStoreWithStatus",
"canonicalReference": "@tldraw/editor!TLStoreWithStatus:type"
},
{
"kind": "Content",
"text": ";\n} | {\n store?: undefined;\n persistenceKey?: string;\n sessionId?: string;\n defaultName?: string;\n snapshot?: "
},
{
"kind": "Reference",
"text": "StoreSnapshot",
"canonicalReference": "@tldraw/store!StoreSnapshot:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLRecord",
"canonicalReference": "@tldraw/tlschema!TLRecord:type"
},
{
"kind": "Content",
"text": ">;\n}) & "
},
{
"kind": "Reference",
"text": "TldrawUiProps",
"canonicalReference": "@tldraw/tldraw!TldrawUiProps:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLExternalContentProps",
"canonicalReference": "@tldraw/tldraw!~TLExternalContentProps:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/Tldraw.tsx",
"releaseTag": "Public",
"name": "TldrawProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 17
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawScribble:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawScribble: "
},
{
"kind": "Reference",
"text": "TLScribbleComponent",
"canonicalReference": "@tldraw/editor!TLScribbleComponent:type"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawScribble.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawScribble",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawSelectionBackground:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawSelectionBackground: "
},
{
"kind": "Reference",
"text": "TLSelectionBackgroundComponent",
"canonicalReference": "@tldraw/editor!TLSelectionBackgroundComponent:type"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawSelectionBackground.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawSelectionBackground",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawSelectionForeground:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawSelectionForeground: "
},
{
"kind": "Reference",
"text": "TLSelectionForegroundComponent",
"canonicalReference": "@tldraw/editor!TLSelectionForegroundComponent:type"
}
],
"fileUrlPath": "packages/tldraw/src/lib/canvas/TldrawSelectionForeground.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawSelectionForeground",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!TldrawUi:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "TldrawUi: "
},
{
"kind": "Reference",
"text": "React.NamedExoticComponent",
"canonicalReference": "@types/react!React.NamedExoticComponent:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TldrawUiProps",
"canonicalReference": "@tldraw/tldraw!TldrawUiProps:type"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/TldrawUi.tsx",
"isReadonly": true,
"releaseTag": "Public",
"name": "TldrawUi",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps:interface",
"docComment": "/**\n * Base props for the {@link @tldraw/tldraw#Tldraw} and {@link TldrawUi} components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TldrawUiBaseProps "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/TldrawUi.tsx",
"releaseTag": "Public",
"name": "TldrawUiBaseProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps#assetUrls:member",
"docComment": "/**\n * Asset URL override.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "assetUrls?: "
},
{
"kind": "Reference",
"text": "TLUiAssetUrlOverrides",
"canonicalReference": "@tldraw/tldraw!TLUiAssetUrlOverrides:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "assetUrls",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps#children:member",
"docComment": "/**\n * The component's children.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "children?: "
},
{
"kind": "Reference",
"text": "ReactNode",
"canonicalReference": "@types/react!React.ReactNode:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps#hideUi:member",
"docComment": "/**\n * Whether to hide the user interface and only display the canvas.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "hideUi?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "hideUi",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps#renderDebugMenuItems:member",
"docComment": "/**\n * Additional items to add to the debug menu (will be deprecated)\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "renderDebugMenuItems?: "
},
{
"kind": "Content",
"text": "() => "
},
{
"kind": "Reference",
"text": "React.ReactNode",
"canonicalReference": "@types/react!React.ReactNode:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "renderDebugMenuItems",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps#shareZone:member",
"docComment": "/**\n * A component to use for the share zone (will be deprecated)\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "shareZone?: "
},
{
"kind": "Reference",
"text": "ReactNode",
"canonicalReference": "@types/react!React.ReactNode:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "shareZone",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProvider:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function TldrawUiContextProvider({ overrides, assetUrls, onUiEvent, forceMobile, children, }: "
},
{
"kind": "Reference",
"text": "TldrawUiContextProviderProps",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/TldrawUiContextProvider.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ overrides, assetUrls, onUiEvent, forceMobile, children, }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "TldrawUiContextProvider"
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps:interface",
"docComment": "/**\n * Props for the {@link @tldraw/tldraw#Tldraw} and {@link TldrawUi} components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TldrawUiContextProviderProps "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/TldrawUiContextProvider.tsx",
"releaseTag": "Public",
"name": "TldrawUiContextProviderProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps#assetUrls:member",
"docComment": "/**\n * Urls for where to find fonts and other assets for the UI.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "assetUrls?: "
},
{
"kind": "Reference",
"text": "RecursivePartial",
"canonicalReference": "@tldraw/utils!RecursivePartial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiAssetUrls",
"canonicalReference": "@tldraw/tldraw!~TLUiAssetUrls:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "assetUrls",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps#children:member",
"docComment": "/**\n * The component's children.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "children?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps#forceMobile:member",
"docComment": "/**\n * Whether to always should the mobile breakpoints.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "forceMobile?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "forceMobile",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps#onUiEvent:member",
"docComment": "/**\n * Callback for when an event occurs in the UI.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "onUiEvent?: "
},
{
"kind": "Reference",
"text": "TLUiEventHandler",
"canonicalReference": "@tldraw/tldraw!TLUiEventHandler:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onUiEvent",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps#overrides:member",
"docComment": "/**\n * Overrides for the UI.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "overrides?: "
},
{
"kind": "Reference",
"text": "TLUiOverrides",
"canonicalReference": "@tldraw/tldraw!TLUiOverrides:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiOverrides",
"canonicalReference": "@tldraw/tldraw!TLUiOverrides:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "overrides",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TldrawUiProps:type",
"docComment": "/**\n * Props for the {@link @tldraw/tldraw#Tldraw} and {@link TldrawUi} components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TldrawUiProps = "
},
{
"kind": "Reference",
"text": "TldrawUiBaseProps",
"canonicalReference": "@tldraw/tldraw!TldrawUiBaseProps:interface"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "TldrawUiContextProviderProps",
"canonicalReference": "@tldraw/tldraw!TldrawUiContextProviderProps:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/TldrawUi.tsx",
"releaseTag": "Public",
"name": "TldrawUiProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiActionItem<TransationKey extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", IconType extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useActions.tsx",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "TransationKey",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"typeParameterName": "IconType",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"defaultTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"name": "TLUiActionItem",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#checkbox:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "checkbox?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "checkbox",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#contextMenuLabel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "contextMenuLabel?: "
},
{
"kind": "Content",
"text": "TransationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "contextMenuLabel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon?: "
},
{
"kind": "Content",
"text": "IconType"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#kbd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "kbd?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "kbd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#label:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "label?: "
},
{
"kind": "Content",
"text": "TransationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#menuLabel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "menuLabel?: "
},
{
"kind": "Content",
"text": "TransationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "menuLabel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#onSelect:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onSelect: "
},
{
"kind": "Content",
"text": "(source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void> | void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onSelect",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#readonlyOk:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "readonlyOk: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "readonlyOk",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#shortcutsLabel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shortcutsLabel?: "
},
{
"kind": "Content",
"text": "TransationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "shortcutsLabel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem#title:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "title?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "title",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiActionsContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiActionsContextType = "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiActionItem",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useActions.tsx",
"releaseTag": "Public",
"name": "TLUiActionsContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiActionsMenuSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiActionsMenuSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useActionsMenuSchema.tsx",
"releaseTag": "Public",
"name": "TLUiActionsMenuSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiAssetUrlOverrides:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiAssetUrlOverrides = "
},
{
"kind": "Reference",
"text": "RecursivePartial",
"canonicalReference": "@tldraw/utils!RecursivePartial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiAssetUrls",
"canonicalReference": "@tldraw/tldraw!~TLUiAssetUrls:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/assetUrls.ts",
"releaseTag": "Public",
"name": "TLUiAssetUrlOverrides",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiButtonProps extends "
},
{
"kind": "Reference",
"text": "React.HTMLAttributes",
"canonicalReference": "@types/react!React.HTMLAttributes:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLButtonElement",
"canonicalReference": "!HTMLButtonElement:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Button.tsx",
"releaseTag": "Public",
"name": "TLUiButtonProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#disabled:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "disabled?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "disabled",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#iconLeft:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "iconLeft?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "iconLeft",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#invertIcon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "invertIcon?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "invertIcon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#isChecked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isChecked?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "isChecked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#kbd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "kbd?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "kbd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#label:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "label?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#loading:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "loading?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "loading",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#smallIcon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "smallIcon?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "smallIcon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#spinner:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "spinner?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "spinner",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiButtonProps#type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "type: "
},
{
"kind": "Content",
"text": "'danger' | 'help' | 'icon' | 'low' | 'menu' | 'normal' | 'primary' | 'tool'"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiContextMenuProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiContextMenuProps "
}
],
"fileUrlPath": "packages/tldraw/.tsbuild-api/lib/ui/components/ContextMenu.d.ts",
"releaseTag": "Public",
"name": "TLUiContextMenuProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiContextMenuProps#children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "children: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/ContextMenu.tsx",
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiContextTTLUiMenuSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiContextTTLUiMenuSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useContextMenuSchema.tsx",
"releaseTag": "Public",
"name": "TLUiContextTTLUiMenuSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiCustomMenuItem:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiCustomMenuItem = "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: 'custom';\n disabled: boolean;\n readonlyOk: boolean;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiCustomMenuItem",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiDialog "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useDialogsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiDialog",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiDialog#component:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component: "
},
{
"kind": "Content",
"text": "(props: "
},
{
"kind": "Reference",
"text": "TLUiDialogProps",
"canonicalReference": "@tldraw/tldraw!TLUiDialogProps:interface"
},
{
"kind": "Content",
"text": ") => any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "component",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiDialog#id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiDialog#onClose:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onClose?: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onClose",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiDialogProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiDialogProps "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useDialogsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiDialogProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiDialogProps#onClose:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onClose: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onClose",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiDialogsContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiDialogsContextType = "
},
{
"kind": "Content",
"text": "{\n addDialog: (dialog: "
},
{
"kind": "Reference",
"text": "Omit",
"canonicalReference": "!Omit:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiDialog",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface"
},
{
"kind": "Content",
"text": ", 'id'> & {\n id?: string;\n }) => string;\n removeDialog: (id: string) => string;\n updateDialog: (id: string, newDialogData: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiDialog",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface"
},
{
"kind": "Content",
"text": ">) => string;\n clearDialogs: () => void;\n dialogs: "
},
{
"kind": "Reference",
"text": "TLUiDialog",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface"
},
{
"kind": "Content",
"text": "[];\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useDialogsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiDialogsContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 12
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiEventContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiEventContextType = "
},
{
"kind": "Reference",
"text": "TLUiEventHandler",
"canonicalReference": "@tldraw/tldraw!TLUiEventHandler:type"
},
{
"kind": "Content",
"text": "<keyof "
},
{
"kind": "Reference",
"text": "TLUiEventMap",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiEventContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiEventHandler:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiEventHandler<T extends "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "TLUiEventMap",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap:interface"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "TLUiEventMap",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap:interface"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "(name: T, data: "
},
{
"kind": "Reference",
"text": "Join",
"canonicalReference": "@tldraw/tldraw!~Join:type"
},
{
"kind": "Content",
"text": "<{\n source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ";\n}, "
},
{
"kind": "Reference",
"text": "TLUiEventMap",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap:interface"
},
{
"kind": "Content",
"text": "[T]>) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiEventHandler",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
}
],
"typeTokenRange": {
"startIndex": 7,
"endIndex": 14
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiEventMap "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiEventMap",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"align-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'align-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'bottom' | 'center-horizontal' | 'center-vertical' | 'left' | 'right' | 'top';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"align-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"close-menu\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'close-menu': "
},
{
"kind": "Content",
"text": "{\n id: string;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"close-menu\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"convert-to-bookmark\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'convert-to-bookmark': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"convert-to-bookmark\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"convert-to-embed\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'convert-to-embed': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"convert-to-embed\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"copy-as\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'copy-as': "
},
{
"kind": "Content",
"text": "{\n format: 'json' | 'png' | 'svg';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"copy-as\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"create-new-project\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'create-new-project': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"create-new-project\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"delete-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'delete-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"delete-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"distribute-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'distribute-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'horizontal' | 'vertical';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"distribute-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"duplicate-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'duplicate-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"duplicate-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"edit-link\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'edit-link': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"edit-link\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"exit-pen-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'exit-pen-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"exit-pen-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"export-as\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'export-as': "
},
{
"kind": "Content",
"text": "{\n format: 'json' | 'png' | 'svg';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"export-as\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"fit-frame-to-content\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'fit-frame-to-content': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"fit-frame-to-content\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"flip-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'flip-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'horizontal' | 'vertical';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"flip-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"group-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'group-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"group-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"insert-embed\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'insert-embed': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"insert-embed\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"insert-media\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'insert-media': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"insert-media\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"open-cursor-chat\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'open-cursor-chat': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"open-cursor-chat\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"open-embed-link\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'open-embed-link': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"open-embed-link\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"open-file\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'open-file': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"open-file\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"open-menu\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'open-menu': "
},
{
"kind": "Content",
"text": "{\n id: string;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"open-menu\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"pack-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'pack-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"pack-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"remove-frame\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'remove-frame': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"remove-frame\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"reorder-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'reorder-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'backward' | 'forward' | 'toBack' | 'toFront';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"reorder-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"reset-zoom\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'reset-zoom': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"reset-zoom\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"rotate-ccw\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'rotate-ccw': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"rotate-ccw\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"rotate-cw\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'rotate-cw': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"rotate-cw\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"save-project-to-file\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'save-project-to-file': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"save-project-to-file\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"select-all-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'select-all-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"select-all-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"select-none-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'select-none-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"select-none-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"select-tool\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'select-tool': "
},
{
"kind": "Content",
"text": "{\n id: string;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"select-tool\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"stack-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'stack-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'horizontal' | 'vertical';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"stack-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"stop-following\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'stop-following': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"stop-following\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"stretch-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'stretch-shapes': "
},
{
"kind": "Content",
"text": "{\n operation: 'horizontal' | 'vertical';\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"stretch-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-auto-size\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-auto-size': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-auto-size\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-dark-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-dark-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-dark-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-debug-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-debug-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-debug-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-edge-scrolling\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-edge-scrolling': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-edge-scrolling\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-focus-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-focus-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-focus-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-grid-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-grid-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-grid-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-lock\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-lock': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-lock\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-reduce-motion\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-reduce-motion': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-reduce-motion\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-snap-mode\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-snap-mode': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-snap-mode\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-tool-lock\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-tool-lock': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-tool-lock\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"toggle-transparent\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'toggle-transparent': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"toggle-transparent\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"ungroup-shapes\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'ungroup-shapes': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"ungroup-shapes\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"unlock-all\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'unlock-all': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"unlock-all\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-in\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-in': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-in\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-into-view\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-into-view': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-into-view\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-out\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-out': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-out\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-to-content\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-to-content': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-to-content\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-to-fit\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-to-fit': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-to-fit\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-to-selection\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-to-selection': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-to-selection\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#\"zoom-tool\":member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "'zoom-tool': "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "\"zoom-tool\"",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#copy:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "copy: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "copy",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#cut:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "cut: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "cut",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#paste:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "paste: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "paste",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#print:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "print: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "print",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#redo:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "redo: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "redo",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiEventMap#undo:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "undo: "
},
{
"kind": "Content",
"text": "null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "undo",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiEventSource = "
},
{
"kind": "Content",
"text": "'actions-menu' | 'context-menu' | 'debug-panel' | 'dialog' | 'export-menu' | 'help-menu' | 'helper-buttons' | 'kbd' | 'menu' | 'navigation-zone' | 'page-menu' | 'people-menu' | 'quick-actions' | 'share-menu' | 'toolbar' | 'unknown' | 'zoom-menu'"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiEventSource",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiHelpMenuSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiHelpMenuSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useHelpMenuSchema.tsx",
"releaseTag": "Public",
"name": "TLUiHelpMenuSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiIconProps extends "
},
{
"kind": "Reference",
"text": "React.HTMLProps",
"canonicalReference": "@types/react!React.HTMLProps:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLDivElement",
"canonicalReference": "!HTMLDivElement:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Icon.tsx",
"releaseTag": "Public",
"name": "TLUiIconProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "children?: "
},
{
"kind": "Content",
"text": "undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#color:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "color?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "color",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#crossOrigin:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "crossOrigin?: "
},
{
"kind": "Content",
"text": "'anonymous' | 'use-credentials'"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "crossOrigin",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#invertIcon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "invertIcon?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "invertIcon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiIconProps#small:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "small?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "small",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiIconType = "
},
{
"kind": "Content",
"text": "'align-bottom-center' | 'align-bottom-left' | 'align-bottom-right' | 'align-bottom' | 'align-center-center' | 'align-center-horizontal' | 'align-center-left' | 'align-center-right' | 'align-center-vertical' | 'align-left' | 'align-right' | 'align-top-center' | 'align-top-left' | 'align-top-right' | 'align-top' | 'arrow-left' | 'arrowhead-arrow' | 'arrowhead-bar' | 'arrowhead-diamond' | 'arrowhead-dot' | 'arrowhead-none' | 'arrowhead-square' | 'arrowhead-triangle-inverted' | 'arrowhead-triangle' | 'aspect-ratio' | 'avatar' | 'blob' | 'bring-forward' | 'bring-to-front' | 'check' | 'checkbox-checked' | 'checkbox-empty' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'chevrons-ne' | 'chevrons-sw' | 'clipboard-copied' | 'clipboard-copy' | 'code' | 'collab' | 'color' | 'comment' | 'cross-2' | 'cross' | 'dash-dashed' | 'dash-dotted' | 'dash-draw' | 'dash-solid' | 'discord' | 'distribute-horizontal' | 'distribute-vertical' | 'dot' | 'dots-horizontal' | 'dots-vertical' | 'drag-handle-dots' | 'duplicate' | 'edit' | 'external-link' | 'file' | 'fill-none' | 'fill-pattern' | 'fill-semi' | 'fill-solid' | 'follow' | 'following' | 'font-draw' | 'font-mono' | 'font-sans' | 'font-serif' | 'geo-arrow-down' | 'geo-arrow-left' | 'geo-arrow-right' | 'geo-arrow-up' | 'geo-check-box' | 'geo-cloud' | 'geo-diamond' | 'geo-ellipse' | 'geo-hexagon' | 'geo-octagon' | 'geo-oval' | 'geo-pentagon' | 'geo-rectangle' | 'geo-rhombus-2' | 'geo-rhombus' | 'geo-star' | 'geo-trapezoid' | 'geo-triangle' | 'geo-x-box' | 'github' | 'group' | 'hidden' | 'image' | 'info-circle' | 'leading' | 'link' | 'lock-small' | 'lock' | 'menu' | 'minus' | 'mixed' | 'pack' | 'page' | 'plus' | 'question-mark-circle' | 'question-mark' | 'redo' | 'reset-zoom' | 'rotate-ccw' | 'rotate-cw' | 'ruler' | 'search' | 'send-backward' | 'send-to-back' | 'settings-horizontal' | 'settings-vertical-1' | 'settings-vertical' | 'share-1' | 'share-2' | 'size-extra-large' | 'size-large' | 'size-medium' | 'size-small' | 'spline-cubic' | 'spline-line' | 'stack-horizontal' | 'stack-vertical' | 'status-offline' | 'status-online' | 'stretch-horizontal' | 'stretch-vertical' | 'text-align-center' | 'text-align-justify' | 'text-align-left' | 'text-align-right' | 'tool-arrow' | 'tool-embed' | 'tool-eraser' | 'tool-frame' | 'tool-hand' | 'tool-highlight' | 'tool-laser' | 'tool-line' | 'tool-media' | 'tool-note' | 'tool-pencil' | 'tool-pointer' | 'tool-text' | 'trash' | 'triangle-down' | 'triangle-up' | 'twitter' | 'undo' | 'ungroup' | 'unlock-small' | 'unlock' | 'vertical-align-center' | 'vertical-align-end' | 'vertical-align-start' | 'visible' | 'warning-triangle' | 'zoom-in' | 'zoom-out'"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/icon-types.ts",
"releaseTag": "Public",
"name": "TLUiIconType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiInputProps "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/components/primitives/Input.tsx",
"releaseTag": "Public",
"name": "TLUiInputProps",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#autofocus:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "autofocus?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "autofocus",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#autoselect:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "autoselect?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "autoselect",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "children?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#className:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "className?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "className",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#defaultValue:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "defaultValue?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "defaultValue",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#disabled:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "disabled?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "disabled",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#iconLeft:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "iconLeft?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "iconLeft",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#label:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "label?: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#onBlur:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onBlur?: "
},
{
"kind": "Content",
"text": "(value: string) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onBlur",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#onCancel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onCancel?: "
},
{
"kind": "Content",
"text": "(value: string) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onCancel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#onComplete:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onComplete?: "
},
{
"kind": "Content",
"text": "(value: string) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onComplete",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#onValueChange:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onValueChange?: "
},
{
"kind": "Content",
"text": "(value: string) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "onValueChange",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#placeholder:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "placeholder?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "placeholder",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#shouldManuallyMaintainScrollPositionWhenFocused:member",
"docComment": "/**\n * Usually on iOS when you focus an input, the browser will adjust the viewport to bring the input into view. Sometimes this doesn't work properly though - for example, if the input is newly created, iOS seems to have a hard time adjusting the viewport for it. This prop allows you to opt-in to some extra code to manually bring the input into view when the visual viewport of the browser changes, but we don't want to use it everywhere because generally the native behavior looks nicer in scenarios where it's sufficient.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "shouldManuallyMaintainScrollPositionWhenFocused?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "shouldManuallyMaintainScrollPositionWhenFocused",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiInputProps#value:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "value?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "value",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiKeyboardShortcutsSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useKeyboardShortcutsSchema.tsx",
"releaseTag": "Public",
"name": "TLUiKeyboardShortcutsSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaProviderProps:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiKeyboardShortcutsSchemaProviderProps = "
},
{
"kind": "Content",
"text": "{\n overrides?: (editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", schema: "
},
{
"kind": "Reference",
"text": "TLUiKeyboardShortcutsSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaContextType:type"
},
{
"kind": "Content",
"text": ", more: {\n tools: "
},
{
"kind": "Reference",
"text": "TLUiToolsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToolsContextType:type"
},
{
"kind": "Content",
"text": ";\n actions: "
},
{
"kind": "Reference",
"text": "TLUiActionsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiActionsContextType:type"
},
{
"kind": "Content",
"text": ";\n }) => "
},
{
"kind": "Reference",
"text": "TLUiKeyboardShortcutsSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaContextType:type"
},
{
"kind": "Content",
"text": ";\n children: any;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useKeyboardShortcutsSchema.tsx",
"releaseTag": "Public",
"name": "TLUiKeyboardShortcutsSchemaProviderProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 12
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuChild:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuChild<TranslationKey extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "null | "
},
{
"kind": "Reference",
"text": "TLUiCustomMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiCustomMenuItem:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuGroup",
"canonicalReference": "@tldraw/tldraw!TLUiMenuGroup:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiMenuItem:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiSubMenu",
"canonicalReference": "@tldraw/tldraw!TLUiSubMenu:type"
},
{
"kind": "Content",
"text": "<TranslationKey>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiMenuChild",
"typeParameters": [
{
"typeParameterName": "TranslationKey",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 14
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuGroup:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuGroup = "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: 'group';\n checkbox: boolean;\n disabled: boolean;\n readonlyOk: boolean;\n children: "
},
{
"kind": "Reference",
"text": "TLUiMenuChild",
"canonicalReference": "@tldraw/tldraw!TLUiMenuChild:type"
},
{
"kind": "Content",
"text": "[];\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiMenuGroup",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuItem:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuItem = "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: 'item';\n readonlyOk: boolean;\n actionItem: "
},
{
"kind": "Reference",
"text": "TLUiActionItem",
"canonicalReference": "@tldraw/tldraw!TLUiActionItem:interface"
},
{
"kind": "Content",
"text": ";\n disabled: boolean;\n checked: boolean;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiMenuItem",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuSchema = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "TLUiCustomMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiCustomMenuItem:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuGroup",
"canonicalReference": "@tldraw/tldraw!TLUiMenuGroup:type"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TLUiMenuItem",
"canonicalReference": "@tldraw/tldraw!TLUiMenuItem:type"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiMenuSchema",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useMenuSchema.tsx",
"releaseTag": "Public",
"name": "TLUiMenuSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchemaProviderProps:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiMenuSchemaProviderProps = "
},
{
"kind": "Content",
"text": "{\n overrides?: (editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", schema: "
},
{
"kind": "Reference",
"text": "TLUiMenuSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchemaContextType:type"
},
{
"kind": "Content",
"text": ", helpers: {\n actions: "
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<typeof "
},
{
"kind": "Reference",
"text": "useActions",
"canonicalReference": "@tldraw/tldraw!useActions:function"
},
{
"kind": "Content",
"text": ">;\n noneSelected: boolean;\n oneSelected: boolean;\n twoSelected: boolean;\n threeSelected: boolean;\n }) => "
},
{
"kind": "Reference",
"text": "TLUiMenuSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchemaContextType:type"
},
{
"kind": "Content",
"text": ";\n children: any;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useMenuSchema.tsx",
"releaseTag": "Public",
"name": "TLUiMenuSchemaProviderProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 12
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiOverrides:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiOverrides = "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<{\n actionsMenu: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ActionsMenuSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!~ActionsMenuSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n actions: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ActionsProviderProps",
"canonicalReference": "@tldraw/tldraw!~ActionsProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n contextMenu: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiContextMenuSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!~TLUiContextMenuSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n helpMenu: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiHelpMenuSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!~TLUiHelpMenuSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n menu: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiMenuSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n toolbar: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiToolbarSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!~TLUiToolbarSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n keyboardShortcutsMenu: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiKeyboardShortcutsSchemaProviderProps",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n tools: "
},
{
"kind": "Reference",
"text": "WithDefaultHelpers",
"canonicalReference": "@tldraw/tldraw!~WithDefaultHelpers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NonNullable",
"canonicalReference": "!NonNullable:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiToolsProviderProps",
"canonicalReference": "@tldraw/tldraw!TLUiToolsProviderProps:type"
},
{
"kind": "Content",
"text": "['overrides']>>;\n translations: "
},
{
"kind": "Reference",
"text": "TLUiTranslationProviderProps",
"canonicalReference": "@tldraw/tldraw!~TLUiTranslationProviderProps:interface"
},
{
"kind": "Content",
"text": "['overrides'];\n}>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/overrides.ts",
"releaseTag": "Public",
"name": "TLUiOverrides",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 53
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiSubMenu:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiSubMenu<TranslationKey extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: 'submenu';\n label: TranslationKey;\n disabled: boolean;\n readonlyOk: boolean;\n children: "
},
{
"kind": "Reference",
"text": "TLUiMenuChild",
"canonicalReference": "@tldraw/tldraw!TLUiMenuChild:type"
},
{
"kind": "Content",
"text": "[];\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/menuHelpers.ts",
"releaseTag": "Public",
"name": "TLUiSubMenu",
"typeParameters": [
{
"typeParameterName": "TranslationKey",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiToast:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiToast "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToastsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiToast",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#actions:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "actions?: "
},
{
"kind": "Reference",
"text": "TLUiToastAction",
"canonicalReference": "@tldraw/tldraw!TLUiToastAction:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "actions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#closeLabel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "closeLabel?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "closeLabel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#description:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "description?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "description",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon?: "
},
{
"kind": "Reference",
"text": "TLUiIconType",
"canonicalReference": "@tldraw/tldraw!TLUiIconType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#keepOpen:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "keepOpen?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "keepOpen",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToast#title:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "title?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "title",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiToastAction:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiToastAction "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToastsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiToastAction",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToastAction#label:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "label: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToastAction#onClick:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onClick: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onClick",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToastAction#type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "type: "
},
{
"kind": "Content",
"text": "'danger' | 'normal' | 'primary'"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiToastsContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiToastsContextType = "
},
{
"kind": "Content",
"text": "{\n addToast: (toast: "
},
{
"kind": "Reference",
"text": "Omit",
"canonicalReference": "!Omit:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiToast",
"canonicalReference": "@tldraw/tldraw!TLUiToast:interface"
},
{
"kind": "Content",
"text": ", 'id'> & {\n id?: string;\n }) => string;\n removeToast: (id: "
},
{
"kind": "Reference",
"text": "TLUiToast",
"canonicalReference": "@tldraw/tldraw!TLUiToast:interface"
},
{
"kind": "Content",
"text": "['id']) => string;\n clearToasts: () => void;\n toasts: "
},
{
"kind": "Reference",
"text": "TLUiToast",
"canonicalReference": "@tldraw/tldraw!TLUiToast:interface"
},
{
"kind": "Content",
"text": "[];\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToastsProvider.tsx",
"releaseTag": "Public",
"name": "TLUiToastsContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 10
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiToolbarItem:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiToolbarItem = "
},
{
"kind": "Content",
"text": "{\n id: string;\n type: 'item';\n readonlyOk: boolean;\n toolItem: "
},
{
"kind": "Reference",
"text": "TLUiToolItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem:interface"
},
{
"kind": "Content",
"text": ";\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToolbarSchema.tsx",
"releaseTag": "Public",
"name": "TLUiToolbarItem",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiToolbarSchemaContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiToolbarSchemaContextType = "
},
{
"kind": "Reference",
"text": "TLUiToolbarItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolbarItem:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToolbarSchema.tsx",
"releaseTag": "Public",
"name": "TLUiToolbarSchemaContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface TLUiToolItem<TranslationKey extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", IconType extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> "
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTools.tsx",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "TranslationKey",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"typeParameterName": "IconType",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"defaultTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"name": "TLUiToolItem",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#icon:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "icon: "
},
{
"kind": "Content",
"text": "IconType"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "icon",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#kbd:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "kbd?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "kbd",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#label:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "label: "
},
{
"kind": "Content",
"text": "TranslationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#meta:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "meta?: "
},
{
"kind": "Content",
"text": "{\n [key: string]: any;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "meta",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#onSelect:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onSelect: "
},
{
"kind": "Content",
"text": "(source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onSelect",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#readonlyOk:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "readonlyOk: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "readonlyOk",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem#shortcutsLabel:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "shortcutsLabel?: "
},
{
"kind": "Content",
"text": "TranslationKey"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "shortcutsLabel",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiToolsContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiToolsContextType = "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiToolItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTools.tsx",
"releaseTag": "Public",
"name": "TLUiToolsContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiToolsProviderProps:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiToolsProviderProps = "
},
{
"kind": "Content",
"text": "{\n overrides?: (editor: "
},
{
"kind": "Reference",
"text": "Editor",
"canonicalReference": "@tldraw/editor!Editor:class"
},
{
"kind": "Content",
"text": ", tools: "
},
{
"kind": "Reference",
"text": "TLUiToolsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToolsContextType:type"
},
{
"kind": "Content",
"text": ", helpers: {\n insertMedia: () => void;\n }) => "
},
{
"kind": "Reference",
"text": "TLUiToolsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToolsContextType:type"
},
{
"kind": "Content",
"text": ";\n children: any;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTools.tsx",
"releaseTag": "Public",
"name": "TLUiToolsProviderProps",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiTranslation:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiTranslation = "
},
{
"kind": "Content",
"text": "{\n readonly locale: string;\n readonly label: string;\n readonly messages: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": ", string>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTranslation/translations.ts",
"releaseTag": "Public",
"name": "TLUiTranslation",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationContextType:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiTranslationContextType = "
},
{
"kind": "Reference",
"text": "TLUiTranslation",
"canonicalReference": "@tldraw/tldraw!TLUiTranslation:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTranslation/useTranslation.tsx",
"releaseTag": "Public",
"name": "TLUiTranslationContextType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLUiTranslationKey = "
},
{
"kind": "Content",
"text": "'action.align-bottom' | 'action.align-center-horizontal.short' | 'action.align-center-horizontal' | 'action.align-center-vertical.short' | 'action.align-center-vertical' | 'action.align-left' | 'action.align-right' | 'action.align-top' | 'action.back-to-content' | 'action.bring-forward' | 'action.bring-to-front' | 'action.convert-to-bookmark' | 'action.convert-to-embed' | 'action.copy-as-json.short' | 'action.copy-as-json' | 'action.copy-as-png.short' | 'action.copy-as-png' | 'action.copy-as-svg.short' | 'action.copy-as-svg' | 'action.copy' | 'action.cut' | 'action.delete' | 'action.distribute-horizontal.short' | 'action.distribute-horizontal' | 'action.distribute-vertical.short' | 'action.distribute-vertical' | 'action.duplicate' | 'action.edit-link' | 'action.exit-pen-mode' | 'action.export-as-json.short' | 'action.export-as-json' | 'action.export-as-png.short' | 'action.export-as-png' | 'action.export-as-svg.short' | 'action.export-as-svg' | 'action.fit-frame-to-content' | 'action.flip-horizontal.short' | 'action.flip-horizontal' | 'action.flip-vertical.short' | 'action.flip-vertical' | 'action.fork-project' | 'action.group' | 'action.insert-embed' | 'action.insert-media' | 'action.leave-shared-project' | 'action.new-project' | 'action.new-shared-project' | 'action.open-cursor-chat' | 'action.open-embed-link' | 'action.open-file' | 'action.pack' | 'action.paste' | 'action.print' | 'action.redo' | 'action.remove-frame' | 'action.rotate-ccw' | 'action.rotate-cw' | 'action.save-copy' | 'action.select-all' | 'action.select-none' | 'action.send-backward' | 'action.send-to-back' | 'action.share-project' | 'action.stack-horizontal.short' | 'action.stack-horizontal' | 'action.stack-vertical.short' | 'action.stack-vertical' | 'action.stop-following' | 'action.stretch-horizontal.short' | 'action.stretch-horizontal' | 'action.stretch-vertical.short' | 'action.stretch-vertical' | 'action.toggle-auto-size' | 'action.toggle-dark-mode.menu' | 'action.toggle-dark-mode' | 'action.toggle-debug-mode.menu' | 'action.toggle-debug-mode' | 'action.toggle-edge-scrolling.menu' | 'action.toggle-edge-scrolling' | 'action.toggle-focus-mode.menu' | 'action.toggle-focus-mode' | 'action.toggle-grid.menu' | 'action.toggle-grid' | 'action.toggle-lock' | 'action.toggle-reduce-motion.menu' | 'action.toggle-reduce-motion' | 'action.toggle-snap-mode.menu' | 'action.toggle-snap-mode' | 'action.toggle-tool-lock.menu' | 'action.toggle-tool-lock' | 'action.toggle-transparent.context-menu' | 'action.toggle-transparent.menu' | 'action.toggle-transparent' | 'action.undo' | 'action.ungroup' | 'action.unlock-all' | 'action.zoom-in' | 'action.zoom-out' | 'action.zoom-to-100' | 'action.zoom-to-fit' | 'action.zoom-to-selection' | 'actions-menu.title' | 'align-style.end' | 'align-style.justify' | 'align-style.middle' | 'align-style.start' | 'arrowheadEnd-style.arrow' | 'arrowheadEnd-style.bar' | 'arrowheadEnd-style.diamond' | 'arrowheadEnd-style.dot' | 'arrowheadEnd-style.inverted' | 'arrowheadEnd-style.none' | 'arrowheadEnd-style.pipe' | 'arrowheadEnd-style.square' | 'arrowheadEnd-style.triangle' | 'arrowheadStart-style.arrow' | 'arrowheadStart-style.bar' | 'arrowheadStart-style.diamond' | 'arrowheadStart-style.dot' | 'arrowheadStart-style.inverted' | 'arrowheadStart-style.none' | 'arrowheadStart-style.pipe' | 'arrowheadStart-style.square' | 'arrowheadStart-style.triangle' | 'color-style.black' | 'color-style.blue' | 'color-style.green' | 'color-style.grey' | 'color-style.light-blue' | 'color-style.light-green' | 'color-style.light-red' | 'color-style.light-violet' | 'color-style.orange' | 'color-style.red' | 'color-style.violet' | 'color-style.yellow' | 'context-menu.arrange' | 'context-menu.copy-as' | 'context-menu.export-as' | 'context-menu.move-to-page' | 'context-menu.reorder' | 'context.pages.new-page' | 'cursor-chat.type-to-chat' | 'dash-style.dashed' | 'dash-style.dotted' | 'dash-style.draw' | 'dash-style.solid' | 'debug-panel.more' | 'edit-link-dialog.cancel' | 'edit-link-dialog.clear' | 'edit-link-dialog.detail' | 'edit-link-dialog.invalid-url' | 'edit-link-dialog.save' | 'edit-link-dialog.title' | 'edit-link-dialog.url' | 'edit-pages-dialog.move-down' | 'edit-pages-dialog.move-up' | 'embed-dialog.back' | 'embed-dialog.cancel' | 'embed-dialog.create' | 'embed-dialog.instruction' | 'embed-dialog.invalid-url' | 'embed-dialog.title' | 'embed-dialog.url' | 'file-system.confirm-clear.cancel' | 'file-system.confirm-clear.continue' | 'file-system.confirm-clear.description' | 'file-system.confirm-clear.dont-show-again' | 'file-system.confirm-clear.title' | 'file-system.confirm-open.cancel' | 'file-system.confirm-open.description' | 'file-system.confirm-open.dont-show-again' | 'file-system.confirm-open.open' | 'file-system.confirm-open.title' | 'file-system.file-open-error.file-format-version-too-new' | 'file-system.file-open-error.generic-corrupted-file' | 'file-system.file-open-error.not-a-tldraw-file' | 'file-system.file-open-error.title' | 'file-system.shared-document-file-open-error.description' | 'file-system.shared-document-file-open-error.title' | 'fill-style.none' | 'fill-style.pattern' | 'fill-style.semi' | 'fill-style.solid' | 'focus-mode.toggle-focus-mode' | 'font-style.draw' | 'font-style.mono' | 'font-style.sans' | 'font-style.serif' | 'geo-style.arrow-down' | 'geo-style.arrow-left' | 'geo-style.arrow-right' | 'geo-style.arrow-up' | 'geo-style.check-box' | 'geo-style.cloud' | 'geo-style.diamond' | 'geo-style.ellipse' | 'geo-style.hexagon' | 'geo-style.octagon' | 'geo-style.oval' | 'geo-style.pentagon' | 'geo-style.rectangle' | 'geo-style.rhombus-2' | 'geo-style.rhombus' | 'geo-style.star' | 'geo-style.trapezoid' | 'geo-style.triangle' | 'geo-style.x-box' | 'help-menu.about' | 'help-menu.discord' | 'help-menu.github' | 'help-menu.keyboard-shortcuts' | 'help-menu.title' | 'help-menu.twitter' | 'home-project-dialog.description' | 'home-project-dialog.ok' | 'home-project-dialog.title' | 'menu.copy-as' | 'menu.edit' | 'menu.export-as' | 'menu.file' | 'menu.language' | 'menu.preferences' | 'menu.title' | 'menu.view' | 'navigation-zone.toggle-minimap' | 'navigation-zone.zoom' | 'opacity-style.0.1' | 'opacity-style.0.25' | 'opacity-style.0.5' | 'opacity-style.0.75' | 'opacity-style.1' | 'page-menu.create-new-page' | 'page-menu.edit-done' | 'page-menu.edit-start' | 'page-menu.go-to-page' | 'page-menu.max-page-count-reached' | 'page-menu.new-page-initial-name' | 'page-menu.submenu.delete' | 'page-menu.submenu.duplicate-page' | 'page-menu.submenu.move-down' | 'page-menu.submenu.move-up' | 'page-menu.submenu.rename' | 'page-menu.submenu.title' | 'page-menu.title' | 'people-menu.change-color' | 'people-menu.change-name' | 'people-menu.follow' | 'people-menu.following' | 'people-menu.invite' | 'people-menu.leading' | 'people-menu.title' | 'people-menu.user' | 'rename-project-dialog.cancel' | 'rename-project-dialog.rename' | 'rename-project-dialog.title' | 'share-menu.copy-link-note' | 'share-menu.copy-link' | 'share-menu.copy-readonly-link-note' | 'share-menu.copy-readonly-link' | 'share-menu.create-snapshot-link' | 'share-menu.default-project-name' | 'share-menu.fork-note' | 'share-menu.offline-note' | 'share-menu.project-too-large' | 'share-menu.readonly-link' | 'share-menu.save-note' | 'share-menu.share-project' | 'share-menu.snapshot-link-note' | 'share-menu.title' | 'share-menu.upload-failed' | 'sharing.confirm-leave.cancel' | 'sharing.confirm-leave.description' | 'sharing.confirm-leave.dont-show-again' | 'sharing.confirm-leave.leave' | 'sharing.confirm-leave.title' | 'shortcuts-dialog.collaboration' | 'shortcuts-dialog.edit' | 'shortcuts-dialog.file' | 'shortcuts-dialog.preferences' | 'shortcuts-dialog.title' | 'shortcuts-dialog.tools' | 'shortcuts-dialog.transform' | 'shortcuts-dialog.view' | 'size-style.l' | 'size-style.m' | 'size-style.s' | 'size-style.xl' | 'spline-style.cubic' | 'spline-style.line' | 'status.offline' | 'status.online' | 'style-panel.align' | 'style-panel.arrowhead-end' | 'style-panel.arrowhead-start' | 'style-panel.arrowheads' | 'style-panel.color' | 'style-panel.dash' | 'style-panel.fill' | 'style-panel.font' | 'style-panel.geo' | 'style-panel.mixed' | 'style-panel.opacity' | 'style-panel.position' | 'style-panel.size' | 'style-panel.spline' | 'style-panel.title' | 'style-panel.vertical-align' | 'toast.close' | 'toast.error.copy-fail.desc' | 'toast.error.copy-fail.title' | 'toast.error.export-fail.desc' | 'toast.error.export-fail.title' | 'tool-panel.drawing' | 'tool-panel.more' | 'tool-panel.shapes' | 'tool.arrow-down' | 'tool.arrow-left' | 'tool.arrow-right' | 'tool.arrow-up' | 'tool.arrow' | 'tool.asset' | 'tool.check-box' | 'tool.cloud' | 'tool.diamond' | 'tool.draw' | 'tool.ellipse' | 'tool.embed' | 'tool.eraser' | 'tool.frame' | 'tool.hand' | 'tool.hexagon' | 'tool.highlight' | 'tool.laser' | 'tool.line' | 'tool.note' | 'tool.octagon' | 'tool.oval' | 'tool.pentagon' | 'tool.rectangle' | 'tool.rhombus' | 'tool.select' | 'tool.star' | 'tool.text' | 'tool.trapezoid' | 'tool.triangle' | 'tool.x-box' | 'vscode.file-open.backup-failed' | 'vscode.file-open.backup-saved' | 'vscode.file-open.backup' | 'vscode.file-open.desc' | 'vscode.file-open.dont-show-again' | 'vscode.file-open.open'"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTranslation/TLUiTranslationKey.ts",
"releaseTag": "Public",
"name": "TLUiTranslationKey",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!toolbarItem:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function toolbarItem(toolItem: "
},
{
"kind": "Reference",
"text": "TLUiToolItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolItem:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TLUiToolbarItem",
"canonicalReference": "@tldraw/tldraw!TLUiToolbarItem:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToolbarSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "toolItem",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "toolbarItem"
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/tldraw!truncateStringWithEllipsis:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "truncateStringWithEllipsis: "
},
{
"kind": "Content",
"text": "(str: string, maxLength: number) => string"
}
],
"fileUrlPath": "packages/tldraw/src/lib/utils/text/text.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "truncateStringWithEllipsis",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!UiEventsProvider:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function UiEventsProvider({ onEvent, children }: "
},
{
"kind": "Reference",
"text": "EventsProviderProps",
"canonicalReference": "@tldraw/tldraw!EventsProviderProps:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ onEvent, children }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "UiEventsProvider"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useActions:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useActions(): "
},
{
"kind": "Reference",
"text": "TLUiActionsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiActionsContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useActions.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useActions"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useActionsMenuSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useActionsMenuSchema(): "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useActionsMenuSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useActionsMenuSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useBreakpoint:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useBreakpoint(): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useBreakpoint.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useBreakpoint"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useCanRedo:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useCanRedo(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useCanRedo.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useCanRedo"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useCanUndo:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useCanUndo(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useCanUndo.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useCanUndo"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useContextMenuSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useContextMenuSchema(): "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useContextMenuSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useContextMenuSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useCopyAs:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useCopyAs(): "
},
{
"kind": "Content",
"text": "(ids: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": "[], format?: "
},
{
"kind": "Reference",
"text": "TLCopyType",
"canonicalReference": "@tldraw/tldraw!~TLCopyType:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useCopyAs.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useCopyAs"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useDefaultHelpers:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useDefaultHelpers(): "
},
{
"kind": "Content",
"text": "{\n addToast: (toast: "
},
{
"kind": "Reference",
"text": "Omit",
"canonicalReference": "!Omit:type"
},
{
"kind": "Content",
"text": "<import(\"./hooks/useToastsProvider\")."
},
{
"kind": "Reference",
"text": "TLUiToast",
"canonicalReference": "@tldraw/tldraw!TLUiToast:interface"
},
{
"kind": "Content",
"text": ", \"id\"> & {\n id?: string | undefined;\n }) => string;\n removeToast: (id: string) => string;\n clearToasts: () => void;\n addDialog: (dialog: "
},
{
"kind": "Reference",
"text": "Omit",
"canonicalReference": "!Omit:type"
},
{
"kind": "Content",
"text": "<import(\"./hooks/useDialogsProvider\")."
},
{
"kind": "Reference",
"text": "TLUiDialog",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface"
},
{
"kind": "Content",
"text": ", \"id\"> & {\n id?: string | undefined;\n }) => string;\n clearDialogs: () => void;\n removeDialog: (id: string) => string;\n updateDialog: (id: string, newDialogData: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<import(\"./hooks/useDialogsProvider\")."
},
{
"kind": "Reference",
"text": "TLUiDialog",
"canonicalReference": "@tldraw/tldraw!TLUiDialog:interface"
},
{
"kind": "Content",
"text": ">) => string;\n msg: (id: string) => string;\n isMobile: boolean;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/overrides.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useDefaultHelpers"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useDialogs:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useDialogs(): "
},
{
"kind": "Reference",
"text": "TLUiDialogsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiDialogsContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useDialogsProvider.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useDialogs"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useExportAs:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useExportAs(): "
},
{
"kind": "Content",
"text": "(ids: "
},
{
"kind": "Reference",
"text": "TLShapeId",
"canonicalReference": "@tldraw/tlschema!TLShapeId:type"
},
{
"kind": "Content",
"text": "[], format?: "
},
{
"kind": "Reference",
"text": "TLExportType",
"canonicalReference": "@tldraw/tldraw!~TLExportType:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useExportAs.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useExportAs"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useHelpMenuSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useHelpMenuSchema(): "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useHelpMenuSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useHelpMenuSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useKeyboardShortcuts:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useKeyboardShortcuts(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useKeyboardShortcuts.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useKeyboardShortcuts"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useKeyboardShortcutsSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useKeyboardShortcutsSchema(): "
},
{
"kind": "Reference",
"text": "TLUiKeyboardShortcutsSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiKeyboardShortcutsSchemaContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useKeyboardShortcutsSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useKeyboardShortcutsSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useLocalStorageState:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useLocalStorageState<T = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ">(key: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", defaultValue: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "readonly [T, (setter: ((value: T) => T) | T) => void]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useLocalStorageState.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "useLocalStorageState"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useMenuClipboardEvents:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useMenuClipboardEvents(): "
},
{
"kind": "Content",
"text": "{\n copy: (source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ") => void;\n cut: (source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ") => void;\n paste: (data: "
},
{
"kind": "Reference",
"text": "ClipboardItem",
"canonicalReference": "!ClipboardItem:interface"
},
{
"kind": "Content",
"text": "[] | "
},
{
"kind": "Reference",
"text": "DataTransfer",
"canonicalReference": "!DataTransfer:interface"
},
{
"kind": "Content",
"text": ", source: "
},
{
"kind": "Reference",
"text": "TLUiEventSource",
"canonicalReference": "@tldraw/tldraw!TLUiEventSource:type"
},
{
"kind": "Content",
"text": ", point?: "
},
{
"kind": "Reference",
"text": "VecLike",
"canonicalReference": "@tldraw/editor!VecLike:type"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useClipboardEvents.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useMenuClipboardEvents"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useMenuIsOpen:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useMenuIsOpen(id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", cb?: "
},
{
"kind": "Content",
"text": "(isOpen: boolean) => void"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "readonly [boolean, (isOpen: boolean) => void]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useMenuIsOpen.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "cb",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": true
}
],
"name": "useMenuIsOpen"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useMenuSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useMenuSchema(): "
},
{
"kind": "Reference",
"text": "TLUiMenuSchema",
"canonicalReference": "@tldraw/tldraw!TLUiMenuSchema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useMenuSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useMenuSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useNativeClipboardEvents:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useNativeClipboardEvents(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useClipboardEvents.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useNativeClipboardEvents"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useReadonly:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useReadonly(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useReadonly.ts",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useReadonly"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useToasts:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useToasts(): "
},
{
"kind": "Reference",
"text": "TLUiToastsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToastsContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToastsProvider.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useToasts"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useToolbarSchema:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useToolbarSchema(): "
},
{
"kind": "Reference",
"text": "TLUiToolbarSchemaContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToolbarSchemaContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useToolbarSchema.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useToolbarSchema"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useTools:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useTools(): "
},
{
"kind": "Reference",
"text": "TLUiToolsContextType",
"canonicalReference": "@tldraw/tldraw!TLUiToolsContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTools.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useTools"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useTranslation:function(1)",
"docComment": "/**\n * Returns a function to translate a translation key into a string based on the current translation.\n *\n * @example\n * ```ts\n * const msg = useTranslation()\n * const label = msg('style-panel.styles')\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useTranslation(): "
},
{
"kind": "Content",
"text": "(id: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "TLUiTranslationKey",
"canonicalReference": "@tldraw/tldraw!TLUiTranslationKey:type"
},
{
"kind": "Content",
"text": "> | string) => string"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useTranslation/useTranslation.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useTranslation"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/tldraw!useUiEvents:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useUiEvents(): "
},
{
"kind": "Reference",
"text": "TLUiEventContextType",
"canonicalReference": "@tldraw/tldraw!TLUiEventContextType:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/tldraw/src/lib/ui/hooks/useEventsProvider.tsx",
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "useUiEvents"
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class VideoShapeUtil extends "
},
{
"kind": "Reference",
"text": "BaseBoxShapeUtil",
"canonicalReference": "@tldraw/editor!BaseBoxShapeUtil:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TLVideoShape",
"canonicalReference": "@tldraw/tlschema!TLVideoShape:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/shapes/video/VideoShapeUtil.tsx",
"releaseTag": "Public",
"isAbstract": false,
"name": "VideoShapeUtil",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#canEdit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "canEdit: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "canEdit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#component:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "component(shape: "
},
{
"kind": "Reference",
"text": "TLVideoShape",
"canonicalReference": "@tldraw/tlschema!TLVideoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#getDefaultProps:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getDefaultProps(): "
},
{
"kind": "Reference",
"text": "TLVideoShape",
"canonicalReference": "@tldraw/tlschema!TLVideoShape:type"
},
{
"kind": "Content",
"text": "['props']"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
"isAbstract": false,
"name": "getDefaultProps"
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#indicator:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "indicator(shape: "
},
{
"kind": "Reference",
"text": "TLVideoShape",
"canonicalReference": "@tldraw/tlschema!TLVideoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX.Element",
"canonicalReference": "@types/react!__global.JSX.Element:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "indicator"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#isAspectRatioLocked:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isAspectRatioLocked: "
},
{
"kind": "Content",
"text": "() => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "isAspectRatioLocked",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil.migrations:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static migrations: "
},
{
"kind": "Content",
"text": "import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Migrations",
"canonicalReference": "@tldraw/store!Migrations:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "migrations",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil.props:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static props: "
},
{
"kind": "Content",
"text": "{\n w: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n h: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n time: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<number>;\n playing: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<boolean>;\n url: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<string>;\n assetId: import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "Validator",
"canonicalReference": "@tldraw/validate!Validator:class"
},
{
"kind": "Content",
"text": "<import(\"@tldraw/editor\")."
},
{
"kind": "Reference",
"text": "TLAssetId",
"canonicalReference": "@tldraw/tlschema!TLAssetId:type"
},
{
"kind": "Content",
"text": " | null>;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "props",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 16
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil#toSvg:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "toSvg(shape: "
},
{
"kind": "Reference",
"text": "TLVideoShape",
"canonicalReference": "@tldraw/tlschema!TLVideoShape:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SVGGElement",
"canonicalReference": "!SVGGElement:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "shape",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "toSvg"
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!VideoShapeUtil.type:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static type: "
},
{
"kind": "Content",
"text": "\"video\""
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@tldraw/tldraw!ZoomTool:class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ZoomTool extends "
},
{
"kind": "Reference",
"text": "StateNode",
"canonicalReference": "@tldraw/editor!StateNode:class"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/tldraw/src/lib/tools/ZoomTool/ZoomTool.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "ZoomTool",
"preserveMemberOrder": false,
"members": [
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool.children:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static children: "
},
{
"kind": "Content",
"text": "() => (typeof "
},
{
"kind": "Reference",
"text": "Idle",
"canonicalReference": "@tldraw/tldraw!~Idle_12:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "Pointing",
"canonicalReference": "@tldraw/tldraw!~Pointing_8:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "ZoomBrushing",
"canonicalReference": "@tldraw/tldraw!~ZoomBrushing:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool.id:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "id",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#info:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "info: "
},
{
"kind": "Reference",
"text": "TLPointerEventInfo",
"canonicalReference": "@tldraw/editor!TLPointerEventInfo:type"
},
{
"kind": "Content",
"text": " & {\n onInteractionEnd?: string | undefined;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "info",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool.initial:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static initial: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": true,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#onEnter:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onEnter: "
},
{
"kind": "Content",
"text": "(info: "
},
{
"kind": "Reference",
"text": "TLPointerEventInfo",
"canonicalReference": "@tldraw/editor!TLPointerEventInfo:type"
},
{
"kind": "Content",
"text": " & {\n onInteractionEnd: string;\n }) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onEnter",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#onExit:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onExit: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onExit",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#onInterrupt:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onInterrupt: "
},
{
"kind": "Reference",
"text": "TLInterruptEvent",
"canonicalReference": "@tldraw/editor!TLInterruptEvent:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onInterrupt",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#onKeyDown:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onKeyDown: "
},
{
"kind": "Reference",
"text": "TLKeyboardEvent",
"canonicalReference": "@tldraw/editor!TLKeyboardEvent:type"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onKeyDown",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@tldraw/tldraw!ZoomTool#onKeyUp:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "onKeyUp: "
},
{
"kind": "Reference",
"text": "TLKeyboardEvent",
"canonicalReference": "@tldraw/editor!TLKeyboardEvent:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "onKeyUp",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"implementsTokenRanges": []
}
]
}
]
}
Reference in a new issue View git blame Copy permalink