diff --git a/.eslintignore b/.eslintignore index caf76fb2e..2790821f8 100644 --- a/.eslintignore +++ b/.eslintignore @@ -17,7 +17,6 @@ **/next.config.js **/setupTests.js **/setupJest.js -apps/webdriver/www apps/vscode/extension/editor apps/examples/www apps/docs/api-content.json diff --git a/.gitignore b/.gitignore index 2778a2e44..cec604b8f 100644 --- a/.gitignore +++ b/.gitignore @@ -56,7 +56,6 @@ packages/assets/embed-icons packages/assets/fonts packages/assets/icons packages/assets/translations -apps/webdriver/www/ apps/examples/www/embed-icons apps/examples/www/fonts apps/examples/www/icons @@ -79,4 +78,6 @@ apps/examples/www/index.js apps/examples/build.esbuild.json apps/examples/e2e/test-results -apps/examples/playwright-report \ No newline at end of file +apps/examples/playwright-report + +docs/gen \ No newline at end of file diff --git a/.ignore b/.ignore index f3e114740..5a6f04ad1 100644 --- a/.ignore +++ b/.ignore @@ -17,5 +17,4 @@ apps/example/www/index.css **/dist/* *.cjs -bublic/packages/tldraw/ui.css -bublic/packages/tldraw/editor.css \ No newline at end of file +packages/tldraw/tldraw.css \ No newline at end of file diff --git a/.prettierignore b/.prettierignore index ec4a2cd93..7e8e9e0c4 100644 --- a/.prettierignore +++ b/.prettierignore @@ -11,6 +11,5 @@ **/_archive/* apps/docs/api-content.json apps/docs/content.json -apps/webdriver/www/index.js apps/vscode/extension/editor/* apps/examples/www \ No newline at end of file diff --git a/docs/gen/ACCEPTED_ASSET_TYPE-var.mdx b/docs/gen/ACCEPTED_ASSET_TYPE-var.mdx deleted file mode 100644 index eee0c8e8a..000000000 --- a/docs/gen/ACCEPTED_ASSET_TYPE-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: ACCEPTED_ASSET_TYPE -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 0 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ACCEPTED_ASSET_TYPE: string -``` - diff --git a/docs/gen/ACCEPTED_IMG_TYPE-var.mdx b/docs/gen/ACCEPTED_IMG_TYPE-var.mdx deleted file mode 100644 index 01917a425..000000000 --- a/docs/gen/ACCEPTED_IMG_TYPE-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: ACCEPTED_IMG_TYPE -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 1 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ACCEPTED_IMG_TYPE: string[] -``` - diff --git a/docs/gen/ACCEPTED_VID_TYPE-var.mdx b/docs/gen/ACCEPTED_VID_TYPE-var.mdx deleted file mode 100644 index 603fe8908..000000000 --- a/docs/gen/ACCEPTED_VID_TYPE-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: ACCEPTED_VID_TYPE -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 2 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ACCEPTED_VID_TYPE: string[] -``` - diff --git a/docs/gen/AllRecords-type.mdx b/docs/gen/AllRecords-type.mdx deleted file mode 100644 index e45714d74..000000000 --- a/docs/gen/AllRecords-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: AllRecords -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 0 ----Public TypeAlias - -Get the type of all records in a record store. - - -##### Signature - - -```ts -type AllRecords> = ExtractR> -``` - -##### References - -[Store](/gen/store/Store-class), [ExtractR](/gen/store/~ExtractR-type), [ExtractRecordType](/gen/store/~ExtractRecordType-type) - diff --git a/docs/gen/ArrowShape-var.mdx b/docs/gen/ArrowShape-var.mdx deleted file mode 100644 index f83ff6653..000000000 --- a/docs/gen/ArrowShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ArrowShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 3 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ArrowShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLArrowShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - diff --git a/docs/gen/ArrowShapeArrowheadEndStyle-var.mdx b/docs/gen/ArrowShapeArrowheadEndStyle-var.mdx deleted file mode 100644 index 1198aeedf..000000000 --- a/docs/gen/ArrowShapeArrowheadEndStyle-var.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ArrowShapeArrowheadEndStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 0 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ArrowShapeArrowheadEndStyle: import('../styles/StyleProp').EnumStyleProp< - | 'arrow' - | 'bar' - | 'diamond' - | 'dot' - | 'inverted' - | 'none' - | 'pipe' - | 'square' - | 'triangle' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/ArrowShapeArrowheadStartStyle-var.mdx b/docs/gen/ArrowShapeArrowheadStartStyle-var.mdx deleted file mode 100644 index 847fee1c5..000000000 --- a/docs/gen/ArrowShapeArrowheadStartStyle-var.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ArrowShapeArrowheadStartStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 1 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ArrowShapeArrowheadStartStyle: import('../styles/StyleProp').EnumStyleProp< - | 'arrow' - | 'bar' - | 'diamond' - | 'dot' - | 'inverted' - | 'none' - | 'pipe' - | 'square' - | 'triangle' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/ArrowShapeUtil-class.mdx b/docs/gen/ArrowShapeUtil-class.mdx deleted file mode 100644 index 0c45c4297..000000000 --- a/docs/gen/ArrowShapeUtil-class.mdx +++ /dev/null @@ -1,925 +0,0 @@ ---- -title: ArrowShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 4 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canBind](#ArrowShapeUtil-canBind-member) - - [canEdit](#ArrowShapeUtil-canEdit-member) - - [canSnap](#ArrowShapeUtil-canSnap-member) - - [hideResizeHandles](#ArrowShapeUtil-hideResizeHandles-member) - - [hideRotateHandle](#ArrowShapeUtil-hideRotateHandle-member) - - [hideSelectionBoundsBg](#ArrowShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#ArrowShapeUtil-hideSelectionBoundsFg-member) - - [isClosed](#ArrowShapeUtil-isClosed-member) - - [labelBoundsCache](#ArrowShapeUtil-labelBoundsCache-member) - - [onDoubleClickHandle](#ArrowShapeUtil-onDoubleClickHandle-member) - - [onEditEnd](#ArrowShapeUtil-onEditEnd-member) - - [onHandleChange](#ArrowShapeUtil-onHandleChange-member) - - [onResize](#ArrowShapeUtil-onResize-member) - - [onTranslateStart](#ArrowShapeUtil-onTranslateStart-member) - - [type](#ArrowShapeUtil-type-member) -- [Methods](#methods) - - [component](#ArrowShapeUtil-component-member-1) - - [getArrowInfo](#ArrowShapeUtil-getArrowInfo-member-1) - - [getBounds](#ArrowShapeUtil-getBounds-member-1) - - [getCenter](#ArrowShapeUtil-getCenter-member-1) - - [getDefaultProps](#ArrowShapeUtil-getDefaultProps-member-1) - - [getHandles](#ArrowShapeUtil-getHandles-member-1) - - [getLabelBounds](#ArrowShapeUtil-getLabelBounds-member-1) - - [getOutline](#ArrowShapeUtil-getOutline-member-1) - - [getOutlineWithoutLabel](#ArrowShapeUtil-getOutlineWithoutLabel-member-1) - - [hitTestLineSegment](#ArrowShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#ArrowShapeUtil-hitTestPoint-member-1) - - [indicator](#ArrowShapeUtil-indicator-member-1) - - [snapPoints](#ArrowShapeUtil-snapPoints-member-1) - - [toSvg](#ArrowShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class ArrowShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -## Properties - -### `canBind` \{#ArrowShapeUtil-canBind-member} - -Public Property - -##### Signature - - -```ts -canBind: () => boolean -``` - ---- - -### `canEdit` \{#ArrowShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `canSnap` \{#ArrowShapeUtil-canSnap-member} - -Public Property - -##### Signature - - -```ts -canSnap: () => boolean -``` - ---- - -### `hideResizeHandles` \{#ArrowShapeUtil-hideResizeHandles-member} - -Public Property - -##### Signature - - -```ts -hideResizeHandles: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `hideRotateHandle` \{#ArrowShapeUtil-hideRotateHandle-member} - -Public Property - -##### Signature - - -```ts -hideRotateHandle: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `hideSelectionBoundsBg` \{#ArrowShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `hideSelectionBoundsFg` \{#ArrowShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `isClosed` \{#ArrowShapeUtil-isClosed-member} - -Public Property - -##### Signature - - -```ts -isClosed: () => boolean -``` - ---- - -### `labelBoundsCache` \{#ArrowShapeUtil-labelBoundsCache-member} - -Public Readonly Property - -##### Signature - - -```ts -get labelBoundsCache(): ComputedCache -``` - -##### References - -[ComputedCache](/gen/store/ComputedCache-type), [Box2d](/gen/primitives/Box2d-class), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `onDoubleClickHandle` \{#ArrowShapeUtil-onDoubleClickHandle-member} - -Public Property - -##### Signature - - -```ts -onDoubleClickHandle: ( - shape: TLArrowShape, - handle: TLHandle -) => TLShapePartial | void -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLHandle](/gen/tlschema/TLHandle-interface), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `onEditEnd` \{#ArrowShapeUtil-onEditEnd-member} - -Public Property - -##### Signature - - -```ts -onEditEnd: TLOnEditEndHandler -``` - -##### References - -[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `onHandleChange` \{#ArrowShapeUtil-onHandleChange-member} - -Public Property - -##### Signature - - -```ts -onHandleChange: TLOnHandleChangeHandler -``` - -##### References - -[TLOnHandleChangeHandler](/gen/editor/TLOnHandleChangeHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `onResize` \{#ArrowShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `onTranslateStart` \{#ArrowShapeUtil-onTranslateStart-member} - -Public Property - -##### Signature - - -```ts -onTranslateStart: TLOnTranslateStartHandler -``` - -##### References - -[TLOnTranslateStartHandler](/gen/editor/TLOnTranslateStartHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `type` \{#ArrowShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'arrow' -``` - ---- - -## Methods - -### `component()` \{#ArrowShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element | null -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getArrowInfo()` \{#ArrowShapeUtil-getArrowInfo-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -ArrowInfo | undefined -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [ArrowInfo](/gen/editor/~ArrowInfo-type) - ---- - -### `getBounds()` \{#ArrowShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#ArrowShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#ArrowShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLArrowShape['props'] -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type) - ---- - -### `getHandles()` \{#ArrowShapeUtil-getHandles-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -TLHandle[] -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLHandle](/gen/tlschema/TLHandle-interface) - ---- - -### `getLabelBounds()` \{#ArrowShapeUtil-getLabelBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Box2d | null -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getOutline()` \{#ArrowShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineWithoutLabel()` \{#ArrowShapeUtil-getOutlineWithoutLabel-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#ArrowShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#ArrowShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `indicator()` \{#ArrowShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element | null -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `snapPoints()` \{#ArrowShapeUtil-snapPoints-member-1} - -Public Method - -##### Parameters - - - - - - - -`_shape` - - - - -```ts -TLArrowShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `toSvg()` \{#ArrowShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLArrowShape -``` - - - - - - - - -`font` - - - - -```ts -string -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/AssetRecordType-var.mdx b/docs/gen/AssetRecordType-var.mdx deleted file mode 100644 index b9c405469..000000000 --- a/docs/gen/AssetRecordType-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: AssetRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 4 ----Public Readonly Variable - - - - -##### Signature - - -```ts -AssetRecordType: import('@tldraw/store').RecordType -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLAsset](/gen/tlschema/TLAsset-type) - diff --git a/docs/gen/BaseBoxShapeTool-class.mdx b/docs/gen/BaseBoxShapeTool-class.mdx deleted file mode 100644 index 8d5e5087f..000000000 --- a/docs/gen/BaseBoxShapeTool-class.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: BaseBoxShapeTool -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 5 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [children](#BaseBoxShapeTool-children-member) - - [id](#BaseBoxShapeTool-id-member) - - [initial](#BaseBoxShapeTool-initial-member) - - [shapeType](#BaseBoxShapeTool-shapeType-member) -
- - - - -##### Signature - - -```ts -abstract class BaseBoxShapeTool extends StateNode {} -``` - -##### References - -[StateNode](/gen/editor/StateNode-class) - ---- - -## Properties - -### `children` \{#BaseBoxShapeTool-children-member} - -Public Static Property - -##### Signature - - -```ts -static children: () => (typeof Idle | typeof Pointing)[] -``` - -##### References - -[Idle](/gen/editor/~Idle_4-class), [Pointing](/gen/editor/~Pointing_2-class) - ---- - -### `id` \{#BaseBoxShapeTool-id-member} - -Public Static Property - -##### Signature - - -```ts -static id: string -``` - ---- - -### `initial` \{#BaseBoxShapeTool-initial-member} - -Public Static Property - -##### Signature - - -```ts -static initial: string -``` - ---- - -### `shapeType` \{#BaseBoxShapeTool-shapeType-member} - -Public Property - -##### Signature - - -```ts -abstract shapeType: TLShapeUtilConstructor -``` - -##### References - -[TLShapeUtilConstructor](/gen/editor/TLShapeUtilConstructor-interface) - ---- - diff --git a/docs/gen/BaseBoxShapeUtil-class.mdx b/docs/gen/BaseBoxShapeUtil-class.mdx deleted file mode 100644 index 31ba0a46e..000000000 --- a/docs/gen/BaseBoxShapeUtil-class.mdx +++ /dev/null @@ -1,309 +0,0 @@ ---- -title: BaseBoxShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 6 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [onResize](#BaseBoxShapeUtil-onResize-member) -- [Methods](#methods) - - [getBounds](#BaseBoxShapeUtil-getBounds-member-1) - - [getCenter](#BaseBoxShapeUtil-getCenter-member-1) - - [getOutline](#BaseBoxShapeUtil-getOutline-member-1) - - [hitTestLineSegment](#BaseBoxShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#BaseBoxShapeUtil-hitTestPoint-member-1) -
- - - - -##### Signature - - -```ts -abstract class BaseBoxShapeUtil< - Shape extends TLBaseBoxShape -> extends ShapeUtil {} -``` - -##### References - -[TLBaseBoxShape](/gen/editor/TLBaseBoxShape-type), [ShapeUtil](/gen/editor/ShapeUtil-class) - ---- - -## Properties - -### `onResize` \{#BaseBoxShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type) - ---- - -## Methods - -### `getBounds()` \{#BaseBoxShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#BaseBoxShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutline()` \{#BaseBoxShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#BaseBoxShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#BaseBoxShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - diff --git a/docs/gen/BaseRecord-interface.mdx b/docs/gen/BaseRecord-interface.mdx deleted file mode 100644 index 1b97ed673..000000000 --- a/docs/gen/BaseRecord-interface.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: BaseRecord -status: published -category: store -group: Interface -author: api -date: 06/23/2023 -order: 2 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [id](#BaseRecord-id-member) - - [typeName](#BaseRecord-typeName-member) -
- -The base record that all records must extend. - - -##### Signature - - -```ts -interface BaseRecord< - TypeName extends string, - Id extends RecordId -> {} -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [UnknownRecord](/gen/store/UnknownRecord-type) - ---- - -## Properties - -### `id` \{#BaseRecord-id-member} - -Public Readonly PropertySignature - -##### Signature - - -```ts -readonly id: Id -``` - ---- - -### `typeName` \{#BaseRecord-typeName-member} - -Public Readonly PropertySignature - -##### Signature - - -```ts -readonly typeName: TypeName -``` - ---- - diff --git a/docs/gen/BookmarkShape-var.mdx b/docs/gen/BookmarkShape-var.mdx deleted file mode 100644 index 88bf07c04..000000000 --- a/docs/gen/BookmarkShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: BookmarkShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 8 ----Public Readonly Variable - - - - -##### Signature - - -```ts -BookmarkShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLBookmarkShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type) - diff --git a/docs/gen/BookmarkShapeUtil-class.mdx b/docs/gen/BookmarkShapeUtil-class.mdx deleted file mode 100644 index b0587ac87..000000000 --- a/docs/gen/BookmarkShapeUtil-class.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -title: BookmarkShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 9 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canResize](#BookmarkShapeUtil-canResize-member) - - [hideSelectionBoundsBg](#BookmarkShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#BookmarkShapeUtil-hideSelectionBoundsFg-member) - - [onBeforeCreate](#BookmarkShapeUtil-onBeforeCreate-member) - - [onBeforeUpdate](#BookmarkShapeUtil-onBeforeUpdate-member) - - [type](#BookmarkShapeUtil-type-member) -- [Methods](#methods) - - [component](#BookmarkShapeUtil-component-member-1) - - [getDefaultProps](#BookmarkShapeUtil-getDefaultProps-member-1) - - [indicator](#BookmarkShapeUtil-indicator-member-1) -
- - - - -##### Signature - - -```ts -class BookmarkShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type) - ---- - -## Properties - -### `canResize` \{#BookmarkShapeUtil-canResize-member} - -Public Property - -##### Signature - - -```ts -canResize: () => boolean -``` - ---- - -### `hideSelectionBoundsBg` \{#BookmarkShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: () => boolean -``` - ---- - -### `hideSelectionBoundsFg` \{#BookmarkShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: () => boolean -``` - ---- - -### `onBeforeCreate` \{#BookmarkShapeUtil-onBeforeCreate-member} - -Public Property - -##### Signature - - -```ts -onBeforeCreate?: TLOnBeforeCreateHandler -``` - -##### References - -[TLOnBeforeCreateHandler](/gen/editor/TLOnBeforeCreateHandler-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type) - ---- - -### `onBeforeUpdate` \{#BookmarkShapeUtil-onBeforeUpdate-member} - -Public Property - -##### Signature - - -```ts -onBeforeUpdate?: TLOnBeforeUpdateHandler -``` - -##### References - -[TLOnBeforeUpdateHandler](/gen/editor/TLOnBeforeUpdateHandler-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type) - ---- - -### `type` \{#BookmarkShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'bookmark' -``` - ---- - -## Methods - -### `component()` \{#BookmarkShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLBookmarkShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getDefaultProps()` \{#BookmarkShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLBookmarkShape['props'] -``` - -##### References - -[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type) - ---- - -### `indicator()` \{#BookmarkShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLBookmarkShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - diff --git a/docs/gen/Box2d-class.mdx b/docs/gen/Box2d-class.mdx deleted file mode 100644 index 0c3ae5bcc..000000000 --- a/docs/gen/Box2d-class.mdx +++ /dev/null @@ -1,1664 +0,0 @@ ---- -title: Box2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 3 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [aspectRatio](#Box2d-aspectRatio-member) - - [center](#Box2d-center-member) - - [Collides](#Box2d-Collides-member) - - [Common](#Box2d-Common-member) - - [Contains](#Box2d-Contains-member) - - [ContainsPoint](#Box2d-ContainsPoint-member) - - [corners](#Box2d-corners-member) - - [h](#Box2d-h-member) - - [height](#Box2d-height-member) - - [Includes](#Box2d-Includes-member) - - [maxX](#Box2d-maxX-member) - - [maxY](#Box2d-maxY-member) - - [midX](#Box2d-midX-member) - - [midY](#Box2d-midY-member) - - [minX](#Box2d-minX-member) - - [minY](#Box2d-minY-member) - - [point](#Box2d-point-member) - - [sides](#Box2d-sides-member) - - [Sides](#Box2d-Sides-member) - - [size](#Box2d-size-member) - - [snapPoints](#Box2d-snapPoints-member) - - [w](#Box2d-w-member) - - [width](#Box2d-width-member) - - [x](#Box2d-x-member) - - [y](#Box2d-y-member) -- [Methods](#methods) - - [clone](#Box2d-clone-member-1) - - [collides](#Box2d-collides-member-1) - - [contains](#Box2d-contains-member-1) - - [containsPoint](#Box2d-containsPoint-member-1) - - [equals](#Box2d-equals-member-1) - - [Equals](#Box2d-Equals-member-1) - - [expand](#Box2d-expand-member-1) - - [Expand](#Box2d-Expand-member-1) - - [expandBy](#Box2d-expandBy-member-1) - - [ExpandBy](#Box2d-ExpandBy-member-1) - - [From](#Box2d-From-member-1) - - [FromPoints](#Box2d-FromPoints-member-1) - - [getHandlePoint](#Box2d-getHandlePoint-member-1) - - [includes](#Box2d-includes-member-1) - - [resize](#Box2d-resize-member-1) - - [Resize](#Box2d-Resize-member-1) - - [scale](#Box2d-scale-member-1) - - [set](#Box2d-set-member-1) - - [setTo](#Box2d-setTo-member-1) - - [snapToGrid](#Box2d-snapToGrid-member-1) - - [toFixed](#Box2d-toFixed-member-1) - - [toJson](#Box2d-toJson-member-1) - - [translate](#Box2d-translate-member-1) - - [union](#Box2d-union-member-1) -
- - - - -##### Signature - - -```ts -class Box2d {} -``` - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Box2d` class - - -##### Parameters - - - - - - - -`x` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`y` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`w` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`h` - - (optional) - - - - -```ts -number -``` - - - - - - - ---- - -## Properties - -### `aspectRatio` \{#Box2d-aspectRatio-member} - -Public Readonly Property - -##### Signature - - -```ts -get aspectRatio(): number -``` - ---- - -### `center` \{#Box2d-center-member} - -Public Property - -##### Signature - - -```ts -get center(): Vec2d - -set center(v: Vec2d) -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Collides` \{#Box2d-Collides-member} - -Public Static Property - -##### Signature - - -```ts -static Collides: (A: Box2d, B: Box2d) => boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `Common` \{#Box2d-Common-member} - -Public Static Property - -##### Signature - - -```ts -static Common: (boxes: Box2d[]) => Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `Contains` \{#Box2d-Contains-member} - -Public Static Property - -##### Signature - - -```ts -static Contains: (A: Box2d, B: Box2d) => boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `ContainsPoint` \{#Box2d-ContainsPoint-member} - -Public Static Property - -##### Signature - - -```ts -static ContainsPoint: (A: Box2d, B: number | VecLike, y?: number) => boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `corners` \{#Box2d-corners-member} - -Public Readonly Property - -##### Signature - - -```ts -get corners(): Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `h` \{#Box2d-h-member} - -Public Property - -##### Signature - - -```ts -h: number -``` - ---- - -### `height` \{#Box2d-height-member} - -Public Property - -##### Signature - - -```ts -get height(): number - -set height(n: number) -``` - ---- - -### `Includes` \{#Box2d-Includes-member} - -Public Static Property - -##### Signature - - -```ts -static Includes: (A: Box2d, B: Box2d) => boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `maxX` \{#Box2d-maxX-member} - -Public Readonly Property - -##### Signature - - -```ts -get maxX(): number -``` - ---- - -### `maxY` \{#Box2d-maxY-member} - -Public Readonly Property - -##### Signature - - -```ts -get maxY(): number -``` - ---- - -### `midX` \{#Box2d-midX-member} - -Public Readonly Property - -##### Signature - - -```ts -get midX(): number -``` - ---- - -### `midY` \{#Box2d-midY-member} - -Public Readonly Property - -##### Signature - - -```ts -get midY(): number -``` - ---- - -### `minX` \{#Box2d-minX-member} - -Public Property - -##### Signature - - -```ts -get minX(): number - -set minX(n: number) -``` - ---- - -### `minY` \{#Box2d-minY-member} - -Public Property - -##### Signature - - -```ts -get minY(): number - -set minY(n: number) -``` - ---- - -### `point` \{#Box2d-point-member} - -Public Property - -##### Signature - - -```ts -get point(): Vec2d - -set point(val: Vec2d) -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `sides` \{#Box2d-sides-member} - -Public Readonly Property - -##### Signature - - -```ts -get sides(): Array<[Vec2d, Vec2d]> -``` - -##### References - -[Array](/gen/Array-interface), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Sides` \{#Box2d-Sides-member} - -Public Static Property - -##### Signature - - -```ts -static Sides: (A: Box2d, inset?: number) => Vec2d[][] -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `size` \{#Box2d-size-member} - -Public Readonly Property - -##### Signature - - -```ts -get size(): Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `snapPoints` \{#Box2d-snapPoints-member} - -Public Readonly Property - -##### Signature - - -```ts -get snapPoints(): Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `w` \{#Box2d-w-member} - -Public Property - -##### Signature - - -```ts -w: number -``` - ---- - -### `width` \{#Box2d-width-member} - -Public Property - -##### Signature - - -```ts -get width(): number - -set width(n: number) -``` - ---- - -### `x` \{#Box2d-x-member} - -Public Property - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#Box2d-y-member} - -Public Property - -##### Signature - - -```ts -y: number -``` - ---- - -## Methods - -### `clone()` \{#Box2d-clone-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `collides()` \{#Box2d-collides-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `contains()` \{#Box2d-contains-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `containsPoint()` \{#Box2d-containsPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -number | VecLike -``` - - - - - - - - -`y` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `equals()` \{#Box2d-equals-member-1} - -Public Method - -##### Parameters - - - - - - - -`other` - - - - -```ts -Box2d | Box2dModel -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class), [Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `Equals()` \{#Box2d-Equals-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`a` - - - - -```ts -Box2d | Box2dModel -``` - - - - - - - - -`b` - - - - -```ts -Box2d | Box2dModel -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class), [Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `expand()` \{#Box2d-expand-member-1} - -Public Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `Expand()` \{#Box2d-Expand-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -Box2d -``` - - - - - - - - -`B` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `expandBy()` \{#Box2d-expandBy-member-1} - -Public Method - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `ExpandBy()` \{#Box2d-ExpandBy-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -Box2d -``` - - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `From()` \{#Box2d-From-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`box` - - - - -```ts -Box2dModel -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `FromPoints()` \{#Box2d-FromPoints-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getHandlePoint()` \{#Box2d-getHandlePoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`handle` - - - - -```ts -SelectionCorner | SelectionEdge -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `includes()` \{#Box2d-includes-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `resize()` \{#Box2d-resize-member-1} - -Public Method - -##### Parameters - - - - - - - -`handle` - - - - -```ts -SelectionCorner | SelectionEdge | string -``` - - - - - - - - -`dx` - - - - -```ts -number -``` - - - - - - - - -`dy` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type) - ---- - -### `Resize()` \{#Box2d-Resize-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`box` - - - - -```ts -Box2d -``` - - - - - - - - -`handle` - - - - -```ts -SelectionCorner | SelectionEdge | string -``` - - - - - - - - -`dx` - - - - -```ts -number -``` - - - - - - - - -`dy` - - - - -```ts -number -``` - - - - - - - - -`isAspectRatioLocked` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -{ - box: Box2d - scaleX: number - scaleY: number -} -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class), [SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type) - ---- - -### `scale()` \{#Box2d-scale-member-1} - -Public Method - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `set()` \{#Box2d-set-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`y` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`w` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`h` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setTo()` \{#Box2d-setTo-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `snapToGrid()` \{#Box2d-snapToGrid-member-1} - -Public Method - -##### Parameters - - - - - - - -`size` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `toFixed()` \{#Box2d-toFixed-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `toJson()` \{#Box2d-toJson-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Box2dModel -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `translate()` \{#Box2d-translate-member-1} - -Public Method - -##### Parameters - - - - - - - -`delta` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `union()` \{#Box2d-union-member-1} - -Public Method - -##### Parameters - - - - - - - -`box` - - - - -```ts -Box2dModel -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - diff --git a/docs/gen/Box2dModel-interface.mdx b/docs/gen/Box2dModel-interface.mdx deleted file mode 100644 index ae6695d00..000000000 --- a/docs/gen/Box2dModel-interface.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: Box2dModel -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 6 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [h](#Box2dModel-h-member) - - [w](#Box2dModel-w-member) - - [x](#Box2dModel-x-member) - - [y](#Box2dModel-y-member) -
- -A serializable model for 2D boxes. - - -##### Signature - - -```ts -interface Box2dModel {} -``` - ---- - -## Properties - -### `h` \{#Box2dModel-h-member} - -Public PropertySignature - -##### Signature - - -```ts -h: number -``` - ---- - -### `w` \{#Box2dModel-w-member} - -Public PropertySignature - -##### Signature - - -```ts -w: number -``` - ---- - -### `x` \{#Box2dModel-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#Box2dModel-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - diff --git a/docs/gen/BreakPointProvider-function-1.mdx b/docs/gen/BreakPointProvider-function-1.mdx deleted file mode 100644 index fc4c23331..000000000 --- a/docs/gen/BreakPointProvider-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BreakPointProvider -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 0 ----Public Function - - - - -##### Parameters - - - - - - - -`{ children }` - - - - -```ts -{ - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/Button-var.mdx b/docs/gen/Button-var.mdx deleted file mode 100644 index 9c426c5f6..000000000 --- a/docs/gen/Button-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Button -status: published -category: ui -group: Variable -author: api -date: 06/23/2023 -order: 1 ----Public Readonly Variable - - - - -##### Signature - - -```ts -Button: React.ForwardRefExoticComponent< - TLUiButtonProps & React.RefAttributes -> -``` - -##### References - -[React.ForwardRefExoticComponent](/gen/@types/react-React-ForwardRefExoticComponent-interface), [TLUiButtonProps](/gen/ui/TLUiButtonProps-interface), [React.RefAttributes](/gen/@types/react-React-RefAttributes-interface), [HTMLButtonElement](/gen/HTMLButtonElement-interface) - diff --git a/docs/gen/CameraRecordType-var.mdx b/docs/gen/CameraRecordType-var.mdx deleted file mode 100644 index 6297f6a14..000000000 --- a/docs/gen/CameraRecordType-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: CameraRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 8 ----Public Readonly Variable - - - - -##### Signature - - -```ts -CameraRecordType: import('@tldraw/store').RecordType -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLCamera](/gen/tlschema/TLCamera-interface) - diff --git a/docs/gen/Canvas-var.mdx b/docs/gen/Canvas-var.mdx deleted file mode 100644 index 88066dd95..000000000 --- a/docs/gen/Canvas-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Canvas -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 10 ----Public Readonly Variable - - - - -##### Signature - - -```ts -Canvas: React.MemoExoticComponent<() => JSX.Element> -``` - -##### References - -[React.MemoExoticComponent](/gen/@types/react-React-MemoExoticComponent-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/CollectionDiff-type.mdx b/docs/gen/CollectionDiff-type.mdx deleted file mode 100644 index 5595ca254..000000000 --- a/docs/gen/CollectionDiff-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: CollectionDiff -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 3 ----Public TypeAlias - -A diff describing the changes to a collection. - - -##### Signature - - -```ts -type CollectionDiff = { - added?: Set - removed?: Set -} -``` - -##### References - -[Set](/gen/Set-interface) - diff --git a/docs/gen/ComputedCache-type.mdx b/docs/gen/ComputedCache-type.mdx deleted file mode 100644 index 091f3c1be..000000000 --- a/docs/gen/ComputedCache-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ComputedCache -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 6 ----Public TypeAlias - -A record store is a collection of records of different types. - - -##### Signature - - -```ts -type ComputedCache = { - get(id: IdOf): Data | undefined -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [IdOf](/gen/store/IdOf-type) - diff --git a/docs/gen/ContextMenu-var.mdx b/docs/gen/ContextMenu-var.mdx deleted file mode 100644 index 22b60c873..000000000 --- a/docs/gen/ContextMenu-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: ContextMenu -status: published -category: ui -group: Variable -author: api -date: 06/23/2023 -order: 3 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ContextMenu: ({ children }: { children: any }) => JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/CubicSegment2d-class.mdx b/docs/gen/CubicSegment2d-class.mdx deleted file mode 100644 index 488a64013..000000000 --- a/docs/gen/CubicSegment2d-class.mdx +++ /dev/null @@ -1,312 +0,0 @@ ---- -title: CubicSegment2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 8 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [[Symbol.iterator]](#CubicSegment2d-[Symbol-iterator]-member) -- [Methods](#methods) - - [getPath](#CubicSegment2d-getPath-member-1) - - [getPoint](#CubicSegment2d-getPoint-member-1) - - [getX](#CubicSegment2d-getX-member-1) - - [getY](#CubicSegment2d-getY-member-1) -
- - - - -##### Signature - - -```ts -class CubicSegment2d extends BaseSegment2d {} -``` - -##### References - -[BaseSegment2d](/gen/primitives/~BaseSegment2d-class), [CubicSegment2dModel](/gen/primitives/CubicSegment2dModel-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `CubicSegment2d` class - - -##### Parameters - - - - - - - -`a` - - - - -```ts -VecLike -``` - - - - - - - - -`b` - - - - -```ts -VecLike -``` - - - - - - - - -`c` - - - - -```ts -VecLike -``` - - - - - - - - -`d` - - - - -```ts -VecLike -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -## Properties - -### `[Symbol.iterator]` \{#CubicSegment2d-[Symbol-iterator]-member} - -Public Property - -##### Signature - - -```ts -[Symbol.iterator]: ( - this: InstanceType -) => Generator -``` - -##### References - -[Symbol.iterator](/gen/SymbolConstructor-iterator), [InstanceType](/gen/InstanceType-type), [CubicSegment2d](/gen/primitives/CubicSegment2d-class), [Generator](/gen/Generator-interface), [VecLike](/gen/primitives/VecLike-type) - ---- - -## Methods - -### `getPath()` \{#CubicSegment2d-getPath-member-1} - -Public Method - -##### Parameters - - - - - - - -`head` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -string -``` - ---- - -### `getPoint()` \{#CubicSegment2d-getPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getX()` \{#CubicSegment2d-getX-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - ---- - -### `getY()` \{#CubicSegment2d-getY-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - ---- - diff --git a/docs/gen/CubicSegment2dModel-interface.mdx b/docs/gen/CubicSegment2dModel-interface.mdx deleted file mode 100644 index 06d91a17f..000000000 --- a/docs/gen/CubicSegment2dModel-interface.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: CubicSegment2dModel -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 9 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [a](#CubicSegment2dModel-a-member) - - [b](#CubicSegment2dModel-b-member) - - [c](#CubicSegment2dModel-c-member) - - [d](#CubicSegment2dModel-d-member) - - [p](#CubicSegment2dModel-p-member) -
- - - - -##### Signature - - -```ts -interface CubicSegment2dModel {} -``` - ---- - -## Properties - -### `a` \{#CubicSegment2dModel-a-member} - -Public PropertySignature - -##### Signature - - -```ts -a: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `b` \{#CubicSegment2dModel-b-member} - -Public PropertySignature - -##### Signature - - -```ts -b: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `c` \{#CubicSegment2dModel-c-member} - -Public PropertySignature - -##### Signature - - -```ts -c: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `d` \{#CubicSegment2dModel-d-member} - -Public PropertySignature - -##### Signature - - -```ts -d: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `p` \{#CubicSegment2dModel-p-member} - -Public PropertySignature - -##### Signature - - -```ts -p: number -``` - ---- - diff --git a/docs/gen/CubicSpline2d-class.mdx b/docs/gen/CubicSpline2d-class.mdx deleted file mode 100644 index e820a124f..000000000 --- a/docs/gen/CubicSpline2d-class.mdx +++ /dev/null @@ -1,244 +0,0 @@ ---- -title: CubicSpline2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 10 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [segments](#CubicSpline2d-segments-member) -- [Methods](#methods) - - [FromPoints](#CubicSpline2d-FromPoints-member-1) - - [getSegmentsFromPoints](#CubicSpline2d-getSegmentsFromPoints-member-1) -
- - - - -##### Signature - - -```ts -class CubicSpline2d extends BaseSpline2d {} -``` - -##### References - -[BaseSpline2d](/gen/primitives/~BaseSpline2d-class), [CubicSegment2dModel](/gen/primitives/CubicSegment2dModel-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `CubicSpline2d` class - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`k` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -## Properties - -### `segments` \{#CubicSpline2d-segments-member} - -Public Property - -##### Signature - - -```ts -segments: CubicSegment2d[] -``` - -##### References - -[CubicSegment2d](/gen/primitives/CubicSegment2d-class) - ---- - -## Methods - -### `FromPoints()` \{#CubicSpline2d-FromPoints-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -Vec2d[] -``` - - - - - - - -##### Returns - - -```ts -CubicSpline2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [CubicSpline2d](/gen/primitives/CubicSpline2d-class) - ---- - -### `getSegmentsFromPoints()` \{#CubicSpline2d-getSegmentsFromPoints-member-1} - -Public Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`k` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -CubicSegment2d[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [CubicSegment2d](/gen/primitives/CubicSegment2d-class) - ---- - diff --git a/docs/gen/DefaultColorStyle-var.mdx b/docs/gen/DefaultColorStyle-var.mdx deleted file mode 100644 index 260586224..000000000 --- a/docs/gen/DefaultColorStyle-var.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DefaultColorStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 15 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultColorStyle: import('./StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultDashStyle-var.mdx b/docs/gen/DefaultDashStyle-var.mdx deleted file mode 100644 index 7091728a0..000000000 --- a/docs/gen/DefaultDashStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DefaultDashStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 16 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultDashStyle: import('./StyleProp').EnumStyleProp< - 'dashed' | 'dotted' | 'draw' | 'solid' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultFillStyle-var.mdx b/docs/gen/DefaultFillStyle-var.mdx deleted file mode 100644 index d2a067ae7..000000000 --- a/docs/gen/DefaultFillStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DefaultFillStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 17 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultFillStyle: import('./StyleProp').EnumStyleProp< - 'none' | 'pattern' | 'semi' | 'solid' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultFontStyle-var.mdx b/docs/gen/DefaultFontStyle-var.mdx deleted file mode 100644 index c5492f400..000000000 --- a/docs/gen/DefaultFontStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DefaultFontStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 18 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultFontStyle: import('./StyleProp').EnumStyleProp< - 'draw' | 'mono' | 'sans' | 'serif' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultHorizontalAlignStyle-var.mdx b/docs/gen/DefaultHorizontalAlignStyle-var.mdx deleted file mode 100644 index a67cab9c5..000000000 --- a/docs/gen/DefaultHorizontalAlignStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DefaultHorizontalAlignStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 19 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultHorizontalAlignStyle: import('./StyleProp').EnumStyleProp< - 'end-legacy' | 'end' | 'middle-legacy' | 'middle' | 'start-legacy' | 'start' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultSizeStyle-var.mdx b/docs/gen/DefaultSizeStyle-var.mdx deleted file mode 100644 index 1156f9ac2..000000000 --- a/docs/gen/DefaultSizeStyle-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: DefaultSizeStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 20 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultSizeStyle: import('./StyleProp').EnumStyleProp<'l' | 'm' | 's' | 'xl'> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/DefaultVerticalAlignStyle-var.mdx b/docs/gen/DefaultVerticalAlignStyle-var.mdx deleted file mode 100644 index 0d6c1d8e8..000000000 --- a/docs/gen/DefaultVerticalAlignStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DefaultVerticalAlignStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 21 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DefaultVerticalAlignStyle: import('./StyleProp').EnumStyleProp< - 'end' | 'middle' | 'start' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/Dialog-namespace.mdx b/docs/gen/Dialog-namespace.mdx deleted file mode 100644 index a99d97791..000000000 --- a/docs/gen/Dialog-namespace.mdx +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: Dialog -status: published -category: ui -group: Namespace -author: api -date: 06/23/2023 -order: 4 ----None Namespace - -
- Table of Contents -- [Methods](#methods) - - [Body](#Dialog-Body-function-1) - - [CloseButton](#Dialog-CloseButton-function-1) - - [Footer](#Dialog-Footer-function-1) - - [Header](#Dialog-Header-function-1) - - [Title](#Dialog-Title-function-1) -
- -##### Signature - - -```ts - -``` - ---- - -## Methods - -### `Body` \{#Dialog-Body-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ className, children, style, }` - - - - -```ts -{ - className?: string - children: any - style?: React.CSSProperties -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[React.CSSProperties](/gen/@types/react-React-CSSProperties-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `CloseButton` \{#Dialog-CloseButton-function-1} - -Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Footer` \{#Dialog-Footer-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ className, children }` - - - - -```ts -{ - className?: string - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Header` \{#Dialog-Header-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ className, children }` - - - - -```ts -{ - className?: string - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Title` \{#Dialog-Title-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ className, children }` - - - - -```ts -{ - className?: string - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - diff --git a/docs/gen/DocumentRecordType-var.mdx b/docs/gen/DocumentRecordType-var.mdx deleted file mode 100644 index 85b541def..000000000 --- a/docs/gen/DocumentRecordType-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: DocumentRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 22 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DocumentRecordType: import('@tldraw/store').RecordType -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLDocument](/gen/tlschema/TLDocument-interface) - diff --git a/docs/gen/DrawShape-var.mdx b/docs/gen/DrawShape-var.mdx deleted file mode 100644 index 61890201d..000000000 --- a/docs/gen/DrawShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: DrawShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 26 ----Public Readonly Variable - - - - -##### Signature - - -```ts -DrawShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLDrawShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type) - diff --git a/docs/gen/DrawShapeUtil-class.mdx b/docs/gen/DrawShapeUtil-class.mdx deleted file mode 100644 index b52013bec..000000000 --- a/docs/gen/DrawShapeUtil-class.mdx +++ /dev/null @@ -1,630 +0,0 @@ ---- -title: DrawShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 27 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [hideResizeHandles](#DrawShapeUtil-hideResizeHandles-member) - - [hideRotateHandle](#DrawShapeUtil-hideRotateHandle-member) - - [hideSelectionBoundsBg](#DrawShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#DrawShapeUtil-hideSelectionBoundsFg-member) - - [isClosed](#DrawShapeUtil-isClosed-member) - - [onResize](#DrawShapeUtil-onResize-member) - - [type](#DrawShapeUtil-type-member) -- [Methods](#methods) - - [component](#DrawShapeUtil-component-member-1) - - [expandSelectionOutlinePx](#DrawShapeUtil-expandSelectionOutlinePx-member-1) - - [getBounds](#DrawShapeUtil-getBounds-member-1) - - [getCenter](#DrawShapeUtil-getCenter-member-1) - - [getDefaultProps](#DrawShapeUtil-getDefaultProps-member-1) - - [getOutline](#DrawShapeUtil-getOutline-member-1) - - [hitTestLineSegment](#DrawShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#DrawShapeUtil-hitTestPoint-member-1) - - [indicator](#DrawShapeUtil-indicator-member-1) - - [toSvg](#DrawShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class DrawShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -## Properties - -### `hideResizeHandles` \{#DrawShapeUtil-hideResizeHandles-member} - -Public Property - -##### Signature - - -```ts -hideResizeHandles: (shape: TLDrawShape) => boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `hideRotateHandle` \{#DrawShapeUtil-hideRotateHandle-member} - -Public Property - -##### Signature - - -```ts -hideRotateHandle: (shape: TLDrawShape) => boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `hideSelectionBoundsBg` \{#DrawShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: (shape: TLDrawShape) => boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `hideSelectionBoundsFg` \{#DrawShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: (shape: TLDrawShape) => boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `isClosed` \{#DrawShapeUtil-isClosed-member} - -Public Property - -##### Signature - - -```ts -isClosed: (shape: TLDrawShape) => boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `onResize` \{#DrawShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `type` \{#DrawShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'draw' -``` - ---- - -## Methods - -### `component()` \{#DrawShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `expandSelectionOutlinePx()` \{#DrawShapeUtil-expandSelectionOutlinePx-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `getBounds()` \{#DrawShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#DrawShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#DrawShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLDrawShape['props'] -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type) - ---- - -### `getOutline()` \{#DrawShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#DrawShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#DrawShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `indicator()` \{#DrawShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#DrawShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLDrawShape -``` - - - - - - - - -`_font` - - - - -```ts -string | undefined -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLDrawShape](/gen/tlschema/TLDrawShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/DropdownMenu-namespace.mdx b/docs/gen/DropdownMenu-namespace.mdx deleted file mode 100644 index 164964b63..000000000 --- a/docs/gen/DropdownMenu-namespace.mdx +++ /dev/null @@ -1,519 +0,0 @@ ---- -title: DropdownMenu -status: published -category: ui -group: Namespace -author: api -date: 06/23/2023 -order: 5 ----None Namespace - -
- Table of Contents -- [Methods](#methods) - - [CheckboxItem](#DropdownMenu-CheckboxItem-function-1) - - [Content](#DropdownMenu-Content-function-1) - - [Group](#DropdownMenu-Group-function-1) - - [Indicator](#DropdownMenu-Indicator-function-1) - - [Item](#DropdownMenu-Item-function-1) - - [RadioItem](#DropdownMenu-RadioItem-function-1) - - [Root](#DropdownMenu-Root-function-1) - - [Sub](#DropdownMenu-Sub-function-1) - - [SubContent](#DropdownMenu-SubContent-function-1) - - [SubTrigger](#DropdownMenu-SubTrigger-function-1) - - [Trigger](#DropdownMenu-Trigger-function-1) -
- -##### Signature - - -```ts - -``` - ---- - -## Methods - -### `CheckboxItem` \{#DropdownMenu-CheckboxItem-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ children, onSelect, ...rest }` - - - - -```ts -DropdownMenuCheckboxItemProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[DropdownMenuCheckboxItemProps](/gen/ui/DropdownMenu-DropdownMenuCheckboxItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Content` \{#DropdownMenu-Content-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ side, align, sideOffset, alignOffset, children, }` - - - - -```ts -{ - children: any - alignOffset?: number - sideOffset?: number - align?: 'center' | 'end' | 'start' - side?: 'bottom' | 'left' | 'right' | 'top' -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Group` \{#DropdownMenu-Group-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ children, size, }` - - - - -```ts -{ - children: any - size?: 'medium' | 'small' | 'tiny' | 'wide' -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Indicator` \{#DropdownMenu-Indicator-function-1} - -Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Item` \{#DropdownMenu-Item-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ noClose, ...props }` - - - - -```ts -DropdownMenuItemProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[DropdownMenuItemProps](/gen/ui/DropdownMenu-DropdownMenuItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `RadioItem` \{#DropdownMenu-RadioItem-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ children, onSelect, ...rest }` - - - - -```ts -DropdownMenuCheckboxItemProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[DropdownMenuCheckboxItemProps](/gen/ui/DropdownMenu-DropdownMenuCheckboxItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Root` \{#DropdownMenu-Root-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ id, children, modal, }` - - - - -```ts -{ - id: string - children: any - modal?: boolean -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Sub` \{#DropdownMenu-Sub-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ id, children }` - - - - -```ts -{ - id: string - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `SubContent` \{#DropdownMenu-SubContent-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ alignOffset, sideOffset, children, }` - - - - -```ts -{ - alignOffset?: number - sideOffset?: number - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `SubTrigger` \{#DropdownMenu-SubTrigger-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ label, 'data-testid': testId, 'data-direction': dataDirection, }` - - - - -```ts -{ - label: TLUiTranslationKey - 'data-testid'?: string - 'data-direction'?: 'left' | 'right' -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `Trigger` \{#DropdownMenu-Trigger-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`{ children, 'data-testid': testId, }` - - - - -```ts -{ - children: any - 'data-testid'?: string -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - diff --git a/docs/gen/EASINGS-var.mdx b/docs/gen/EASINGS-var.mdx deleted file mode 100644 index 4ebc2c8a6..000000000 --- a/docs/gen/EASINGS-var.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: EASINGS -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 13 ----Public Readonly Variable - - - - -##### Signature - - -```ts -EASINGS: { - readonly linear: (t: number) => number - readonly easeInQuad: (t: number) => number - readonly easeOutQuad: (t: number) => number - readonly easeInOutQuad: (t: number) => number - readonly easeInCubic: (t: number) => number - readonly easeOutCubic: (t: number) => number - readonly easeInOutCubic: (t: number) => number - readonly easeInQuart: (t: number) => number - readonly easeOutQuart: (t: number) => number - readonly easeInOutQuart: (t: number) => number - readonly easeInQuint: (t: number) => number - readonly easeOutQuint: (t: number) => number - readonly easeInOutQuint: (t: number) => number - readonly easeInSine: (t: number) => number - readonly easeOutSine: (t: number) => number - readonly easeInOutSine: (t: number) => number - readonly easeInExpo: (t: number) => number - readonly easeOutExpo: (t: number) => number - readonly easeInOutExpo: (t: number) => number -} -``` - diff --git a/docs/gen/EMBED_DEFINITIONS-var.mdx b/docs/gen/EMBED_DEFINITIONS-var.mdx deleted file mode 100644 index f7e830c88..000000000 --- a/docs/gen/EMBED_DEFINITIONS-var.mdx +++ /dev/null @@ -1,222 +0,0 @@ ---- -title: EMBED_DEFINITIONS -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 24 ----Public Readonly Variable - - - - -##### Signature - - -```ts -EMBED_DEFINITIONS: readonly [ - { - readonly type: 'tldraw' - readonly title: 'tldraw' - readonly hostnames: readonly [ - 'beta.tldraw.com', - 'lite.tldraw.com', - 'www.tldraw.com' - ] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'codesandbox' - readonly title: 'CodeSandbox' - readonly hostnames: readonly ['codesandbox.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'codepen' - readonly title: 'Codepen' - readonly hostnames: readonly ['codepen.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 520 - readonly height: 400 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'scratch' - readonly title: 'Scratch' - readonly hostnames: readonly ['scratch.mit.edu'] - readonly width: 520 - readonly height: 400 - readonly doesResize: false - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'youtube' - readonly title: 'YouTube' - readonly hostnames: readonly ['*.youtube.com', 'youtube.com', 'youtu.be'] - readonly width: 800 - readonly height: 450 - readonly doesResize: true - readonly canUnmount: false - readonly overridePermissions: { - readonly 'allow-presentation': true - } - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'figma' - readonly title: 'Figma' - readonly hostnames: readonly ['figma.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'google_maps' - readonly title: 'Google Maps' - readonly hostnames: readonly ['google.*'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'google_calendar' - readonly title: 'Google Calendar' - readonly hostnames: readonly ['calendar.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly instructionLink: 'https://support.google.com/calendar/answer/41207?hl=en' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'google_slides' - readonly title: 'Google Slides' - readonly hostnames: readonly ['docs.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'github_gist' - readonly title: 'GitHub Gist' - readonly hostnames: readonly ['gist.github.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'replit' - readonly title: 'Replit' - readonly hostnames: readonly ['replit.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'felt' - readonly title: 'Felt' - readonly hostnames: readonly ['felt.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'spotify' - readonly title: 'Spotify' - readonly hostnames: readonly ['open.spotify.com'] - readonly width: 720 - readonly height: 500 - readonly minHeight: 500 - readonly overrideOutlineRadius: 12 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'vimeo' - readonly title: 'Vimeo' - readonly hostnames: readonly ['vimeo.com', 'player.vimeo.com'] - readonly width: 640 - readonly height: 360 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'excalidraw' - readonly title: 'Excalidraw' - readonly hostnames: readonly ['excalidraw.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - }, - { - readonly type: 'observable' - readonly title: 'Observable' - readonly hostnames: readonly ['observablehq.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: false - readonly backgroundColor: '#fff' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } -] -``` - diff --git a/docs/gen/EPSILON-var.mdx b/docs/gen/EPSILON-var.mdx deleted file mode 100644 index 28554e0fe..000000000 --- a/docs/gen/EPSILON-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: EPSILON -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 15 ----Public Readonly Variable - - - - -##### Signature - - -```ts -EPSILON: number -``` - diff --git a/docs/gen/EVENT_NAME_MAP-var.mdx b/docs/gen/EVENT_NAME_MAP-var.mdx deleted file mode 100644 index dad6dafb7..000000000 --- a/docs/gen/EVENT_NAME_MAP-var.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: EVENT_NAME_MAP -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 33 ----Public Readonly Variable - - - - -##### Signature - - -```ts -EVENT_NAME_MAP: Record< - Exclude, - keyof TLEventHandlers -> -``` - -##### References - -[Record](/gen/Record-type), [Exclude](/gen/Exclude-type), [TLEventName](/gen/editor/TLEventName-type), [TLPinchEventName](/gen/editor/TLPinchEventName-type), [TLEventHandlers](/gen/editor/TLEventHandlers-interface) - diff --git a/docs/gen/EasingType-type.mdx b/docs/gen/EasingType-type.mdx deleted file mode 100644 index 0f667da2f..000000000 --- a/docs/gen/EasingType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: EasingType -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 14 ----Public TypeAlias - - - - -##### Signature - - -```ts -type EasingType = keyof typeof EASINGS -``` - -##### References - -[EASINGS](/gen/primitives/EASINGS-var) - diff --git a/docs/gen/Editor-class.mdx b/docs/gen/Editor-class.mdx deleted file mode 100644 index 3dacabd9b..000000000 --- a/docs/gen/Editor-class.mdx +++ /dev/null @@ -1,12503 +0,0 @@ ---- -title: Editor -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 28 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [allShapesCommonBounds](#Editor-allShapesCommonBounds-member) - - [animationSpeed](#Editor-animationSpeed-member) - - [assets](#Editor-assets-member) - - [brush](#Editor-brush-member) - - [camera](#Editor-camera-member) - - [cameraState](#Editor-cameraState-member) - - [canMoveCamera](#Editor-canMoveCamera-member) - - [canRedo](#Editor-canRedo-member) - - [canUndo](#Editor-canUndo-member) - - [croppingId](#Editor-croppingId-member) - - [currentPage](#Editor-currentPage-member) - - [currentPageId](#Editor-currentPageId-member) - - [currentPageShapeIds](#Editor-currentPageShapeIds-member) - - [currentToolId](#Editor-currentToolId-member) - - [cursor](#Editor-cursor-member) - - [devicePixelRatio](#Editor-devicePixelRatio-member) - - [disposables](#Editor-disposables-member) - - [documentSettings](#Editor-documentSettings-member) - - [editingId](#Editor-editingId-member) - - [editingShape](#Editor-editingShape-member) - - [erasingIds](#Editor-erasingIds-member) - - [erasingIdsSet](#Editor-erasingIdsSet-member) - - [externalContentManager](#Editor-externalContentManager-member) - - [focusLayerId](#Editor-focusLayerId-member) - - [focusLayerShape](#Editor-focusLayerShape-member) - - [getContainer](#Editor-getContainer-member) - - [gridSize](#Editor-gridSize-member) - - [hintingIds](#Editor-hintingIds-member) - - [history](#Editor-history-member) - - [hoveredId](#Editor-hoveredId-member) - - [hoveredShape](#Editor-hoveredShape-member) - - [inputs](#Editor-inputs-member) - - [instanceState](#Editor-instanceState-member) - - [isChangingStyle](#Editor-isChangingStyle-member) - - [isChromeForIos](#Editor-isChromeForIos-member) - - [isCoarsePointer](#Editor-isCoarsePointer-member) - - [isDarkMode](#Editor-isDarkMode-member) - - [isFocused](#Editor-isFocused-member) - - [isFocusMode](#Editor-isFocusMode-member) - - [isGridMode](#Editor-isGridMode-member) - - [isIos](#Editor-isIos-member) - - [isMenuOpen](#Editor-isMenuOpen-member) - - [isPenMode](#Editor-isPenMode-member) - - [isReadOnly](#Editor-isReadOnly-member) - - [isSafari](#Editor-isSafari-member) - - [isSnapMode](#Editor-isSnapMode-member) - - [isToolLocked](#Editor-isToolLocked-member) - - [locale](#Editor-locale-member) - - [onlySelectedShape](#Editor-onlySelectedShape-member) - - [openMenus](#Editor-openMenus-member) - - [pages](#Editor-pages-member) - - [pageState](#Editor-pageState-member) - - [renderingBounds](#Editor-renderingBounds-member) - - [renderingBoundsExpanded](#Editor-renderingBoundsExpanded-member) - - [renderingShapes](#Editor-renderingShapes-member) - - [root](#Editor-root-member) - - [scribble](#Editor-scribble-member) - - [selectedIds](#Editor-selectedIds-member) - - [selectedIdsSet](#Editor-selectedIdsSet-member) - - [selectedPageBounds](#Editor-selectedPageBounds-member) - - [selectedShapes](#Editor-selectedShapes-member) - - [selectionBounds](#Editor-selectionBounds-member) - - [selectionPageCenter](#Editor-selectionPageCenter-member) - - [selectionRotation](#Editor-selectionRotation-member) - - [shapesArray](#Editor-shapesArray-member) - - [shapeUtils](#Editor-shapeUtils-member) - - [sharedOpacity](#Editor-sharedOpacity-member) - - [sharedStyles](#Editor-sharedStyles-member) - - [snaps](#Editor-snaps-member) - - [sortedShapesArray](#Editor-sortedShapesArray-member) - - [store](#Editor-store-member) - - [textMeasure](#Editor-textMeasure-member) - - [user](#Editor-user-member) - - [viewportPageBounds](#Editor-viewportPageBounds-member) - - [viewportPageCenter](#Editor-viewportPageCenter-member) - - [viewportScreenBounds](#Editor-viewportScreenBounds-member) - - [viewportScreenCenter](#Editor-viewportScreenCenter-member) - - [zoomBrush](#Editor-zoomBrush-member) - - [zoomLevel](#Editor-zoomLevel-member) -- [Methods](#methods) - - [addOpenMenu](#Editor-addOpenMenu-member-1) - - [alignShapes](#Editor-alignShapes-member-1) - - [animateCamera](#Editor-animateCamera-member-1) - - [animateShapes](#Editor-animateShapes-member-1) - - [animateToShape](#Editor-animateToShape-member-1) - - [animateToUser](#Editor-animateToUser-member-1) - - [bail](#Editor-bail-member-1) - - [bailToMark](#Editor-bailToMark-member-1) - - [batch](#Editor-batch-member-1) - - [blur](#Editor-blur-member-1) - - [bringForward](#Editor-bringForward-member-1) - - [bringToFront](#Editor-bringToFront-member-1) - - [cancel](#Editor-cancel-member-1) - - [cancelDoubleClick](#Editor-cancelDoubleClick-member-1) - - [centerOnPoint](#Editor-centerOnPoint-member-1) - - [complete](#Editor-complete-member-1) - - [createAssets](#Editor-createAssets-member-1) - - [createPage](#Editor-createPage-member-1) - - [createShapes](#Editor-createShapes-member-1) - - [deleteAssets](#Editor-deleteAssets-member-1) - - [deleteOpenMenu](#Editor-deleteOpenMenu-member-1) - - [deletePage](#Editor-deletePage-member-1) - - [deleteShapes](#Editor-deleteShapes-member-1) - - [deselect](#Editor-deselect-member-1) - - [dispatch](#Editor-dispatch-member-1) - - [dispose](#Editor-dispose-member-1) - - [distributeShapes](#Editor-distributeShapes-member-1) - - [duplicatePage](#Editor-duplicatePage-member-1) - - [duplicateShapes](#Editor-duplicateShapes-member-1) - - [findAncestor](#Editor-findAncestor-member-1) - - [findCommonAncestor](#Editor-findCommonAncestor-member-1) - - [flipShapes](#Editor-flipShapes-member-1) - - [focus](#Editor-focus-member-1) - - [getAncestorPageId](#Editor-getAncestorPageId-member-1) - - [getAncestors](#Editor-getAncestors-member-1) - - [getAncestorsById](#Editor-getAncestorsById-member-1) - - [getArrowsBoundTo](#Editor-getArrowsBoundTo-member-1) - - [getAssetById](#Editor-getAssetById-member-1) - - [getAssetBySrc](#Editor-getAssetBySrc-member-1) - - [getBounds](#Editor-getBounds-member-1) - - [getBoundsById](#Editor-getBoundsById-member-1) - - [getClipPathById](#Editor-getClipPathById-member-1) - - [getContent](#Editor-getContent-member-1) - - [getDeltaInParentSpace](#Editor-getDeltaInParentSpace-member-1) - - [getDeltaInShapeSpace](#Editor-getDeltaInShapeSpace-member-1) - - [getDroppingShape](#Editor-getDroppingShape-member-1) - - [getHandles](#Editor-getHandles-member-1) - - [getHandlesById](#Editor-getHandlesById-member-1) - - [getHighestIndexForParent](#Editor-getHighestIndexForParent-member-1) - - [getMaskedPageBounds](#Editor-getMaskedPageBounds-member-1) - - [getMaskedPageBoundsById](#Editor-getMaskedPageBoundsById-member-1) - - [getOutermostSelectableShape](#Editor-getOutermostSelectableShape-member-1) - - [getOutline](#Editor-getOutline-member-1) - - [getOutlineById](#Editor-getOutlineById-member-1) - - [getOutlineSegments](#Editor-getOutlineSegments-member-1) - - [getOutlineSegmentsById](#Editor-getOutlineSegmentsById-member-1) - - [getPageBounds](#Editor-getPageBounds-member-1) - - [getPageBoundsById](#Editor-getPageBoundsById-member-1) - - [getPageById](#Editor-getPageById-member-1) - - [getPageCenter](#Editor-getPageCenter-member-1) - - [getPageCenterById](#Editor-getPageCenterById-member-1) - - [getPageCorners](#Editor-getPageCorners-member-1) - - [getPageInfoById](#Editor-getPageInfoById-member-1) - - [getPageMaskById](#Editor-getPageMaskById-member-1) - - [getPagePointById](#Editor-getPagePointById-member-1) - - [getPageRotation](#Editor-getPageRotation-member-1) - - [getPageRotationById](#Editor-getPageRotationById-member-1) - - [getPageStateByPageId](#Editor-getPageStateByPageId-member-1) - - [getPageTransform](#Editor-getPageTransform-member-1) - - [getPageTransformById](#Editor-getPageTransformById-member-1) - - [getParentIdForNewShapeAtPoint](#Editor-getParentIdForNewShapeAtPoint-member-1) - - [getParentShape](#Editor-getParentShape-member-1) - - [getParentsMappedToChildren](#Editor-getParentsMappedToChildren-member-1) - - [getParentTransform](#Editor-getParentTransform-member-1) - - [getPointInParentSpace](#Editor-getPointInParentSpace-member-1) - - [getPointInShapeSpace](#Editor-getPointInShapeSpace-member-1) - - [getShapeAndDescendantIds](#Editor-getShapeAndDescendantIds-member-1) - - [getShapeById](#Editor-getShapeById-member-1) - - [getShapeIdsInPage](#Editor-getShapeIdsInPage-member-1) - - [getShapesAtPoint](#Editor-getShapesAtPoint-member-1) - - [getShapeUtil](#Editor-getShapeUtil-member-1) - - [getShapeUtil](#Editor-getShapeUtil-member-2) - - [getSortedChildIds](#Editor-getSortedChildIds-member-1) - - [getStateDescendant](#Editor-getStateDescendant-member-1) - - [getSvg](#Editor-getSvg-member-1) - - [getTransform](#Editor-getTransform-member-1) - - [groupShapes](#Editor-groupShapes-member-1) - - [hasAncestor](#Editor-hasAncestor-member-1) - - [interrupt](#Editor-interrupt-member-1) - - [isIn](#Editor-isIn-member-1) - - [isInAny](#Editor-isInAny-member-1) - - [isPointInShape](#Editor-isPointInShape-member-1) - - [isSelected](#Editor-isSelected-member-1) - - [isShapeInPage](#Editor-isShapeInPage-member-1) - - [isShapeOfType](#Editor-isShapeOfType-member-1) - - [isShapeOrAncestorLocked](#Editor-isShapeOrAncestorLocked-member-1) - - [isWithinSelection](#Editor-isWithinSelection-member-1) - - [mark](#Editor-mark-member-1) - - [moveShapesToPage](#Editor-moveShapesToPage-member-1) - - [nudgeShapes](#Editor-nudgeShapes-member-1) - - [packShapes](#Editor-packShapes-member-1) - - [pageToScreen](#Editor-pageToScreen-member-1) - - [pan](#Editor-pan-member-1) - - [panZoomIntoView](#Editor-panZoomIntoView-member-1) - - [popFocusLayer](#Editor-popFocusLayer-member-1) - - [putContent](#Editor-putContent-member-1) - - [putExternalContent](#Editor-putExternalContent-member-1) - - [redo](#Editor-redo-member-1) - - [renamePage](#Editor-renamePage-member-1) - - [reorderShapes](#Editor-reorderShapes-member-1) - - [reparentShapesById](#Editor-reparentShapesById-member-1) - - [replaceStoreContentsWithRecordsForOtherDocument](#Editor-replaceStoreContentsWithRecordsForOtherDocument-member-1) - - [resetZoom](#Editor-resetZoom-member-1) - - [resizeShape](#Editor-resizeShape-member-1) - - [rotateShapesBy](#Editor-rotateShapesBy-member-1) - - [screenToPage](#Editor-screenToPage-member-1) - - [select](#Editor-select-member-1) - - [selectAll](#Editor-selectAll-member-1) - - [selectNone](#Editor-selectNone-member-1) - - [sendBackward](#Editor-sendBackward-member-1) - - [sendToBack](#Editor-sendToBack-member-1) - - [setAnimationSpeed](#Editor-setAnimationSpeed-member-1) - - [setBrush](#Editor-setBrush-member-1) - - [setCamera](#Editor-setCamera-member-1) - - [setCroppingId](#Editor-setCroppingId-member-1) - - [setCurrentPageId](#Editor-setCurrentPageId-member-1) - - [setCursor](#Editor-setCursor-member-1) - - [setDarkMode](#Editor-setDarkMode-member-1) - - [setDevicePixelRatio](#Editor-setDevicePixelRatio-member-1) - - [setEditingId](#Editor-setEditingId-member-1) - - [setErasingIds](#Editor-setErasingIds-member-1) - - [setFocusLayer](#Editor-setFocusLayer-member-1) - - [setFocusMode](#Editor-setFocusMode-member-1) - - [setGridMode](#Editor-setGridMode-member-1) - - [setHintingIds](#Editor-setHintingIds-member-1) - - [setHoveredId](#Editor-setHoveredId-member-1) - - [setLocale](#Editor-setLocale-member-1) - - [setOpacity](#Editor-setOpacity-member-1) - - [setPageState](#Editor-setPageState-member-1) - - [setPenMode](#Editor-setPenMode-member-1) - - [setReadOnly](#Editor-setReadOnly-member-1) - - [setScribble](#Editor-setScribble-member-1) - - [setSelectedIds](#Editor-setSelectedIds-member-1) - - [setSelectedTool](#Editor-setSelectedTool-member-1) - - [setSnapMode](#Editor-setSnapMode-member-1) - - [setStyle](#Editor-setStyle-member-1) - - [setToolLocked](#Editor-setToolLocked-member-1) - - [setZoomBrush](#Editor-setZoomBrush-member-1) - - [slideCamera](#Editor-slideCamera-member-1) - - [stackShapes](#Editor-stackShapes-member-1) - - [startFollowingUser](#Editor-startFollowingUser-member-1) - - [stopCameraAnimation](#Editor-stopCameraAnimation-member-1) - - [stopFollowingUser](#Editor-stopFollowingUser-member-1) - - [stretchShapes](#Editor-stretchShapes-member-1) - - [toggleLock](#Editor-toggleLock-member-1) - - [undo](#Editor-undo-member-1) - - [ungroupShapes](#Editor-ungroupShapes-member-1) - - [updateAssets](#Editor-updateAssets-member-1) - - [updateDocumentSettings](#Editor-updateDocumentSettings-member-1) - - [updateInstanceState](#Editor-updateInstanceState-member-1) - - [updatePage](#Editor-updatePage-member-1) - - [updateShapes](#Editor-updateShapes-member-1) - - [updateViewportScreenBounds](#Editor-updateViewportScreenBounds-member-1) - - [visitDescendants](#Editor-visitDescendants-member-1) - - [zoomIn](#Editor-zoomIn-member-1) - - [zoomOut](#Editor-zoomOut-member-1) - - [zoomToBounds](#Editor-zoomToBounds-member-1) - - [zoomToContent](#Editor-zoomToContent-member-1) - - [zoomToFit](#Editor-zoomToFit-member-1) - - [zoomToSelection](#Editor-zoomToSelection-member-1) -
- - - - -##### Signature - - -```ts -class Editor extends EventEmitter {} -``` - -##### References - -[EventEmitter](/gen/eventemitter3-EventEmitter-EventEmitter), [TLEventMap](/gen/editor/TLEventMap-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Editor` class - - -##### Parameters - - - - - - - -`{ store, user, shapes, tools, getContainer }` - - - - -```ts -TLEditorOptions -``` - - - - - - - -##### References - -[TLEditorOptions](/gen/editor/TLEditorOptions-interface) - ---- - -## Properties - -### `allShapesCommonBounds` \{#Editor-allShapesCommonBounds-member} - -Public Readonly Property - -The common bounds of all of the shapes on the page. - - -##### Signature - - -```ts -get allShapesCommonBounds(): Box2d | null -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `animationSpeed` \{#Editor-animationSpeed-member} - -Public Readonly Property - -The user's chosen animation speed. - - -##### Signature - - -```ts -get animationSpeed(): number -``` - ---- - -### `assets` \{#Editor-assets-member} - -Public Readonly Property - -Get all assets in the editor. - - -##### Signature - - -```ts -get assets(): ( - | import('@tldraw/tlschema').TLBookmarkAsset - | TLImageAsset - | TLVideoAsset -)[] -``` - -##### References - -[TLBookmarkAsset](/gen/tlschema/TLBookmarkAsset-type), [TLImageAsset](/gen/tlschema/TLImageAsset-type), [TLVideoAsset](/gen/tlschema/TLVideoAsset-type) - ---- - -### `brush` \{#Editor-brush-member} - -Public Readonly Property - -The instance's brush state. - - -##### Signature - - -```ts -get brush(): Box2dModel | null -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `camera` \{#Editor-camera-member} - -Public Readonly Property - -The current camera. - - -##### Signature - - -```ts -get camera(): import('@tldraw/tlschema').TLCamera -``` - -##### References - -[TLCamera](/gen/tlschema/TLCamera-interface) - ---- - -### `cameraState` \{#Editor-cameraState-member} - -Public Readonly Property - -Whether the camera is moving or idle. - - -##### Signature - - -```ts -get cameraState(): 'idle' | 'moving' -``` - ---- - -### `canMoveCamera` \{#Editor-canMoveCamera-member} - -Public Property - -Whether the editor's camera can move. - - - - -##### Example - - - - -```ts -editor.canMoveCamera = false -``` - - -##### Parameters - - - - - - - -`canMove` - - - - -Whether the camera can move. - - - - - - - - -##### Signature - - -```ts -get canMoveCamera(): boolean - -set canMoveCamera(canMove: boolean) -``` - ---- - -### `canRedo` \{#Editor-canRedo-member} - -Public Readonly Property - -Whether the app can redo. - - -##### Signature - - -```ts -get canRedo(): boolean -``` - ---- - -### `canUndo` \{#Editor-canUndo-member} - -Public Readonly Property - -Whether the app can undo. - - -##### Signature - - -```ts -get canUndo(): boolean -``` - ---- - -### `croppingId` \{#Editor-croppingId-member} - -Public Readonly Property - -The current cropping shape's id. - - -##### Signature - - -```ts -get croppingId(): null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `currentPage` \{#Editor-currentPage-member} - -Public Readonly Property - -The current page. - - -##### Signature - - -```ts -get currentPage(): TLPage -``` - -##### References - -[TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `currentPageId` \{#Editor-currentPageId-member} - -Public Readonly Property - -The current page id. - - -##### Signature - - -```ts -get currentPageId(): TLPageId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `currentPageShapeIds` \{#Editor-currentPageShapeIds-member} - -Public Readonly Property - -An array of all of the shapes on the current page. - - -##### Signature - - -```ts -get currentPageShapeIds(): Set -``` - -##### References - -[Set](/gen/Set-interface), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `currentToolId` \{#Editor-currentToolId-member} - -Public Readonly Property - -The id of the current selected tool. - - -##### Signature - - -```ts -get currentToolId(): string -``` - ---- - -### `cursor` \{#Editor-cursor-member} - -Public Readonly Property - -The instance's cursor state. - - -##### Signature - - -```ts -get cursor(): TLCursor -``` - -##### References - -[TLCursor](/gen/tlschema/TLCursor-interface) - ---- - -### `devicePixelRatio` \{#Editor-devicePixelRatio-member} - -Public Readonly Property - -The window's device pixel ratio. - - -##### Signature - - -```ts -get devicePixelRatio(): number -``` - ---- - -### `disposables` \{#Editor-disposables-member} - -Public Readonly Property - -A set of functions to call when the app is disposed. - - -##### Signature - - -```ts -readonly disposables: Set<() => void> -``` - -##### References - -[Set](/gen/Set-interface) - ---- - -### `documentSettings` \{#Editor-documentSettings-member} - -Public Readonly Property - -The global document settings that apply to all users. - - -##### Signature - - -```ts -get documentSettings(): TLDocument -``` - -##### References - -[TLDocument](/gen/tlschema/TLDocument-interface) - ---- - -### `editingId` \{#Editor-editingId-member} - -Public Readonly Property - -The current editing shape's id. - - -##### Signature - - -```ts -get editingId(): null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `editingShape` \{#Editor-editingShape-member} - -Public Readonly Property - -##### Signature - - -```ts -get editingShape(): null | TLUnknownShape -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - ---- - -### `erasingIds` \{#Editor-erasingIds-member} - -Public Readonly Property - -The editor's current erasing ids. - - -##### Signature - - -```ts -get erasingIds(): TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `erasingIdsSet` \{#Editor-erasingIdsSet-member} - -Public Readonly Property - -A derived set containing the current erasing ids. - - -##### Signature - - -```ts -get erasingIdsSet(): Set -``` - -##### References - -[Set](/gen/Set-interface), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `externalContentManager` \{#Editor-externalContentManager-member} - -Public Property - - - - -##### Signature - - -```ts -externalContentManager: ExternalContentManager -``` - -##### References - -[ExternalContentManager](/gen/editor/PlopManager-class) - ---- - -### `focusLayerId` \{#Editor-focusLayerId-member} - -Public Readonly Property - -The shape id of the current focus layer. - - -##### Signature - - -```ts -get focusLayerId(): TLPageId | TLShapeId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `focusLayerShape` \{#Editor-focusLayerShape-member} - -Public Readonly Property - -The shape of the current focus layer. - - -##### Signature - - -```ts -get focusLayerShape(): TLShape | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getContainer` \{#Editor-getContainer-member} - -Public Property - -The current HTML element containing the editor. - - - - -##### Example - - - - -```ts -const container = editor.getContainer() -``` - - -##### Signature - - -```ts -getContainer: () => HTMLElement -``` - -##### References - -[HTMLElement](/gen/HTMLElement-interface) - ---- - -### `gridSize` \{#Editor-gridSize-member} - -Public Readonly Property - -The document's grid size. - - -##### Signature - - -```ts -get gridSize(): number -``` - ---- - -### `hintingIds` \{#Editor-hintingIds-member} - -Public Readonly Property - -The editor's current hinting ids. - - -##### Signature - - -```ts -get hintingIds(): TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `history` \{#Editor-history-member} - -Public Readonly Property - -A manager for the app's history. - - -##### Signature - - -```ts -readonly history: HistoryManager -``` - -##### References - -[HistoryManager](/gen/editor/~HistoryManager-class) - ---- - -### `hoveredId` \{#Editor-hoveredId-member} - -Public Readonly Property - -The current hovered shape id. - - - -##### Signature - - -```ts -get hoveredId(): null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `hoveredShape` \{#Editor-hoveredShape-member} - -Public Readonly Property - -The current hovered shape. - - - -##### Signature - - -```ts -get hoveredShape(): null | TLUnknownShape -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - ---- - -### `inputs` \{#Editor-inputs-member} - -Public Property - -The app's current input state. - - -##### Signature - - -```ts -inputs: { - originPagePoint: Vec2d - originScreenPoint: Vec2d - previousPagePoint: Vec2d - previousScreenPoint: Vec2d - currentPagePoint: Vec2d - currentScreenPoint: Vec2d - keys: Set - buttons: Set - isPen: boolean - shiftKey: boolean - ctrlKey: boolean - altKey: boolean - isDragging: boolean - isPointing: boolean - isPinching: boolean - isEditing: boolean - isPanning: boolean - pointerVelocity: Vec2d -} -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [Set](/gen/Set-interface) - ---- - -### `instanceState` \{#Editor-instanceState-member} - -Public Readonly Property - -The current instance's state. - - -##### Signature - - -```ts -get instanceState(): TLInstance -``` - -##### References - -[TLInstance](/gen/tlschema/TLInstance-interface) - ---- - -### `isChangingStyle` \{#Editor-isChangingStyle-member} - -Public Property - -Whether the user is currently changing the style of a shape. This may cause the UI to change. - - - - -##### Example - - - - -```ts -editor.isChangingStyle = true -``` - - -##### Signature - - -```ts -get isChangingStyle(): boolean - -set isChangingStyle(v: boolean) -``` - ---- - -### `isChromeForIos` \{#Editor-isChromeForIos-member} - -Public Readonly Property - -Whether the editor is running on iOS. - - -##### Signature - - -```ts -readonly isChromeForIos: boolean -``` - ---- - -### `isCoarsePointer` \{#Editor-isCoarsePointer-member} - -Public Property - -Whether the user is using a "coarse" pointer, such as on a touch screen. This is automatically set by the canvas. - - -##### Signature - - -```ts -get isCoarsePointer(): boolean - -set isCoarsePointer(v: boolean) -``` - ---- - -### `isDarkMode` \{#Editor-isDarkMode-member} - -Public Readonly Property - -Whether the user has dark mode enabled. - - -##### Signature - - -```ts -get isDarkMode(): boolean -``` - ---- - -### `isFocused` \{#Editor-isFocused-member} - -Public Readonly Property - -Whether or not the editor is focused. - - -##### Signature - - -```ts -get isFocused(): boolean -``` - ---- - -### `isFocusMode` \{#Editor-isFocusMode-member} - -Public Readonly Property - -Whether the instance is in focus mode or not. - - -##### Signature - - -```ts -get isFocusMode(): boolean -``` - ---- - -### `isGridMode` \{#Editor-isGridMode-member} - -Public Readonly Property - -Whether the instance's grid is enabled. - - -##### Signature - - -```ts -get isGridMode(): boolean -``` - ---- - -### `isIos` \{#Editor-isIos-member} - -Public Readonly Property - -Whether the editor is running on iOS. - - -##### Signature - - -```ts -readonly isIos: boolean -``` - ---- - -### `isMenuOpen` \{#Editor-isMenuOpen-member} - -Public Readonly Property - -Get whether any menus are open. - - -##### Signature - - -```ts -get isMenuOpen(): boolean -``` - ---- - -### `isPenMode` \{#Editor-isPenMode-member} - -Public Readonly Property - -Whether the editor is in pen mode or not. - - -##### Signature - - -```ts -get isPenMode(): boolean -``` - ---- - -### `isReadOnly` \{#Editor-isReadOnly-member} - -Public Readonly Property - -Whether the editor is in read-only mode or not. - - -##### Signature - - -```ts -get isReadOnly(): boolean -``` - ---- - -### `isSafari` \{#Editor-isSafari-member} - -Public Readonly Property - -Whether the editor is running in Safari. - - -##### Signature - - -```ts -readonly isSafari: boolean -``` - ---- - -### `isSnapMode` \{#Editor-isSnapMode-member} - -Public Readonly Property - -Whether the user has "always snap" mode enabled. - - -##### Signature - - -```ts -get isSnapMode(): boolean -``` - ---- - -### `isToolLocked` \{#Editor-isToolLocked-member} - -Public Readonly Property - -Whether the instance has "tool lock" mode enabled. - - -##### Signature - - -```ts -get isToolLocked(): boolean -``` - ---- - -### `locale` \{#Editor-locale-member} - -Public Readonly Property - -Get the user's locale. - - -##### Signature - - -```ts -get locale(): string -``` - ---- - -### `onlySelectedShape` \{#Editor-onlySelectedShape-member} - -Public Readonly Property - -The app's only selected shape. - - - - -##### Example - - - - -```ts -editor.onlySelectedShape -``` - - - -##### Signature - - -```ts -get onlySelectedShape(): null | TLShape -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `openMenus` \{#Editor-openMenus-member} - -Public Readonly Property - -A set of strings representing any open menus. When menus are open, certain interactions will behave differently; for example, when a draw tool is selected and a menu is open, a pointer-down will not create a dot (because the user is probably trying to close the menu) however a pointer-down event followed by a drag will begin drawing a line (because the user is BOTH trying to close the menu AND start drawing a line). - - -##### Signature - - -```ts -get openMenus(): string[] -``` - ---- - -### `pages` \{#Editor-pages-member} - -Public Readonly Property - -Info about the project's current pages. - - -##### Signature - - -```ts -get pages(): TLPage[] -``` - -##### References - -[TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `pageState` \{#Editor-pageState-member} - -Public Readonly Property - -The current page state. - - -##### Signature - - -```ts -get pageState(): TLInstancePageState -``` - -##### References - -[TLInstancePageState](/gen/tlschema/TLInstancePageState-interface) - ---- - -### `renderingBounds` \{#Editor-renderingBounds-member} - -Public Readonly Property - -The current rendering bounds in page space, used for checking which shapes are "on screen". - - -##### Signature - - -```ts -get renderingBounds(): Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `renderingBoundsExpanded` \{#Editor-renderingBoundsExpanded-member} - -Public Readonly Property - -The current rendering bounds in page space, expanded slightly. Used for determining which shapes to render and which to "cull". - - -##### Signature - - -```ts -get renderingBoundsExpanded(): Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `renderingShapes` \{#Editor-renderingShapes-member} - -Public Readonly Property - -Get the shapes that should be displayed in the current viewport. - - -##### Signature - - -```ts -get renderingShapes(): { - id: TLShapeId - index: number - backgroundIndex: number - opacity: number - isCulled: boolean - isInViewport: boolean - maskedPageBounds: Box2d | undefined -}[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `root` \{#Editor-root-member} - -Public Readonly Property - -The root state of the statechart. - - -##### Signature - - -```ts -readonly root: RootState -``` - -##### References - -[RootState](/gen/editor/~RootState-class) - ---- - -### `scribble` \{#Editor-scribble-member} - -Public Readonly Property - -The instance's scribble state. - - -##### Signature - - -```ts -get scribble(): null | TLScribble -``` - -##### References - -[TLScribble](/gen/tlschema/TLScribble-type) - ---- - -### `selectedIds` \{#Editor-selectedIds-member} - -Public Readonly Property - -The current selected ids. - - -##### Signature - - -```ts -get selectedIds(): TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `selectedIdsSet` \{#Editor-selectedIdsSet-member} - -Public Readonly Property - -The current selected ids as a set - - -##### Signature - - -```ts -get selectedIdsSet(): ReadonlySet -``` - -##### References - -[ReadonlySet](/gen/ReadonlySet-interface), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `selectedPageBounds` \{#Editor-selectedPageBounds-member} - -Public Readonly Property - -The current page bounds of all the selected shapes (Not the same thing as the page bounds of the selection bounding box when the selection has been rotated) - - - -##### Signature - - -```ts -get selectedPageBounds(): Box2d | null -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `selectedShapes` \{#Editor-selectedShapes-member} - -Public Readonly Property - -An array containing all of the currently selected shapes. - - - - -##### Example - - - - -```ts -editor.selectedShapes -``` - - - -##### Signature - - -```ts -get selectedShapes(): TLShape[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `selectionBounds` \{#Editor-selectionBounds-member} - -Public Readonly Property - -The bounds of the selection bounding box. - - - -##### Signature - - -```ts -get selectionBounds(): Box2d | undefined -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `selectionPageCenter` \{#Editor-selectionPageCenter-member} - -Public Readonly Property - -The center of the selection bounding box. - - - -##### Signature - - -```ts -get selectionPageCenter(): null | Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `selectionRotation` \{#Editor-selectionRotation-member} - -Public Readonly Property - -The rotation of the selection bounding box. - - - -##### Signature - - -```ts -get selectionRotation(): number -``` - ---- - -### `shapesArray` \{#Editor-shapesArray-member} - -Public Readonly Property - -An array containing all of the shapes in the current page. - - - - -##### Example - - - - -```ts -editor.shapesArray -``` - - - -##### Signature - - -```ts -get shapesArray(): TLShape[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `shapeUtils` \{#Editor-shapeUtils-member} - -Public Property - -A map of shape utility classes (TLShapeUtils) by shape type. - - -##### Signature - - -```ts -shapeUtils: { - readonly [K in string]?: ShapeUtil -} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - ---- - -### `sharedOpacity` \{#Editor-sharedOpacity-member} - -Public Readonly Property - -Get the currently selected shared opacity. If any shapes are selected, this returns the shared opacity of the selected shapes. Otherwise, this returns the chosen opacity for the next shape. - - -##### Signature - - -```ts -get sharedOpacity(): SharedStyle -``` - -##### References - -[SharedStyle](/gen/editor/SharedStyle-type) - ---- - -### `sharedStyles` \{#Editor-sharedStyles-member} - -Public Readonly Property - -A derived object containing either all current styles among the user's selected shapes, or else the user's most recent style choices that correspond to the current active state (i.e. the selected tool). - - -##### Signature - - -```ts -get sharedStyles(): ReadonlySharedStyleMap -``` - -##### References - -[ReadonlySharedStyleMap](/gen/editor/ReadonlySharedStyleMap-class) - ---- - -### `snaps` \{#Editor-snaps-member} - -Public Readonly Property - -A manager for the app's snapping feature. - - -##### Signature - - -```ts -readonly snaps: SnapManager -``` - -##### References - -[SnapManager](/gen/editor/~SnapManager-class) - ---- - -### `sortedShapesArray` \{#Editor-sortedShapesArray-member} - -Public Readonly Property - -An array containing all of the shapes in the current page, sorted in z-index order (accounting for nested shapes): e.g. A, B, BA, BB, C. - - - - -##### Example - - - - -```ts -editor.sortedShapesArray -``` - - - -##### Signature - - -```ts -get sortedShapesArray(): TLShape[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `store` \{#Editor-store-member} - -Public Readonly Property - -The editor's store - - -##### Signature - - -```ts -readonly store: TLStore -``` - -##### References - -[TLStore](/gen/tlschema/TLStore-type) - ---- - -### `textMeasure` \{#Editor-textMeasure-member} - -Public Readonly Property - -A helper for measuring text. - - -##### Signature - - -```ts -readonly textMeasure: TextManager -``` - -##### References - -[TextManager](/gen/editor/~TextManager-class) - ---- - -### `user` \{#Editor-user-member} - -Public Readonly Property - -A manager for the user and their preferences. - - -##### Signature - - -```ts -readonly user: UserPreferencesManager -``` - -##### References - -[UserPreferencesManager](/gen/editor/~UserPreferencesManager-class) - ---- - -### `viewportPageBounds` \{#Editor-viewportPageBounds-member} - -Public Readonly Property - -The current viewport in page space. - - -##### Signature - - -```ts -get viewportPageBounds(): Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `viewportPageCenter` \{#Editor-viewportPageCenter-member} - -Public Readonly Property - -The center of the viewport in page space. - - -##### Signature - - -```ts -get viewportPageCenter(): Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `viewportScreenBounds` \{#Editor-viewportScreenBounds-member} - -Public Readonly Property - -The bounds of the editor's viewport in screen space. - - -##### Signature - - -```ts -get viewportScreenBounds(): Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `viewportScreenCenter` \{#Editor-viewportScreenCenter-member} - -Public Readonly Property - -The center of the editor's viewport in screen space. - - -##### Signature - - -```ts -get viewportScreenCenter(): Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `zoomBrush` \{#Editor-zoomBrush-member} - -Public Readonly Property - -The instance's zoom brush state. - - -##### Signature - - -```ts -get zoomBrush(): Box2dModel | null -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `zoomLevel` \{#Editor-zoomLevel-member} - -Public Readonly Property - -The current camera zoom level. - - -##### Signature - - -```ts -get zoomLevel(): number -``` - ---- - -## Methods - -### `addOpenMenu()` \{#Editor-addOpenMenu-member-1} - -Public Method - -Add an open menu. - - - - -##### Example - - - - -```ts -editor.addOpenMenu('menu-id') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `alignShapes()` \{#Editor-alignShapes-member-1} - -Public Method - -Align shape positions. - - - - -##### Example - - - - -```ts -editor.alignShapes('left') -editor.alignShapes('left', ['box1', 'box2']) -``` - - -##### Parameters - - - - - - - -`operation` - - - - -```ts - | 'bottom' - | 'center-horizontal' - | 'center-vertical' - | 'left' - | 'right' - | 'top' -``` - -The align operation to apply. - - - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to align. Defaults to selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `animateCamera()` \{#Editor-animateCamera-member-1} - -Public Method - -Animate the camera. - - - - -##### Example - - - - -```ts -editor.animateCamera(0, 0) -editor.animateCamera(0, 0, 1) -editor.animateCamera(0, 0, 1, { duration: 1000, easing: (t) => t * t }) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The camera's x position. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The camera's y position. - - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - -The camera's z position. Defaults to the current zoom. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -Options for the animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `animateShapes()` \{#Editor-animateShapes-member-1} - -Public Method - -Animate shapes. - - - - -##### Example - - - - -```ts -editor.animateShapes([{ id: 'box1', type: 'box', x: 100, y: 100 }]) -``` - - -##### Parameters - - - - - - - -`partials` - - - - -```ts -(null | TLShapePartial | undefined)[] -``` - -The shape partials to update. - - - - - - - - - -`options` - - (optional) - - - - -```ts -{ - duration?: number - ease?: (t: number) => number -} -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `animateToShape()` \{#Editor-animateToShape-member-1} - -Public Method - -Animate the camera to a shape. - - -##### Parameters - - - - - - - -`shapeId` - - - - -```ts -TLShapeId -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `animateToUser()` \{#Editor-animateToUser-member-1} - -Public Method - -Animate the camera to a user's cursor position. This also briefly show the user's cursor if it's not currently visible. - - -##### Parameters - - - - - - - -`userId` - - - - -```ts -string -``` - -The id of the user to aniamte to. - - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `bail()` \{#Editor-bail-member-1} - -Public Method - -Clear all marks in the undo stack back to the next mark. - - - - -##### Example - - - - -```ts -editor.bail() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `bailToMark()` \{#Editor-bailToMark-member-1} - -Public Method - -Clear all marks in the undo stack back to the mark with the provided mark id. - - - - -##### Example - - - - -```ts -editor.bailToMark('creating') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `batch()` \{#Editor-batch-member-1} - -Public Method - -Run a function in a batch, which will be undone/redone as a single action. - - - - -##### Example - - - - -```ts -editor.batch(() => { - editor.selectAll() - editor.deleteShapes() - editor.createShapes(myShapes) - editor.selectNone() -}) - -editor.undo() // will undo all of the above -``` - - -##### Parameters - - - - - - - -`fn` - - - - -```ts -() => void -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `blur()` \{#Editor-blur-member-1} - -Public Method - -Blur the app, cancelling any interaction state. - - - - -##### Example - - - - -```ts -editor.blur() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `bringForward()` \{#Editor-bringForward-member-1} - -Public Method - -Bring shapes forward in the page's object list. - - - - -##### Example - - - - -```ts -editor.bringForward() -editor.bringForward(['id1', 'id2']) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. Defaults to the ids of the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `bringToFront()` \{#Editor-bringToFront-member-1} - -Public Method - -Bring shapes to the front of the page's object list. - - - - -##### Example - - - - -```ts -editor.bringToFront() -editor.bringToFront(['id1', 'id2']) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. Defaults to the ids of the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `cancel()` \{#Editor-cancel-member-1} - -Public Method - -Dispatch a cancel event. - - - - -##### Example - - - - -```ts -editor.cancel() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `cancelDoubleClick()` \{#Editor-cancelDoubleClick-member-1} - -Public Method - -Prevent a double click event from firing the next time the user clicks - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - ---- - -### `centerOnPoint()` \{#Editor-centerOnPoint-member-1} - -Public Method - -Center the camera on a point (in page space). - - - - -##### Example - - - - -```ts -editor.centerOnPoint(100, 100) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The x position of the point. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The y position of the point. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `complete()` \{#Editor-complete-member-1} - -Public Method - -Dispatch a complete event. - - - - -##### Example - - - - -```ts -editor.complete() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `createAssets()` \{#Editor-createAssets-member-1} - -Public Method - -Create one or more assets. - - - - -##### Example - - - - -```ts -editor.createAssets([...myAssets]) -``` - - -##### Parameters - - - - - - - -`assets` - - - - -```ts -TLAsset[] -``` - -The assets to create. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAsset](/gen/tlschema/TLAsset-type) - ---- - -### `createPage()` \{#Editor-createPage-member-1} - -Public Method - -Create a page. - - - - -##### Example - - - - -```ts -editor.createPage('New Page') -editor.createPage('New Page', 'page1') -``` - - -##### Parameters - - - - - - - -`title` - - - - -```ts -string -``` - -The new page's title. - - - - - - - - - -`id` - - (optional) - - - - -```ts -TLPageId -``` - -The new page's id. - - - - - - - - - -`belowPageIndex` - - (optional) - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `createShapes()` \{#Editor-createShapes-member-1} - -Public Method - -Create shapes. - - - - -##### Example - - - - -```ts -editor.createShapes([{ id: 'box1', type: 'text', props: { text: 'ok' } }]) -``` - - -##### Parameters - - - - - - - -`partials` - - - - -```ts -TLShapePartial[] -``` - -The shape partials to create. - - - - - - - - - -`select` - - (optional) - - - - -```ts -boolean -``` - -Whether to select the created shapes. Defaults to false. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `deleteAssets()` \{#Editor-deleteAssets-member-1} - -Public Method - -Delete one or more assets. - - - - -##### Example - - - - -```ts -editor.deleteAssets(['asset1', 'asset2']) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLAssetId[] -``` - -The assets to delete. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAssetId](/gen/tlschema/TLAssetId-type) - ---- - -### `deleteOpenMenu()` \{#Editor-deleteOpenMenu-member-1} - -Public Method - -Delete an open menu. - - - - -##### Example - - - - -```ts -editor.deleteOpenMenu('menu-id') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `deletePage()` \{#Editor-deletePage-member-1} - -Public Method - -Delete a page. - - - - -##### Example - - - - -```ts -editor.deletePage('page1') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLPageId -``` - -The id of the page to delete. - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `deleteShapes()` \{#Editor-deleteShapes-member-1} - -Public Method - -Delete shapes. - - - - -##### Example - - - - -```ts -editor.deleteShapes() -editor.deleteShapes(['box1', 'box2']) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to delete. Defaults to the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `deselect()` \{#Editor-deselect-member-1} - -Public Method - -Remove a shape from the existing set of selected shapes. - - - - -##### Example - - - - -```ts -editor.deselect(shape.id) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `dispatch()` \{#Editor-dispatch-member-1} - -Public Method - -Dispatch an event to the editor. - - - - -##### Example - - - - -```ts -editor.dispatch(myPointerEvent) -``` - - -##### Parameters - - - - - - - -`info` - - - - -```ts -TLEventInfo -``` - -The event info. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLEventInfo](/gen/editor/TLEventInfo-type) - ---- - -### `dispose()` \{#Editor-dispose-member-1} - -Public Method - -Dispose the editor. - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - ---- - -### `distributeShapes()` \{#Editor-distributeShapes-member-1} - -Public Method - -Distribute shape positions. - - - - -##### Example - - - - -```ts -editor.distributeShapes('left') -editor.distributeShapes('left', ['box1', 'box2']) -``` - - -##### Parameters - - - - - - - -`operation` - - - - -```ts -'horizontal' | 'vertical' -``` - -Whether to distribute shapes horizontally or vertically. - - - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to distribute. Defaults to selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `duplicatePage()` \{#Editor-duplicatePage-member-1} - -Public Method - -Duplicate a page. - - -##### Parameters - - - - - - - -`id` - - (optional) - - - - -```ts -TLPageId -``` - -The id of the page to duplicate. Defaults to the current page. - - - - - - - - - -`createId` - - (optional) - - - - -```ts -TLPageId -``` - -The id of the new page. Defaults to a new id. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `duplicateShapes()` \{#Editor-duplicateShapes-member-1} - -Public Method - -Duplicate shapes. - - - - -##### Example - - - - -```ts -editor.duplicateShapes() -editor.duplicateShapes(['id1', 'id2']) -editor.duplicateShapes(['id1', 'id2'], { x: 8, y: 8 }) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to duplicate. Defaults to the ids of the selected shapes. - - - - - - - - - -`offset` - - (optional) - - - - -```ts -VecLike -``` - -The offset (in pixels) to apply to the duplicated shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `findAncestor()` \{#Editor-findAncestor-member-1} - -Public Method - -Find the first ancestor matching the given predicate - - - - -##### Example - - - - -```ts -const ancestor = editor.findAncestor(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to check the ancestors for. - - - - - - - - - -`predicate` - - - - -```ts -(parent: TLShape) => boolean -``` - - - - - - - -##### Returns - - -```ts -TLShape | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `findCommonAncestor()` \{#Editor-findCommonAncestor-member-1} - -Public Method - -Get the common ancestor of two or more shapes that matches a predicate. - - -##### Parameters - - - - - - - -`shapes` - - - - -```ts -TLShape[] -``` - -The shapes to check. - - - - - - - - - -`predicate` - - (optional) - - - - -```ts -(shape: TLShape) => boolean -``` - -The predicate to match. - - - - - - - - -##### Returns - - -```ts -TLShapeId | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `flipShapes()` \{#Editor-flipShapes-member-1} - -Public Method - -Flip shape positions. - - - - -##### Example - - - - -```ts -editor.flipShapes('horizontal') -editor.flipShapes('horizontal', ['box1', 'box2']) -``` - - -##### Parameters - - - - - - - -`operation` - - - - -```ts -'horizontal' | 'vertical' -``` - -Whether to flip horizontally or vertically. - - - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to flip. Defaults to selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `focus()` \{#Editor-focus-member-1} - -Public Method - -Focus the editor. - - - - -##### Example - - - - -```ts -editor.focus() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `getAncestorPageId()` \{#Editor-getAncestorPageId-member-1} - -Public Method - -Get the id of the containing page for a given shape. - - -##### Parameters - - - - - - - -`shape` - - (optional) - - - - -```ts -TLShape -``` - -The shape to get the page id for. - - - - - - - - -##### Returns - - -```ts -TLPageId | undefined -``` - - The id of the page that contains the shape, or undefined if the shape is undefined. - - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `getAncestors()` \{#Editor-getAncestors-member-1} - -Public Method - -Get the ancestors of a shape. - - - - -##### Example - - - - -```ts -const ancestors = editor.getAncestors(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the ancestors for. - - - - - - - - - -`acc` - - (optional) - - - - -```ts -TLShape[] -``` - - - - - - - -##### Returns - - -```ts -TLShape[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getAncestorsById()` \{#Editor-getAncestorsById-member-1} - -Public Method - -Get the ancestors of a shape by its id. - - - - -##### Example - - - - -```ts -const ancestors = editor.getAncestorsById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to get the ancestors for. - - - - - - - - - -`acc` - - (optional) - - - - -```ts -TLShape[] -``` - - - - - - - -##### Returns - - -```ts -TLShape[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getArrowsBoundTo()` \{#Editor-getArrowsBoundTo-member-1} - -Public Method - -Get all arrows bound to a shape. - - -##### Parameters - - - - - - - -`shapeId` - - - - -```ts -TLShapeId -``` - -The id of the shape. - - - - - - - - -##### Returns - - -```ts -{ - arrowId: TLShapeId - handleId: 'end' | 'start' -}[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getAssetById()` \{#Editor-getAssetById-member-1} - -Public Method - -Get an asset by its id. - - - - -##### Example - - - - -```ts -editor.getAssetById('asset1') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLAssetId -``` - -The id of the asset. - - - - - - - - -##### Returns - - -```ts -TLAsset | undefined -``` - -##### References - -[TLAssetId](/gen/tlschema/TLAssetId-type), [TLAsset](/gen/tlschema/TLAsset-type) - ---- - -### `getAssetBySrc()` \{#Editor-getAssetBySrc-member-1} - -Public Method - -Get an asset by its src property. - - - - -##### Example - - - - -```ts -editor.getAssetBySource('https://example.com/image.png') -``` - - -##### Parameters - - - - - - - -`src` - - - - -```ts -string -``` - -The source value of the asset. - - - - - - - - -##### Returns - - -```ts - | import('@tldraw/tlschema').TLBookmarkAsset - | TLImageAsset - | TLVideoAsset - | undefined -``` - -##### References - -[TLBookmarkAsset](/gen/tlschema/TLBookmarkAsset-type), [TLImageAsset](/gen/tlschema/TLImageAsset-type), [TLVideoAsset](/gen/tlschema/TLVideoAsset-type) - ---- - -### `getBounds()` \{#Editor-getBounds-member-1} - -Public Method - -Get the local bounds of a shape. - - - - -##### Example - - - - -```ts -editor.getBounds(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -T -``` - -The shape to get the bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getBoundsById()` \{#Editor-getBoundsById-member-1} - -Public Method - -Get the local bounds of a shape by its id. - - - - -##### Example - - - - -```ts -editor.getBoundsById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -T['id'] -``` - -The id of the shape to get the bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getClipPathById()` \{#Editor-getClipPathById-member-1} - -Public Method - -Get the clip path for a shape. - - - - -##### Example - - - - -```ts -const clipPath = editor.getClipPathById(shape.id) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The shape id. - - - - - - - - -##### Returns - - -```ts -string | undefined -``` - - The clip path or undefined. - - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getContent()` \{#Editor-getContent-member-1} - -Public Method - -Get content that can be exported for the given shape ids. - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to get content for. Defaults to the selected shape ids. - - - - - - - - -##### Returns - - -```ts -TLContent | undefined -``` - - The exported content. - - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLContent](/gen/editor/TLContent-interface) - ---- - -### `getDeltaInParentSpace()` \{#Editor-getDeltaInParentSpace-member-1} - -Public Method - -Convert a delta in page space to a delta in the parent space of a shape. - - - - -##### Example - - - - -```ts -editor.getDeltaInParentSpace(myShape, { x: 100, y: 100 }) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the delta in the parent space of. - - - - - - - - - -`delta` - - - - -```ts -VecLike -``` - -The page delta to convert. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDeltaInShapeSpace()` \{#Editor-getDeltaInShapeSpace-member-1} - -Public Method - -Convert a delta in page space to a delta in the local space of a shape. - - - - -##### Example - - - - -```ts -editor.getDeltaInShapeSpace(myShape, { x: 100, y: 100 }) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the delta in the local space of. - - - - - - - - - -`delta` - - - - -```ts -VecLike -``` - -The page delta to convert. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDroppingShape()` \{#Editor-getDroppingShape-member-1} - -Public Method - -Get the shape that some shapes should be dropped on at a given point. - - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The point to find the parent for. - - - - - - - - - -`droppingShapes` - - (optional) - - - - -```ts -TLShape[] -``` - -The shapes that are being dropped. - - - - - - - - -##### Returns - - -```ts -TLUnknownShape | undefined -``` - - The shape to drop on. - - -##### References - -[VecLike](/gen/primitives/VecLike-type), [TLShape](/gen/tlschema/TLShape-type), [TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - ---- - -### `getHandles()` \{#Editor-getHandles-member-1} - -Public Method - -Get the handles (if any) for a shape. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -T -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -TLHandle[] | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLHandle](/gen/tlschema/TLHandle-interface) - ---- - -### `getHandlesById()` \{#Editor-getHandlesById-member-1} - -Public Method - -Get the handles (if any) for a shape by its id. - - -##### Parameters - - - - - - - -`id` - - - - -```ts -T['id'] -``` - - - - - - - -##### Returns - - -```ts -TLHandle[] | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLHandle](/gen/tlschema/TLHandle-interface) - ---- - -### `getHighestIndexForParent()` \{#Editor-getHighestIndexForParent-member-1} - -Public Method - -Get the index above the highest child of a given parent. - - -##### Parameters - - - - - - - -`parentId` - - - - -```ts -TLPageId | TLShapeId -``` - -The id of the parent. - - - - - - - - -##### Returns - - -```ts -string -``` - - The index. - - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getMaskedPageBounds()` \{#Editor-getMaskedPageBounds-member-1} - -Public Method - -Get the page (or absolute) bounds of a shape, incorporating any masks. For example, if the shape were the child of a frame and was half way out of the frame, the bounds would be the half of the shape that was in the frame. - - - - -##### Example - - - - -```ts -editor.getMaskedPageBounds(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the masked bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getMaskedPageBoundsById()` \{#Editor-getMaskedPageBoundsById-member-1} - -Public Method - -Get the page (or absolute) bounds of a shape by its id, incorporating any masks. For example, if the shape were the child of a frame and was half way out of the frame, the bounds would be the half of the shape that was in the frame. - - - - -##### Example - - - - -```ts -editor.getMaskedPageBoundsById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to get the masked page bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d | undefined -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getOutermostSelectableShape()` \{#Editor-getOutermostSelectableShape-member-1} - -Public Method - -Get the shape that should be selected when you click on a given shape, assuming there is nothing already selected. It will not return anything higher than or including the current focus layer. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the outermost selectable shape for. - - - - - - - - - -`filter` - - (optional) - - - - -```ts -(shape: TLShape) => boolean -``` - -A function to filter the selectable shapes. - - - - - - - - -##### Returns - - -```ts -TLShape -``` - - The outermost selectable shape. - - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getOutline()` \{#Editor-getOutline-member-1} - -Public Method - -Get the local outline of a shape. - - - - -##### Example - - - - -```ts -editor.getOutline(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -T -``` - -The shape to get the outline for. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineById()` \{#Editor-getOutlineById-member-1} - -Public Method - -Get the local outline of a shape. - - - - -##### Example - - - - -```ts -editor.getOutlineById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The shape id to get the outline for. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineSegments()` \{#Editor-getOutlineSegments-member-1} - -Public Method - -Get the local outline segments of a shape. - - - - -##### Example - - - - -```ts -editor.getOutlineSegments(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -T -``` - -The shape to get the outline segments for. - - - - - - - - -##### Returns - - -```ts -Vec2d[][] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineSegmentsById()` \{#Editor-getOutlineSegmentsById-member-1} - -Public Method - -Get the local outline segments of a shape by its Id. - - - - -##### Example - - - - -```ts -editor.getOutlineSegmentsById(myShapeId) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - - - - - - - -##### Returns - - -```ts -Vec2d[][] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPageBounds()` \{#Editor-getPageBounds-member-1} - -Public Method - -Get the page (or absolute) bounds of a shape. - - - - -##### Example - - - - -```ts -editor.getPageBounds(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getPageBoundsById()` \{#Editor-getPageBoundsById-member-1} - -Public Method - -Get the page (or absolute) bounds of a shape by its id. - - - - -##### Example - - - - -```ts -editor.getPageBoundsById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to get the page bounds for. - - - - - - - - -##### Returns - - -```ts -Box2d | undefined -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getPageById()` \{#Editor-getPageById-member-1} - -Public Method - -Get a page by its ID. - - - - -##### Example - - - - -```ts -editor.getPageById(myPage.id) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLPageId -``` - - - - - - - -##### Returns - - -```ts -TLPage | undefined -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `getPageCenter()` \{#Editor-getPageCenter-member-1} - -Public Method - -Get the page point (or absolute point) of a shape. - - - - -##### Example - - - - -```ts -editor.getPagePoint(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the page point for. - - - - - - - - -##### Returns - - -```ts -null | Vec2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPageCenterById()` \{#Editor-getPageCenterById-member-1} - -Public Method - -Get the page point (or absolute point) of a shape by its id. - - - - -##### Example - - - - -```ts -editor.getPagePoint(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The shape id to get the page point for. - - - - - - - - -##### Returns - - -```ts -null | Vec2d -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPageCorners()` \{#Editor-getPageCorners-member-1} - -Public Method - -Get the corners of a shape in page space. - - - - -##### Example - - - - -```ts -const corners = editor.getPageCorners(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the corners for. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPageInfoById()` \{#Editor-getPageInfoById-member-1} - -Public Method - -Get a page by its ID. - - - - -##### Example - - - - -```ts -editor.getPageById(myPage.id) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLPage['id'] -``` - - - - - - - -##### Returns - - -```ts -TLPage | undefined -``` - -##### References - -[TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `getPageMaskById()` \{#Editor-getPageMaskById-member-1} - -Public Method - -Get the page mask for a shape. - - - - -##### Example - - - - -```ts -const pageMask = editor.getPageMaskById(shape.id) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to get the page mask for. - - - - - - - - -##### Returns - - -```ts -undefined | VecLike[] -``` - - The page mask for the shape. - - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `getPagePointById()` \{#Editor-getPagePointById-member-1} - -Public Method - -Get the page point (or absolute point) of a shape. - - - - -##### Example - - - - -```ts -editor.getPagePoint(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - - - - - - - -##### Returns - - -```ts -undefined | Vec2d -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPageRotation()` \{#Editor-getPageRotation-member-1} - -Public Method - -Get the page rotation (or absolute rotation) of a shape. - - - - -##### Example - - - - -```ts -editor.getPageRotation(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the page rotation for. - - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getPageRotationById()` \{#Editor-getPageRotationById-member-1} - -Public Method - -Get the page rotation (or absolute rotation) of a shape by its id. - - - - -##### Example - - - - -```ts -editor.getPageRotationById(myShapeId) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to get the page rotation for. - - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getPageStateByPageId()` \{#Editor-getPageStateByPageId-member-1} - -Public Method - -Get a page state by its id. - - - - -##### Example - - - - -```ts -editor.getPageStateByPageId('page1') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLPageId -``` - - - - - - - -##### Returns - - -```ts -TLInstancePageState | undefined -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLInstancePageState](/gen/tlschema/TLInstancePageState-interface) - ---- - -### `getPageTransform()` \{#Editor-getPageTransform-member-1} - -Public Method - -Get the page transform (or absolute transform) of a shape. - - - - -##### Example - - - - -```ts -editor.getPageTransform(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the page transform for. - - - - - - - - -##### Returns - - -```ts -Matrix2d | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `getPageTransformById()` \{#Editor-getPageTransformById-member-1} - -Public Method - -Get the page transform (or absolute transform) of a shape by its id. - - - - -##### Example - - - - -```ts -editor.getPageTransformById(myShape) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The if of the shape to get the page transform for. - - - - - - - - -##### Returns - - -```ts -Matrix2d | undefined -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `getParentIdForNewShapeAtPoint()` \{#Editor-getParentIdForNewShapeAtPoint-member-1} - -Public Method - -Get the id of what should be the parent of a new shape at a given point. The parent can be a page or shape. - - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The point to find the parent for. - - - - - - - - - -`shapeType` - - - - -```ts -TLShape['type'] -``` - -The type of shape that will be created. - - - - - - - - -##### Returns - - -```ts -TLPageId | TLShapeId -``` - - The id of the parent. - - -##### References - -[VecLike](/gen/primitives/VecLike-type), [TLShape](/gen/tlschema/TLShape-type), [TLPageId](/gen/tlschema/TLPageId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getParentShape()` \{#Editor-getParentShape-member-1} - -Public Method - -Get the parent shape for a given shape. Returns undefined if the shape is the direct child of the page. - - - - -##### Example - - - - -```ts -editor.getParentShape(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - (optional) - - - - -```ts -TLShape -``` - - - - - - - -##### Returns - - -```ts -TLShape | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getParentsMappedToChildren()` \{#Editor-getParentsMappedToChildren-member-1} - -Public Method - -For a given set of ids, get a map containing the ids of their parents and the children of those parents. - - - - -##### Example - - - - -```ts -editor.getParentsMappedToChildren(['id1', 'id2', 'id3']) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids to get the parents and children of. - - - - - - - - -##### Returns - - -```ts -Map> -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Map](/gen/Map-interface), [TLParentId](/gen/tlschema/TLParentId-type), [Set](/gen/Set-interface), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getParentTransform()` \{#Editor-getParentTransform-member-1} - -Public Method - -Get the local transform of a shape's parent as a matrix model. - - - - -##### Example - - - - -```ts -editor.getParentTransform(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the parent transform for. - - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `getPointInParentSpace()` \{#Editor-getPointInParentSpace-member-1} - -Public Method - -Convert a delta in page space to a point in the local space of a shape. For example, if a shape's page point were `{ x: 100, y: 100 }`, a page point at `{ x: 110, y: 110 }` would be at `{ x: 10, y: 10 }` in the shape's local space. - - - - -##### Example - - - - -```ts -editor.getPointInShapeSpace(myShape.id, { x: 100, y: 100 }) -``` - - -##### Parameters - - - - - - - -`shapeId` - - - - -```ts -TLShapeId -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The page point to get in the local space of the shape. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPointInShapeSpace()` \{#Editor-getPointInShapeSpace-member-1} - -Public Method - -Convert a point in page space to a point in the local space of a shape. For example, if a shape's page point were `{ x: 100, y: 100 }`, a page point at `{ x: 110, y: 110 }` would be at `{ x: 10, y: 10 }` in the shape's local space. - - - - -##### Example - - - - -```ts -editor.getPointInShapeSpace(myShape, { x: 100, y: 100 }) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the point in the local space of. - - - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The page point to get in the local space of the shape. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getShapeAndDescendantIds()` \{#Editor-getShapeAndDescendantIds-member-1} - -Public Method - -Get the shape ids of all descendants of the given shapes (including the shapes themselves). - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to get descendants of. - - - - - - - - -##### Returns - - -```ts -Set -``` - - The decscendant ids. - - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Set](/gen/Set-interface) - ---- - -### `getShapeById()` \{#Editor-getShapeById-member-1} - -Public Method - -Get a shape by its id. - - - - -##### Example - - - - -```ts -editor.getShapeById('box1') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLParentId -``` - -The id of the shape to get. - - - - - - - - -##### Returns - - -```ts -T | undefined -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLParentId](/gen/tlschema/TLParentId-type) - ---- - -### `getShapeIdsInPage()` \{#Editor-getShapeIdsInPage-member-1} - -Public Method - -Get the ids of shapes on a page. - - - - -##### Example - - - - -```ts -const idsOnPage1 = editor.getShapeIdsInPage('page1') -const idsOnPage2 = editor.getShapeIdsInPage('page2') -``` - - -##### Parameters - - - - - - - -`pageId` - - - - -```ts -TLPageId -``` - -The id of the page. - - - - - - - - -##### Returns - - -```ts -Set -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [Set](/gen/Set-interface), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getShapesAtPoint()` \{#Editor-getShapesAtPoint-member-1} - -Public Method - -Get the shapes, if any, at a given page point. - - - - -##### Example - - - - -```ts -editor.getShapesAtPoint({ x: 100, y: 100 }) -``` - - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The page point to test. - - - - - - - - -##### Returns - - -```ts -TLShape[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `getShapeUtil()` \{#Editor-getShapeUtil-member-1} - -Public Method - -Get a shape util by its definition. - - - - -##### Example - - - - -```ts -editor.getShapeUtil(ArrowShapeUtil) -``` - - -##### Parameters - - - - - - - -`util` - - - - -```ts -C -``` - -The shape util. - - - - - - - - -##### Returns - - -```ts -InstanceType -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [InstanceType](/gen/InstanceType-type) - ---- - -### `getShapeUtil()` \{#Editor-getShapeUtil-member-2} - -Public Method - -Get a shape util from a shape itself. - - - - -##### Example - - - - -```ts -const util = editor.getShapeUtil(myShape) -const util = editor.getShapeUtil(myShape) -const util = editor.getShapeUtil(ArrowShapeUtil) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -S | TLShapePartial -``` - -A shape or shape partial. - - - - - - - - -##### Returns - - -```ts -ShapeUtil -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type), [ShapeUtil](/gen/editor/ShapeUtil-class) - ---- - -### `getSortedChildIds()` \{#Editor-getSortedChildIds-member-1} - -Public Method - -Get an array of all the children of a shape. - - - - -##### Example - - - - -```ts -editor.getSortedChildIds('frame1') -``` - - -##### Parameters - - - - - - - -`parentId` - - - - -```ts -TLParentId -``` - -The id of the parent shape. - - - - - - - - -##### Returns - - -```ts -TLShapeId[] -``` - -##### References - -[TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `getStateDescendant()` \{#Editor-getStateDescendant-member-1} - -Public Method - -Get a descendant by its path. - - - - -##### Example - - - - -```ts -state.getStateDescendant('select') -state.getStateDescendant('select.brushing') -``` - - -##### Parameters - - - - - - - -`path` - - - - -```ts -string -``` - -The descendant's path of state ids, separated by periods. - - - - - - - - -##### Returns - - -```ts -StateNode | undefined -``` - -##### References - -[StateNode](/gen/editor/StateNode-class) - ---- - -### `getSvg()` \{#Editor-getSvg-member-1} - -Public Method - -Get an exported SVG of the given shapes. - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to export. Defaults to selected shapes. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -Partial<{ - scale: number - background: boolean - padding: number - darkMode?: boolean | undefined - preserveAspectRatio: React.SVGAttributes['preserveAspectRatio'] -}> -``` - -Options for the export. - - - - - - - - -##### Returns - - -```ts -Promise -``` - - The SVG element. - - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Partial](/gen/Partial-type), [React.SVGAttributes](/gen/@types/react-React-SVGAttributes-interface), [SVGSVGElement](/gen/SVGSVGElement-interface), [Promise](/gen/Promise-interface) - ---- - -### `getTransform()` \{#Editor-getTransform-member-1} - -Public Method - -Get the local transform for a shape as a matrix model. This transform reflects both its translation (x, y) from from either its parent's top left corner, if the shape's parent is another shape, or else from the 0,0 of the page, if the shape's parent is the page; and the shape's rotation. - - - - -##### Example - - - - -```ts -editor.getTransform(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to get the local transform for. - - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `groupShapes()` \{#Editor-groupShapes-member-1} - -Public Method - -Group some shapes together. - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -Ids of the shapes to group. Defaults to the selected shapes. - - - - - - - - - -`groupId` - - (optional) - - - - -```ts -TLShapeId -``` - -Id of the group to create. Defaults to a new shape id. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `hasAncestor()` \{#Editor-hasAncestor-member-1} - -Public Method - -Returns true if the the given shape has the given ancestor. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape | undefined -``` - -The shape. - - - - - - - - - -`ancestorId` - - - - -```ts -TLShapeId -``` - -The id of the ancestor. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `interrupt()` \{#Editor-interrupt-member-1} - -Public Method - -Dispatch an interrupt event. - - - - -##### Example - - - - -```ts -editor.interrupt() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `isIn()` \{#Editor-isIn-member-1} - -Public Method - -Get whether a certain tool (or other state node) is currently active. - - - - -##### Example - - - - -```ts -editor.isIn('select') -editor.isIn('select.brushing') -``` - - -##### Parameters - - - - - - - -`path` - - - - -```ts -string -``` - -The path of active states, separated by periods. - - - - - - - - -##### Returns - - -```ts -boolean -``` - ---- - -### `isInAny()` \{#Editor-isInAny-member-1} - -Public Method - -Get whether the state node is in any of the given active paths. - - - - -##### Example - - - - -```ts -state.isInAny('select', 'erase') -state.isInAny('select.brushing', 'erase.idle') -``` - - -##### Parameters - - - - - - - -`paths` - - - - -```ts -string[] -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - ---- - -### `isPointInShape()` \{#Editor-isPointInShape-member-1} - -Public Method - -Test whether a point (in page space) will will a shape. This method takes into account masks, such as when a shape is the child of a frame and is partially clipped by the frame. - - - - -##### Example - - - - -```ts -editor.isPointInShape({ x: 100, y: 100 }, myShape) -``` - - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The page point to test. - - - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to test against. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `isSelected()` \{#Editor-isSelected-member-1} - -Public Method - -Determine whether or not a shape is selected - - - - -##### Example - - - - -```ts -editor.isSelected('id1') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to check. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `isShapeInPage()` \{#Editor-isShapeInPage-member-1} - -Public Method - -Get whether the given shape is the descendant of the given page. - - - - -##### Example - - - - -```ts -editor.isShapeInPage(myShape) -editor.isShapeInPage(myShape, 'page1') -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLShape -``` - -The shape to check. - - - - - - - - - -`pageId` - - (optional) - - - - -```ts -TLPageId -``` - -The id of the page to check against. Defaults to the current page. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `isShapeOfType()` \{#Editor-isShapeOfType-member-1} - -Public Method - -Get whether a shape matches the type of a TLShapeUtil. - - - - -##### Example - - - - -```ts -const isArrowShape = isShapeOfType(someShape, ArrowShapeUtil) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLUnknownShape -``` - -the shape to test - - - - - - - - - -`util` - - - - -```ts -{ - new (...args: any): ShapeUtil - type: string -} -``` - -the TLShapeUtil constructor to test against - - - - - - - - -##### Returns - - -```ts -shape is T -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [ShapeUtil](/gen/editor/ShapeUtil-class), [shape](/gen/editor/~shape) - ---- - -### `isShapeOrAncestorLocked()` \{#Editor-isShapeOrAncestorLocked-member-1} - -Public Method - -Check whether a shape or its parent is locked. - - -##### Parameters - - - - - - - -`shape` - - (optional) - - - - -```ts -TLShape -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `isWithinSelection()` \{#Editor-isWithinSelection-member-1} - -Public Method - -Determine whether a not a shape is within the current selection. A shape is within the selection if it or any of its parents is selected. - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to check. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `mark()` \{#Editor-mark-member-1} - -Public Method - -Create a new "mark", or stopping point, in the undo redo history. Creating a mark will clear any redos. - - - - -##### Example - - - - -```ts -editor.mark() -editor.mark('flip shapes') -``` - - -##### Parameters - - - - - - - -`reason` - - (optional) - - - - -```ts -string -``` - -The reason for the mark. - - - - - - - - - -`onUndo` - - (optional) - - - - -```ts -boolean -``` - -Whether to stop at the mark when undoing. - - - - - - - - - -`onRedo` - - (optional) - - - - -```ts -boolean -``` - -Whether to stop at the mark when redoing. - - - - - - - - -##### Returns - - -```ts -string -``` - ---- - -### `moveShapesToPage()` \{#Editor-moveShapesToPage-member-1} - -Public Method - -Move shapes to page. - - - - -##### Example - - - - -```ts -editor.moveShapesToPage(['box1', 'box2'], 'page1') -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. - - - - - - - - - -`pageId` - - - - -```ts -TLPageId -``` - -The id of the page where the shapes will be moved. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `nudgeShapes()` \{#Editor-nudgeShapes-member-1} - -Public Method - -Move shapes by a delta. - - - - -##### Example - - - - -```ts -editor.nudgeShapes(['box1', 'box2'], { x: 0, y: 1 }) -editor.nudgeShapes(['box1', 'box2'], { x: 0, y: 1 }, true) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. - - - - - - - - - -`direction` - - - - -```ts -Vec2dModel -``` - -The direction in which to move the shapes. - - - - - - - - - -`major` - - (optional) - - - - -```ts -boolean -``` - -Whether this is a major nudge, e.g. a shift + arrow nudge. - - - - - - - - - -`ephemeral` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - ---- - -### `packShapes()` \{#Editor-packShapes-member-1} - -Public Method - -Pack shapes into a grid centered on their current position. Based on potpack (https://github.com/mapbox/potpack) - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to pack. Defaults to selected shapes. - - - - - - - - - -`padding` - - (optional) - - - - -```ts -number -``` - -The padding to apply to the packed shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `pageToScreen()` \{#Editor-pageToScreen-member-1} - -Public Method - -Convert a point in page space to a point in screen space. - - - - -##### Example - - - - -```ts -editor.pageToScreen(100, 100) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The x coordinate of the point in screen space. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The y coordinate of the point in screen space. - - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`camera` - - (optional) - - - - -```ts -Vec2dModel -``` - -The camera to use. Defaults to the current camera. - - - - - - - - -##### Returns - - -```ts -{ - x: number - y: number - z: number -} -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface) - ---- - -### `pan()` \{#Editor-pan-member-1} - -Public Method - -Pan the camera. - - - - -##### Example - - - - -```ts -editor.pan(100, 100) -editor.pan(100, 100, { duration: 1000 }) -``` - - -##### Parameters - - - - - - - -`dx` - - - - -```ts -number -``` - -The amount to pan on the x axis. - - - - - - - - - -`dy` - - - - -```ts -number -``` - -The amount to pan on the y axis. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The animation options - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `panZoomIntoView()` \{#Editor-panZoomIntoView-member-1} - -Public Method - -Pan or pan/zoom the selected ids into view. This method tries to not change the zoom if possible. - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to pan and zoom into view. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `popFocusLayer()` \{#Editor-popFocusLayer-member-1} - -Public Method - -Exit the current focus layer, moving up to the next group if there is one. - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `putContent()` \{#Editor-putContent-member-1} - -Public Method - -Place content into the editor. - - -##### Parameters - - - - - - - -`content` - - - - -```ts -TLContent -``` - -The content. - - - - - - - - - -`options` - - (optional) - - - - -```ts -{ - point?: VecLike - select?: boolean - preservePosition?: boolean - preserveIds?: boolean -} -``` - -Options for placing the content. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLContent](/gen/editor/TLContent-interface), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `putExternalContent()` \{#Editor-putExternalContent-member-1} - -Public Method - -Handle external content, such as files, urls, embeds, or plain text which has been put into the app, for example by pasting external text or dropping external images onto canvas. - - -##### Parameters - - - - - - - -`info` - - - - -```ts -TLExternalContent -``` - -Info about the external content. - - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -### `redo()` \{#Editor-redo-member-1} - -Public Method - -Redo to the next mark. - - - - -##### Example - - - - -```ts -editor.redo() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `renamePage()` \{#Editor-renamePage-member-1} - -Public Method - -Rename a page. - - - - -##### Example - - - - -```ts -editor.renamePage('page1', 'My Page') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLPageId -``` - -The id of the page to rename. - - - - - - - - - -`name` - - - - -```ts -string -``` - -The new name. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `reorderShapes()` \{#Editor-reorderShapes-member-1} - -Public Method - -Reorder shapes. - - -##### Parameters - - - - - - - -`operation` - - - - -```ts -'backward' | 'forward' | 'toBack' | 'toFront' -``` - -The operation to perform. - - - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids to reorder. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `reparentShapesById()` \{#Editor-reparentShapesById-member-1} - -Public Method - -Reparent shapes to a new parent. This operation preserves the shape's current page positions / rotations. - - - - -##### Example - - - - -```ts -editor.reparentShapesById(['box1', 'box2'], 'frame1') -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to reparent. - - - - - - - - - -`parentId` - - - - -```ts -TLParentId -``` - -The id of the new parent shape. - - - - - - - - - -`insertIndex` - - (optional) - - - - -```ts -string -``` - -The index to insert the children. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLParentId](/gen/tlschema/TLParentId-type) - ---- - -### `replaceStoreContentsWithRecordsForOtherDocument()` \{#Editor-replaceStoreContentsWithRecordsForOtherDocument-member-1} - -Public Method - -Replace the store's contents with the given records. - - -##### Parameters - - - - - - - -`records` - - - - -```ts -TLRecord[] -``` - -The records to replace the store's contents with. - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[TLRecord](/gen/tlschema/TLRecord-type) - ---- - -### `resetZoom()` \{#Editor-resetZoom-member-1} - -Public Method - -Set the zoom back to 100%. - - - - -##### Example - - - - -```ts -editor.resetZoom() -``` - - -##### Parameters - - - - - - - -`point` - - (optional) - - - - -```ts -Vec2d -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `resizeShape()` \{#Editor-resizeShape-member-1} - -Public Method - -Resize a shape. - - -##### Parameters - - - - - - - -`id` - - - - -```ts -TLShapeId -``` - -The id of the shape to resize. - - - - - - - - - -`scale` - - - - -```ts -VecLike -``` - -The scale factor to apply to the shape. - - - - - - - - - -`options` - - (optional) - - - - -```ts -{ - initialBounds?: Box2d - scaleOrigin?: VecLike - scaleAxisRotation?: number - initialShape?: TLShape - initialPageTransform?: MatLike - dragHandle?: TLResizeHandle - mode?: TLResizeMode -} -``` - -Additional options. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [VecLike](/gen/primitives/VecLike-type), [Box2d](/gen/primitives/Box2d-class), [TLShape](/gen/tlschema/TLShape-type), [MatLike](/gen/primitives/MatLike-type), [TLResizeHandle](/gen/editor/TLResizeHandle-type), [TLResizeMode](/gen/editor/TLResizeMode-type) - ---- - -### `rotateShapesBy()` \{#Editor-rotateShapesBy-member-1} - -Public Method - -Rotate shapes by a delta in radians. - - - - -##### Example - - - - -```ts -editor.rotateShapesBy(['box1', 'box2'], Math.PI) -editor.rotateShapesBy(['box1', 'box2'], Math.PI / 2) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. - - - - - - - - - -`delta` - - - - -```ts -number -``` - -The delta in radians to apply to the selection rotation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `screenToPage()` \{#Editor-screenToPage-member-1} - -Public Method - -Convert a point in screen space to a point in page space. - - - - -##### Example - - - - -```ts -editor.screenToPage(100, 100) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The x coordinate of the point in screen space. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The y coordinate of the point in screen space. - - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`camera` - - (optional) - - - - -```ts -Vec2dModel -``` - -The camera to use. Defaults to the current camera. - - - - - - - - -##### Returns - - -```ts -{ - x: number - y: number - z: number -} -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface) - ---- - -### `select()` \{#Editor-select-member-1} - -Public Method - -Select one or more shapes. - - - - -##### Example - - - - -```ts -editor.select('id1') -editor.select('id1', 'id2') -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids to select. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `selectAll()` \{#Editor-selectAll-member-1} - -Public Method - -Select all direct children of the current page. - - - - -##### Example - - - - -```ts -editor.selectAll() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `selectNone()` \{#Editor-selectNone-member-1} - -Public Method - -Clear the selection. - - - - -##### Example - - - - -```ts -editor.selectNone() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `sendBackward()` \{#Editor-sendBackward-member-1} - -Public Method - -Send shapes backward in the page's object list. - - - - -##### Example - - - - -```ts -editor.sendBackward() -editor.sendBackward(['id1', 'id2']) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. Defaults to the ids of the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `sendToBack()` \{#Editor-sendToBack-member-1} - -Public Method - -Send shapes to the back of the page's object list. - - - - -##### Example - - - - -```ts -editor.sendToBack() -editor.sendToBack(['id1', 'id2']) -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to move. Defaults to the ids of the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setAnimationSpeed()` \{#Editor-setAnimationSpeed-member-1} - -Public Method - -Set the user's chosen animation speed. Set to 0.0 to disable animations. Set to 1.0 for full speed. - - -##### Parameters - - - - - - - -`animationSpeed` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setBrush()` \{#Editor-setBrush-member-1} - -Public Method - -Set the current brush. - - - - -##### Example - - - - -```ts -editor.setBrush({ x: 0, y: 0, w: 100, h: 100 }) -editor.setBrush() // Clears the brush -``` - - -##### Parameters - - - - - - - -`brush` - - (optional) - - - - -```ts -Box2dModel | null -``` - -The brush box model to set, or null for no brush model. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `setCamera()` \{#Editor-setCamera-member-1} - -Public Method - -Set the current camera. - - - - -##### Example - - - - -```ts -editor.setCamera(0, 0) -editor.setCamera(0, 0, 1) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The camera's x position. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The camera's y position. - - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - -The camera's z position. Defaults to the current zoom. - - - - - - - - - -`{ stopFollowing }` - - (optional) - - - - -```ts -TLViewportOptions -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLViewportOptions](/gen/editor/~TLViewportOptions-type) - ---- - -### `setCroppingId()` \{#Editor-setCroppingId-member-1} - -Public Method - -Set the current cropping shape's id. - - -##### Parameters - - - - - - - -`id` - - - - -```ts -null | TLShapeId -``` - -The id of the shape to crop or null to clear the cropping id. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setCurrentPageId()` \{#Editor-setCurrentPageId-member-1} - -Public Method - -Set the current page. - - - - -##### Example - - - - -```ts -editor.setCurrentPageId('page1') -``` - - -##### Parameters - - - - - - - -`pageId` - - - - -```ts -TLPageId -``` - -The id of the page to set as the current page. - - - - - - - - - -`{ stopFollowing }` - - (optional) - - - - -```ts -TLViewportOptions -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLViewportOptions](/gen/editor/~TLViewportOptions-type) - ---- - -### `setCursor()` \{#Editor-setCursor-member-1} - -Public Method - -Set the current cursor. - - - - -##### Example - - - - -```ts -editor.setCursor({ type: 'default' }) -editor.setCursor({ type: 'default', rotation: Math.PI / 2, color: 'red' }) -``` - - -##### Parameters - - - - - - - -`cursor` - - - - -```ts -Partial -``` - -A partial of the cursor object. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Partial](/gen/Partial-type), [TLCursor](/gen/tlschema/TLCursor-interface) - ---- - -### `setDarkMode()` \{#Editor-setDarkMode-member-1} - -Public Method - -Set whether the user has dark mode enabled. - - -##### Parameters - - - - - - - -`isDarkMode` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setDevicePixelRatio()` \{#Editor-setDevicePixelRatio-member-1} - -Public Method - -Set the window's device pixel ratio. This should usually only be set by the Canvas component. - - -```ts -editor.setDevicePixelRatio(2) -``` - - -##### Parameters - - - - - - - -`dpr` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setEditingId()` \{#Editor-setEditingId-member-1} - -Public Method - -Set the current editing id. - - -##### Parameters - - - - - - - -`id` - - - - -```ts -null | TLShapeId -``` - -The id of the shape to edit or null to clear the editing id. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setErasingIds()` \{#Editor-setErasingIds-member-1} - -Public Method - -Set the current erasing shapes. - - - - -##### Example - - - - -```ts -editor.setErasingIds(['box1', 'box2']) -editor.setErasingIds() // Clears the erasing set -``` - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of shapes to set as erasing. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setFocusLayer()` \{#Editor-setFocusLayer-member-1} - -Public Method - -Set the focus layer to the given shape id. - - -##### Parameters - - - - - - - -`next` - - - - -```ts -null | TLShapeId -``` - -The next focus layer id or null to reset the focus layer to the page - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setFocusMode()` \{#Editor-setFocusMode-member-1} - -Public Method - -Set whether the instance is in focus mode or not. - - -##### Parameters - - - - - - - -`isFocusMode` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setGridMode()` \{#Editor-setGridMode-member-1} - -Public Method - -Set whether the instance's grid is enabled. - - -##### Parameters - - - - - - - -`isGridMode` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setHintingIds()` \{#Editor-setHintingIds-member-1} - -Public Method - -Set the hinted shape ids. - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids to set as hinted. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setHoveredId()` \{#Editor-setHoveredId-member-1} - -Public Method - -Set the current hovered shape. - - - - -##### Example - - - - -```ts -editor.setHoveredId('box1') -editor.setHoveredId() // Clears the hovered shape. -``` - - -##### Parameters - - - - - - - -`id` - - (optional) - - - - -```ts -null | TLShapeId -``` - -The id of the page to set as the current page - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setLocale()` \{#Editor-setLocale-member-1} - -Public Method - -Update the user's locale. This affects which translations are used when rendering UI elements. - - - - -##### Example - - - - -```ts -editor.setLocale('fr') -``` - - -##### Parameters - - - - - - - -`locale` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `setOpacity()` \{#Editor-setOpacity-member-1} - -Public Method - -Set the current opacity. This will effect any selected shapes, or the next-created shape. - - - - -##### Example - - - - -```ts -editor.setOpacity(0.5) -editor.setOpacity(0.5, true) -``` - - -##### Parameters - - - - - - - -`opacity` - - - - -```ts -number -``` - -The opacity to set. Must be a number between 0 and 1 inclusive. - - - - - - - - - -`ephemeral` - - (optional) - - - - -```ts -boolean -``` - -Whether the opacity change is ephemeral. Ephemeral changes don't get added to the undo/redo stack. Defaults to false. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - -Whether the opacity change will be squashed into the existing history entry rather than creating a new one. Defaults to false. - - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setPageState()` \{#Editor-setPageState-member-1} - -Public Method - -Update a page state. - - - - -##### Example - - - - -```ts -editor.setPageState({ id: 'page1', editingId: 'shape:123' }) -editor.setPageState({ id: 'page1', editingId: 'shape:123' }, true) -``` - - -##### Parameters - - - - - - - -`partial` - - - - -```ts -Partial -``` - -The partial of the page state object containing the changes. - - - - - - - - - -`ephemeral` - - (optional) - - - - -```ts -boolean -``` - -Whether the command is ephemeral. - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Partial](/gen/Partial-type), [TLInstancePageState](/gen/tlschema/TLInstancePageState-interface) - ---- - -### `setPenMode()` \{#Editor-setPenMode-member-1} - -Public Method - -Set whether the editor is in pen mode or not. - - -##### Parameters - - - - - - - -`isPenMode` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setReadOnly()` \{#Editor-setReadOnly-member-1} - -Public Method - -Set whether the editor is in read-only mode or not. - - -##### Parameters - - - - - - - -`isReadOnly` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setScribble()` \{#Editor-setScribble-member-1} - -Public Method - -Set the current scribble. - - - - -##### Example - - - - -```ts -editor.setScribble(nextScribble) -editor.setScribble() // clears the scribble -``` - - -##### Parameters - - - - - - - -`scribble` - - (optional) - - - - -```ts -null | TLScribble -``` - -The new scribble object. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLScribble](/gen/tlschema/TLScribble-type) - ---- - -### `setSelectedIds()` \{#Editor-setSelectedIds-member-1} - -Public Method - -Select one or more shapes. - - - - -##### Example - - - - -```ts -editor.setSelectedIds(['id1']) -editor.setSelectedIds(['id1', 'id2']) -``` - - -##### Parameters - - - - - - - -`ids` - - - - -```ts -TLShapeId[] -``` - -The ids to select. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - -Whether the change should create a new history entry or combine with the previous (if the previous is the same type). - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `setSelectedTool()` \{#Editor-setSelectedTool-member-1} - -Public Method - -Set the selected tool. - - - - -##### Example - - - - -```ts -editor.setSelectedTool('hand') -editor.setSelectedTool('hand', { date: Date.now() }) -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - -The id of the tool to select. - - - - - - - - - -`info` - - (optional) - - - - -```ts -{} -``` - -Arbitrary data to pass along into the transition. - - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setSnapMode()` \{#Editor-setSnapMode-member-1} - -Public Method - -Set whether the user has "always snap" mode enabled. - - -##### Parameters - - - - - - - -`isSnapMode` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setStyle()` \{#Editor-setStyle-member-1} - -Public Method - -Set the current styles - - - - -##### Example - - - - -```ts -editor.setProp(DefaultColorStyle, 'red') -editor.setProp(DefaultColorStyle, 'red', true) -``` - - -##### Parameters - - - - - - - -`style` - - - - -```ts -StyleProp -``` - -The style to set. - - - - - - - - - -`value` - - - - -```ts -T -``` - -The value to set. - - - - - - - - - -`ephemeral` - - (optional) - - - - -```ts -boolean -``` - -Whether the style change is ephemeral. Ephemeral changes don't get added to the undo/redo stack. Defaults to false. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - -Whether the style change will be squashed into the existing history entry rather than creating a new one. Defaults to false. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `setToolLocked()` \{#Editor-setToolLocked-member-1} - -Public Method - -Set whether the instance has "tool lock" mode enabled. - - -##### Parameters - - - - - - - -`isToolLocked` - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setZoomBrush()` \{#Editor-setZoomBrush-member-1} - -Public Method - -Set the current zoom brush. - - - - -##### Example - - - - -```ts -editor.setZoomBrush({ x: 0, y: 0, w: 100, h: 100 }) -editor.setZoomBrush() // Clears the zoom -``` - - -##### Parameters - - - - - - - -`zoomBrush` - - (optional) - - - - -```ts -Box2dModel | null -``` - -The zoom box model to set, or null for no zoom model. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `slideCamera()` \{#Editor-slideCamera-member-1} - -Public Method - -Slide the camera in a certain direction. - - -##### Parameters - - - - - - - -`opts` - - (optional) - - - - -```ts -{ - speed: number - direction: Vec2d - friction: number - speedThreshold?: number | undefined -} -``` - -Options for the slide - - - - - - - - -##### Returns - - -```ts -this | undefined -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `stackShapes()` \{#Editor-stackShapes-member-1} - -Public Method - -Stack shape. - - - - -##### Example - - - - -```ts -editor.stackShapes('horizontal') -editor.stackShapes('horizontal', ['box1', 'box2']) -editor.stackShapes('horizontal', ['box1', 'box2'], 20) -``` - - -##### Parameters - - - - - - - -`operation` - - - - -```ts -'horizontal' | 'vertical' -``` - -Whether to stack horizontally or vertically. - - - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to stack. Defaults to selected shapes. - - - - - - - - - -`gap` - - (optional) - - - - -```ts -number -``` - -A specific gap to use when stacking. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `startFollowingUser()` \{#Editor-startFollowingUser-member-1} - -Public Method - -Start viewport-following a user. - - -##### Parameters - - - - - - - -`userId` - - - - -```ts -string -``` - -The id of the user to follow. - - - - - - - - -##### Returns - - -```ts -this | undefined -``` - ---- - -### `stopCameraAnimation()` \{#Editor-stopCameraAnimation-member-1} - -Public Method - -Stop the current camera animation, if any. - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `stopFollowingUser()` \{#Editor-stopFollowingUser-member-1} - -Public Method - -Stop viewport-following a user. - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `stretchShapes()` \{#Editor-stretchShapes-member-1} - -Public Method - -Stretch shape sizes and positions to fill their common bounding box. - - - - -##### Example - - - - -```ts -editor.stretchShapes('horizontal') -editor.stretchShapes('horizontal', ['box1', 'box2']) -``` - - -##### Parameters - - - - - - - -`operation` - - - - -```ts -'horizontal' | 'vertical' -``` - -Whether to stretch shapes horizontally or vertically. - - - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to stretch. Defaults to selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `toggleLock()` \{#Editor-toggleLock-member-1} - -Public Method - -Toggle the lock state of one or more shapes. If there is a mix of locked and unlocked shapes, all shapes will be locked. - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -The ids of the shapes to toggle. Defaults to selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `undo()` \{#Editor-undo-member-1} - -Public Method - -Undo to the last mark. - - - - -##### Example - - - - -```ts -editor.undo() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -HistoryManager -``` - -##### References - -[HistoryManager](/gen/editor/~HistoryManager-class) - ---- - -### `ungroupShapes()` \{#Editor-ungroupShapes-member-1} - -Public Method - -Ungroup some shapes. - - -##### Parameters - - - - - - - -`ids` - - (optional) - - - - -```ts -TLShapeId[] -``` - -Ids of the shapes to ungroup. Defaults to the selected shapes. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `updateAssets()` \{#Editor-updateAssets-member-1} - -Public Method - -Update one or more assets. - - - - -##### Example - - - - -```ts -editor.updateAssets([{ id: 'asset1', name: 'New name' }]) -``` - - -##### Parameters - - - - - - - -`assets` - - - - -```ts -TLAssetPartial[] -``` - -The assets to update. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAssetPartial](/gen/tlschema/TLAssetPartial-type) - ---- - -### `updateDocumentSettings()` \{#Editor-updateDocumentSettings-member-1} - -Public Method - -Update the global document settings that apply to all users. - - -##### Parameters - - - - - - - -`settings` - - - - -```ts -Partial -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Partial](/gen/Partial-type), [TLDocument](/gen/tlschema/TLDocument-interface) - ---- - -### `updateInstanceState()` \{#Editor-updateInstanceState-member-1} - -Public Method - -Update the instance's state. - - -##### Parameters - - - - - - - -`partial` - - - - -```ts -Partial> -``` - -A partial object to update the instance state with. - - - - - - - - - -`ephemeral` - - (optional) - - - - -```ts -boolean -``` - -Whether the change is ephemeral. Ephemeral changes don't get added to the undo/redo stack. Defaults to false. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - -Whether the change will be squashed into the existing history entry rather than creating a new one. Defaults to false. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Partial](/gen/Partial-type), [Omit](/gen/Omit-type), [TLInstance](/gen/tlschema/TLInstance-interface) - ---- - -### `updatePage()` \{#Editor-updatePage-member-1} - -Public Method - -Update a page. - - - - -##### Example - - - - -```ts -editor.updatePage({ id: 'page2', name: 'Page 2' }) -``` - - -##### Parameters - - - - - - - -`partial` - - - - -```ts -RequiredKeys -``` - -The partial of the shape to update. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[RequiredKeys](/gen/editor/RequiredKeys-type), [TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `updateShapes()` \{#Editor-updateShapes-member-1} - -Public Method - -Update shapes using partials of each shape. - - - - -##### Example - - - - -```ts -editor.updateShapes([{ id: 'box1', type: 'geo', props: { w: 100, h: 100 } }]) -``` - - -##### Parameters - - - - - - - -`partials` - - - - -```ts -(null | TLShapePartial | undefined)[] -``` - -The shape partials to update. - - - - - - - - - -`squashing` - - (optional) - - - - -```ts -boolean -``` - -Whether the change is ephemeral. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `updateViewportScreenBounds()` \{#Editor-updateViewportScreenBounds-member-1} - -Public Method - -Update the viewport. The viewport will measure the size and screen position of its container element. This should be done whenever the container's position on the screen changes. - - - - -##### Example - - - - -```ts -editor.updateViewportScreenBounds() -editor.updateViewportScreenBounds(true) -``` - - -##### Parameters - - - - - - - -`center` - - (optional) - - - - -```ts -boolean -``` - -(optional) Whether to preserve the viewport page center as the viewport changes. - - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `visitDescendants()` \{#Editor-visitDescendants-member-1} - -Public Method - -Run a visitor function for all descendants of a shape. - - - - -##### Example - - - - -```ts -editor.visitDescendants('frame1', myCallback) -``` - - -##### Parameters - - - - - - - -`parentId` - - - - -```ts -TLParentId -``` - -The id of the parent shape. - - - - - - - - - -`visitor` - - - - -```ts -(id: TLShapeId) => false | void -``` - -The visitor function. - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `zoomIn()` \{#Editor-zoomIn-member-1} - -Public Method - -Zoom the camera in. - - - - -##### Example - - - - -```ts -editor.zoomIn() -editor.zoomIn(editor.viewportScreenCenter, { duration: 120 }) -editor.zoomIn(editor.inputs.currentScreenPoint, { duration: 120 }) -``` - - -##### Parameters - - - - - - - -`point` - - (optional) - - - - -```ts -Vec2d -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `zoomOut()` \{#Editor-zoomOut-member-1} - -Public Method - -Zoom the camera out. - - - - -##### Example - - - - -```ts -editor.zoomOut() -editor.zoomOut(editor.viewportScreenCenter, { duration: 120 }) -editor.zoomOut(editor.inputs.currentScreenPoint, { duration: 120 }) -``` - - -##### Parameters - - - - - - - -`point` - - (optional) - - - - -```ts -Vec2d -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `zoomToBounds()` \{#Editor-zoomToBounds-member-1} - -Public Method - -Zoom the camera to fit a bounding box (in page space). - - - - -##### Example - - - - -```ts -editor.zoomToBounds(0, 0, 100, 100) -``` - - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - -The bounding box's x position. - - - - - - - - - -`y` - - - - -```ts -number -``` - -The bounding box's y position. - - - - - - - - - -`width` - - - - -```ts -number -``` - -The bounding box's width. - - - - - - - - - -`height` - - - - -```ts -number -``` - -The bounding box's height. - - - - - - - - - -`targetZoom` - - (optional) - - - - -```ts -number -``` - -The desired zoom level. Defaults to 0.1. - - - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `zoomToContent()` \{#Editor-zoomToContent-member-1} - -Public Method - -Move the camera to the nearest content. - - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `zoomToFit()` \{#Editor-zoomToFit-member-1} - -Public Method - -Zoom the camera to fit the current page's content in the viewport. - - - - -##### Example - - - - -```ts -editor.zoomToFit() -``` - - -##### Parameters - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - -### `zoomToSelection()` \{#Editor-zoomToSelection-member-1} - -Public Method - -Zoom the camera to fit the current selection in the viewport. - - - - -##### Example - - - - -```ts -editor.zoomToSelection() -``` - - -##### Parameters - - - - - - - -`opts` - - (optional) - - - - -```ts -TLAnimationOptions -``` - -The options for an animation. - - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[TLAnimationOptions](/gen/editor/TLAnimationOptions-type) - ---- - diff --git a/docs/gen/EmbedDefinition-type.mdx b/docs/gen/EmbedDefinition-type.mdx deleted file mode 100644 index b3c591c42..000000000 --- a/docs/gen/EmbedDefinition-type.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: EmbedDefinition -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 25 ----Public TypeAlias - - - - -##### Signature - - -```ts -type EmbedDefinition = { - readonly type: string - readonly title: string - readonly hostnames: readonly string[] - readonly minWidth?: number - readonly minHeight?: number - readonly width: number - readonly height: number - readonly doesResize: boolean - readonly canUnmount: boolean - readonly isAspectRatioLocked?: boolean - readonly overridePermissions?: TLEmbedShapePermissions - readonly instructionLink?: string - readonly backgroundColor?: string - readonly overrideOutlineRadius?: number - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined -} -``` - -##### References - -[TLEmbedShapePermissions](/gen/tlschema/TLEmbedShapePermissions-type) - diff --git a/docs/gen/EmbedShape-var.mdx b/docs/gen/EmbedShape-var.mdx deleted file mode 100644 index 859c4d06c..000000000 --- a/docs/gen/EmbedShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: EmbedShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 29 ----Public Readonly Variable - - - - -##### Signature - - -```ts -EmbedShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLEmbedShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - diff --git a/docs/gen/EmbedShapeUtil-class.mdx b/docs/gen/EmbedShapeUtil-class.mdx deleted file mode 100644 index 042372945..000000000 --- a/docs/gen/EmbedShapeUtil-class.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -title: EmbedShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 30 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canEdit](#EmbedShapeUtil-canEdit-member) - - [canResize](#EmbedShapeUtil-canResize-member) - - [canUnmount](#EmbedShapeUtil-canUnmount-member) - - [hideSelectionBoundsBg](#EmbedShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#EmbedShapeUtil-hideSelectionBoundsFg-member) - - [isAspectRatioLocked](#EmbedShapeUtil-isAspectRatioLocked-member) - - [onResize](#EmbedShapeUtil-onResize-member) - - [type](#EmbedShapeUtil-type-member) -- [Methods](#methods) - - [component](#EmbedShapeUtil-component-member-1) - - [getDefaultProps](#EmbedShapeUtil-getDefaultProps-member-1) - - [indicator](#EmbedShapeUtil-indicator-member-1) -
- - - - -##### Signature - - -```ts -class EmbedShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -## Properties - -### `canEdit` \{#EmbedShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `canResize` \{#EmbedShapeUtil-canResize-member} - -Public Property - -##### Signature - - -```ts -canResize: (shape: TLEmbedShape) => boolean -``` - -##### References - -[TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `canUnmount` \{#EmbedShapeUtil-canUnmount-member} - -Public Property - -##### Signature - - -```ts -canUnmount: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `hideSelectionBoundsBg` \{#EmbedShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `hideSelectionBoundsFg` \{#EmbedShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `isAspectRatioLocked` \{#EmbedShapeUtil-isAspectRatioLocked-member} - -Public Property - -##### Signature - - -```ts -isAspectRatioLocked: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `onResize` \{#EmbedShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `type` \{#EmbedShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'embed' -``` - ---- - -## Methods - -### `component()` \{#EmbedShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLEmbedShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getDefaultProps()` \{#EmbedShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLEmbedShape['props'] -``` - -##### References - -[TLEmbedShape](/gen/tlschema/TLEmbedShape-type) - ---- - -### `indicator()` \{#EmbedShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLEmbedShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - diff --git a/docs/gen/EnumStyleProp-class.mdx b/docs/gen/EnumStyleProp-class.mdx deleted file mode 100644 index 5e90f7be8..000000000 --- a/docs/gen/EnumStyleProp-class.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: EnumStyleProp -status: published -category: tlschema -group: Class -author: api -date: 06/23/2023 -order: 28 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [values](#EnumStyleProp-values-member) -
- - - -##### Signature - - -```ts -class EnumStyleProp extends StyleProp {} -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class) - ---- - -## Properties - -### `values` \{#EnumStyleProp-values-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly values: readonly T[] -``` - ---- - diff --git a/docs/gen/ErrorBoundary-class.mdx b/docs/gen/ErrorBoundary-class.mdx deleted file mode 100644 index 8c92bcac6..000000000 --- a/docs/gen/ErrorBoundary-class.mdx +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: ErrorBoundary -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 31 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [state](#ErrorBoundary-state-member) -- [Methods](#methods) - - [componentDidCatch](#ErrorBoundary-componentDidCatch-member-1) - - [getDerivedStateFromError](#ErrorBoundary-getDerivedStateFromError-member-1) - - [render](#ErrorBoundary-render-member-1) -
- - - - -##### Signature - - -```ts -class ErrorBoundary extends React.Component< - React.PropsWithRef>, - TLErrorBoundaryState -> {} -``` - -##### References - -[React.Component](/gen/@types/react-React-Component-class), [React.PropsWithRef](/gen/@types/react-React-PropsWithRef-type), [React.PropsWithChildren](/gen/@types/react-React-PropsWithChildren-type), [TLErrorBoundaryProps](/gen/editor/TLErrorBoundaryProps-interface), [TLErrorBoundaryState](/gen/editor/~TLErrorBoundaryState-type) - ---- - -## Properties - -### `state` \{#ErrorBoundary-state-member} - -Public Property - -##### Signature - - -```ts -state: TLErrorBoundaryState -``` - -##### References - -[TLErrorBoundaryState](/gen/editor/~TLErrorBoundaryState-type) - ---- - -## Methods - -### `componentDidCatch()` \{#ErrorBoundary-componentDidCatch-member-1} - -Public Method - -##### Parameters - - - - - - - -`error` - - - - -```ts -unknown -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `getDerivedStateFromError()` \{#ErrorBoundary-getDerivedStateFromError-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`error` - - - - -```ts -Error -``` - - - - - - - -##### Returns - - -```ts -{ - error: Error -} -``` - -##### References - -[Error](/gen/Error-interface) - ---- - -### `render()` \{#ErrorBoundary-render-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts - | boolean - | JSX.Element - | null - | number - | React.ReactFragment - | string - | undefined -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface), [React.ReactFragment](/gen/@types/react-React-ReactFragment-type) - ---- - diff --git a/docs/gen/ErrorScreen-function-1.mdx b/docs/gen/ErrorScreen-function-1.mdx deleted file mode 100644 index d15d9d9ba..000000000 --- a/docs/gen/ErrorScreen-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ErrorScreen -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 32 ----Public Function - - - - -##### Parameters - - - - - - - -`{ children }` - - - - -```ts -{ - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/FrameShape-var.mdx b/docs/gen/FrameShape-var.mdx deleted file mode 100644 index add3c4978..000000000 --- a/docs/gen/FrameShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: FrameShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 35 ----Public Readonly Variable - - - - -##### Signature - - -```ts -FrameShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLFrameShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type) - diff --git a/docs/gen/FrameShapeUtil-class.mdx b/docs/gen/FrameShapeUtil-class.mdx deleted file mode 100644 index c161d2c07..000000000 --- a/docs/gen/FrameShapeUtil-class.mdx +++ /dev/null @@ -1,373 +0,0 @@ ---- -title: FrameShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 36 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canBind](#FrameShapeUtil-canBind-member) - - [canDropShapes](#FrameShapeUtil-canDropShapes-member) - - [canEdit](#FrameShapeUtil-canEdit-member) - - [canReceiveNewChildrenOfType](#FrameShapeUtil-canReceiveNewChildrenOfType-member) - - [onDragShapesOut](#FrameShapeUtil-onDragShapesOut-member) - - [onDragShapesOver](#FrameShapeUtil-onDragShapesOver-member) - - [onResizeEnd](#FrameShapeUtil-onResizeEnd-member) - - [type](#FrameShapeUtil-type-member) -- [Methods](#methods) - - [component](#FrameShapeUtil-component-member-1) - - [getDefaultProps](#FrameShapeUtil-getDefaultProps-member-1) - - [indicator](#FrameShapeUtil-indicator-member-1) - - [providesBackgroundForChildren](#FrameShapeUtil-providesBackgroundForChildren-member-1) - - [toSvg](#FrameShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class FrameShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLFrameShape](/gen/tlschema/TLFrameShape-type) - ---- - -## Properties - -### `canBind` \{#FrameShapeUtil-canBind-member} - -Public Property - -##### Signature - - -```ts -canBind: () => boolean -``` - ---- - -### `canDropShapes` \{#FrameShapeUtil-canDropShapes-member} - -Public Property - -##### Signature - - -```ts -canDropShapes: (shape: TLFrameShape, _shapes: TLShape[]) => boolean -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `canEdit` \{#FrameShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `canReceiveNewChildrenOfType` \{#FrameShapeUtil-canReceiveNewChildrenOfType-member} - -Public Property - -##### Signature - - -```ts -canReceiveNewChildrenOfType: ( - shape: TLShape, - _type: TLShape['type'] -) => boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `onDragShapesOut` \{#FrameShapeUtil-onDragShapesOut-member} - -Public Property - -##### Signature - - -```ts -onDragShapesOut: (_shape: TLFrameShape, shapes: TLShape[]) => void -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `onDragShapesOver` \{#FrameShapeUtil-onDragShapesOver-member} - -Public Property - -##### Signature - - -```ts -onDragShapesOver: ( - frame: TLFrameShape, - shapes: TLShape[] -) => { - shouldHint: boolean -} -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type) - ---- - -### `onResizeEnd` \{#FrameShapeUtil-onResizeEnd-member} - -Public Property - -##### Signature - - -```ts -onResizeEnd: TLOnResizeEndHandler -``` - -##### References - -[TLOnResizeEndHandler](/gen/editor/TLOnResizeEndHandler-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type) - ---- - -### `type` \{#FrameShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'frame' -``` - ---- - -## Methods - -### `component()` \{#FrameShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLFrameShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getDefaultProps()` \{#FrameShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLFrameShape['props'] -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type) - ---- - -### `indicator()` \{#FrameShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLFrameShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `providesBackgroundForChildren()` \{#FrameShapeUtil-providesBackgroundForChildren-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -boolean -``` - ---- - -### `toSvg()` \{#FrameShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLFrameShape -``` - - - - - - - - -`font` - - - - -```ts -string -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -Promise | SVGElement -``` - -##### References - -[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [Promise](/gen/Promise-interface), [SVGElement](/gen/SVGElement-interface) - ---- - diff --git a/docs/gen/GRID_STEPS-var.mdx b/docs/gen/GRID_STEPS-var.mdx deleted file mode 100644 index 491675f88..000000000 --- a/docs/gen/GRID_STEPS-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: GRID_STEPS -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 59 ----Public Readonly Variable - - - - -##### Signature - - -```ts -GRID_STEPS: { - min: number - mid: number - step: number -}[] -``` - diff --git a/docs/gen/GeoShape-var.mdx b/docs/gen/GeoShape-var.mdx deleted file mode 100644 index 0c8067603..000000000 --- a/docs/gen/GeoShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: GeoShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 37 ----Public Readonly Variable - - - - -##### Signature - - -```ts -GeoShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLGeoShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type) - diff --git a/docs/gen/GeoShapeGeoStyle-var.mdx b/docs/gen/GeoShapeGeoStyle-var.mdx deleted file mode 100644 index 5989da22c..000000000 --- a/docs/gen/GeoShapeGeoStyle-var.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: GeoShapeGeoStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 30 ----Public Readonly Variable - - - - -##### Signature - - -```ts -GeoShapeGeoStyle: import('../styles/StyleProp').EnumStyleProp< - | 'arrow-down' - | 'arrow-left' - | 'arrow-right' - | 'arrow-up' - | 'check-box' - | 'diamond' - | 'ellipse' - | 'hexagon' - | 'octagon' - | 'oval' - | 'pentagon' - | 'rectangle' - | 'rhombus-2' - | 'rhombus' - | 'star' - | 'trapezoid' - | 'triangle' - | 'x-box' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/GeoShapeUtil-class.mdx b/docs/gen/GeoShapeUtil-class.mdx deleted file mode 100644 index ea3103b6a..000000000 --- a/docs/gen/GeoShapeUtil-class.mdx +++ /dev/null @@ -1,773 +0,0 @@ ---- -title: GeoShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 38 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canEdit](#GeoShapeUtil-canEdit-member) - - [onBeforeCreate](#GeoShapeUtil-onBeforeCreate-member) - - [onBeforeUpdate](#GeoShapeUtil-onBeforeUpdate-member) - - [onDoubleClick](#GeoShapeUtil-onDoubleClick-member) - - [onEditEnd](#GeoShapeUtil-onEditEnd-member) - - [onResize](#GeoShapeUtil-onResize-member) - - [type](#GeoShapeUtil-type-member) -- [Methods](#methods) - - [component](#GeoShapeUtil-component-member-1) - - [getBounds](#GeoShapeUtil-getBounds-member-1) - - [getCenter](#GeoShapeUtil-getCenter-member-1) - - [getDefaultProps](#GeoShapeUtil-getDefaultProps-member-1) - - [getOutline](#GeoShapeUtil-getOutline-member-1) - - [hitTestLineSegment](#GeoShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#GeoShapeUtil-hitTestPoint-member-1) - - [indicator](#GeoShapeUtil-indicator-member-1) - - [toSvg](#GeoShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class GeoShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLGeoShape](/gen/tlschema/TLGeoShape-type) - ---- - -## Properties - -### `canEdit` \{#GeoShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `onBeforeCreate` \{#GeoShapeUtil-onBeforeCreate-member} - -Public Property - -##### Signature - - -```ts -onBeforeCreate: (shape: TLGeoShape) => - | { - props: { - growY: number - geo: - | 'arrow-down' - | 'arrow-left' - | 'arrow-right' - | 'arrow-up' - | 'check-box' - | 'diamond' - | 'ellipse' - | 'hexagon' - | 'octagon' - | 'oval' - | 'pentagon' - | 'rectangle' - | 'rhombus-2' - | 'rhombus' - | 'star' - | 'trapezoid' - | 'triangle' - | 'x-box' - labelColor: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - fill: 'none' | 'pattern' | 'semi' | 'solid' - dash: 'dashed' | 'dotted' | 'draw' | 'solid' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - verticalAlign: 'end' | 'middle' | 'start' - url: string - w: number - h: number - text: string - } - type: 'geo' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onBeforeUpdate` \{#GeoShapeUtil-onBeforeUpdate-member} - -Public Property - -##### Signature - - -```ts -onBeforeUpdate: ( - prev: TLGeoShape, - next: TLGeoShape -) => - | { - props: { - growY: number - geo: - | 'arrow-down' - | 'arrow-left' - | 'arrow-right' - | 'arrow-up' - | 'check-box' - | 'diamond' - | 'ellipse' - | 'hexagon' - | 'octagon' - | 'oval' - | 'pentagon' - | 'rectangle' - | 'rhombus-2' - | 'rhombus' - | 'star' - | 'trapezoid' - | 'triangle' - | 'x-box' - labelColor: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - fill: 'none' | 'pattern' | 'semi' | 'solid' - dash: 'dashed' | 'dotted' | 'draw' | 'solid' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - verticalAlign: 'end' | 'middle' | 'start' - url: string - w: number - h: number - text: string - } - type: 'geo' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onDoubleClick` \{#GeoShapeUtil-onDoubleClick-member} - -Public Property - -##### Signature - - -```ts -onDoubleClick: (shape: TLGeoShape) => - | { - props: { - geo: 'check-box' - } - type: 'geo' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | { - props: { - geo: 'rectangle' - } - type: 'geo' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onEditEnd` \{#GeoShapeUtil-onEditEnd-member} - -Public Property - -##### Signature - - -```ts -onEditEnd: TLOnEditEndHandler -``` - -##### References - -[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type) - ---- - -### `onResize` \{#GeoShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type) - ---- - -### `type` \{#GeoShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'geo' -``` - ---- - -## Methods - -### `component()` \{#GeoShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getBounds()` \{#GeoShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#GeoShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#GeoShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLGeoShape['props'] -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type) - ---- - -### `getOutline()` \{#GeoShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#GeoShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#GeoShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `indicator()` \{#GeoShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#GeoShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGeoShape -``` - - - - - - - - -`font` - - - - -```ts -string -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGElement -``` - -##### References - -[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGElement](/gen/SVGElement-interface) - ---- - diff --git a/docs/gen/GroupShape-var.mdx b/docs/gen/GroupShape-var.mdx deleted file mode 100644 index cf6011000..000000000 --- a/docs/gen/GroupShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: GroupShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 60 ----Public Readonly Variable - - - - -##### Signature - - -```ts -GroupShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLGroupShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type) - diff --git a/docs/gen/GroupShapeUtil-class.mdx b/docs/gen/GroupShapeUtil-class.mdx deleted file mode 100644 index e5bf78fb9..000000000 --- a/docs/gen/GroupShapeUtil-class.mdx +++ /dev/null @@ -1,352 +0,0 @@ ---- -title: GroupShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 61 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canBind](#GroupShapeUtil-canBind-member) - - [hideSelectionBoundsBg](#GroupShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#GroupShapeUtil-hideSelectionBoundsFg-member) - - [onChildrenChange](#GroupShapeUtil-onChildrenChange-member) - - [type](#GroupShapeUtil-type-member) - - [type](#GroupShapeUtil-type-member) -- [Methods](#methods) - - [component](#GroupShapeUtil-component-member-1) - - [getBounds](#GroupShapeUtil-getBounds-member-1) - - [getCenter](#GroupShapeUtil-getCenter-member-1) - - [getDefaultProps](#GroupShapeUtil-getDefaultProps-member-1) - - [getOutline](#GroupShapeUtil-getOutline-member-1) - - [indicator](#GroupShapeUtil-indicator-member-1) -
- - - - -##### Signature - - -```ts -class GroupShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLGroupShape](/gen/tlschema/TLGroupShape-type) - ---- - -## Properties - -### `canBind` \{#GroupShapeUtil-canBind-member} - -Public Property - -##### Signature - - -```ts -canBind: () => boolean -``` - ---- - -### `hideSelectionBoundsBg` \{#GroupShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: () => boolean -``` - ---- - -### `hideSelectionBoundsFg` \{#GroupShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: () => boolean -``` - ---- - -### `onChildrenChange` \{#GroupShapeUtil-onChildrenChange-member} - -Public Property - -##### Signature - - -```ts -onChildrenChange: TLOnChildrenChangeHandler -``` - -##### References - -[TLOnChildrenChangeHandler](/gen/editor/TLOnChildrenChangeHandler-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type) - ---- - -### `type` \{#GroupShapeUtil-type-member} - -Public Property - -##### Signature - - -```ts -type: 'group' -``` - ---- - -### `type` \{#GroupShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'group' -``` - ---- - -## Methods - -### `component()` \{#GroupShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGroupShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element | null -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getBounds()` \{#GroupShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGroupShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#GroupShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGroupShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#GroupShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLGroupShape['props'] -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type) - ---- - -### `getOutline()` \{#GroupShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGroupShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `indicator()` \{#GroupShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLGroupShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLGroupShape](/gen/tlschema/TLGroupShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - diff --git a/docs/gen/HTMLContainer-function-1.mdx b/docs/gen/HTMLContainer-function-1.mdx deleted file mode 100644 index 47d8e3025..000000000 --- a/docs/gen/HTMLContainer-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: HTMLContainer -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 66 ----Public Function - - - - -##### Parameters - - - - - - - -`{ children, className, ...rest }` - - - - -```ts -HTMLContainerProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[HTMLContainerProps](/gen/editor/HTMLContainerProps-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/HTMLContainerProps-type.mdx b/docs/gen/HTMLContainerProps-type.mdx deleted file mode 100644 index e3c8dac30..000000000 --- a/docs/gen/HTMLContainerProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: HTMLContainerProps -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 67 ----Public TypeAlias - - - - -##### Signature - - -```ts -type HTMLContainerProps = React.HTMLAttributes -``` - -##### References - -[React.HTMLAttributes](/gen/@types/react-React-HTMLAttributes-interface), [HTMLDivElement](/gen/HTMLDivElement-interface) - diff --git a/docs/gen/HighlightShape-var.mdx b/docs/gen/HighlightShape-var.mdx deleted file mode 100644 index 55312b1c8..000000000 --- a/docs/gen/HighlightShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: HighlightShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 64 ----Public Readonly Variable - - - - -##### Signature - - -```ts -HighlightShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLHighlightShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - diff --git a/docs/gen/HighlightShapeUtil-class.mdx b/docs/gen/HighlightShapeUtil-class.mdx deleted file mode 100644 index d4c7520fd..000000000 --- a/docs/gen/HighlightShapeUtil-class.mdx +++ /dev/null @@ -1,726 +0,0 @@ ---- -title: HighlightShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 65 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [hideResizeHandles](#HighlightShapeUtil-hideResizeHandles-member) - - [hideRotateHandle](#HighlightShapeUtil-hideRotateHandle-member) - - [hideSelectionBoundsBg](#HighlightShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#HighlightShapeUtil-hideSelectionBoundsFg-member) - - [onResize](#HighlightShapeUtil-onResize-member) - - [type](#HighlightShapeUtil-type-member) -- [Methods](#methods) - - [backgroundComponent](#HighlightShapeUtil-backgroundComponent-member-1) - - [component](#HighlightShapeUtil-component-member-1) - - [expandSelectionOutlinePx](#HighlightShapeUtil-expandSelectionOutlinePx-member-1) - - [getBounds](#HighlightShapeUtil-getBounds-member-1) - - [getCenter](#HighlightShapeUtil-getCenter-member-1) - - [getDefaultProps](#HighlightShapeUtil-getDefaultProps-member-1) - - [getOutline](#HighlightShapeUtil-getOutline-member-1) - - [hitTestLineSegment](#HighlightShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#HighlightShapeUtil-hitTestPoint-member-1) - - [indicator](#HighlightShapeUtil-indicator-member-1) - - [toBackgroundSvg](#HighlightShapeUtil-toBackgroundSvg-member-1) - - [toSvg](#HighlightShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class HighlightShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -## Properties - -### `hideResizeHandles` \{#HighlightShapeUtil-hideResizeHandles-member} - -Public Property - -##### Signature - - -```ts -hideResizeHandles: (shape: TLHighlightShape) => boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `hideRotateHandle` \{#HighlightShapeUtil-hideRotateHandle-member} - -Public Property - -##### Signature - - -```ts -hideRotateHandle: (shape: TLHighlightShape) => boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `hideSelectionBoundsBg` \{#HighlightShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: (shape: TLHighlightShape) => boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `hideSelectionBoundsFg` \{#HighlightShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: (shape: TLHighlightShape) => boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `onResize` \{#HighlightShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `type` \{#HighlightShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'highlight' -``` - ---- - -## Methods - -### `backgroundComponent()` \{#HighlightShapeUtil-backgroundComponent-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `component()` \{#HighlightShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `expandSelectionOutlinePx()` \{#HighlightShapeUtil-expandSelectionOutlinePx-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `getBounds()` \{#HighlightShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#HighlightShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#HighlightShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLHighlightShape['props'] -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type) - ---- - -### `getOutline()` \{#HighlightShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#HighlightShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#HighlightShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `indicator()` \{#HighlightShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toBackgroundSvg()` \{#HighlightShapeUtil-toBackgroundSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - - -`font` - - - - -```ts -string | undefined -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGPathElement -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGPathElement](/gen/SVGPathElement-interface) - ---- - -### `toSvg()` \{#HighlightShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLHighlightShape -``` - - - - - - - - -`_font` - - - - -```ts -string | undefined -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGPathElement -``` - -##### References - -[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGPathElement](/gen/SVGPathElement-interface) - ---- - diff --git a/docs/gen/HistoryEntry-type.mdx b/docs/gen/HistoryEntry-type.mdx deleted file mode 100644 index 6fe43be36..000000000 --- a/docs/gen/HistoryEntry-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: HistoryEntry -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 11 ----Public TypeAlias - -An entry containing changes that originated either by user actions or remote changes. - - -##### Signature - - -```ts -type HistoryEntry = { - changes: RecordsDiff - source: ChangeSource -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [RecordsDiff](/gen/store/RecordsDiff-type), [ChangeSource](/gen/store/~ChangeSource-type) - diff --git a/docs/gen/INDENT-var.mdx b/docs/gen/INDENT-var.mdx deleted file mode 100644 index 5759218c1..000000000 --- a/docs/gen/INDENT-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: INDENT -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 70 ----Public Readonly Variable - - - - -##### Signature - - -```ts -INDENT = ' ' -``` - diff --git a/docs/gen/Icon-var.mdx b/docs/gen/Icon-var.mdx deleted file mode 100644 index 97c096542..000000000 --- a/docs/gen/Icon-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Icon -status: published -category: ui -group: Variable -author: api -date: 06/23/2023 -order: 7 ----Public Readonly Variable - - - - -##### Signature - - -```ts -Icon: import('react').NamedExoticComponent -``` - -##### References - -[NamedExoticComponent](/gen/@types/react-React-NamedExoticComponent-interface), [TLUiIconProps](/gen/ui/TLUiIconProps-interface) - diff --git a/docs/gen/IdOf-type.mdx b/docs/gen/IdOf-type.mdx deleted file mode 100644 index a191d4ec3..000000000 --- a/docs/gen/IdOf-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: IdOf -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 12 ----Public TypeAlias - - - - -##### Signature - - -```ts -type IdOf = R['id'] -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - diff --git a/docs/gen/ImageShape-var.mdx b/docs/gen/ImageShape-var.mdx deleted file mode 100644 index a4790b914..000000000 --- a/docs/gen/ImageShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ImageShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 68 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ImageShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLImageShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLImageShape](/gen/tlschema/TLImageShape-type) - diff --git a/docs/gen/ImageShapeUtil-class.mdx b/docs/gen/ImageShapeUtil-class.mdx deleted file mode 100644 index 96dab4053..000000000 --- a/docs/gen/ImageShapeUtil-class.mdx +++ /dev/null @@ -1,260 +0,0 @@ ---- -title: ImageShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 69 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canCrop](#ImageShapeUtil-canCrop-member) - - [isAspectRatioLocked](#ImageShapeUtil-isAspectRatioLocked-member) - - [onDoubleClick](#ImageShapeUtil-onDoubleClick-member) - - [onDoubleClickEdge](#ImageShapeUtil-onDoubleClickEdge-member) - - [type](#ImageShapeUtil-type-member) -- [Methods](#methods) - - [component](#ImageShapeUtil-component-member-1) - - [getDefaultProps](#ImageShapeUtil-getDefaultProps-member-1) - - [indicator](#ImageShapeUtil-indicator-member-1) - - [toSvg](#ImageShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class ImageShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLImageShape](/gen/tlschema/TLImageShape-type) - ---- - -## Properties - -### `canCrop` \{#ImageShapeUtil-canCrop-member} - -Public Property - -##### Signature - - -```ts -canCrop: () => boolean -``` - ---- - -### `isAspectRatioLocked` \{#ImageShapeUtil-isAspectRatioLocked-member} - -Public Property - -##### Signature - - -```ts -isAspectRatioLocked: () => boolean -``` - ---- - -### `onDoubleClick` \{#ImageShapeUtil-onDoubleClick-member} - -Public Property - -##### Signature - - -```ts -onDoubleClick: (shape: TLImageShape) => void -``` - -##### References - -[TLImageShape](/gen/tlschema/TLImageShape-type) - ---- - -### `onDoubleClickEdge` \{#ImageShapeUtil-onDoubleClickEdge-member} - -Public Property - -##### Signature - - -```ts -onDoubleClickEdge: TLOnDoubleClickHandler -``` - -##### References - -[TLOnDoubleClickHandler](/gen/editor/TLOnDoubleClickHandler-type), [TLImageShape](/gen/tlschema/TLImageShape-type) - ---- - -### `type` \{#ImageShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'image' -``` - ---- - -## Methods - -### `component()` \{#ImageShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLImageShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLImageShape](/gen/tlschema/TLImageShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getDefaultProps()` \{#ImageShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLImageShape['props'] -``` - -##### References - -[TLImageShape](/gen/tlschema/TLImageShape-type) - ---- - -### `indicator()` \{#ImageShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLImageShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element | null -``` - -##### References - -[TLImageShape](/gen/tlschema/TLImageShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#ImageShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLImageShape -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[TLImageShape](/gen/tlschema/TLImageShape-type), [Promise](/gen/Promise-interface), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/Input-var.mdx b/docs/gen/Input-var.mdx deleted file mode 100644 index b47b0b4e6..000000000 --- a/docs/gen/Input-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Input -status: published -category: ui -group: Variable -author: api -date: 06/23/2023 -order: 8 ----Public Readonly Variable - - - - -##### Signature - - -```ts -Input: React.ForwardRefExoticComponent< - TLUiInputProps & React.RefAttributes -> -``` - -##### References - -[React.ForwardRefExoticComponent](/gen/@types/react-React-ForwardRefExoticComponent-interface), [TLUiInputProps](/gen/ui/TLUiInputProps-interface), [React.RefAttributes](/gen/@types/react-React-RefAttributes-interface), [HTMLInputElement](/gen/HTMLInputElement-interface) - diff --git a/docs/gen/InstancePageStateRecordType-var.mdx b/docs/gen/InstancePageStateRecordType-var.mdx deleted file mode 100644 index 3cd994804..000000000 --- a/docs/gen/InstancePageStateRecordType-var.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: InstancePageStateRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 35 ----Public Readonly Variable - - - - -##### Signature - - -```ts -InstancePageStateRecordType: import('@tldraw/store').RecordType< - TLInstancePageState, - 'pageId' -> -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLInstancePageState](/gen/tlschema/TLInstancePageState-interface) - diff --git a/docs/gen/InstancePresenceRecordType-var.mdx b/docs/gen/InstancePresenceRecordType-var.mdx deleted file mode 100644 index cace3df1d..000000000 --- a/docs/gen/InstancePresenceRecordType-var.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: InstancePresenceRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 36 ----Public Readonly Variable - - - - -##### Signature - - -```ts -InstancePresenceRecordType: import('@tldraw/store').RecordType< - TLInstancePresence, - 'currentPageId' | 'userId' | 'userName' -> -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLInstancePresence](/gen/tlschema/TLInstancePresence-interface) - diff --git a/docs/gen/LANGUAGES-var.mdx b/docs/gen/LANGUAGES-var.mdx deleted file mode 100644 index 463363409..000000000 --- a/docs/gen/LANGUAGES-var.mdx +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: LANGUAGES -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 40 ----Public Readonly Variable - - - - -##### Signature - - -```ts -LANGUAGES: readonly [ - { - readonly locale: 'ar' - readonly label: 'عربي' - }, - { - readonly locale: 'ca' - readonly label: 'Català' - }, - { - readonly locale: 'da' - readonly label: 'Danish' - }, - { - readonly locale: 'de' - readonly label: 'Deutsch' - }, - { - readonly locale: 'en' - readonly label: 'English' - }, - { - readonly locale: 'es' - readonly label: 'Español' - }, - { - readonly locale: 'fa' - readonly label: 'فارسی' - }, - { - readonly locale: 'fi' - readonly label: 'Suomi' - }, - { - readonly locale: 'fr' - readonly label: 'Français' - }, - { - readonly locale: 'gl' - readonly label: 'Galego' - }, - { - readonly locale: 'he' - readonly label: 'עברית' - }, - { - readonly locale: 'it' - readonly label: 'Italiano' - }, - { - readonly locale: 'ja' - readonly label: '日本語' - }, - { - readonly locale: 'ko-kr' - readonly label: '한국어' - }, - { - readonly locale: 'ku' - readonly label: 'کوردی' - }, - { - readonly locale: 'hi-in' - readonly label: 'हिन्दी' - }, - { - readonly locale: 'hu' - readonly label: 'Magyar' - }, - { - readonly locale: 'my' - readonly label: 'မြန်မာစာ' - }, - { - readonly locale: 'ne' - readonly label: 'नेपाली' - }, - { - readonly locale: 'no' - readonly label: 'Norwegian' - }, - { - readonly locale: 'pl' - readonly label: 'Polski' - }, - { - readonly locale: 'pt-br' - readonly label: 'Português - Brasil' - }, - { - readonly locale: 'pt-pt' - readonly label: 'Português - Europeu' - }, - { - readonly locale: 'ro' - readonly label: 'Română' - }, - { - readonly locale: 'ru' - readonly label: 'Russian' - }, - { - readonly locale: 'sv' - readonly label: 'Svenska' - }, - { - readonly locale: 'te' - readonly label: 'తెలుగు' - }, - { - readonly locale: 'th' - readonly label: 'ภาษาไทย' - }, - { - readonly locale: 'tr' - readonly label: 'Türkçe' - }, - { - readonly locale: 'uk' - readonly label: 'Ukrainian' - }, - { - readonly locale: 'vi' - readonly label: 'Tiếng Việt' - }, - { - readonly locale: 'zh-cn' - readonly label: 'Chinese - Simplified' - }, - { - readonly locale: 'zh-tw' - readonly label: '繁體中文 (台灣)' - } -] -``` - diff --git a/docs/gen/LineSegment2d-class.mdx b/docs/gen/LineSegment2d-class.mdx deleted file mode 100644 index 4d936e0ac..000000000 --- a/docs/gen/LineSegment2d-class.mdx +++ /dev/null @@ -1,556 +0,0 @@ ---- -title: LineSegment2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 50 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [a](#LineSegment2d-a-member) - - [angle](#LineSegment2d-angle-member) - - [b](#LineSegment2d-b-member) - - [bounds](#LineSegment2d-bounds-member) - - [length](#LineSegment2d-length-member) - - [tangent](#LineSegment2d-tangent-member) -- [Methods](#methods) - - [Angle](#LineSegment2d-Angle-member-1) - - [getClosestPointTo](#LineSegment2d-getClosestPointTo-member-1) - - [getNormal](#LineSegment2d-getNormal-member-1) - - [getPath](#LineSegment2d-getPath-member-1) - - [getPoint](#LineSegment2d-getPoint-member-1) - - [getX](#LineSegment2d-getX-member-1) - - [getY](#LineSegment2d-getY-member-1) - - [Length](#LineSegment2d-Length-member-1) - - [Tangent](#LineSegment2d-Tangent-member-1) -
- - - - -##### Signature - - -```ts -class LineSegment2d extends BaseSegment2d {} -``` - -##### References - -[BaseSegment2d](/gen/primitives/~BaseSegment2d-class), [LineSegment2dModel](/gen/primitives/LineSegment2dModel-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `LineSegment2d` class - - -##### Parameters - - - - - - - -`a` - - - - -```ts -VecLike -``` - - - - - - - - -`b` - - - - -```ts -VecLike -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -## Properties - -### `a` \{#LineSegment2d-a-member} - -Public Property - -##### Signature - - -```ts -a: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `angle` \{#LineSegment2d-angle-member} - -Public Readonly Property - -##### Signature - - -```ts -get angle(): number -``` - ---- - -### `b` \{#LineSegment2d-b-member} - -Public Property - -##### Signature - - -```ts -b: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `bounds` \{#LineSegment2d-bounds-member} - -Public Readonly Property - -##### Signature - - -```ts -get bounds(): Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `length` \{#LineSegment2d-length-member} - -Public Readonly Property - -##### Signature - - -```ts -get length(): number -``` - ---- - -### `tangent` \{#LineSegment2d-tangent-member} - -Public Readonly Property - -##### Signature - - -```ts -get tangent(): Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -## Methods - -### `Angle()` \{#LineSegment2d-Angle-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -LineSegment2d -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[LineSegment2d](/gen/primitives/LineSegment2d-class) - ---- - -### `getClosestPointTo()` \{#LineSegment2d-getClosestPointTo-member-1} - -Public Method - -Get the closest point on the segment to an arbitrary point. - - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The arbitrary point. - - - - - - - - -##### Returns - - -```ts -{ - point: Vec2d - distance: number -} -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getNormal()` \{#LineSegment2d-getNormal-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getPath()` \{#LineSegment2d-getPath-member-1} - -Public Method - -##### Parameters - - - - - - - -`head` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -string -``` - ---- - -### `getPoint()` \{#LineSegment2d-getPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getX()` \{#LineSegment2d-getX-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - ---- - -### `getY()` \{#LineSegment2d-getY-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - ---- - -### `Length()` \{#LineSegment2d-Length-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -LineSegment2d -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[LineSegment2d](/gen/primitives/LineSegment2d-class) - ---- - -### `Tangent()` \{#LineSegment2d-Tangent-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -LineSegment2d -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[LineSegment2d](/gen/primitives/LineSegment2d-class), [Vec2d](/gen/primitives/Vec2d-class) - ---- - diff --git a/docs/gen/LineSegment2dModel-interface.mdx b/docs/gen/LineSegment2dModel-interface.mdx deleted file mode 100644 index a7e17d104..000000000 --- a/docs/gen/LineSegment2dModel-interface.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: LineSegment2dModel -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 51 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [a](#LineSegment2dModel-a-member) - - [b](#LineSegment2dModel-b-member) - - [p](#LineSegment2dModel-p-member) -
- - - - -##### Signature - - -```ts -interface LineSegment2dModel {} -``` - ---- - -## Properties - -### `a` \{#LineSegment2dModel-a-member} - -Public PropertySignature - -##### Signature - - -```ts -a: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `b` \{#LineSegment2dModel-b-member} - -Public PropertySignature - -##### Signature - - -```ts -b: VecLike -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `p` \{#LineSegment2dModel-p-member} - -Public PropertySignature - -##### Signature - - -```ts -p: number -``` - ---- - diff --git a/docs/gen/LineShape-var.mdx b/docs/gen/LineShape-var.mdx deleted file mode 100644 index 45487c80c..000000000 --- a/docs/gen/LineShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: LineShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 78 ----Public Readonly Variable - - - - -##### Signature - - -```ts -LineShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLLineShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLLineShape](/gen/tlschema/TLLineShape-type) - diff --git a/docs/gen/LineShapeSplineStyle-var.mdx b/docs/gen/LineShapeSplineStyle-var.mdx deleted file mode 100644 index 98a2fac43..000000000 --- a/docs/gen/LineShapeSplineStyle-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: LineShapeSplineStyle -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 42 ----Public Readonly Variable - - - - -##### Signature - - -```ts -LineShapeSplineStyle: import('../styles/StyleProp').EnumStyleProp< - 'cubic' | 'line' -> -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - diff --git a/docs/gen/LineShapeUtil-class.mdx b/docs/gen/LineShapeUtil-class.mdx deleted file mode 100644 index 89977348f..000000000 --- a/docs/gen/LineShapeUtil-class.mdx +++ /dev/null @@ -1,628 +0,0 @@ ---- -title: LineShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 79 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [hideResizeHandles](#LineShapeUtil-hideResizeHandles-member) - - [hideRotateHandle](#LineShapeUtil-hideRotateHandle-member) - - [hideSelectionBoundsBg](#LineShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#LineShapeUtil-hideSelectionBoundsFg-member) - - [isClosed](#LineShapeUtil-isClosed-member) - - [onHandleChange](#LineShapeUtil-onHandleChange-member) - - [onResize](#LineShapeUtil-onResize-member) - - [type](#LineShapeUtil-type-member) -- [Methods](#methods) - - [component](#LineShapeUtil-component-member-1) - - [getBounds](#LineShapeUtil-getBounds-member-1) - - [getDefaultProps](#LineShapeUtil-getDefaultProps-member-1) - - [getHandles](#LineShapeUtil-getHandles-member-1) - - [getOutline](#LineShapeUtil-getOutline-member-1) - - [getOutlineSegments](#LineShapeUtil-getOutlineSegments-member-1) - - [hitTestLineSegment](#LineShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#LineShapeUtil-hitTestPoint-member-1) - - [indicator](#LineShapeUtil-indicator-member-1) - - [toSvg](#LineShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class LineShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLLineShape](/gen/tlschema/TLLineShape-type) - ---- - -## Properties - -### `hideResizeHandles` \{#LineShapeUtil-hideResizeHandles-member} - -Public Property - -##### Signature - - -```ts -hideResizeHandles: () => boolean -``` - ---- - -### `hideRotateHandle` \{#LineShapeUtil-hideRotateHandle-member} - -Public Property - -##### Signature - - -```ts -hideRotateHandle: () => boolean -``` - ---- - -### `hideSelectionBoundsBg` \{#LineShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: () => boolean -``` - ---- - -### `hideSelectionBoundsFg` \{#LineShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: () => boolean -``` - ---- - -### `isClosed` \{#LineShapeUtil-isClosed-member} - -Public Property - -##### Signature - - -```ts -isClosed: () => boolean -``` - ---- - -### `onHandleChange` \{#LineShapeUtil-onHandleChange-member} - -Public Property - -##### Signature - - -```ts -onHandleChange: TLOnHandleChangeHandler -``` - -##### References - -[TLOnHandleChangeHandler](/gen/editor/TLOnHandleChangeHandler-type), [TLLineShape](/gen/tlschema/TLLineShape-type) - ---- - -### `onResize` \{#LineShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLLineShape](/gen/tlschema/TLLineShape-type) - ---- - -### `type` \{#LineShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'line' -``` - ---- - -## Methods - -### `component()` \{#LineShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element | undefined -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getBounds()` \{#LineShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -import('@tldraw/primitives').Box2d -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getDefaultProps()` \{#LineShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLLineShape['props'] -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type) - ---- - -### `getHandles()` \{#LineShapeUtil-getHandles-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -TLHandle[] -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [TLHandle](/gen/tlschema/TLHandle-interface) - ---- - -### `getOutline()` \{#LineShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineSegments()` \{#LineShapeUtil-getOutlineSegments-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[][] -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `hitTestLineSegment()` \{#LineShapeUtil-hitTestLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#LineShapeUtil-hitTestPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - - -`point` - - - - -```ts -Vec2d -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `indicator()` \{#LineShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#LineShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - - -`_font` - - - - -```ts -string -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/LoadingScreen-function-1.mdx b/docs/gen/LoadingScreen-function-1.mdx deleted file mode 100644 index 216971520..000000000 --- a/docs/gen/LoadingScreen-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: LoadingScreen -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 80 ----Public Function - - - - -##### Parameters - - - - - - - -`{ children }` - - - - -```ts -{ - children: any -} -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/MatLike-type.mdx b/docs/gen/MatLike-type.mdx deleted file mode 100644 index ac7432afd..000000000 --- a/docs/gen/MatLike-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: MatLike -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 54 ----Public TypeAlias - - - - -##### Signature - - -```ts -type MatLike = Matrix2d | Matrix2dModel -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class), [Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - diff --git a/docs/gen/Matrix2d-class.mdx b/docs/gen/Matrix2d-class.mdx deleted file mode 100644 index f730acffb..000000000 --- a/docs/gen/Matrix2d-class.mdx +++ /dev/null @@ -1,1530 +0,0 @@ ---- -title: Matrix2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 55 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [a](#Matrix2d-a-member) - - [b](#Matrix2d-b-member) - - [c](#Matrix2d-c-member) - - [d](#Matrix2d-d-member) - - [e](#Matrix2d-e-member) - - [f](#Matrix2d-f-member) - - [Scale](#Matrix2d-Scale-member) -- [Methods](#methods) - - [Absolute](#Matrix2d-Absolute-member-1) - - [applyToBounds](#Matrix2d-applyToBounds-member-1) - - [applyToPoint](#Matrix2d-applyToPoint-member-1) - - [applyToPoint](#Matrix2d-applyToPoint-member-1) - - [applyToPoints](#Matrix2d-applyToPoints-member-1) - - [applyToPoints](#Matrix2d-applyToPoints-member-1) - - [applyToXY](#Matrix2d-applyToXY-member-1) - - [clone](#Matrix2d-clone-member-1) - - [Compose](#Matrix2d-Compose-member-1) - - [decompose](#Matrix2d-decompose-member-1) - - [Decompose](#Matrix2d-Decompose-member-1) - - [decomposed](#Matrix2d-decomposed-member-1) - - [equals](#Matrix2d-equals-member-1) - - [From](#Matrix2d-From-member-1) - - [identity](#Matrix2d-identity-member-1) - - [Identity](#Matrix2d-Identity-member-1) - - [Inverse](#Matrix2d-Inverse-member-1) - - [invert](#Matrix2d-invert-member-1) - - [multiply](#Matrix2d-multiply-member-1) - - [Multiply](#Matrix2d-Multiply-member-1) - - [rotate](#Matrix2d-rotate-member-1) - - [Rotate](#Matrix2d-Rotate-member-1) - - [scale](#Matrix2d-scale-member-1) - - [setTo](#Matrix2d-setTo-member-1) - - [Smooth](#Matrix2d-Smooth-member-1) - - [toCssString](#Matrix2d-toCssString-member-1) - - [toCssString](#Matrix2d-toCssString-member-1) - - [translate](#Matrix2d-translate-member-1) - - [Translate](#Matrix2d-Translate-member-1) -
- - - - -##### Signature - - -```ts -class Matrix2d {} -``` - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Matrix2d` class - - -##### Parameters - - - - - - - -`a` - - - - -```ts -number -``` - - - - - - - - -`b` - - - - -```ts -number -``` - - - - - - - - -`c` - - - - -```ts -number -``` - - - - - - - - -`d` - - - - -```ts -number -``` - - - - - - - - -`e` - - - - -```ts -number -``` - - - - - - - - -`f` - - - - -```ts -number -``` - - - - - - - ---- - -## Properties - -### `a` \{#Matrix2d-a-member} - -Public Property - -##### Signature - - -```ts -a: number -``` - ---- - -### `b` \{#Matrix2d-b-member} - -Public Property - -##### Signature - - -```ts -b: number -``` - ---- - -### `c` \{#Matrix2d-c-member} - -Public Property - -##### Signature - - -```ts -c: number -``` - ---- - -### `d` \{#Matrix2d-d-member} - -Public Property - -##### Signature - - -```ts -d: number -``` - ---- - -### `e` \{#Matrix2d-e-member} - -Public Property - -##### Signature - - -```ts -e: number -``` - ---- - -### `f` \{#Matrix2d-f-member} - -Public Property - -##### Signature - - -```ts -f: number -``` - ---- - -### `Scale` \{#Matrix2d-Scale-member} - -Public Static Property - -##### Signature - - -```ts -static Scale: { - (x: number, y: number): Matrix2dModel - (x: number, y: number, cx: number, cy: number): Matrix2dModel -} -``` - -##### References - -[Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -## Methods - -### `Absolute()` \{#Matrix2d-Absolute-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - -##### Returns - - -```ts -Matrix2dModel -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `applyToBounds()` \{#Matrix2d-applyToBounds-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - - -`box` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `applyToPoint()` \{#Matrix2d-applyToPoint-member-1} - -Public Method - -##### Parameters - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `applyToPoint()` \{#Matrix2d-applyToPoint-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - - -`point` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `applyToPoints()` \{#Matrix2d-applyToPoints-member-1} - -Public Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `applyToPoints()` \{#Matrix2d-applyToPoints-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `applyToXY()` \{#Matrix2d-applyToXY-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number[] -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type) - ---- - -### `clone()` \{#Matrix2d-clone-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `Compose()` \{#Matrix2d-Compose-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`matrices` - - - - -```ts -MatLike[] -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `decompose()` \{#Matrix2d-decompose-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -MatrixInfo -``` - -##### References - -[MatrixInfo](/gen/primitives/MatrixInfo-interface) - ---- - -### `Decompose()` \{#Matrix2d-Decompose-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - -##### Returns - - -```ts -MatrixInfo -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [MatrixInfo](/gen/primitives/MatrixInfo-interface) - ---- - -### `decomposed()` \{#Matrix2d-decomposed-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -MatrixInfo -``` - -##### References - -[MatrixInfo](/gen/primitives/MatrixInfo-interface) - ---- - -### `equals()` \{#Matrix2d-equals-member-1} - -Public Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -Matrix2d | Matrix2dModel -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class), [Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `From()` \{#Matrix2d-From-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type), [Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `identity()` \{#Matrix2d-identity-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `Identity()` \{#Matrix2d-Identity-member-1} - -Public Static Method - -##### Parameters - - -None - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `Inverse()` \{#Matrix2d-Inverse-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -Matrix2dModel -``` - - - - - - - -##### Returns - - -```ts -Matrix2dModel -``` - -##### References - -[Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `invert()` \{#Matrix2d-invert-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `multiply()` \{#Matrix2d-multiply-member-1} - -Public Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -Matrix2d | Matrix2dModel -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class), [Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `Multiply()` \{#Matrix2d-Multiply-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m1` - - - - -```ts -Matrix2dModel -``` - - - - - - - - -`m2` - - - - -```ts -Matrix2dModel -``` - - - - - - - -##### Returns - - -```ts -Matrix2dModel -``` - -##### References - -[Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `rotate()` \{#Matrix2d-rotate-member-1} - -Public Method - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - - - - - - - - -`cx` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`cy` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `Rotate()` \{#Matrix2d-Rotate-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - - - - - - - - -`cx` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`cy` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `scale()` \{#Matrix2d-scale-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setTo()` \{#Matrix2d-setTo-member-1} - -Public Method - -##### Parameters - - - - - - - -`model` - - - - -```ts -Matrix2dModel -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[Matrix2dModel](/gen/primitives/Matrix2dModel-interface) - ---- - -### `Smooth()` \{#Matrix2d-Smooth-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - - -`precision` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -MatLike -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type) - ---- - -### `toCssString()` \{#Matrix2d-toCssString-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -string -``` - ---- - -### `toCssString()` \{#Matrix2d-toCssString-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type) - ---- - -### `translate()` \{#Matrix2d-translate-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - -### `Translate()` \{#Matrix2d-Translate-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Matrix2d -``` - -##### References - -[Matrix2d](/gen/primitives/Matrix2d-class) - ---- - diff --git a/docs/gen/Matrix2dModel-interface.mdx b/docs/gen/Matrix2dModel-interface.mdx deleted file mode 100644 index 85d5a04ca..000000000 --- a/docs/gen/Matrix2dModel-interface.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: Matrix2dModel -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 56 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [a](#Matrix2dModel-a-member) - - [b](#Matrix2dModel-b-member) - - [c](#Matrix2dModel-c-member) - - [d](#Matrix2dModel-d-member) - - [e](#Matrix2dModel-e-member) - - [f](#Matrix2dModel-f-member) -
- - - - -##### Signature - - -```ts -interface Matrix2dModel {} -``` - ---- - -## Properties - -### `a` \{#Matrix2dModel-a-member} - -Public PropertySignature - -##### Signature - - -```ts -a: number -``` - ---- - -### `b` \{#Matrix2dModel-b-member} - -Public PropertySignature - -##### Signature - - -```ts -b: number -``` - ---- - -### `c` \{#Matrix2dModel-c-member} - -Public PropertySignature - -##### Signature - - -```ts -c: number -``` - ---- - -### `d` \{#Matrix2dModel-d-member} - -Public PropertySignature - -##### Signature - - -```ts -d: number -``` - ---- - -### `e` \{#Matrix2dModel-e-member} - -Public PropertySignature - -##### Signature - - -```ts -e: number -``` - ---- - -### `f` \{#Matrix2dModel-f-member} - -Public PropertySignature - -##### Signature - - -```ts -f: number -``` - ---- - diff --git a/docs/gen/MatrixInfo-interface.mdx b/docs/gen/MatrixInfo-interface.mdx deleted file mode 100644 index 729fbd42e..000000000 --- a/docs/gen/MatrixInfo-interface.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: MatrixInfo -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 57 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [rotation](#MatrixInfo-rotation-member) - - [scaleX](#MatrixInfo-scaleX-member) - - [scaleY](#MatrixInfo-scaleY-member) - - [x](#MatrixInfo-x-member) - - [y](#MatrixInfo-y-member) -
- - - - -##### Signature - - -```ts -interface MatrixInfo {} -``` - ---- - -## Properties - -### `rotation` \{#MatrixInfo-rotation-member} - -Public PropertySignature - -##### Signature - - -```ts -rotation: number -``` - ---- - -### `scaleX` \{#MatrixInfo-scaleX-member} - -Public PropertySignature - -##### Signature - - -```ts -scaleX: number -``` - ---- - -### `scaleY` \{#MatrixInfo-scaleY-member} - -Public PropertySignature - -##### Signature - - -```ts -scaleY: number -``` - ---- - -### `x` \{#MatrixInfo-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#MatrixInfo-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - diff --git a/docs/gen/Migration-type.mdx b/docs/gen/Migration-type.mdx deleted file mode 100644 index ba6c22ba3..000000000 --- a/docs/gen/Migration-type.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Migration -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 15 ----Public TypeAlias - - - - -##### Signature - - -```ts -type Migration = { - up: (oldState: Before) => After - down: (newState: After) => Before -} -``` - diff --git a/docs/gen/MigrationFailureReason-enum.mdx b/docs/gen/MigrationFailureReason-enum.mdx deleted file mode 100644 index 8e82aa5cd..000000000 --- a/docs/gen/MigrationFailureReason-enum.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: MigrationFailureReason -status: published -category: store -group: Enum -author: api -date: 06/23/2023 -order: 16 ----Public Enum - - - - -##### Signature - - -```ts -enum MigrationFailureReason {} -``` - diff --git a/docs/gen/MigrationResult-type.mdx b/docs/gen/MigrationResult-type.mdx deleted file mode 100644 index 391ad776e..000000000 --- a/docs/gen/MigrationResult-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: MigrationResult -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 17 ----Public TypeAlias - - - - -##### Signature - - -```ts -type MigrationResult = - | { - type: 'error' - reason: MigrationFailureReason - } - | { - type: 'success' - value: T - } -``` - -##### References - -[MigrationFailureReason](/gen/store/MigrationFailureReason-enum) - diff --git a/docs/gen/Migrations-interface.mdx b/docs/gen/Migrations-interface.mdx deleted file mode 100644 index 55114259a..000000000 --- a/docs/gen/Migrations-interface.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Migrations -status: published -category: store -group: Interface -author: api -date: 06/23/2023 -order: 18 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [subTypeKey](#Migrations-subTypeKey-member) - - [subTypeMigrations](#Migrations-subTypeMigrations-member) -
- - - - -##### Signature - - -```ts -interface Migrations extends BaseMigrationsInfo {} -``` - -##### References - -[BaseMigrationsInfo](/gen/store/~BaseMigrationsInfo-interface) - ---- - -## Properties - -### `subTypeKey` \{#Migrations-subTypeKey-member} - -Public PropertySignature - -##### Signature - - -```ts -subTypeKey?: string -``` - ---- - -### `subTypeMigrations` \{#Migrations-subTypeMigrations-member} - -Public PropertySignature - -##### Signature - - -```ts -subTypeMigrations?: Record -``` - -##### References - -[Record](/gen/Record-type), [BaseMigrationsInfo](/gen/store/~BaseMigrationsInfo-interface) - ---- - diff --git a/docs/gen/NoteShape-var.mdx b/docs/gen/NoteShape-var.mdx deleted file mode 100644 index c625641e6..000000000 --- a/docs/gen/NoteShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: NoteShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 86 ----Public Readonly Variable - - - - -##### Signature - - -```ts -NoteShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLNoteShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type) - diff --git a/docs/gen/NoteShapeUtil-class.mdx b/docs/gen/NoteShapeUtil-class.mdx deleted file mode 100644 index 5e07f3f54..000000000 --- a/docs/gen/NoteShapeUtil-class.mdx +++ /dev/null @@ -1,587 +0,0 @@ ---- -title: NoteShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 87 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canEdit](#NoteShapeUtil-canEdit-member) - - [hideResizeHandles](#NoteShapeUtil-hideResizeHandles-member) - - [hideSelectionBoundsBg](#NoteShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#NoteShapeUtil-hideSelectionBoundsFg-member) - - [onBeforeCreate](#NoteShapeUtil-onBeforeCreate-member) - - [onBeforeUpdate](#NoteShapeUtil-onBeforeUpdate-member) - - [onEditEnd](#NoteShapeUtil-onEditEnd-member) - - [type](#NoteShapeUtil-type-member) -- [Methods](#methods) - - [component](#NoteShapeUtil-component-member-1) - - [getBounds](#NoteShapeUtil-getBounds-member-1) - - [getCenter](#NoteShapeUtil-getCenter-member-1) - - [getDefaultProps](#NoteShapeUtil-getDefaultProps-member-1) - - [getHeight](#NoteShapeUtil-getHeight-member-1) - - [getOutline](#NoteShapeUtil-getOutline-member-1) - - [indicator](#NoteShapeUtil-indicator-member-1) - - [toSvg](#NoteShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class NoteShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLNoteShape](/gen/tlschema/TLNoteShape-type) - ---- - -## Properties - -### `canEdit` \{#NoteShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `hideResizeHandles` \{#NoteShapeUtil-hideResizeHandles-member} - -Public Property - -##### Signature - - -```ts -hideResizeHandles: () => boolean -``` - ---- - -### `hideSelectionBoundsBg` \{#NoteShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsBg: () => boolean -``` - ---- - -### `hideSelectionBoundsFg` \{#NoteShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -##### Signature - - -```ts -hideSelectionBoundsFg: () => boolean -``` - ---- - -### `onBeforeCreate` \{#NoteShapeUtil-onBeforeCreate-member} - -Public Property - -##### Signature - - -```ts -onBeforeCreate: (next: TLNoteShape) => - | { - props: { - growY: number - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - verticalAlign: 'end' | 'middle' | 'start' - url: string - text: string - } - type: 'note' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onBeforeUpdate` \{#NoteShapeUtil-onBeforeUpdate-member} - -Public Property - -##### Signature - - -```ts -onBeforeUpdate: ( - prev: TLNoteShape, - next: TLNoteShape -) => - | { - props: { - growY: number - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - verticalAlign: 'end' | 'middle' | 'start' - url: string - text: string - } - type: 'note' - x: number - y: number - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onEditEnd` \{#NoteShapeUtil-onEditEnd-member} - -Public Property - -##### Signature - - -```ts -onEditEnd: TLOnEditEndHandler -``` - -##### References - -[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type) - ---- - -### `type` \{#NoteShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'note' -``` - ---- - -## Methods - -### `component()` \{#NoteShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getBounds()` \{#NoteShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#NoteShapeUtil-getCenter-member-1} - -Public Method - -##### Parameters - - - - - - - -`_shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#NoteShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLNoteShape['props'] -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type) - ---- - -### `getHeight()` \{#NoteShapeUtil-getHeight-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type) - ---- - -### `getOutline()` \{#NoteShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `indicator()` \{#NoteShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#NoteShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLNoteShape -``` - - - - - - - - -`font` - - - - -```ts -string -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/PI-var.mdx b/docs/gen/PI-var.mdx deleted file mode 100644 index 71ec846c1..000000000 --- a/docs/gen/PI-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: PI -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 59 ----Public Readonly Variable - - - - -##### Signature - - -```ts -PI: number -``` - diff --git a/docs/gen/PI2-var.mdx b/docs/gen/PI2-var.mdx deleted file mode 100644 index 2de68a76c..000000000 --- a/docs/gen/PI2-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: PI2 -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 60 ----Public Readonly Variable - - - - -##### Signature - - -```ts -PI2: number -``` - diff --git a/docs/gen/PageRecordType-var.mdx b/docs/gen/PageRecordType-var.mdx deleted file mode 100644 index db89b535c..000000000 --- a/docs/gen/PageRecordType-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: PageRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 44 ----Public Readonly Variable - - - - -##### Signature - - -```ts -PageRecordType: import('@tldraw/store').RecordType -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLPage](/gen/tlschema/TLPage-interface) - diff --git a/docs/gen/PlopManager-class.mdx b/docs/gen/PlopManager-class.mdx deleted file mode 100644 index 4f4b25334..000000000 --- a/docs/gen/PlopManager-class.mdx +++ /dev/null @@ -1,704 +0,0 @@ ---- -title: PlopManager -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 89 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [editor](#PlopManager-editor-member) - - [handleContent](#PlopManager-handleContent-member) - - [handleUrl](#PlopManager-handleUrl-member) -- [Methods](#methods) - - [createAssetFromFile](#PlopManager-createAssetFromFile-member-1) - - [createAssetFromUrl](#PlopManager-createAssetFromUrl-member-1) - - [createShapesForAssets](#PlopManager-createShapesForAssets-member-1) - - [handleEmbed](#PlopManager-handleEmbed-member-1) - - [handleFiles](#PlopManager-handleFiles-member-1) - - [handleSvgText](#PlopManager-handleSvgText-member-1) - - [handleText](#PlopManager-handleText-member-1) -
- - - - -##### Signature - - -```ts -class ExternalContentManager {} -``` - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `ExternalContentManager` class - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - -##### References - -[Editor](/gen/editor/Editor-class) - ---- - -## Properties - -### `editor` \{#PlopManager-editor-member} - -Public Property - -##### Signature - - -```ts -editor: Editor -``` - -##### References - -[Editor](/gen/editor/Editor-class) - ---- - -### `handleContent` \{#PlopManager-handleContent-member} - -Public Property - -##### Signature - - -```ts -handleContent: (info: TLExternalContent) => Promise -``` - -##### References - -[TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -### `handleUrl` \{#PlopManager-handleUrl-member} - -Public Property - -Handle urls from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled. - - - - -##### Example - - - - -```ts -editor.this.handleUrl = myCustomMethod -``` - - -##### Parameters - - - - - - - -`editor` - - - - -The editor instance - - - - - - - - - -`info` - - - - -The info object describing the external content. - - - - - - - - -##### Signature - - -```ts -handleUrl: ( - editor: Editor, - { - point, - url, - }: Extract< - TLExternalContent, - { - type: 'url' - } - > -) => Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -## Methods - -### `createAssetFromFile()` \{#PlopManager-createAssetFromFile-member-1} - -Public Method - -Override this method to change how assets are created from files. - - -##### Parameters - - - - - - - -`_editor` - - - - -```ts -Editor -``` - - - - - - - - -`file` - - - - -```ts -File -``` - -The file to create the asset from. - - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [File](/gen/File-interface), [Promise](/gen/Promise-interface), [TLAsset](/gen/tlschema/TLAsset-type) - ---- - -### `createAssetFromUrl()` \{#PlopManager-createAssetFromUrl-member-1} - -Public Method - -Override me to change the way assets are created from urls. - - -##### Parameters - - - - - - - -`_editor` - - - - -```ts -Editor -``` - - - - - - - - -`url` - - - - -```ts -string -``` - -The url to create the asset from - - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Promise](/gen/Promise-interface), [TLAsset](/gen/tlschema/TLAsset-type) - ---- - -### `createShapesForAssets()` \{#PlopManager-createShapesForAssets-member-1} - -Public Method - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - - -`assets` - - - - -```ts -TLAsset[] -``` - - - - - - - - -`position` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [TLAsset](/gen/tlschema/TLAsset-type), [VecLike](/gen/primitives/VecLike-type), [Promise](/gen/Promise-interface) - ---- - -### `handleEmbed()` \{#PlopManager-handleEmbed-member-1} - -Public Method - -Handle embed info from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled. - - - - -##### Example - - - - -```ts -editor.this.handleEmbed = myCustomMethod -``` - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - -The editor instance - - - - - - - - - -`{ point, url, embed }` - - - - -```ts -Extract< - TLExternalContent, - { - type: 'embed' - } -> -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -### `handleFiles()` \{#PlopManager-handleFiles-member-1} - -Public Method - -Handle files from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled. - - - - -##### Example - - - - -```ts -editor.this.handleFiles = myCustomMethod -``` - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - -The editor instance - - - - - - - - - -`{ point, files }` - - - - -```ts -Extract< - TLExternalContent, - { - type: 'files' - } -> -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -### `handleSvgText()` \{#PlopManager-handleSvgText-member-1} - -Public Method - -Handle svg text from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled. - - - - -##### Example - - - - -```ts -editor.this.handleSvgText = myCustomMethod -``` - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - -The editor instance. - - - - - - - - - -`{ point, text }` - - - - -```ts -Extract< - TLExternalContent, - { - type: 'svg-text' - } -> -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - -### `handleText()` \{#PlopManager-handleText-member-1} - -Public Method - -Handle plain text from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled. - - - - -##### Example - - - - -```ts -editor.this.handleText = myCustomMethod -``` - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - -The editor instance - - - - - - - - - -`{ point, text }` - - - - -```ts -Extract< - TLExternalContent, - { - type: 'text' - } -> -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface) - ---- - diff --git a/docs/gen/PointerRecordType-var.mdx b/docs/gen/PointerRecordType-var.mdx deleted file mode 100644 index 7a8e704f5..000000000 --- a/docs/gen/PointerRecordType-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: PointerRecordType -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 46 ----Public Readonly Variable - - - - -##### Signature - - -```ts -PointerRecordType: import('@tldraw/store').RecordType -``` - -##### References - -[RecordType](/gen/store/RecordType-class), [TLPointer](/gen/tlschema/~TLPointer-interface) - diff --git a/docs/gen/Polyline2d-class.mdx b/docs/gen/Polyline2d-class.mdx deleted file mode 100644 index 6cfe7c0cf..000000000 --- a/docs/gen/Polyline2d-class.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: Polyline2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 70 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [segments](#Polyline2d-segments-member) -- [Methods](#methods) - - [FromPoints](#Polyline2d-FromPoints-member-1) - - [getSegmentsFromPoints](#Polyline2d-getSegmentsFromPoints-member-1) -
- - - - -##### Signature - - -```ts -class Polyline2d extends BaseSpline2d {} -``` - -##### References - -[BaseSpline2d](/gen/primitives/~BaseSpline2d-class), [LineSegment2dModel](/gen/primitives/LineSegment2dModel-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Polyline2d` class - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`k` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -## Properties - -### `segments` \{#Polyline2d-segments-member} - -Public Property - -##### Signature - - -```ts -segments: LineSegment2d[] -``` - -##### References - -[LineSegment2d](/gen/primitives/LineSegment2d-class) - ---- - -## Methods - -### `FromPoints()` \{#Polyline2d-FromPoints-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -Polyline2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Polyline2d](/gen/primitives/Polyline2d-class) - ---- - -### `getSegmentsFromPoints()` \{#Polyline2d-getSegmentsFromPoints-member-1} - -Public Method - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`p` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -LineSegment2d[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [LineSegment2d](/gen/primitives/LineSegment2d-class) - ---- - diff --git a/docs/gen/ROTATE_CORNER_TO_SELECTION_CORNER-var.mdx b/docs/gen/ROTATE_CORNER_TO_SELECTION_CORNER-var.mdx deleted file mode 100644 index bf9798808..000000000 --- a/docs/gen/ROTATE_CORNER_TO_SELECTION_CORNER-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ROTATE_CORNER_TO_SELECTION_CORNER -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 74 ----Public Readonly Variable - - - - -##### Signature - - -```ts -ROTATE_CORNER_TO_SELECTION_CORNER: { - readonly top_left_rotate: 'top_left' - readonly top_right_rotate: 'top_right' - readonly bottom_right_rotate: 'bottom_right' - readonly bottom_left_rotate: 'bottom_left' - readonly mobile_rotate: 'top_left' -} -``` - diff --git a/docs/gen/ReadonlySharedStyleMap-class.mdx b/docs/gen/ReadonlySharedStyleMap-class.mdx deleted file mode 100644 index f859f8b5d..000000000 --- a/docs/gen/ReadonlySharedStyleMap-class.mdx +++ /dev/null @@ -1,319 +0,0 @@ ---- -title: ReadonlySharedStyleMap -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 91 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [map](#ReadonlySharedStyleMap-map-member) - - [size](#ReadonlySharedStyleMap-size-member) -- [Methods](#methods) - - [[Symbol.iterator]](#ReadonlySharedStyleMap-[Symbol-iterator]-member-1) - - [entries](#ReadonlySharedStyleMap-entries-member-1) - - [equals](#ReadonlySharedStyleMap-equals-member-1) - - [get](#ReadonlySharedStyleMap-get-member-1) - - [getAsKnownValue](#ReadonlySharedStyleMap-getAsKnownValue-member-1) - - [keys](#ReadonlySharedStyleMap-keys-member-1) - - [values](#ReadonlySharedStyleMap-values-member-1) -
- - - - -##### Signature - - -```ts -class ReadonlySharedStyleMap {} -``` - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `ReadonlySharedStyleMap` class - - -##### Parameters - - - - - - - -`entries` - - (optional) - - - - -```ts -Iterable< - [StyleProp, SharedStyle] -> -``` - - - - - - - -##### References - -[Iterable](/gen/Iterable-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - -## Properties - -### `map` \{#ReadonlySharedStyleMap-map-member} - -Public Property - -##### Signature - - -```ts -protected map: Map, SharedStyle> -``` - -##### References - -[Map](/gen/Map-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - -### `size` \{#ReadonlySharedStyleMap-size-member} - -Public Readonly Property - -##### Signature - - -```ts -get size(): number -``` - ---- - -## Methods - -### `[Symbol.iterator]()` \{#ReadonlySharedStyleMap-[Symbol-iterator]-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -IterableIterator<[StyleProp, SharedStyle]> -``` - -##### References - -[Symbol.iterator](/gen/SymbolConstructor-iterator), [IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - -### `entries()` \{#ReadonlySharedStyleMap-entries-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -IterableIterator<[StyleProp, SharedStyle]> -``` - -##### References - -[IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - -### `equals()` \{#ReadonlySharedStyleMap-equals-member-1} - -Public Method - -##### Parameters - - - - - - - -`other` - - - - -```ts -ReadonlySharedStyleMap -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[ReadonlySharedStyleMap](/gen/editor/ReadonlySharedStyleMap-class) - ---- - -### `get()` \{#ReadonlySharedStyleMap-get-member-1} - -Public Method - -##### Parameters - - - - - - - -`prop` - - - - -```ts -StyleProp -``` - - - - - - - -##### Returns - - -```ts -SharedStyle | undefined -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - -### `getAsKnownValue()` \{#ReadonlySharedStyleMap-getAsKnownValue-member-1} - -Public Method - -##### Parameters - - - - - - - -`prop` - - - - -```ts -StyleProp -``` - - - - - - - -##### Returns - - -```ts -T | undefined -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `keys()` \{#ReadonlySharedStyleMap-keys-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -IterableIterator> -``` - -##### References - -[IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `values()` \{#ReadonlySharedStyleMap-values-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -IterableIterator> -``` - -##### References - -[IterableIterator](/gen/IterableIterator-interface), [SharedStyle](/gen/editor/SharedStyle-type) - ---- - diff --git a/docs/gen/RecordId-type.mdx b/docs/gen/RecordId-type.mdx deleted file mode 100644 index 6eb4c7f71..000000000 --- a/docs/gen/RecordId-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: RecordId -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 19 ----Public TypeAlias - - - - -##### Signature - - -```ts -type RecordId = string & { - __type__: R -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - diff --git a/docs/gen/RecordType-class.mdx b/docs/gen/RecordType-class.mdx deleted file mode 100644 index e4a1c3e7d..000000000 --- a/docs/gen/RecordType-class.mdx +++ /dev/null @@ -1,689 +0,0 @@ ---- -title: RecordType -status: published -category: store -group: Class -author: api -date: 06/23/2023 -order: 21 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [createDefaultProperties](#RecordType-createDefaultProperties-member) - - [isInstance](#RecordType-isInstance-member) - - [migrations](#RecordType-migrations-member) - - [scope](#RecordType-scope-member) - - [typeName](#RecordType-typeName-member) - - [validator](#RecordType-validator-member) -- [Methods](#methods) - - [clone](#RecordType-clone-member-1) - - [create](#RecordType-create-member-1) - - [createCustomId](#RecordType-createCustomId-member-1) - - [createId](#RecordType-createId-member-1) - - [isId](#RecordType-isId-member-1) - - [parseId](#RecordType-parseId-member-1) - - [validate](#RecordType-validate-member-1) - - [withDefaultProperties](#RecordType-withDefaultProperties-member-1) -
- -A record type is a type that can be stored in a record store. It is created with `createRecordType`. - - -##### Signature - - -```ts -class RecordType< - R extends UnknownRecord, - RequiredProperties extends keyof Omit -> {} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Omit](/gen/Omit-type) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `RecordType` class - - -##### Parameters - - - - - - - -`typeName` - - - - -```ts -R['typeName'] -``` - - - - - - - - -`config` - - - - -```ts -{ - readonly createDefaultProperties: () => Exclude< - OmitMeta, - RequiredProperties - > - readonly migrations: Migrations - readonly validator?: - | { - validate: (r: unknown) => R - } - | StoreValidator - readonly scope?: RecordScope -} -``` - - - - - - - -##### References - -[Exclude](/gen/Exclude-type), [OmitMeta](/gen/store/~OmitMeta-type), [Migrations](/gen/store/Migrations-interface), [StoreValidator](/gen/store/StoreValidator-type), [RecordScope](/gen/store/~RecordScope-type) - ---- - -## Properties - -### `createDefaultProperties` \{#RecordType-createDefaultProperties-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly createDefaultProperties: () => Exclude< - OmitMeta, - RequiredProperties -> -``` - -##### References - -[Exclude](/gen/Exclude-type), [OmitMeta](/gen/store/~OmitMeta-type) - ---- - -### `isInstance` \{#RecordType-isInstance-member} - -Public Property - -Check whether a record is an instance of this record type. - - - - -##### Example - - - - -```ts -const result = recordType.isInstance(someRecord) -``` - - -##### Parameters - - - - - - - -`record` - - - - -The record to check. - - - - - - - - -##### Signature - - -```ts -isInstance: (record?: UnknownRecord) => record is R -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [record](/gen/store/~record) - ---- - -### `migrations` \{#RecordType-migrations-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly migrations: Migrations -``` - -##### References - -[Migrations](/gen/store/Migrations-interface) - ---- - -### `scope` \{#RecordType-scope-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly scope: RecordScope -``` - -##### References - -[RecordScope](/gen/store/~RecordScope-type) - ---- - -### `typeName` \{#RecordType-typeName-member} - -Public Readonly Property - -The unique type associated with this record. - - - -##### Signature - - -```ts -readonly typeName: R['typeName'] -``` - ---- - -### `validator` \{#RecordType-validator-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly validator: - | { - validate: (r: unknown) => R - } - | StoreValidator -``` - -##### References - -[StoreValidator](/gen/store/StoreValidator-type) - ---- - -## Methods - -### `clone()` \{#RecordType-clone-member-1} - -Public Method - -Clone a record of this type. - - -##### Parameters - - - - - - - -`record` - - - - -```ts -R -``` - -The record to clone. - - - - - - - - -##### Returns - - -```ts -R -``` - - The cloned record. - - ---- - -### `create()` \{#RecordType-create-member-1} - -Public Method - -Create a new record of this type. - - -##### Parameters - - - - - - - -`properties` - - - - -```ts -Pick & - Omit, RequiredProperties> -``` - -The properties of the record. - - - - - - - - -##### Returns - - -```ts -R -``` - - The new record. - - -##### References - -[Pick](/gen/Pick-type), [Omit](/gen/Omit-type), [Partial](/gen/Partial-type) - ---- - -### `createCustomId()` \{#RecordType-createCustomId-member-1} - -Public Method - -Create a new ID for this record type based on the given ID. - - - - -##### Example - - - - -```ts -const id = recordType.createCustomId('myId') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - -The ID to base the new ID on. - - - - - - - - -##### Returns - - -```ts -IdOf -``` - - The new ID. - - -##### References - -[IdOf](/gen/store/IdOf-type) - ---- - -### `createId()` \{#RecordType-createId-member-1} - -Public Method - -Create a new ID for this record type. - - - - -##### Example - - - - -```ts -const id = recordType.createId() -``` - - -##### Parameters - - - - - - - -`customUniquePart` - - (optional) - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -IdOf -``` - - The new ID. - - -##### References - -[IdOf](/gen/store/IdOf-type) - ---- - -### `isId()` \{#RecordType-isId-member-1} - -Public Method - -Check whether an id is an id of this type. - - - - -##### Example - - - - -```ts -const result = recordType.isIn('someId') -``` - - -##### Parameters - - - - - - - -`id` - - (optional) - - - - -```ts -string -``` - -The id to check. - - - - - - - - -##### Returns - - -```ts -id is IdOf -``` - - Whether the id is an id of this type. - - -##### References - -[id](/gen/store/~id), [IdOf](/gen/store/IdOf-type) - ---- - -### `parseId()` \{#RecordType-parseId-member-1} - -Public Method - -Takes an id like `user:123` and returns the part after the colon `123` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -IdOf -``` - -The id - - - - - - - - -##### Returns - - -```ts -string -``` - - - - -##### References - -[IdOf](/gen/store/IdOf-type) - ---- - -### `validate()` \{#RecordType-validate-member-1} - -Public Method - -Check that the passed in record passes the validations for this type. Returns its input correctly typed if it does, but throws an error otherwise. - - -##### Parameters - - - - - - - -`record` - - - - -```ts -unknown -``` - - - - - - - -##### Returns - - -```ts -R -``` - ---- - -### `withDefaultProperties()` \{#RecordType-withDefaultProperties-member-1} - -Public Method - -Create a new RecordType that has the same type name as this RecordType and includes the given default properties. - - - - -##### Example - - - - -```ts -const authorType = createRecordType('author', () => ({ living: true })) -const deadAuthorType = authorType.withDefaultProperties({ living: false }) -``` - - -##### Parameters - - - - - - - -`createDefaultProperties` - - - - -```ts -() => DefaultProps -``` - - - - - - - -##### Returns - - -```ts -RecordType> -``` - - The new RecordType. - - -##### References - -[Omit](/gen/Omit-type), [Partial](/gen/Partial-type), [RecordType](/gen/store/RecordType-class), [Exclude](/gen/Exclude-type) - ---- - diff --git a/docs/gen/RecordVersion-type.mdx b/docs/gen/RecordVersion-type.mdx deleted file mode 100644 index 1475d63e1..000000000 --- a/docs/gen/RecordVersion-type.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: RecordVersion -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 22 ----Public TypeAlias - - - - -##### Signature - - -```ts -type RecordVersion = { - rootVersion: number - subTypeVersion?: number -} -``` - diff --git a/docs/gen/RecordsDiff-type.mdx b/docs/gen/RecordsDiff-type.mdx deleted file mode 100644 index 0137896e2..000000000 --- a/docs/gen/RecordsDiff-type.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: RecordsDiff -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 20 ----Public TypeAlias - -A diff describing the changes to a record. - - -##### Signature - - -```ts -type RecordsDiff = { - added: Record, R> - updated: Record, [from: R, to: R]> - removed: Record, R> -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Record](/gen/Record-type), [IdOf](/gen/store/IdOf-type) - diff --git a/docs/gen/RequiredKeys-type.mdx b/docs/gen/RequiredKeys-type.mdx deleted file mode 100644 index f1a841046..000000000 --- a/docs/gen/RequiredKeys-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: RequiredKeys -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 94 ----Public TypeAlias - - - - -##### Signature - - -```ts -type RequiredKeys = Pick & Partial -``` - -##### References - -[Pick](/gen/Pick-type), [Partial](/gen/Partial-type) - diff --git a/docs/gen/RotateCorner-type.mdx b/docs/gen/RotateCorner-type.mdx deleted file mode 100644 index 948bd673c..000000000 --- a/docs/gen/RotateCorner-type.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: RotateCorner -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 75 ----Public TypeAlias - - - - -##### Signature - - -```ts -type RotateCorner = - | 'bottom_left_rotate' - | 'bottom_right_rotate' - | 'mobile_rotate' - | 'top_left_rotate' - | 'top_right_rotate' -``` - diff --git a/docs/gen/SIN-var.mdx b/docs/gen/SIN-var.mdx deleted file mode 100644 index 039509c12..000000000 --- a/docs/gen/SIN-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: SIN -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 84 ----Public Readonly Variable - - - - -##### Signature - - -```ts -SIN: (x: number) => number -``` - diff --git a/docs/gen/SVGContainer-function-1.mdx b/docs/gen/SVGContainer-function-1.mdx deleted file mode 100644 index 1fc3e3e84..000000000 --- a/docs/gen/SVGContainer-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: SVGContainer -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 103 ----Public Function - - - - -##### Parameters - - - - - - - -`{ children, className, ...rest }` - - - - -```ts -SVGContainerProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[SVGContainerProps](/gen/editor/SVGContainerProps-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/SVGContainerProps-type.mdx b/docs/gen/SVGContainerProps-type.mdx deleted file mode 100644 index 8307878b9..000000000 --- a/docs/gen/SVGContainerProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: SVGContainerProps -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 104 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SVGContainerProps = React.HTMLAttributes -``` - -##### References - -[React.HTMLAttributes](/gen/@types/react-React-HTMLAttributes-interface), [SVGElement](/gen/SVGElement-interface) - diff --git a/docs/gen/SchemaShapeInfo-type.mdx b/docs/gen/SchemaShapeInfo-type.mdx deleted file mode 100644 index debaae099..000000000 --- a/docs/gen/SchemaShapeInfo-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: SchemaShapeInfo -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 47 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SchemaShapeInfo = { - migrations?: Migrations - props?: Record< - string, - { - validate: (prop: any) => any - } - > -} -``` - -##### References - -[Migrations](/gen/store/Migrations-interface), [Record](/gen/Record-type) - diff --git a/docs/gen/SelectionCorner-type.mdx b/docs/gen/SelectionCorner-type.mdx deleted file mode 100644 index f2753ce0c..000000000 --- a/docs/gen/SelectionCorner-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: SelectionCorner -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 77 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SelectionCorner = 'bottom_left' | 'bottom_right' | 'top_left' | 'top_right' -``` - diff --git a/docs/gen/SelectionEdge-type.mdx b/docs/gen/SelectionEdge-type.mdx deleted file mode 100644 index cc1ff01e8..000000000 --- a/docs/gen/SelectionEdge-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: SelectionEdge -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 78 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SelectionEdge = 'bottom' | 'left' | 'right' | 'top' -``` - diff --git a/docs/gen/SelectionHandle-type.mdx b/docs/gen/SelectionHandle-type.mdx deleted file mode 100644 index 92d3b4b4c..000000000 --- a/docs/gen/SelectionHandle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: SelectionHandle -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 79 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SelectionHandle = SelectionCorner | SelectionEdge -``` - -##### References - -[SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type) - diff --git a/docs/gen/SerializedSchema-interface.mdx b/docs/gen/SerializedSchema-interface.mdx deleted file mode 100644 index 89782f3e5..000000000 --- a/docs/gen/SerializedSchema-interface.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: SerializedSchema -status: published -category: store -group: Interface -author: api -date: 06/23/2023 -order: 24 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [recordVersions](#SerializedSchema-recordVersions-member) - - [schemaVersion](#SerializedSchema-schemaVersion-member) - - [storeVersion](#SerializedSchema-storeVersion-member) -
- - - - -##### Signature - - -```ts -interface SerializedSchema {} -``` - ---- - -## Properties - -### `recordVersions` \{#SerializedSchema-recordVersions-member} - -Public PropertySignature - -Record versions are the versions for each record type. e.g. adding a new field to a record - - -##### Signature - - -```ts -recordVersions: Record< - string, - | { - version: number - subTypeVersions: Record - subTypeKey: string - } - | { - version: number - } -> -``` - -##### References - -[Record](/gen/Record-type) - ---- - -### `schemaVersion` \{#SerializedSchema-schemaVersion-member} - -Public PropertySignature - -Schema version is the version for this type you're looking at right now - - -##### Signature - - -```ts -schemaVersion: number -``` - ---- - -### `storeVersion` \{#SerializedSchema-storeVersion-member} - -Public PropertySignature - -Store version is the version for the structure of the store. e.g. higher level structure like removing or renaming a record type. - - -##### Signature - - -```ts -storeVersion: number -``` - ---- - diff --git a/docs/gen/ShapeProps-type.mdx b/docs/gen/ShapeProps-type.mdx deleted file mode 100644 index 92ee1eda7..000000000 --- a/docs/gen/ShapeProps-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ShapeProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 49 ----Public TypeAlias - - - - -##### Signature - - -```ts -type ShapeProps> = { - [K in keyof Shape['props']]: T.Validatable -} -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [T.Validatable](/gen/validate/Validatable-type) - diff --git a/docs/gen/ShapeUtil-class.mdx b/docs/gen/ShapeUtil-class.mdx deleted file mode 100644 index 24501ebb1..000000000 --- a/docs/gen/ShapeUtil-class.mdx +++ /dev/null @@ -1,2723 +0,0 @@ ---- -title: ShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 99 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canBind](#ShapeUtil-canBind-member) - - [canCrop](#ShapeUtil-canCrop-member) - - [canEdit](#ShapeUtil-canEdit-member) - - [canResize](#ShapeUtil-canResize-member) - - [canScroll](#ShapeUtil-canScroll-member) - - [canSnap](#ShapeUtil-canSnap-member) - - [canUnmount](#ShapeUtil-canUnmount-member) - - [editor](#ShapeUtil-editor-member) - - [hideResizeHandles](#ShapeUtil-hideResizeHandles-member) - - [hideRotateHandle](#ShapeUtil-hideRotateHandle-member) - - [hideSelectionBoundsBg](#ShapeUtil-hideSelectionBoundsBg-member) - - [hideSelectionBoundsFg](#ShapeUtil-hideSelectionBoundsFg-member) - - [isAspectRatioLocked](#ShapeUtil-isAspectRatioLocked-member) - - [isClosed](#ShapeUtil-isClosed-member) - - [onBeforeCreate](#ShapeUtil-onBeforeCreate-member) - - [onBeforeUpdate](#ShapeUtil-onBeforeUpdate-member) - - [onChildrenChange](#ShapeUtil-onChildrenChange-member) - - [onClick](#ShapeUtil-onClick-member) - - [onDoubleClick](#ShapeUtil-onDoubleClick-member) - - [onDoubleClickEdge](#ShapeUtil-onDoubleClickEdge-member) - - [onDoubleClickHandle](#ShapeUtil-onDoubleClickHandle-member) - - [onDragShapesOut](#ShapeUtil-onDragShapesOut-member) - - [onDragShapesOver](#ShapeUtil-onDragShapesOver-member) - - [onDropShapesOver](#ShapeUtil-onDropShapesOver-member) - - [onEditEnd](#ShapeUtil-onEditEnd-member) - - [onHandleChange](#ShapeUtil-onHandleChange-member) - - [onResize](#ShapeUtil-onResize-member) - - [onResizeEnd](#ShapeUtil-onResizeEnd-member) - - [onResizeStart](#ShapeUtil-onResizeStart-member) - - [onRotate](#ShapeUtil-onRotate-member) - - [onRotateEnd](#ShapeUtil-onRotateEnd-member) - - [onRotateStart](#ShapeUtil-onRotateStart-member) - - [onTranslate](#ShapeUtil-onTranslate-member) - - [onTranslateEnd](#ShapeUtil-onTranslateEnd-member) - - [onTranslateStart](#ShapeUtil-onTranslateStart-member) - - [styleProps](#ShapeUtil-styleProps-member) - - [type](#ShapeUtil-type-member) - - [type](#ShapeUtil-type-member) -- [Methods](#methods) - - [canDropShapes](#ShapeUtil-canDropShapes-member-1) - - [canReceiveNewChildrenOfType](#ShapeUtil-canReceiveNewChildrenOfType-member-1) - - [center](#ShapeUtil-center-member-1) - - [component](#ShapeUtil-component-member-1) - - [getBounds](#ShapeUtil-getBounds-member-1) - - [getCenter](#ShapeUtil-getCenter-member-1) - - [getDefaultProps](#ShapeUtil-getDefaultProps-member-1) - - [getHandles](#ShapeUtil-getHandles-member-1) - - [getOutline](#ShapeUtil-getOutline-member-1) - - [getOutlineSegments](#ShapeUtil-getOutlineSegments-member-1) - - [getStyleIfExists](#ShapeUtil-getStyleIfExists-member-1) - - [hasStyle](#ShapeUtil-hasStyle-member-1) - - [hitTestLineSegment](#ShapeUtil-hitTestLineSegment-member-1) - - [hitTestPoint](#ShapeUtil-hitTestPoint-member-1) - - [indicator](#ShapeUtil-indicator-member-1) - - [iterateStyles](#ShapeUtil-iterateStyles-member-1) - - [setStyleInPartial](#ShapeUtil-setStyleInPartial-member-1) - - [snapPoints](#ShapeUtil-snapPoints-member-1) - - [toBackgroundSvg](#ShapeUtil-toBackgroundSvg-member-1) - - [toSvg](#ShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -abstract class ShapeUtil {} -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `ShapeUtil` class - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - - -`type` - - - - -```ts -Shape['type'] -``` - - - - - - - - -`styleProps` - - - - -```ts -ReadonlyMap, string> -``` - - - - - - - -##### References - -[Editor](/gen/editor/Editor-class), [ReadonlyMap](/gen/ReadonlyMap-interface), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -## Properties - -### `canBind` \{#ShapeUtil-canBind-member} - -Public Property - -Whether the shape can be bound to by an arrow. - - -##### Parameters - - - - - - - -`_otherShape` - - - - -The other shape attempting to bind to this shape. - - - - - - - - -##### Signature - - -```ts -canBind: (_shape: Shape, _otherShape?: K | undefined) => boolean -``` - ---- - -### `canCrop` \{#ShapeUtil-canCrop-member} - -Public Property - -Whether the shape can be cropped. - - -##### Signature - - -```ts -canCrop: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `canEdit` \{#ShapeUtil-canEdit-member} - -Public Property - -Whether the shape can be double clicked to edit. - - -##### Signature - - -```ts -canEdit: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `canResize` \{#ShapeUtil-canResize-member} - -Public Property - -Whether the shape can be resized. - - -##### Signature - - -```ts -canResize: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `canScroll` \{#ShapeUtil-canScroll-member} - -Public Property - -Whether the shape can be scrolled while editing. - - -##### Signature - - -```ts -canScroll: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `canSnap` \{#ShapeUtil-canSnap-member} - -Public Property - -Whether the shape can be snapped to by another shape. - - -##### Signature - - -```ts -canSnap: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `canUnmount` \{#ShapeUtil-canUnmount-member} - -Public Property - -Whether the shape should unmount when not visible in the editor. Consider keeping this to false if the shape's `component` has local state. - - -##### Signature - - -```ts -canUnmount: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `editor` \{#ShapeUtil-editor-member} - -Public Property - -##### Signature - - -```ts -editor: Editor -``` - -##### References - -[Editor](/gen/editor/Editor-class) - ---- - -### `hideResizeHandles` \{#ShapeUtil-hideResizeHandles-member} - -Public Property - -Whether the shape should hide its resize handles when selected. - - -##### Signature - - -```ts -hideResizeHandles: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `hideRotateHandle` \{#ShapeUtil-hideRotateHandle-member} - -Public Property - -Whether the shape should hide its resize handles when selected. - - -##### Signature - - -```ts -hideRotateHandle: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `hideSelectionBoundsBg` \{#ShapeUtil-hideSelectionBoundsBg-member} - -Public Property - -Whether the shape should hide its selection bounds background when selected. - - -##### Signature - - -```ts -hideSelectionBoundsBg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `hideSelectionBoundsFg` \{#ShapeUtil-hideSelectionBoundsFg-member} - -Public Property - -Whether the shape should hide its selection bounds foreground when selected. - - -##### Signature - - -```ts -hideSelectionBoundsFg: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `isAspectRatioLocked` \{#ShapeUtil-isAspectRatioLocked-member} - -Public Property - -Whether the shape's aspect ratio is locked. - - -##### Signature - - -```ts -isAspectRatioLocked: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `isClosed` \{#ShapeUtil-isClosed-member} - -Public Property - -Whether the shape's outline is closed. - - -##### Signature - - -```ts -isClosed: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type) - ---- - -### `onBeforeCreate` \{#ShapeUtil-onBeforeCreate-member} - -Public Property - -A callback called just before a shape is created. This method provides a last chance to modify the created shape. - - - - -##### Example - - - - -```ts -onBeforeCreate = (next) => { - return { ...next, x: next.x + 1 } -} -``` - - -##### Parameters - - - - - - - -`next` - - - - -The next shape. - - - - - - - - -##### Signature - - -```ts -onBeforeCreate?: TLOnBeforeCreateHandler -``` - -##### References - -[TLOnBeforeCreateHandler](/gen/editor/TLOnBeforeCreateHandler-type) - ---- - -### `onBeforeUpdate` \{#ShapeUtil-onBeforeUpdate-member} - -Public Property - -A callback called just before a shape is updated. This method provides a last chance to modify the updated shape. - - - - -##### Example - - - - -```ts -onBeforeUpdate = (prev, next) => { - if (prev.x === next.x) { - return { ...next, x: next.x + 1 } - } -} -``` - - -##### Parameters - - - - - - - -`prev` - - - - -The previous shape. - - - - - - - - - -`next` - - - - -The next shape. - - - - - - - - -##### Signature - - -```ts -onBeforeUpdate?: TLOnBeforeUpdateHandler -``` - -##### References - -[TLOnBeforeUpdateHandler](/gen/editor/TLOnBeforeUpdateHandler-type) - ---- - -### `onChildrenChange` \{#ShapeUtil-onChildrenChange-member} - -Public Property - -A callback called when a shape's children change. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onChildrenChange?: TLOnChildrenChangeHandler -``` - -##### References - -[TLOnChildrenChangeHandler](/gen/editor/TLOnChildrenChangeHandler-type) - ---- - -### `onClick` \{#ShapeUtil-onClick-member} - -Public Property - -A callback called when a shape is clicked. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onClick?: TLOnClickHandler -``` - -##### References - -[TLOnClickHandler](/gen/editor/TLOnClickHandler-type) - ---- - -### `onDoubleClick` \{#ShapeUtil-onDoubleClick-member} - -Public Property - -A callback called when a shape is double clicked. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onDoubleClick?: TLOnDoubleClickHandler -``` - -##### References - -[TLOnDoubleClickHandler](/gen/editor/TLOnDoubleClickHandler-type) - ---- - -### `onDoubleClickEdge` \{#ShapeUtil-onDoubleClickEdge-member} - -Public Property - -A callback called when a shape's edge is double clicked. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onDoubleClickEdge?: TLOnDoubleClickHandler -``` - -##### References - -[TLOnDoubleClickHandler](/gen/editor/TLOnDoubleClickHandler-type) - ---- - -### `onDoubleClickHandle` \{#ShapeUtil-onDoubleClickHandle-member} - -Public Property - -A callback called when a shape's handle is double clicked. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - - -`handle` - - - - -The handle that is double-clicked. - - - - - - - - -##### Signature - - -```ts -onDoubleClickHandle?: TLOnDoubleClickHandleHandler -``` - -##### References - -[TLOnDoubleClickHandleHandler](/gen/editor/TLOnDoubleClickHandleHandler-type) - ---- - -### `onDragShapesOut` \{#ShapeUtil-onDragShapesOut-member} - -Public Property - -A callback called when some other shapes are dragged out of this one. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - - -`shapes` - - - - -The shapes that are being dragged out. - - - - - - - - -##### Signature - - -```ts -onDragShapesOut?: TLOnDragHandler -``` - -##### References - -[TLOnDragHandler](/gen/editor/TLOnDragHandler-type) - ---- - -### `onDragShapesOver` \{#ShapeUtil-onDragShapesOver-member} - -Public Property - -A callback called when some other shapes are dragged over this one. - - - - -##### Example - - - - -```ts -onDragShapesOver = (shape, shapes) => { - return { shouldHint: true } -} -``` - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - - -`shapes` - - - - -The shapes that are being dragged over this one. - - - - - - - - -##### Signature - - -```ts -onDragShapesOver?: TLOnDragHandler< - Shape, - { - shouldHint: boolean - } -> -``` - -##### References - -[TLOnDragHandler](/gen/editor/TLOnDragHandler-type) - ---- - -### `onDropShapesOver` \{#ShapeUtil-onDropShapesOver-member} - -Public Property - -A callback called when some other shapes are dropped over this one. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - - -`shapes` - - - - -The shapes that are being dropped over this one. - - - - - - - - -##### Signature - - -```ts -onDropShapesOver?: TLOnDragHandler -``` - -##### References - -[TLOnDragHandler](/gen/editor/TLOnDragHandler-type) - ---- - -### `onEditEnd` \{#ShapeUtil-onEditEnd-member} - -Public Property - -A callback called when a shape finishes being editing. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onEditEnd?: TLOnEditEndHandler -``` - -##### References - -[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type) - ---- - -### `onHandleChange` \{#ShapeUtil-onHandleChange-member} - -Public Property - -A callback called when a shape's handle changes. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - - -`info` - - - - -An object containing the handle and whether the handle is 'precise' or not. - - - - - - - - -##### Signature - - -```ts -onHandleChange?: TLOnHandleChangeHandler -``` - -##### References - -[TLOnHandleChangeHandler](/gen/editor/TLOnHandleChangeHandler-type) - ---- - -### `onResize` \{#ShapeUtil-onResize-member} - -Public Property - -A callback called when a shape changes from a resize. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape at the start of the resize. - - - - - - - - - -`info` - - - - -Info about the resize. - - - - - - - - -##### Signature - - -```ts -onResize?: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type) - ---- - -### `onResizeEnd` \{#ShapeUtil-onResizeEnd-member} - -Public Property - -A callback called when a shape finishes resizing. - - -##### Parameters - - - - - - - -`initial` - - - - -The shape at the start of the resize. - - - - - - - - - -`current` - - - - -The current shape. - - - - - - - - -##### Signature - - -```ts -onResizeEnd?: TLOnResizeEndHandler -``` - -##### References - -[TLOnResizeEndHandler](/gen/editor/TLOnResizeEndHandler-type) - ---- - -### `onResizeStart` \{#ShapeUtil-onResizeStart-member} - -Public Property - -A callback called when a shape starts being resized. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onResizeStart?: TLOnResizeStartHandler -``` - -##### References - -[TLOnResizeStartHandler](/gen/editor/TLOnResizeStartHandler-type) - ---- - -### `onRotate` \{#ShapeUtil-onRotate-member} - -Public Property - -A callback called when a shape changes from a rotation. - - -##### Parameters - - - - - - - -`initial` - - - - -The shape at the start of the rotation. - - - - - - - - - -`current` - - - - -The current shape. - - - - - - - - -##### Signature - - -```ts -onRotate?: TLOnRotateHandler -``` - -##### References - -[TLOnRotateHandler](/gen/editor/TLOnRotateHandler-type) - ---- - -### `onRotateEnd` \{#ShapeUtil-onRotateEnd-member} - -Public Property - -A callback called when a shape finishes rotating. - - -##### Parameters - - - - - - - -`initial` - - - - -The shape at the start of the rotation. - - - - - - - - - -`current` - - - - -The current shape. - - - - - - - - -##### Signature - - -```ts -onRotateEnd?: TLOnRotateEndHandler -``` - -##### References - -[TLOnRotateEndHandler](/gen/editor/TLOnRotateEndHandler-type) - ---- - -### `onRotateStart` \{#ShapeUtil-onRotateStart-member} - -Public Property - -A callback called when a shape starts being rotated. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onRotateStart?: TLOnRotateStartHandler -``` - -##### References - -[TLOnRotateStartHandler](/gen/editor/TLOnRotateStartHandler-type) - ---- - -### `onTranslate` \{#ShapeUtil-onTranslate-member} - -Public Property - -A callback called when a shape changes from a translation. - - -##### Parameters - - - - - - - -`initial` - - - - -The shape at the start of the translation. - - - - - - - - - -`current` - - - - -The current shape. - - - - - - - - -##### Signature - - -```ts -onTranslate?: TLOnTranslateHandler -``` - -##### References - -[TLOnTranslateHandler](/gen/editor/TLOnTranslateHandler-type) - ---- - -### `onTranslateEnd` \{#ShapeUtil-onTranslateEnd-member} - -Public Property - -A callback called when a shape finishes translating. - - -##### Parameters - - - - - - - -`initial` - - - - -The shape at the start of the translation. - - - - - - - - - -`current` - - - - -The current shape. - - - - - - - - -##### Signature - - -```ts -onTranslateEnd?: TLOnTranslateEndHandler -``` - -##### References - -[TLOnTranslateEndHandler](/gen/editor/TLOnTranslateEndHandler-type) - ---- - -### `onTranslateStart` \{#ShapeUtil-onTranslateStart-member} - -Public Property - -A callback called when a shape starts being translated. - - -##### Parameters - - - - - - - -`shape` - - - - -The shape. - - - - - - - - -##### Signature - - -```ts -onTranslateStart?: TLOnTranslateStartHandler -``` - -##### References - -[TLOnTranslateStartHandler](/gen/editor/TLOnTranslateStartHandler-type) - ---- - -### `styleProps` \{#ShapeUtil-styleProps-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly styleProps: ReadonlyMap, string> -``` - -##### References - -[ReadonlyMap](/gen/ReadonlyMap-interface), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `type` \{#ShapeUtil-type-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly type: Shape['type'] -``` - ---- - -### `type` \{#ShapeUtil-type-member} - -Public Static Property - -The type of the shape util, which should match the shape's type. - - -##### Signature - - -```ts -static type: string -``` - ---- - -## Methods - -### `canDropShapes()` \{#ShapeUtil-canDropShapes-member-1} - -Public Method - -Get whether the shape can receive children of a given type. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape type. - - - - - - - - - -`shapes` - - - - -```ts -TLShape[] -``` - -The shapes that are being dropped. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `canReceiveNewChildrenOfType()` \{#ShapeUtil-canReceiveNewChildrenOfType-member-1} - -Public Method - -Get whether the shape can receive children of a given type. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - - - - - - - - -`type` - - - - -```ts -TLShape['type'] -``` - -The shape type. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - -### `center()` \{#ShapeUtil-center-member-1} - -Public Method - -Get the shape's cached center. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `component()` \{#ShapeUtil-component-member-1} - -Public Method - -Get a JSX element for the shape (as an HTML element). - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -any -``` - ---- - -### `getBounds()` \{#ShapeUtil-getBounds-member-1} - -Public Method - -Get the (not cached) bounds for the shape. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - ---- - -### `getCenter()` \{#ShapeUtil-getCenter-member-1} - -Public Method - -Get the shape's (not cached) center. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getDefaultProps()` \{#ShapeUtil-getDefaultProps-member-1} - -Public Method - -Get the default props for a shape. - - -##### Parameters - - -None - -##### Returns - - -```ts -Shape['props'] -``` - ---- - -### `getHandles()` \{#ShapeUtil-getHandles-member-1} - -Public Method - -Get an array of handle models for the shape. This is an optional method. - - - - -##### Example - - - - -```ts -util.getHandles?.(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -TLHandle[] -``` - -##### References - -[TLHandle](/gen/tlschema/TLHandle-interface) - ---- - -### `getOutline()` \{#ShapeUtil-getOutline-member-1} - -Public Method - -Get the shape's (not cached) outline. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getOutlineSegments()` \{#ShapeUtil-getOutlineSegments-member-1} - -Public Method - -Get an array of outline segments for the shape. For most shapes, this will be a single segment that includes the entire outline. For shapes with handles, this might be segments of the outline between each handle. - - - - -##### Example - - - - -```ts -util.getOutlineSegments(myShape) -``` - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Vec2d[][] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `getStyleIfExists()` \{#ShapeUtil-getStyleIfExists-member-1} - -Public Method - -##### Parameters - - - - - - - -`style` - - - - -```ts -StyleProp -``` - - - - - - - - -`shape` - - - - -```ts -Shape | TLShapePartial -``` - - - - - - - -##### Returns - - -```ts -T | undefined -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `hasStyle()` \{#ShapeUtil-hasStyle-member-1} - -Public Method - -##### Parameters - - - - - - - -`style` - - - - -```ts -StyleProp -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `hitTestLineSegment()` \{#ShapeUtil-hitTestLineSegment-member-1} - -Public Method - -Get whether a point intersects the shape. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The line segment's first point. - - - - - - - - - -`B` - - - - -```ts -VecLike -``` - -The line segment's second point. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Whether the line segment intersects the shape. - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `hitTestPoint()` \{#ShapeUtil-hitTestPoint-member-1} - -Public Method - -Get whether a point intersects the shape. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The point to test. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Whether the point intersects the shape. - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `indicator()` \{#ShapeUtil-indicator-member-1} - -Public Method - -Get JSX describing the shape's indicator (as an SVG element). - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -any -``` - ---- - -### `iterateStyles()` \{#ShapeUtil-iterateStyles-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape | TLShapePartial -``` - - - - - - - -##### Returns - - -```ts -Generator<[StyleProp, unknown], void, unknown> -``` - -##### References - -[TLShapePartial](/gen/tlschema/TLShapePartial-type), [Generator](/gen/Generator-interface), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `setStyleInPartial()` \{#ShapeUtil-setStyleInPartial-member-1} - -Public Method - -##### Parameters - - - - - - - -`style` - - - - -```ts -StyleProp -``` - - - - - - - - -`shape` - - - - -```ts -TLShapePartial -``` - - - - - - - - -`value` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -TLShapePartial -``` - -##### References - -[StyleProp](/gen/tlschema/StyleProp-class), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - ---- - -### `snapPoints()` \{#ShapeUtil-snapPoints-member-1} - -Public Method - -Get the shape's snap points. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `toBackgroundSvg()` \{#ShapeUtil-toBackgroundSvg-member-1} - -Public Method - -Get the shape's background layer as an SVG object. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - - -`font` - - - - -```ts -string | undefined -``` - -The shape's CSS font (actual). - - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -null | Promise | SVGElement -``` - - An SVG element. - - -##### References - -[TLExportColors](/gen/editor/~TLExportColors-type), [Promise](/gen/Promise-interface), [SVGElement](/gen/SVGElement-interface) - ---- - -### `toSvg()` \{#ShapeUtil-toSvg-member-1} - -Public Method - -Get the shape as an SVG object. - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -Shape -``` - -The shape. - - - - - - - - - -`font` - - - - -```ts -string | undefined -``` - -The shape's CSS font (actual). - - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -Promise | SVGElement -``` - - An SVG element. - - -##### References - -[TLExportColors](/gen/editor/~TLExportColors-type), [Promise](/gen/Promise-interface), [SVGElement](/gen/SVGElement-interface) - ---- - diff --git a/docs/gen/SharedStyle-type.mdx b/docs/gen/SharedStyle-type.mdx deleted file mode 100644 index a191e13b6..000000000 --- a/docs/gen/SharedStyle-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: SharedStyle -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 100 ----Public TypeAlias - - - - -##### Signature - - -```ts -type SharedStyle = - | { - readonly type: 'mixed' - } - | { - readonly type: 'shared' - readonly value: T - } -``` - diff --git a/docs/gen/StateNode-class.mdx b/docs/gen/StateNode-class.mdx deleted file mode 100644 index 56af17132..000000000 --- a/docs/gen/StateNode-class.mdx +++ /dev/null @@ -1,846 +0,0 @@ ---- -title: StateNode -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 102 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [children](#StateNode-children-member) - - [children](#StateNode-children-member) - - [current](#StateNode-current-member) - - [editor](#StateNode-editor-member) - - [id](#StateNode-id-member) - - [id](#StateNode-id-member) - - [initial](#StateNode-initial-member) - - [initial](#StateNode-initial-member) - - [isActive](#StateNode-isActive-member) - - [onCancel](#StateNode-onCancel-member) - - [onComplete](#StateNode-onComplete-member) - - [onDoubleClick](#StateNode-onDoubleClick-member) - - [onEnter](#StateNode-onEnter-member) - - [onExit](#StateNode-onExit-member) - - [onInterrupt](#StateNode-onInterrupt-member) - - [onKeyDown](#StateNode-onKeyDown-member) - - [onKeyRepeat](#StateNode-onKeyRepeat-member) - - [onKeyUp](#StateNode-onKeyUp-member) - - [onMiddleClick](#StateNode-onMiddleClick-member) - - [onPointerDown](#StateNode-onPointerDown-member) - - [onPointerEnter](#StateNode-onPointerEnter-member) - - [onPointerLeave](#StateNode-onPointerLeave-member) - - [onPointerMove](#StateNode-onPointerMove-member) - - [onPointerUp](#StateNode-onPointerUp-member) - - [onQuadrupleClick](#StateNode-onQuadrupleClick-member) - - [onRightClick](#StateNode-onRightClick-member) - - [onTripleClick](#StateNode-onTripleClick-member) - - [onWheel](#StateNode-onWheel-member) - - [parent](#StateNode-parent-member) - - [path](#StateNode-path-member) - - [shapeType](#StateNode-shapeType-member) - - [type](#StateNode-type-member) -- [Methods](#methods) - - [enter](#StateNode-enter-member-1) - - [exit](#StateNode-exit-member-1) - - [handleEvent](#StateNode-handleEvent-member-1) - - [transition](#StateNode-transition-member-1) -
- - - - -##### Signature - - -```ts -abstract class StateNode implements Partial {} -``` - -##### References - -[Partial](/gen/Partial-type), [TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `StateNode` class - - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - - -`parent` - - (optional) - - - - -```ts -StateNode -``` - - - - - - - -##### References - -[Editor](/gen/editor/Editor-class), [StateNode](/gen/editor/StateNode-class) - ---- - -## Properties - -### `children` \{#StateNode-children-member} - -Public Property - -##### Signature - - -```ts -children?: Record -``` - -##### References - -[Record](/gen/Record-type), [StateNode](/gen/editor/StateNode-class) - ---- - -### `children` \{#StateNode-children-member} - -Public Static Property - -##### Signature - - -```ts -static children?: () => TLStateNodeConstructor[] -``` - -##### References - -[TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface) - ---- - -### `current` \{#StateNode-current-member} - -Public Property - -##### Signature - - -```ts -current: Atom -``` - -##### References - -[Atom](/gen/state/Atom-interface), [StateNode](/gen/editor/StateNode-class) - ---- - -### `editor` \{#StateNode-editor-member} - -Public Property - -##### Signature - - -```ts -editor: Editor -``` - -##### References - -[Editor](/gen/editor/Editor-class) - ---- - -### `id` \{#StateNode-id-member} - -Public Property - -##### Signature - - -```ts -id: string -``` - ---- - -### `id` \{#StateNode-id-member} - -Public Static Property - -##### Signature - - -```ts -static id: string -``` - ---- - -### `initial` \{#StateNode-initial-member} - -Public Property - -##### Signature - - -```ts -initial?: string -``` - ---- - -### `initial` \{#StateNode-initial-member} - -Public Static Property - -##### Signature - - -```ts -static initial?: string -``` - ---- - -### `isActive` \{#StateNode-isActive-member} - -Public Property - -##### Signature - - -```ts -isActive: boolean -``` - ---- - -### `onCancel` \{#StateNode-onCancel-member} - -Public Property - -##### Signature - - -```ts -onCancel?: TLEventHandlers['onCancel'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onComplete` \{#StateNode-onComplete-member} - -Public Property - -##### Signature - - -```ts -onComplete?: TLEventHandlers['onComplete'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onDoubleClick` \{#StateNode-onDoubleClick-member} - -Public Property - -##### Signature - - -```ts -onDoubleClick?: TLEventHandlers['onDoubleClick'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onEnter` \{#StateNode-onEnter-member} - -Public Property - -##### Signature - - -```ts -onEnter?: TLEnterEventHandler -``` - -##### References - -[TLEnterEventHandler](/gen/editor/TLEnterEventHandler-type) - ---- - -### `onExit` \{#StateNode-onExit-member} - -Public Property - -##### Signature - - -```ts -onExit?: TLExitEventHandler -``` - -##### References - -[TLExitEventHandler](/gen/editor/TLExitEventHandler-type) - ---- - -### `onInterrupt` \{#StateNode-onInterrupt-member} - -Public Property - -##### Signature - - -```ts -onInterrupt?: TLEventHandlers['onInterrupt'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onKeyDown` \{#StateNode-onKeyDown-member} - -Public Property - -##### Signature - - -```ts -onKeyDown?: TLEventHandlers['onKeyDown'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onKeyRepeat` \{#StateNode-onKeyRepeat-member} - -Public Property - -##### Signature - - -```ts -onKeyRepeat?: TLEventHandlers['onKeyRepeat'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onKeyUp` \{#StateNode-onKeyUp-member} - -Public Property - -##### Signature - - -```ts -onKeyUp?: TLEventHandlers['onKeyUp'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onMiddleClick` \{#StateNode-onMiddleClick-member} - -Public Property - -##### Signature - - -```ts -onMiddleClick?: TLEventHandlers['onMiddleClick'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onPointerDown` \{#StateNode-onPointerDown-member} - -Public Property - -##### Signature - - -```ts -onPointerDown?: TLEventHandlers['onPointerDown'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onPointerEnter` \{#StateNode-onPointerEnter-member} - -Public Property - -##### Signature - - -```ts -onPointerEnter?: TLEventHandlers['onPointerEnter'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onPointerLeave` \{#StateNode-onPointerLeave-member} - -Public Property - -##### Signature - - -```ts -onPointerLeave?: TLEventHandlers['onPointerLeave'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onPointerMove` \{#StateNode-onPointerMove-member} - -Public Property - -##### Signature - - -```ts -onPointerMove?: TLEventHandlers['onPointerMove'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onPointerUp` \{#StateNode-onPointerUp-member} - -Public Property - -##### Signature - - -```ts -onPointerUp?: TLEventHandlers['onPointerUp'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onQuadrupleClick` \{#StateNode-onQuadrupleClick-member} - -Public Property - -##### Signature - - -```ts -onQuadrupleClick?: TLEventHandlers['onQuadrupleClick'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onRightClick` \{#StateNode-onRightClick-member} - -Public Property - -##### Signature - - -```ts -onRightClick?: TLEventHandlers['onRightClick'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onTripleClick` \{#StateNode-onTripleClick-member} - -Public Property - -##### Signature - - -```ts -onTripleClick?: TLEventHandlers['onTripleClick'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `onWheel` \{#StateNode-onWheel-member} - -Public Property - -##### Signature - - -```ts -onWheel?: TLEventHandlers['onWheel'] -``` - -##### References - -[TLEventHandlers](/gen/editor/TLEventHandlers-interface) - ---- - -### `parent` \{#StateNode-parent-member} - -Public Property - -##### Signature - - -```ts -parent: StateNode -``` - -##### References - -[StateNode](/gen/editor/StateNode-class) - ---- - -### `path` \{#StateNode-path-member} - -Public Property - -##### Signature - - -```ts -path: Computed -``` - -##### References - -[Computed](/gen/state/Computed-interface) - ---- - -### `shapeType` \{#StateNode-shapeType-member} - -Public Property - -##### Signature - - -```ts -shapeType?: TLShapeUtilConstructor> -``` - -##### References - -[TLShapeUtilConstructor](/gen/editor/TLShapeUtilConstructor-interface), [TLBaseShape](/gen/tlschema/TLBaseShape-interface) - ---- - -### `type` \{#StateNode-type-member} - -Public Property - -##### Signature - - -```ts -type: TLStateNodeType -``` - -##### References - -[TLStateNodeType](/gen/editor/~TLStateNodeType-type) - ---- - -## Methods - -### `enter()` \{#StateNode-enter-member-1} - -Public Method - -##### Parameters - - - - - - - -`info` - - - - -```ts -any -``` - - - - - - - - -`from` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `exit()` \{#StateNode-exit-member-1} - -Public Method - -##### Parameters - - - - - - - -`info` - - - - -```ts -any -``` - - - - - - - - -`from` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `handleEvent()` \{#StateNode-handleEvent-member-1} - -Public Method - -##### Parameters - - - - - - - -`info` - - - - -```ts -Exclude -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Exclude](/gen/Exclude-type), [TLEventInfo](/gen/editor/TLEventInfo-type), [TLPinchEventInfo](/gen/editor/TLPinchEventInfo-type) - ---- - -### `transition()` \{#StateNode-transition-member-1} - -Public Method - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`info` - - - - -```ts -any -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - diff --git a/docs/gen/Store-class.mdx b/docs/gen/Store-class.mdx deleted file mode 100644 index 191b027c8..000000000 --- a/docs/gen/Store-class.mdx +++ /dev/null @@ -1,1292 +0,0 @@ ---- -title: Store -status: published -category: store -group: Class -author: api -date: 06/23/2023 -order: 26 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [allRecords](#Store-allRecords-member) - - [clear](#Store-clear-member) - - [createComputedCache](#Store-createComputedCache-member) - - [createSelectedComputedCache](#Store-createSelectedComputedCache-member) - - [get](#Store-get-member) - - [has](#Store-has-member) - - [history](#Store-history-member) - - [id](#Store-id-member) - - [listen](#Store-listen-member) - - [mergeRemoteChanges](#Store-mergeRemoteChanges-member) - - [onAfterChange](#Store-onAfterChange-member) - - [onAfterCreate](#Store-onAfterCreate-member) - - [onAfterDelete](#Store-onAfterDelete-member) - - [onBeforeDelete](#Store-onBeforeDelete-member) - - [props](#Store-props-member) - - [put](#Store-put-member) - - [query](#Store-query-member) - - [remove](#Store-remove-member) - - [schema](#Store-schema-member) - - [scopedTypes](#Store-scopedTypes-member) - - [serialize](#Store-serialize-member) - - [unsafeGetWithoutCapture](#Store-unsafeGetWithoutCapture-member) - - [update](#Store-update-member) -- [Methods](#methods) - - [_flushHistory](#Store-_flushHistory-member-1) - - [applyDiff](#Store-applyDiff-member-1) - - [extractingChanges](#Store-extractingChanges-member-1) - - [filterChangesByScope](#Store-filterChangesByScope-member-1) - - [getSnapshot](#Store-getSnapshot-member-1) - - [loadSnapshot](#Store-loadSnapshot-member-1) - - [validate](#Store-validate-member-1) -
- -A store of records. - - -##### Signature - - -```ts -class Store {} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Store` class - - -##### Parameters - - - - - - - -`config` - - - - -```ts -{ - initialData?: StoreSnapshot - schema: StoreSchema - props: Props -} -``` - - - - - - - -##### References - -[StoreSnapshot](/gen/store/StoreSnapshot-type), [StoreSchema](/gen/store/StoreSchema-class) - ---- - -## Properties - -### `allRecords` \{#Store-allRecords-member} - -Public Property - -Get an array of all values in the store. - - -##### Signature - - -```ts -allRecords: () => R[] -``` - ---- - -### `clear` \{#Store-clear-member} - -Public Property - -Removes all records from the store. - - -##### Signature - - -```ts -clear: () => void -``` - ---- - -### `createComputedCache` \{#Store-createComputedCache-member} - -Public Property - -Create a computed cache. - - -##### Parameters - - - - - - - -`name` - - - - -The name of the derivation cache. - - - - - - - - - -`derive` - - - - -A function used to derive the value of the cache. - - - - - - - - -##### Signature - - -```ts -createComputedCache: ( - name: string, - derive: (record: V) => T | undefined -) => ComputedCache -``` - -##### References - -[ComputedCache](/gen/store/ComputedCache-type) - ---- - -### `createSelectedComputedCache` \{#Store-createSelectedComputedCache-member} - -Public Property - -Create a computed cache from a selector - - -##### Parameters - - - - - - - -`name` - - - - -The name of the derivation cache. - - - - - - - - - -`selector` - - - - -A function that returns a subset of the original shape - - - - - - - - - -`derive` - - - - -A function used to derive the value of the cache. - - - - - - - - -##### Signature - - -```ts -createSelectedComputedCache: ( - name: string, - selector: (record: V) => T | undefined, - derive: (input: T) => J | undefined -) => ComputedCache -``` - -##### References - -[ComputedCache](/gen/store/ComputedCache-type) - ---- - -### `get` \{#Store-get-member} - -Public Property - -Get the value of a store record by its id. - - -##### Parameters - - - - - - - -`id` - - - - -The id of the record to get. - - - - - - - - -##### Signature - - -```ts -get: >(id: K) => RecFromId | undefined -``` - -##### References - -[IdOf](/gen/store/IdOf-type), [RecFromId](/gen/store/~RecFromId-type) - ---- - -### `has` \{#Store-has-member} - -Public Property - -Get whether the record store has a id. - - -##### Parameters - - - - - - - -`id` - - - - -The id of the record to check. - - - - - - - - -##### Signature - - -```ts -has: >(id: K) => boolean -``` - -##### References - -[IdOf](/gen/store/IdOf-type) - ---- - -### `history` \{#Store-history-member} - -Public Readonly Property - -An atom containing the store's history. - - - -##### Signature - - -```ts -readonly history: Atom> -``` - -##### References - -[Atom](/gen/state/Atom-interface), [RecordsDiff](/gen/store/RecordsDiff-type) - ---- - -### `id` \{#Store-id-member} - -Public Readonly Property - -The random id of the store. - - -##### Signature - - -```ts -readonly id: string -``` - ---- - -### `listen` \{#Store-listen-member} - -Public Property - -Add a new listener to the store. - - -##### Parameters - - - - - - - -`onHistory` - - - - -The listener to call when the store updates. - - - - - - - - - -`filters` - - - - -Filters to apply to the listener. - - - - - - - - -##### Signature - - -```ts -listen: ( - onHistory: StoreListener, - filters?: Partial -) => () => void -``` - -##### References - -[StoreListener](/gen/store/StoreListener-type), [Partial](/gen/Partial-type), [StoreListenerFilters](/gen/store/~StoreListenerFilters-type) - ---- - -### `mergeRemoteChanges` \{#Store-mergeRemoteChanges-member} - -Public Property - -Merge changes from a remote source without triggering listeners. - - -##### Parameters - - - - - - - -`fn` - - - - -A function that merges the external changes. - - - - - - - - -##### Signature - - -```ts -mergeRemoteChanges: (fn: () => void) => void -``` - ---- - -### `onAfterChange` \{#Store-onAfterChange-member} - -Public Property - -A callback fired after each record's change. - - -##### Parameters - - - - - - - -`prev` - - - - -The previous value, if any. - - - - - - - - - -`next` - - - - -The next value. - - - - - - - - -##### Signature - - -```ts -onAfterChange?: (prev: R, next: R) => void -``` - ---- - -### `onAfterCreate` \{#Store-onAfterCreate-member} - -Public Property - -A callback fired after a record is created. Use this to perform related updates to other records in the store. - - -##### Parameters - - - - - - - -`record` - - - - -The record to be created - - - - - - - - -##### Signature - - -```ts -onAfterCreate?: (record: R) => void -``` - ---- - -### `onAfterDelete` \{#Store-onAfterDelete-member} - -Public Property - -A callback fired after a record is deleted. - - -##### Parameters - - - - - - - -`prev` - - - - -The record that will be deleted. - - - - - - - - -##### Signature - - -```ts -onAfterDelete?: (prev: R) => void -``` - ---- - -### `onBeforeDelete` \{#Store-onBeforeDelete-member} - -Public Property - -A callback fired before a record is deleted. - - -##### Parameters - - - - - - - -`prev` - - - - -The record that will be deleted. - - - - - - - - -##### Signature - - -```ts -onBeforeDelete?: (prev: R) => void -``` - ---- - -### `props` \{#Store-props-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly props: Props -``` - ---- - -### `put` \{#Store-put-member} - -Public Property - -Add some records to the store. It's an error if they already exist. - - -##### Parameters - - - - - - - -`records` - - - - -The records to add. - - - - - - - - -##### Signature - - -```ts -put: (records: R[], phaseOverride?: 'initialize') => void -``` - ---- - -### `query` \{#Store-query-member} - -Public Readonly Property - -A StoreQueries instance for this store. - - - -##### Signature - - -```ts -readonly query: StoreQueries -``` - -##### References - -[StoreQueries](/gen/store/~StoreQueries-class) - ---- - -### `remove` \{#Store-remove-member} - -Public Property - -Remove some records from the store via their ids. - - -##### Parameters - - - - - - - -`ids` - - - - -The ids of the records to remove. - - - - - - - - -##### Signature - - -```ts -remove: (ids: IdOf[]) => void -``` - -##### References - -[IdOf](/gen/store/IdOf-type) - ---- - -### `schema` \{#Store-schema-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly schema: StoreSchema -``` - -##### References - -[StoreSchema](/gen/store/StoreSchema-class) - ---- - -### `scopedTypes` \{#Store-scopedTypes-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly scopedTypes: { - readonly [K in RecordScope]: ReadonlySet -} -``` - -##### References - -[RecordScope](/gen/store/~RecordScope-type), [ReadonlySet](/gen/ReadonlySet-interface) - ---- - -### `serialize` \{#Store-serialize-member} - -Public Property - -Creates a JSON payload from the record store. - - -##### Parameters - - - - - - - -`scope` - - - - -The scope of records to serialize. Defaults to 'document'. - - - - - - - - -##### Signature - - -```ts -serialize: (scope?: 'all' | RecordScope) => StoreSnapshot -``` - -##### References - -[RecordScope](/gen/store/~RecordScope-type), [StoreSnapshot](/gen/store/StoreSnapshot-type) - ---- - -### `unsafeGetWithoutCapture` \{#Store-unsafeGetWithoutCapture-member} - -Public Property - -Get the value of a store record by its id without updating its epoch. - - -##### Parameters - - - - - - - -`id` - - - - -The id of the record to get. - - - - - - - - -##### Signature - - -```ts -unsafeGetWithoutCapture: >( - id: K -) => RecFromId | undefined -``` - -##### References - -[IdOf](/gen/store/IdOf-type), [RecFromId](/gen/store/~RecFromId-type) - ---- - -### `update` \{#Store-update-member} - -Public Property - -Update a record. To update multiple records at once, use the `update` method of the `TypedStore` class. - - -##### Parameters - - - - - - - -`id` - - - - -The id of the record to update. - - - - - - - - - -`updater` - - - - -A function that updates the record. - - - - - - - - -##### Signature - - -```ts -update: >( - id: K, - updater: (record: RecFromId) => RecFromId -) => void -``` - -##### References - -[IdOf](/gen/store/IdOf-type), [RecFromId](/gen/store/~RecFromId-type) - ---- - -## Methods - -### `_flushHistory()` \{#Store-_flushHistory-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - ---- - -### `applyDiff()` \{#Store-applyDiff-member-1} - -Public Method - -##### Parameters - - - - - - - -`diff` - - - - -```ts -RecordsDiff -``` - - - - - - - - -`runCallbacks` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[RecordsDiff](/gen/store/RecordsDiff-type) - ---- - -### `extractingChanges()` \{#Store-extractingChanges-member-1} - -Public Method - -##### Parameters - - - - - - - -`fn` - - - - -```ts -() => void -``` - - - - - - - -##### Returns - - -```ts -RecordsDiff -``` - -##### References - -[RecordsDiff](/gen/store/RecordsDiff-type) - ---- - -### `filterChangesByScope()` \{#Store-filterChangesByScope-member-1} - -Public Method - -Filters out non-document changes from a diff. Returns null if there are no changes left. - - -##### Parameters - - - - - - - -`change` - - - - -```ts -RecordsDiff -``` - -the records diff - - - - - - - - - -`scope` - - - - -```ts -RecordScope -``` - - - - - - - -##### Returns - - -```ts -{ - added: { [K in IdOf]: R } - updated: { [K_1 in IdOf]: [from: R, to: R] } - removed: { [K in IdOf]: R } -} | null -``` - - - - -##### References - -[RecordsDiff](/gen/store/RecordsDiff-type), [RecordScope](/gen/store/~RecordScope-type), [IdOf](/gen/store/IdOf-type) - ---- - -### `getSnapshot()` \{#Store-getSnapshot-member-1} - -Public Method - -Get a serialized snapshot of the store and its schema. - - -```ts -const snapshot = store.getSnapshot() -store.loadSnapshot(snapshot) -``` - - -##### Parameters - - - - - - - -`scope` - - (optional) - - - - -```ts -'all' | RecordScope -``` - -The scope of records to serialize. Defaults to 'document'. - - - - - - - - -##### Returns - - -```ts -{ - store: StoreSnapshot - schema: SerializedSchema -} -``` - -##### References - -[RecordScope](/gen/store/~RecordScope-type), [StoreSnapshot](/gen/store/StoreSnapshot-type), [SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `loadSnapshot()` \{#Store-loadSnapshot-member-1} - -Public Method - -Load a serialized snapshot. - - -```ts -const snapshot = store.getSnapshot() -store.loadSnapshot(snapshot) -``` - - -##### Parameters - - - - - - - -`snapshot` - - - - -```ts -{ - store: StoreSnapshot - schema: SerializedSchema -} -``` - -The snapshot to load. - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[StoreSnapshot](/gen/store/StoreSnapshot-type), [SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `validate()` \{#Store-validate-member-1} - -Public Method - -##### Parameters - - - - - - - -`phase` - - - - -```ts - | 'createRecord' - | 'initialize' - | 'tests' - | 'updateRecord' -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - diff --git a/docs/gen/StoreError-type.mdx b/docs/gen/StoreError-type.mdx deleted file mode 100644 index cf4ead6a3..000000000 --- a/docs/gen/StoreError-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: StoreError -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 27 ----Public TypeAlias - - - - -##### Signature - - -```ts -type StoreError = { - error: Error - phase: 'createRecord' | 'initialize' | 'tests' | 'updateRecord' - recordBefore?: unknown - recordAfter: unknown - isExistingValidationIssue: boolean -} -``` - -##### References - -[Error](/gen/Error-interface) - diff --git a/docs/gen/StoreListener-type.mdx b/docs/gen/StoreListener-type.mdx deleted file mode 100644 index 48776b1c8..000000000 --- a/docs/gen/StoreListener-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: StoreListener -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 28 ----Public TypeAlias - -A function that will be called when the history changes. - - -##### Signature - - -```ts -type StoreListener = (entry: HistoryEntry) => void -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [HistoryEntry](/gen/store/HistoryEntry-type) - diff --git a/docs/gen/StoreSchema-class.mdx b/docs/gen/StoreSchema-class.mdx deleted file mode 100644 index 892dc0d98..000000000 --- a/docs/gen/StoreSchema-class.mdx +++ /dev/null @@ -1,403 +0,0 @@ ---- -title: StoreSchema -status: published -category: store -group: Class -author: api -date: 06/23/2023 -order: 29 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [currentStoreVersion](#StoreSchema-currentStoreVersion-member) - - [types](#StoreSchema-types-member) -- [Methods](#methods) - - [create](#StoreSchema-create-member-1) - - [migratePersistedRecord](#StoreSchema-migratePersistedRecord-member-1) - - [migrateStoreSnapshot](#StoreSchema-migrateStoreSnapshot-member-1) - - [serialize](#StoreSchema-serialize-member-1) - - [serializeEarliestVersion](#StoreSchema-serializeEarliestVersion-member-1) - - [validateRecord](#StoreSchema-validateRecord-member-1) -
- - - - -##### Signature - - -```ts -class StoreSchema {} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - ---- - -## Properties - -### `currentStoreVersion` \{#StoreSchema-currentStoreVersion-member} - -Public Readonly Property - -##### Signature - - -```ts -get currentStoreVersion(): number -``` - ---- - -### `types` \{#StoreSchema-types-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly types: { - [Record in R as Record['typeName']]: RecordType -} -``` - -##### References - -[RecordType](/gen/store/RecordType-class) - ---- - -## Methods - -### `create()` \{#StoreSchema-create-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`types` - - - - -```ts -{ - [TypeName in R['typeName']]: { - createId: any - } -} -``` - - - - - - - - -`options` - - (optional) - - - - -```ts -StoreSchemaOptions -``` - - - - - - - -##### Returns - - -```ts -StoreSchema -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [StoreSchemaOptions](/gen/store/StoreSchemaOptions-type), [StoreSchema](/gen/store/StoreSchema-class) - ---- - -### `migratePersistedRecord()` \{#StoreSchema-migratePersistedRecord-member-1} - -Public Method - -##### Parameters - - - - - - - -`record` - - - - -```ts -R -``` - - - - - - - - -`persistedSchema` - - - - -```ts -SerializedSchema -``` - - - - - - - - -`direction` - - (optional) - - - - -```ts -'down' | 'up' -``` - - - - - - - -##### Returns - - -```ts -MigrationResult -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface), [MigrationResult](/gen/store/MigrationResult-type) - ---- - -### `migrateStoreSnapshot()` \{#StoreSchema-migrateStoreSnapshot-member-1} - -Public Method - -##### Parameters - - - - - - - -`storeSnapshot` - - - - -```ts -StoreSnapshot -``` - - - - - - - - -`persistedSchema` - - - - -```ts -SerializedSchema -``` - - - - - - - -##### Returns - - -```ts -MigrationResult> -``` - -##### References - -[StoreSnapshot](/gen/store/StoreSnapshot-type), [SerializedSchema](/gen/store/SerializedSchema-interface), [MigrationResult](/gen/store/MigrationResult-type) - ---- - -### `serialize()` \{#StoreSchema-serialize-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -SerializedSchema -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `serializeEarliestVersion()` \{#StoreSchema-serializeEarliestVersion-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -SerializedSchema -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `validateRecord()` \{#StoreSchema-validateRecord-member-1} - -Public Method - -##### Parameters - - - - - - - -`store` - - - - -```ts -Store -``` - - - - - - - - -`record` - - - - -```ts -R -``` - - - - - - - - -`phase` - - - - -```ts - | 'createRecord' - | 'initialize' - | 'tests' - | 'updateRecord' -``` - - - - - - - - -`recordBefore` - - - - -```ts -null | R -``` - - - - - - - -##### Returns - - -```ts -R -``` - -##### References - -[Store](/gen/store/Store-class) - ---- - diff --git a/docs/gen/StoreSchemaOptions-type.mdx b/docs/gen/StoreSchemaOptions-type.mdx deleted file mode 100644 index a14a9371d..000000000 --- a/docs/gen/StoreSchemaOptions-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StoreSchemaOptions -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 30 ----Public TypeAlias - - - - -##### Signature - - -```ts -type StoreSchemaOptions = { - snapshotMigrations?: Migrations - onValidationFailure?: (data: { - error: unknown - store: Store - record: R - phase: 'createRecord' | 'initialize' | 'tests' | 'updateRecord' - recordBefore: null | R - }) => R - createIntegrityChecker?: (store: Store) => void -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Migrations](/gen/store/Migrations-interface), [Store](/gen/store/Store-class) - diff --git a/docs/gen/StoreSnapshot-type.mdx b/docs/gen/StoreSnapshot-type.mdx deleted file mode 100644 index 0b88dd8a6..000000000 --- a/docs/gen/StoreSnapshot-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: StoreSnapshot -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 31 ----Public TypeAlias - -A serialized snapshot of the record store's values. - - -##### Signature - - -```ts -type StoreSnapshot = Record, R> -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Record](/gen/Record-type), [IdOf](/gen/store/IdOf-type) - diff --git a/docs/gen/StoreValidator-type.mdx b/docs/gen/StoreValidator-type.mdx deleted file mode 100644 index 3e3b23a32..000000000 --- a/docs/gen/StoreValidator-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: StoreValidator -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 32 ----Public TypeAlias - - - - -##### Signature - - -```ts -type StoreValidator = { - validate: (record: unknown) => R -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - diff --git a/docs/gen/StoreValidators-type.mdx b/docs/gen/StoreValidators-type.mdx deleted file mode 100644 index 50692b2ed..000000000 --- a/docs/gen/StoreValidators-type.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: StoreValidators -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 33 ----Public TypeAlias - - - - -##### Signature - - -```ts -type StoreValidators = { - [K in R['typeName']]: StoreValidator< - Extract< - R, - { - typeName: K - } - > - > -} -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [StoreValidator](/gen/store/StoreValidator-type), [Extract](/gen/Extract-type) - diff --git a/docs/gen/StrokeOptions-interface.mdx b/docs/gen/StrokeOptions-interface.mdx deleted file mode 100644 index a09e48be0..000000000 --- a/docs/gen/StrokeOptions-interface.mdx +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: StrokeOptions -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 86 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [easing](#StrokeOptions-easing-member) - - [end](#StrokeOptions-end-member) - - [last](#StrokeOptions-last-member) - - [simulatePressure](#StrokeOptions-simulatePressure-member) - - [size](#StrokeOptions-size-member) - - [smoothing](#StrokeOptions-smoothing-member) - - [start](#StrokeOptions-start-member) - - [streamline](#StrokeOptions-streamline-member) - - [thinning](#StrokeOptions-thinning-member) -
- -The options object for `getStroke` or `getStrokePoints`. - - -##### Signature - - -```ts -interface StrokeOptions {} -``` - ---- - -## Properties - -### `easing` \{#StrokeOptions-easing-member} - -Public PropertySignature - -An easing function to apply to each point's pressure. - - -##### Signature - - -```ts -easing?: (pressure: number) => number -``` - ---- - -### `end` \{#StrokeOptions-end-member} - -Public PropertySignature - -Cap, taper and easing for the end of the line. - - -##### Signature - - -```ts -end?: { - cap?: boolean - taper?: boolean | number - easing?: (distance: number) => number -} -``` - ---- - -### `last` \{#StrokeOptions-last-member} - -Public PropertySignature - -Whether to handle the points as a completed stroke. - - -##### Signature - - -```ts -last?: boolean -``` - ---- - -### `simulatePressure` \{#StrokeOptions-simulatePressure-member} - -Public PropertySignature - -Whether to simulate pressure based on velocity. - - -##### Signature - - -```ts -simulatePressure?: boolean -``` - ---- - -### `size` \{#StrokeOptions-size-member} - -Public PropertySignature - -The base size (diameter) of the stroke. - - -##### Signature - - -```ts -size?: number -``` - ---- - -### `smoothing` \{#StrokeOptions-smoothing-member} - -Public PropertySignature - -How much to soften the stroke's edges. - - -##### Signature - - -```ts -smoothing?: number -``` - ---- - -### `start` \{#StrokeOptions-start-member} - -Public PropertySignature - -Cap, taper and easing for the start of the line. - - -##### Signature - - -```ts -start?: { - cap?: boolean - taper?: boolean | number - easing?: (distance: number) => number -} -``` - ---- - -### `streamline` \{#StrokeOptions-streamline-member} - -Public PropertySignature - -##### Signature - - -```ts -streamline?: number -``` - ---- - -### `thinning` \{#StrokeOptions-thinning-member} - -Public PropertySignature - -The effect of pressure on the stroke's size. - - -##### Signature - - -```ts -thinning?: number -``` - ---- - diff --git a/docs/gen/StrokePoint-interface.mdx b/docs/gen/StrokePoint-interface.mdx deleted file mode 100644 index d57c56338..000000000 --- a/docs/gen/StrokePoint-interface.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: StrokePoint -status: published -category: primitives -group: Interface -author: api -date: 06/23/2023 -order: 87 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [distance](#StrokePoint-distance-member) - - [input](#StrokePoint-input-member) - - [point](#StrokePoint-point-member) - - [pressure](#StrokePoint-pressure-member) - - [radius](#StrokePoint-radius-member) - - [runningLength](#StrokePoint-runningLength-member) - - [vector](#StrokePoint-vector-member) -
- -The points returned by `getStrokePoints`, and the input for `getStrokeOutlinePoints` - - -##### Signature - - -```ts -interface StrokePoint {} -``` - ---- - -## Properties - -### `distance` \{#StrokePoint-distance-member} - -Public PropertySignature - -##### Signature - - -```ts -distance: number -``` - ---- - -### `input` \{#StrokePoint-input-member} - -Public PropertySignature - -##### Signature - - -```ts -input: Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `point` \{#StrokePoint-point-member} - -Public PropertySignature - -##### Signature - - -```ts -point: Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `pressure` \{#StrokePoint-pressure-member} - -Public PropertySignature - -##### Signature - - -```ts -pressure: number -``` - ---- - -### `radius` \{#StrokePoint-radius-member} - -Public PropertySignature - -##### Signature - - -```ts -radius: number -``` - ---- - -### `runningLength` \{#StrokePoint-runningLength-member} - -Public PropertySignature - -##### Signature - - -```ts -runningLength: number -``` - ---- - -### `vector` \{#StrokePoint-vector-member} - -Public PropertySignature - -##### Signature - - -```ts -vector: Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - diff --git a/docs/gen/StyleProp-class.mdx b/docs/gen/StyleProp-class.mdx deleted file mode 100644 index f58f6002e..000000000 --- a/docs/gen/StyleProp-class.mdx +++ /dev/null @@ -1,307 +0,0 @@ ---- -title: StyleProp -status: published -category: tlschema -group: Class -author: api -date: 06/23/2023 -order: 50 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [defaultValue](#StyleProp-defaultValue-member) - - [id](#StyleProp-id-member) - - [type](#StyleProp-type-member) -- [Methods](#methods) - - [define](#StyleProp-define-member-1) - - [defineEnum](#StyleProp-defineEnum-member-1) - - [validate](#StyleProp-validate-member-1) -
- - - - -##### Signature - - -```ts -class StyleProp implements T.Validatable {} -``` - -##### References - -[T.Validatable](/gen/validate/Validatable-type) - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `StyleProp` class - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`defaultValue` - - - - -```ts -Type -``` - - - - - - - - -`type` - - - - -```ts -T.Validatable -``` - - - - - - - -##### References - -[T.Validatable](/gen/validate/Validatable-type) - ---- - -## Properties - -### `defaultValue` \{#StyleProp-defaultValue-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly defaultValue: Type -``` - ---- - -### `id` \{#StyleProp-id-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly id: string -``` - ---- - -### `type` \{#StyleProp-type-member} - -Public Readonly Property - -##### Signature - - -```ts -readonly type: T.Validatable -``` - -##### References - -[T.Validatable](/gen/validate/Validatable-type) - ---- - -## Methods - -### `define()` \{#StyleProp-define-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`uniqueId` - - - - -```ts -string -``` - - - - - - - - -`{ defaultValue, type }` - - - - -```ts -{ - defaultValue: Type - type?: T.Validatable -} -``` - - - - - - - -##### Returns - - -```ts -StyleProp -``` - -##### References - -[T.Validatable](/gen/validate/Validatable-type), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -### `defineEnum()` \{#StyleProp-defineEnum-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`uniqueId` - - - - -```ts -string -``` - - - - - - - - -`{ defaultValue, values }` - - - - -```ts -{ - defaultValue: Values[number] - values: Values -} -``` - - - - - - - -##### Returns - - -```ts -EnumStyleProp -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class) - ---- - -### `validate()` \{#StyleProp-validate-member-1} - -Public Method - -##### Parameters - - - - - - - -`value` - - - - -```ts -unknown -``` - - - - - - - -##### Returns - - -```ts -Type -``` - ---- - diff --git a/docs/gen/T-namespace.mdx b/docs/gen/T-namespace.mdx deleted file mode 100644 index f08b35713..000000000 --- a/docs/gen/T-namespace.mdx +++ /dev/null @@ -1,821 +0,0 @@ ---- -title: T -status: published -category: validate -group: Namespace -author: api -date: 06/23/2023 -order: 0 ----None Namespace - -
- Table of Contents -- [Properties](#properties) - - [any](#T-any-var) - - [array](#T-array-var) - - [bigint](#T-bigint-var) - - [boolean](#T-boolean-var) - - [integer](#T-integer-var) - - [nonZeroInteger](#T-nonZeroInteger-var) - - [nonZeroNumber](#T-nonZeroNumber-var) - - [number](#T-number-var) - - [positiveInteger](#T-positiveInteger-var) - - [positiveNumber](#T-positiveNumber-var) - - [string](#T-string-var) - - [unknown](#T-unknown-var) - - [unknownObject](#T-unknownObject-var) -- [Methods](#methods) - - [arrayOf](#T-arrayOf-function-1) - - [dict](#T-dict-function-1) - - [literal](#T-literal-function-1) - - [literalEnum](#T-literalEnum-function-1) - - [model](#T-model-function-1) - - [nullable](#T-nullable-function-1) - - [object](#T-object-function-1) - - [optional](#T-optional-function-1) - - [setEnum](#T-setEnum-function-1) - - [union](#T-union-function-1) -
- -##### Signature - - -```ts - -``` - ---- - -## Properties - -### `any` \{#T-any-var} - -Public Readonly Variable - -Validation that accepts any value. Generally this should be avoided, but you can use it as an escape hatch if you want to work without validations for e.g. a prototype. - - -##### Signature - - -```ts -any: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `array` \{#T-array-var} - -Public Readonly Variable - -Validates that a value is an array. To check the contents of the array, use T.arrayOf. - - -##### Signature - - -```ts -array: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `bigint` \{#T-bigint-var} - -Public Readonly Variable - -Validates that a value is a bigint. - - -##### Signature - - -```ts -bigint: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `boolean` \{#T-boolean-var} - -Public Readonly Variable - -Validates that a value is boolean. - - -##### Signature - - -```ts -boolean: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `integer` \{#T-integer-var} - -Public Readonly Variable - -Fails if number is not an integer - - -##### Signature - - -```ts -integer: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `nonZeroInteger` \{#T-nonZeroInteger-var} - -Public Readonly Variable - -Fails if value \<= 0 and is not an integer - - -##### Signature - - -```ts -nonZeroInteger: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `nonZeroNumber` \{#T-nonZeroNumber-var} - -Public Readonly Variable - -Fails if value \<= 0 - - -##### Signature - - -```ts -nonZeroNumber: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `number` \{#T-number-var} - -Public Readonly Variable - -Validates that a value is a finite non-NaN number. - - -##### Signature - - -```ts -number: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `positiveInteger` \{#T-positiveInteger-var} - -Public Readonly Variable - -Fails if value \< 0 and is not an integer - - -##### Signature - - -```ts -positiveInteger: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `positiveNumber` \{#T-positiveNumber-var} - -Public Readonly Variable - -Fails if value \< 0 - - -##### Signature - - -```ts -positiveNumber: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `string` \{#T-string-var} - -Public Readonly Variable - -Validates that a value is a string. - - -##### Signature - - -```ts -string: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `unknown` \{#T-unknown-var} - -Public Readonly Variable - -Validation that accepts any value. Useful as a starting point for building your own custom validations. - - -##### Signature - - -```ts -unknown: Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `unknownObject` \{#T-unknownObject-var} - -Public Readonly Variable - - - - -##### Signature - - -```ts -unknownObject: Validator> -``` - -##### References - -[Validator](/gen/validate/T-Validator-class), [Record](/gen/Record-type) - ---- - -## Methods - -### `arrayOf` \{#T-arrayOf-function-1} - -Public Function - -Validates that a value is an array whose contents matches the passed-in validator. - - -##### Parameters - - - - - - - -`itemValidator` - - - - -```ts -Validatable -``` - - - - - - - -##### Returns - - -```ts -ArrayOfValidator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [ArrayOfValidator](/gen/validate/T-ArrayOfValidator-class) - ---- - -### `dict` \{#T-dict-function-1} - -Public Function - -Validation that an option is a dict with particular keys and values. - - -##### Parameters - - - - - - - -`keyValidator` - - - - -```ts -Validatable -``` - - - - - - - - -`valueValidator` - - - - -```ts -Validatable -``` - - - - - - - -##### Returns - - -```ts -DictValidator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [DictValidator](/gen/validate/T-DictValidator-class) - ---- - -### `literal` \{#T-literal-function-1} - -Public Function - -Validates that a value matches another that was passed in. - - - - -##### Example - - - - -```ts -const trueValidator = T.literal(true) -``` - - -##### Parameters - - - - - - - -`expectedValue` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `literalEnum` \{#T-literalEnum-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`values` - - - - -```ts -Values -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[Validator](/gen/validate/T-Validator-class) - ---- - -### `model` \{#T-model-function-1} - -Public Function - -A named object with an ID. Errors will be reported as being part of the object with the given name. - - -##### Parameters - - - - - - - -`name` - - - - -```ts -string -``` - - - - - - - - -`validator` - - - - -```ts -Validatable -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [Validator](/gen/validate/T-Validator-class) - ---- - -### `nullable` \{#T-nullable-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`validator` - - - - -```ts -Validatable -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [Validator](/gen/validate/T-Validator-class) - ---- - -### `object` \{#T-object-function-1} - -Public Function - -Validate an object has a particular shape. - - -##### Parameters - - - - - - - -`config` - - - - -```ts -{ - readonly [K in keyof Shape]: Validatable -} -``` - - - - - - - -##### Returns - - -```ts -ObjectValidator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [ObjectValidator](/gen/validate/T-ObjectValidator-class) - ---- - -### `optional` \{#T-optional-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`validator` - - - - -```ts -Validatable -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[Validatable](/gen/validate/T-Validatable-type), [Validator](/gen/validate/T-Validator-class) - ---- - -### `setEnum` \{#T-setEnum-function-1} - -Public Function - - - - -##### Parameters - - - - - - - -`values` - - - - -```ts -ReadonlySet -``` - - - - - - - -##### Returns - - -```ts -Validator -``` - -##### References - -[ReadonlySet](/gen/ReadonlySet-interface), [Validator](/gen/validate/T-Validator-class) - ---- - -### `union` \{#T-union-function-1} - -Public Function - -Validate a union of several object types. Each object must have a property matching `key` which should be a unique string. - - - - -##### Example - - - - -```ts -const catValidator = T.object({ kind: T.value('cat'), meow: T.boolean }) -const dogValidator = T.object({ kind: T.value('dog'), bark: T.boolean }) -const animalValidator = T.union('kind', { - cat: catValidator, - dog: dogValidator, -}) -``` - - -##### Parameters - - - - - - - -`key` - - - - -```ts -Key -``` - - - - - - - - -`config` - - - - -```ts -Config -``` - - - - - - - -##### Returns - - -```ts -UnionValidator -``` - -##### References - -[UnionValidatorConfig](/gen/validate/~UnionValidatorConfig-type), [UnionValidator](/gen/validate/T-UnionValidator-class) - ---- - diff --git a/docs/gen/TAB_ID-var.mdx b/docs/gen/TAB_ID-var.mdx deleted file mode 100644 index b5ea28783..000000000 --- a/docs/gen/TAB_ID-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TAB_ID -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 105 ----Public Readonly Variable - -A string that is unique per browser tab - - -##### Signature - - -```ts -TAB_ID: string -``` - diff --git a/docs/gen/TAU-var.mdx b/docs/gen/TAU-var.mdx deleted file mode 100644 index b14854292..000000000 --- a/docs/gen/TAU-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TAU -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 88 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TAU: number -``` - diff --git a/docs/gen/TLAnimationOptions-type.mdx b/docs/gen/TLAnimationOptions-type.mdx deleted file mode 100644 index 2703c57fe..000000000 --- a/docs/gen/TLAnimationOptions-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLAnimationOptions -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 108 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLAnimationOptions = Partial<{ - duration: number - easing: typeof EASINGS.easeInOutCubic -}> -``` - -##### References - -[Partial](/gen/Partial-type), [EASINGS.easeInOutCubic](/gen/primitives/__type-easeInOutCubic-member) - diff --git a/docs/gen/TLArrowShape-type.mdx b/docs/gen/TLArrowShape-type.mdx deleted file mode 100644 index 52e0917b4..000000000 --- a/docs/gen/TLArrowShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLArrowShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 53 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLArrowShape = TLBaseShape<'arrow', TLArrowShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLArrowShapeProps](/gen/tlschema/TLArrowShapeProps-type) - diff --git a/docs/gen/TLArrowShapeArrowheadStyle-type.mdx b/docs/gen/TLArrowShapeArrowheadStyle-type.mdx deleted file mode 100644 index 4ff8b119f..000000000 --- a/docs/gen/TLArrowShapeArrowheadStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLArrowShapeArrowheadStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 54 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLArrowShapeArrowheadStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [ArrowShapeArrowheadStartStyle](/gen/tlschema/ArrowShapeArrowheadStartStyle-var) - diff --git a/docs/gen/TLArrowShapeProps-type.mdx b/docs/gen/TLArrowShapeProps-type.mdx deleted file mode 100644 index de7772807..000000000 --- a/docs/gen/TLArrowShapeProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLArrowShapeProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 55 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLArrowShapeProps = ShapePropsType -``` - -##### References - -[ShapePropsType](/gen/tlschema/~ShapePropsType-type), [arrowShapeProps](/gen/tlschema/arrowShapeProps-var) - diff --git a/docs/gen/TLArrowShapeTerminal-type.mdx b/docs/gen/TLArrowShapeTerminal-type.mdx deleted file mode 100644 index 4a41838fd..000000000 --- a/docs/gen/TLArrowShapeTerminal-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLArrowShapeTerminal -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 56 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLArrowShapeTerminal = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [ArrowShapeTerminal](/gen/tlschema/~ArrowShapeTerminal-var) - diff --git a/docs/gen/TLAsset-type.mdx b/docs/gen/TLAsset-type.mdx deleted file mode 100644 index dfcd3caae..000000000 --- a/docs/gen/TLAsset-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLAsset -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 57 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLAsset = TLBookmarkAsset | TLImageAsset | TLVideoAsset -``` - -##### References - -[TLBookmarkAsset](/gen/tlschema/TLBookmarkAsset-type), [TLImageAsset](/gen/tlschema/TLImageAsset-type), [TLVideoAsset](/gen/tlschema/TLVideoAsset-type) - diff --git a/docs/gen/TLAssetId-type.mdx b/docs/gen/TLAssetId-type.mdx deleted file mode 100644 index 3035f6c8c..000000000 --- a/docs/gen/TLAssetId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLAssetId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 58 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLAssetId = RecordId> -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLBaseAsset](/gen/tlschema/TLBaseAsset-interface) - diff --git a/docs/gen/TLAssetPartial-type.mdx b/docs/gen/TLAssetPartial-type.mdx deleted file mode 100644 index 047648637..000000000 --- a/docs/gen/TLAssetPartial-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLAssetPartial -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 59 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLAssetPartial = T extends T - ? { - id: TLAssetId - type: T['type'] - props?: Partial - } & Partial> - : never -``` - -##### References - -[TLAsset](/gen/tlschema/TLAsset-type), [TLAssetId](/gen/tlschema/TLAssetId-type), [Partial](/gen/Partial-type), [Omit](/gen/Omit-type) - diff --git a/docs/gen/TLAssetShape-type.mdx b/docs/gen/TLAssetShape-type.mdx deleted file mode 100644 index 9f27c4ef4..000000000 --- a/docs/gen/TLAssetShape-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLAssetShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 60 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLAssetShape = Extract< - TLShape, - { - props: { - assetId: TLAssetId - } - } -> -``` - -##### References - -[Extract](/gen/Extract-type), [TLShape](/gen/tlschema/TLShape-type), [TLAssetId](/gen/tlschema/TLAssetId-type) - diff --git a/docs/gen/TLBaseAsset-interface.mdx b/docs/gen/TLBaseAsset-interface.mdx deleted file mode 100644 index f30c30b7b..000000000 --- a/docs/gen/TLBaseAsset-interface.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: TLBaseAsset -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 61 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [props](#TLBaseAsset-props-member) - - [type](#TLBaseAsset-type-member) -
- - - - -##### Signature - - -```ts -interface TLBaseAsset - extends BaseRecord<'asset', TLAssetId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLAssetId](/gen/tlschema/TLAssetId-type) - ---- - -## Properties - -### `props` \{#TLBaseAsset-props-member} - -Public PropertySignature - -##### Signature - - -```ts -props: Props -``` - ---- - -### `type` \{#TLBaseAsset-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: Type -``` - ---- - diff --git a/docs/gen/TLBaseBoxShape-type.mdx b/docs/gen/TLBaseBoxShape-type.mdx deleted file mode 100644 index 98633918a..000000000 --- a/docs/gen/TLBaseBoxShape-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLBaseBoxShape -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 109 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLBaseBoxShape = TLBaseShape< - string, - { - w: number - h: number - } -> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface) - diff --git a/docs/gen/TLBaseEventInfo-interface.mdx b/docs/gen/TLBaseEventInfo-interface.mdx deleted file mode 100644 index 7404f6b4f..000000000 --- a/docs/gen/TLBaseEventInfo-interface.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: TLBaseEventInfo -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 110 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [altKey](#TLBaseEventInfo-altKey-member) - - [ctrlKey](#TLBaseEventInfo-ctrlKey-member) - - [shiftKey](#TLBaseEventInfo-shiftKey-member) - - [type](#TLBaseEventInfo-type-member) -
- - - - -##### Signature - - -```ts -interface TLBaseEventInfo {} -``` - ---- - -## Properties - -### `altKey` \{#TLBaseEventInfo-altKey-member} - -Public PropertySignature - -##### Signature - - -```ts -altKey: boolean -``` - ---- - -### `ctrlKey` \{#TLBaseEventInfo-ctrlKey-member} - -Public PropertySignature - -##### Signature - - -```ts -ctrlKey: boolean -``` - ---- - -### `shiftKey` \{#TLBaseEventInfo-shiftKey-member} - -Public PropertySignature - -##### Signature - - -```ts -shiftKey: boolean -``` - ---- - -### `type` \{#TLBaseEventInfo-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: UiEventType -``` - -##### References - -[UiEventType](/gen/editor/UiEventType-type) - ---- - diff --git a/docs/gen/TLBaseShape-interface.mdx b/docs/gen/TLBaseShape-interface.mdx deleted file mode 100644 index 95b8414ac..000000000 --- a/docs/gen/TLBaseShape-interface.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: TLBaseShape -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 62 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [index](#TLBaseShape-index-member) - - [isLocked](#TLBaseShape-isLocked-member) - - [opacity](#TLBaseShape-opacity-member) - - [parentId](#TLBaseShape-parentId-member) - - [props](#TLBaseShape-props-member) - - [rotation](#TLBaseShape-rotation-member) - - [type](#TLBaseShape-type-member) - - [x](#TLBaseShape-x-member) - - [y](#TLBaseShape-y-member) -
- - - - -##### Signature - - -```ts -interface TLBaseShape - extends BaseRecord<'shape', TLShapeId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -## Properties - -### `index` \{#TLBaseShape-index-member} - -Public PropertySignature - -##### Signature - - -```ts -index: string -``` - ---- - -### `isLocked` \{#TLBaseShape-isLocked-member} - -Public PropertySignature - -##### Signature - - -```ts -isLocked: boolean -``` - ---- - -### `opacity` \{#TLBaseShape-opacity-member} - -Public PropertySignature - -##### Signature - - -```ts -opacity: TLOpacityType -``` - -##### References - -[TLOpacityType](/gen/tlschema/TLOpacityType-type) - ---- - -### `parentId` \{#TLBaseShape-parentId-member} - -Public PropertySignature - -##### Signature - - -```ts -parentId: TLParentId -``` - -##### References - -[TLParentId](/gen/tlschema/TLParentId-type) - ---- - -### `props` \{#TLBaseShape-props-member} - -Public PropertySignature - -##### Signature - - -```ts -props: Props -``` - ---- - -### `rotation` \{#TLBaseShape-rotation-member} - -Public PropertySignature - -##### Signature - - -```ts -rotation: number -``` - ---- - -### `type` \{#TLBaseShape-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: Type -``` - ---- - -### `x` \{#TLBaseShape-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#TLBaseShape-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - diff --git a/docs/gen/TLBookmarkAsset-type.mdx b/docs/gen/TLBookmarkAsset-type.mdx deleted file mode 100644 index 1552f6826..000000000 --- a/docs/gen/TLBookmarkAsset-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TLBookmarkAsset -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 63 ----Public TypeAlias - -An asset used for URL bookmarks, used by the TLBookmarkShape. - - -##### Signature - - -```ts -type TLBookmarkAsset = TLBaseAsset< - 'bookmark', - { - title: string - description: string - image: string - src: null | string - } -> -``` - -##### References - -[TLBaseAsset](/gen/tlschema/TLBaseAsset-interface) - diff --git a/docs/gen/TLBookmarkShape-type.mdx b/docs/gen/TLBookmarkShape-type.mdx deleted file mode 100644 index 9e040d8aa..000000000 --- a/docs/gen/TLBookmarkShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLBookmarkShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 64 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLBookmarkShape = TLBaseShape<'bookmark', TLBookmarkShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLBookmarkShapeProps](/gen/tlschema/~TLBookmarkShapeProps-type) - diff --git a/docs/gen/TLCLickEventName-type.mdx b/docs/gen/TLCLickEventName-type.mdx deleted file mode 100644 index f2d5025e8..000000000 --- a/docs/gen/TLCLickEventName-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLCLickEventName -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 115 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCLickEventName = 'double_click' | 'quadruple_click' | 'triple_click' -``` - diff --git a/docs/gen/TLCamera-interface.mdx b/docs/gen/TLCamera-interface.mdx deleted file mode 100644 index 08aeef14f..000000000 --- a/docs/gen/TLCamera-interface.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: TLCamera -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 65 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [x](#TLCamera-x-member) - - [y](#TLCamera-y-member) - - [z](#TLCamera-z-member) -
- -A camera record. - - -##### Signature - - -```ts -interface TLCamera extends BaseRecord<'camera', TLCameraId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLCameraId](/gen/tlschema/TLCameraId-type) - ---- - -## Properties - -### `x` \{#TLCamera-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#TLCamera-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - -### `z` \{#TLCamera-z-member} - -Public PropertySignature - -##### Signature - - -```ts -z: number -``` - ---- - diff --git a/docs/gen/TLCameraId-type.mdx b/docs/gen/TLCameraId-type.mdx deleted file mode 100644 index 38cf891af..000000000 --- a/docs/gen/TLCameraId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLCameraId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 66 ----Public TypeAlias - -The id of a camera record. - - -##### Signature - - -```ts -type TLCameraId = RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLCamera](/gen/tlschema/TLCamera-interface) - diff --git a/docs/gen/TLCancelEvent-type.mdx b/docs/gen/TLCancelEvent-type.mdx deleted file mode 100644 index 41cbe77b7..000000000 --- a/docs/gen/TLCancelEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLCancelEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 111 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCancelEvent = (info: TLCancelEventInfo) => void -``` - -##### References - -[TLCancelEventInfo](/gen/editor/TLCancelEventInfo-type) - diff --git a/docs/gen/TLCancelEventInfo-type.mdx b/docs/gen/TLCancelEventInfo-type.mdx deleted file mode 100644 index 8bc36002b..000000000 --- a/docs/gen/TLCancelEventInfo-type.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: TLCancelEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 112 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCancelEventInfo = { - type: 'misc' - name: 'cancel' -} -``` - diff --git a/docs/gen/TLCanvasUiColor-type.mdx b/docs/gen/TLCanvasUiColor-type.mdx deleted file mode 100644 index c00fb39f6..000000000 --- a/docs/gen/TLCanvasUiColor-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLCanvasUiColor -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 67 ----Public TypeAlias - -A type for the colors used by tldraw's default shapes. - - -##### Signature - - -```ts -type TLCanvasUiColor = SetValue -``` - -##### References - -[SetValue](/gen/tlschema/~SetValue-type), [TL_CANVAS_UI_COLOR_TYPES](/gen/tlschema/TL_CANVAS_UI_COLOR_TYPES-var) - diff --git a/docs/gen/TLClickEvent-type.mdx b/docs/gen/TLClickEvent-type.mdx deleted file mode 100644 index 3835a97ca..000000000 --- a/docs/gen/TLClickEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLClickEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 113 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLClickEvent = (info: TLClickEventInfo) => void -``` - -##### References - -[TLClickEventInfo](/gen/editor/TLClickEventInfo-type) - diff --git a/docs/gen/TLClickEventInfo-type.mdx b/docs/gen/TLClickEventInfo-type.mdx deleted file mode 100644 index 92f59a46d..000000000 --- a/docs/gen/TLClickEventInfo-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLClickEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 114 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLClickEventInfo = TLBaseEventInfo & { - type: 'click' - name: TLCLickEventName - point: VecLike - pointerId: number - button: number - phase: 'down' | 'settle' | 'up' -} & TLPointerEventTarget -``` - -##### References - -[TLBaseEventInfo](/gen/editor/TLBaseEventInfo-interface), [TLCLickEventName](/gen/editor/TLCLickEventName-type), [VecLike](/gen/primitives/VecLike-type), [TLPointerEventTarget](/gen/editor/TLPointerEventTarget-type) - diff --git a/docs/gen/TLCommand-type.mdx b/docs/gen/TLCommand-type.mdx deleted file mode 100644 index bb9e82eb0..000000000 --- a/docs/gen/TLCommand-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLCommand -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 116 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCommand = { - type: 'command' - id: string - data: Data - name: Name - preservesRedoStack?: boolean -} -``` - diff --git a/docs/gen/TLCommandHandler-type.mdx b/docs/gen/TLCommandHandler-type.mdx deleted file mode 100644 index 17fbcf25f..000000000 --- a/docs/gen/TLCommandHandler-type.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: TLCommandHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 117 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCommandHandler = { - do: (data: Data) => void - undo: (data: Data) => void - redo?: (data: Data) => void - squash?: (prevData: Data, nextData: Data) => Data -} -``` - diff --git a/docs/gen/TLCompleteEvent-type.mdx b/docs/gen/TLCompleteEvent-type.mdx deleted file mode 100644 index ef6c0cfd4..000000000 --- a/docs/gen/TLCompleteEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLCompleteEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 118 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCompleteEvent = (info: TLCompleteEventInfo) => void -``` - -##### References - -[TLCompleteEventInfo](/gen/editor/TLCompleteEventInfo-type) - diff --git a/docs/gen/TLCompleteEventInfo-type.mdx b/docs/gen/TLCompleteEventInfo-type.mdx deleted file mode 100644 index 8e24309b6..000000000 --- a/docs/gen/TLCompleteEventInfo-type.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: TLCompleteEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 119 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCompleteEventInfo = { - type: 'misc' - name: 'complete' -} -``` - diff --git a/docs/gen/TLContent-interface.mdx b/docs/gen/TLContent-interface.mdx deleted file mode 100644 index 3276957a7..000000000 --- a/docs/gen/TLContent-interface.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: TLContent -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 120 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [assets](#TLContent-assets-member) - - [rootShapeIds](#TLContent-rootShapeIds-member) - - [schema](#TLContent-schema-member) - - [shapes](#TLContent-shapes-member) -
- - - - -##### Signature - - -```ts -interface TLContent {} -``` - ---- - -## Properties - -### `assets` \{#TLContent-assets-member} - -Public PropertySignature - -##### Signature - - -```ts -assets: TLAsset[] -``` - -##### References - -[TLAsset](/gen/tlschema/TLAsset-type) - ---- - -### `rootShapeIds` \{#TLContent-rootShapeIds-member} - -Public PropertySignature - -##### Signature - - -```ts -rootShapeIds: TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `schema` \{#TLContent-schema-member} - -Public PropertySignature - -##### Signature - - -```ts -schema: SerializedSchema -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `shapes` \{#TLContent-shapes-member} - -Public PropertySignature - -##### Signature - - -```ts -shapes: TLShape[] -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - ---- - diff --git a/docs/gen/TLCopyType-type.mdx b/docs/gen/TLCopyType-type.mdx deleted file mode 100644 index 5fb65c564..000000000 --- a/docs/gen/TLCopyType-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLCopyType -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 121 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLCopyType = 'jpeg' | 'json' | 'png' | 'svg' -``` - diff --git a/docs/gen/TLCursor-interface.mdx b/docs/gen/TLCursor-interface.mdx deleted file mode 100644 index 11c7aaad8..000000000 --- a/docs/gen/TLCursor-interface.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: TLCursor -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 68 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [color](#TLCursor-color-member) - - [rotation](#TLCursor-rotation-member) - - [type](#TLCursor-type-member) -
- -A cursor used by tldraw. - - -##### Signature - - -```ts -interface TLCursor {} -``` - ---- - -## Properties - -### `color` \{#TLCursor-color-member} - -Public PropertySignature - -##### Signature - - -```ts -color: TLCanvasUiColor -``` - -##### References - -[TLCanvasUiColor](/gen/tlschema/TLCanvasUiColor-type) - ---- - -### `rotation` \{#TLCursor-rotation-member} - -Public PropertySignature - -##### Signature - - -```ts -rotation: number -``` - ---- - -### `type` \{#TLCursor-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: TLCursorType -``` - -##### References - -[TLCursorType](/gen/tlschema/TLCursorType-type) - ---- - diff --git a/docs/gen/TLCursorType-type.mdx b/docs/gen/TLCursorType-type.mdx deleted file mode 100644 index f7f749f88..000000000 --- a/docs/gen/TLCursorType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLCursorType -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 69 ----Public TypeAlias - -A type for the cursor types used by tldraw's default shapes. - - -##### Signature - - -```ts -type TLCursorType = SetValue -``` - -##### References - -[SetValue](/gen/tlschema/~SetValue-type), [TL_CURSOR_TYPES](/gen/tlschema/~TL_CURSOR_TYPES-var) - diff --git a/docs/gen/TLDOCUMENT_ID-var.mdx b/docs/gen/TLDOCUMENT_ID-var.mdx deleted file mode 100644 index 08799811c..000000000 --- a/docs/gen/TLDOCUMENT_ID-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDOCUMENT_ID -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 78 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TLDOCUMENT_ID: RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLDocument](/gen/tlschema/TLDocument-interface) - diff --git a/docs/gen/TLDRAW_FILE_EXTENSION-var.mdx b/docs/gen/TLDRAW_FILE_EXTENSION-var.mdx deleted file mode 100644 index b340d7e82..000000000 --- a/docs/gen/TLDRAW_FILE_EXTENSION-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLDRAW_FILE_EXTENSION -status: published -category: file-format -group: Variable -author: api -date: 06/23/2023 -order: 4 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TLDRAW_FILE_EXTENSION: '.tldr' -``` - diff --git a/docs/gen/TLDRAW_FILE_MIMETYPE-var.mdx b/docs/gen/TLDRAW_FILE_MIMETYPE-var.mdx deleted file mode 100644 index fe3176a67..000000000 --- a/docs/gen/TLDRAW_FILE_MIMETYPE-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLDRAW_FILE_MIMETYPE -status: published -category: file-format -group: Variable -author: api -date: 06/23/2023 -order: 5 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TLDRAW_FILE_MIMETYPE: 'application/vnd.tldraw+json' -``` - diff --git a/docs/gen/TLDefaultColorStyle-type.mdx b/docs/gen/TLDefaultColorStyle-type.mdx deleted file mode 100644 index 06068396e..000000000 --- a/docs/gen/TLDefaultColorStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultColorStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 70 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultColorStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultColorStyle](/gen/tlschema/DefaultColorStyle-var) - diff --git a/docs/gen/TLDefaultDashStyle-type.mdx b/docs/gen/TLDefaultDashStyle-type.mdx deleted file mode 100644 index c43b96ebc..000000000 --- a/docs/gen/TLDefaultDashStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultDashStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 71 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultDashStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultDashStyle](/gen/tlschema/DefaultDashStyle-var) - diff --git a/docs/gen/TLDefaultFillStyle-type.mdx b/docs/gen/TLDefaultFillStyle-type.mdx deleted file mode 100644 index 2f935a741..000000000 --- a/docs/gen/TLDefaultFillStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultFillStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 72 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultFillStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultFillStyle](/gen/tlschema/DefaultFillStyle-var) - diff --git a/docs/gen/TLDefaultFontStyle-type.mdx b/docs/gen/TLDefaultFontStyle-type.mdx deleted file mode 100644 index 628b9394e..000000000 --- a/docs/gen/TLDefaultFontStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultFontStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 73 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultFontStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultFontStyle](/gen/tlschema/DefaultFontStyle-var) - diff --git a/docs/gen/TLDefaultHorizontalAlignStyle-type.mdx b/docs/gen/TLDefaultHorizontalAlignStyle-type.mdx deleted file mode 100644 index de44298e3..000000000 --- a/docs/gen/TLDefaultHorizontalAlignStyle-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLDefaultHorizontalAlignStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 74 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultHorizontalAlignStyle = T.TypeOf< - typeof DefaultHorizontalAlignStyle -> -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultHorizontalAlignStyle](/gen/tlschema/DefaultHorizontalAlignStyle-var) - diff --git a/docs/gen/TLDefaultShape-type.mdx b/docs/gen/TLDefaultShape-type.mdx deleted file mode 100644 index 0c5c8812a..000000000 --- a/docs/gen/TLDefaultShape-type.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TLDefaultShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 75 ----Public TypeAlias - -The default set of shapes that are available in the editor. - - -##### Signature - - -```ts -type TLDefaultShape = - | TLArrowShape - | TLBookmarkShape - | TLDrawShape - | TLEmbedShape - | TLFrameShape - | TLGeoShape - | TLGroupShape - | TLHighlightShape - | TLImageShape - | TLLineShape - | TLNoteShape - | TLTextShape - | TLVideoShape -``` - -##### References - -[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLImageShape](/gen/tlschema/TLImageShape-type), [TLLineShape](/gen/tlschema/TLLineShape-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLTextShape](/gen/tlschema/TLTextShape-type), [TLVideoShape](/gen/tlschema/TLVideoShape-type) - diff --git a/docs/gen/TLDefaultSizeStyle-type.mdx b/docs/gen/TLDefaultSizeStyle-type.mdx deleted file mode 100644 index 507a441a4..000000000 --- a/docs/gen/TLDefaultSizeStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultSizeStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 76 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultSizeStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultSizeStyle](/gen/tlschema/DefaultSizeStyle-var) - diff --git a/docs/gen/TLDefaultVerticalAlignStyle-type.mdx b/docs/gen/TLDefaultVerticalAlignStyle-type.mdx deleted file mode 100644 index 99672e2ad..000000000 --- a/docs/gen/TLDefaultVerticalAlignStyle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDefaultVerticalAlignStyle -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 77 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDefaultVerticalAlignStyle = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DefaultVerticalAlignStyle](/gen/tlschema/DefaultVerticalAlignStyle-var) - diff --git a/docs/gen/TLDocument-interface.mdx b/docs/gen/TLDocument-interface.mdx deleted file mode 100644 index 4c713f1e3..000000000 --- a/docs/gen/TLDocument-interface.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: TLDocument -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 79 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [gridSize](#TLDocument-gridSize-member) - - [name](#TLDocument-name-member) -
- -TLDocument - - -##### Signature - - -```ts -interface TLDocument extends BaseRecord<'document', RecordId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [RecordId](/gen/store/RecordId-type), [TLDocument](/gen/tlschema/TLDocument-interface) - ---- - -## Properties - -### `gridSize` \{#TLDocument-gridSize-member} - -Public PropertySignature - -##### Signature - - -```ts -gridSize: number -``` - ---- - -### `name` \{#TLDocument-name-member} - -Public PropertySignature - -##### Signature - - -```ts -name: string -``` - ---- - diff --git a/docs/gen/TLDrawShape-type.mdx b/docs/gen/TLDrawShape-type.mdx deleted file mode 100644 index 81416bdd3..000000000 --- a/docs/gen/TLDrawShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDrawShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 80 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDrawShape = TLBaseShape<'draw', TLDrawShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLDrawShapeProps](/gen/tlschema/~TLDrawShapeProps-type) - diff --git a/docs/gen/TLDrawShapeSegment-type.mdx b/docs/gen/TLDrawShapeSegment-type.mdx deleted file mode 100644 index 9ae470040..000000000 --- a/docs/gen/TLDrawShapeSegment-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLDrawShapeSegment -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 81 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLDrawShapeSegment = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [DrawShapeSegment](/gen/tlschema/~DrawShapeSegment-var) - diff --git a/docs/gen/TLEditorAssetUrls-type.mdx b/docs/gen/TLEditorAssetUrls-type.mdx deleted file mode 100644 index d809af7b8..000000000 --- a/docs/gen/TLEditorAssetUrls-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLEditorAssetUrls -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 124 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEditorAssetUrls = { - fonts: { - monospace: string - serif: string - sansSerif: string - draw: string - } -} -``` - diff --git a/docs/gen/TLEditorComponents-interface.mdx b/docs/gen/TLEditorComponents-interface.mdx deleted file mode 100644 index 2fba9ac9d..000000000 --- a/docs/gen/TLEditorComponents-interface.mdx +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: TLEditorComponents -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 125 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [Background](#TLEditorComponents-Background-member) - - [Brush](#TLEditorComponents-Brush-member) - - [CollaboratorBrush](#TLEditorComponents-CollaboratorBrush-member) - - [CollaboratorCursor](#TLEditorComponents-CollaboratorCursor-member) - - [CollaboratorHint](#TLEditorComponents-CollaboratorHint-member) - - [CollaboratorScribble](#TLEditorComponents-CollaboratorScribble-member) - - [CollaboratorShapeIndicator](#TLEditorComponents-CollaboratorShapeIndicator-member) - - [Cursor](#TLEditorComponents-Cursor-member) - - [ErrorFallback](#TLEditorComponents-ErrorFallback-member) - - [Grid](#TLEditorComponents-Grid-member) - - [Handle](#TLEditorComponents-Handle-member) - - [Scribble](#TLEditorComponents-Scribble-member) - - [ShapeErrorFallback](#TLEditorComponents-ShapeErrorFallback-member) - - [ShapeIndicatorErrorFallback](#TLEditorComponents-ShapeIndicatorErrorFallback-member) - - [SnapLine](#TLEditorComponents-SnapLine-member) - - [Spinner](#TLEditorComponents-Spinner-member) - - [SvgDefs](#TLEditorComponents-SvgDefs-member) - - [ZoomBrush](#TLEditorComponents-ZoomBrush-member) -
- - - - -##### Signature - - -```ts -interface TLEditorComponents {} -``` - ---- - -## Properties - -### `Background` \{#TLEditorComponents-Background-member} - -Public PropertySignature - -##### Signature - - -```ts -Background: null | TLBackgroundComponent -``` - -##### References - -[TLBackgroundComponent](/gen/editor/~TLBackgroundComponent-type) - ---- - -### `Brush` \{#TLEditorComponents-Brush-member} - -Public PropertySignature - -##### Signature - - -```ts -Brush: null | TLBrushComponent -``` - -##### References - -[TLBrushComponent](/gen/editor/~TLBrushComponent-type) - ---- - -### `CollaboratorBrush` \{#TLEditorComponents-CollaboratorBrush-member} - -Public PropertySignature - -##### Signature - - -```ts -CollaboratorBrush: null | TLBrushComponent -``` - -##### References - -[TLBrushComponent](/gen/editor/~TLBrushComponent-type) - ---- - -### `CollaboratorCursor` \{#TLEditorComponents-CollaboratorCursor-member} - -Public PropertySignature - -##### Signature - - -```ts -CollaboratorCursor: null | TLCursorComponent -``` - -##### References - -[TLCursorComponent](/gen/editor/~TLCursorComponent-type) - ---- - -### `CollaboratorHint` \{#TLEditorComponents-CollaboratorHint-member} - -Public PropertySignature - -##### Signature - - -```ts -CollaboratorHint: null | TLCollaboratorHintComponent -``` - -##### References - -[TLCollaboratorHintComponent](/gen/editor/~TLCollaboratorHintComponent-type) - ---- - -### `CollaboratorScribble` \{#TLEditorComponents-CollaboratorScribble-member} - -Public PropertySignature - -##### Signature - - -```ts -CollaboratorScribble: null | TLScribbleComponent -``` - -##### References - -[TLScribbleComponent](/gen/editor/~TLScribbleComponent-type) - ---- - -### `CollaboratorShapeIndicator` \{#TLEditorComponents-CollaboratorShapeIndicator-member} - -Public PropertySignature - -##### Signature - - -```ts -CollaboratorShapeIndicator: null | TLShapeIndicatorComponent -``` - -##### References - -[TLShapeIndicatorComponent](/gen/editor/~TLShapeIndicatorComponent-type) - ---- - -### `Cursor` \{#TLEditorComponents-Cursor-member} - -Public PropertySignature - -##### Signature - - -```ts -Cursor: null | TLCursorComponent -``` - -##### References - -[TLCursorComponent](/gen/editor/~TLCursorComponent-type) - ---- - -### `ErrorFallback` \{#TLEditorComponents-ErrorFallback-member} - -Public PropertySignature - -##### Signature - - -```ts -ErrorFallback: TLErrorFallbackComponent -``` - -##### References - -[TLErrorFallbackComponent](/gen/editor/~TLErrorFallbackComponent-type) - ---- - -### `Grid` \{#TLEditorComponents-Grid-member} - -Public PropertySignature - -##### Signature - - -```ts -Grid: null | TLGridComponent -``` - -##### References - -[TLGridComponent](/gen/editor/~TLGridComponent-type) - ---- - -### `Handle` \{#TLEditorComponents-Handle-member} - -Public PropertySignature - -##### Signature - - -```ts -Handle: null | TLHandleComponent -``` - -##### References - -[TLHandleComponent](/gen/editor/~TLHandleComponent-type) - ---- - -### `Scribble` \{#TLEditorComponents-Scribble-member} - -Public PropertySignature - -##### Signature - - -```ts -Scribble: null | TLScribbleComponent -``` - -##### References - -[TLScribbleComponent](/gen/editor/~TLScribbleComponent-type) - ---- - -### `ShapeErrorFallback` \{#TLEditorComponents-ShapeErrorFallback-member} - -Public PropertySignature - -##### Signature - - -```ts -ShapeErrorFallback: TLShapeErrorFallbackComponent -``` - -##### References - -[TLShapeErrorFallbackComponent](/gen/editor/~TLShapeErrorFallbackComponent-type) - ---- - -### `ShapeIndicatorErrorFallback` \{#TLEditorComponents-ShapeIndicatorErrorFallback-member} - -Public PropertySignature - -##### Signature - - -```ts -ShapeIndicatorErrorFallback: TLShapeIndicatorErrorFallbackComponent -``` - -##### References - -[TLShapeIndicatorErrorFallbackComponent](/gen/editor/~TLShapeIndicatorErrorFallback-type) - ---- - -### `SnapLine` \{#TLEditorComponents-SnapLine-member} - -Public PropertySignature - -##### Signature - - -```ts -SnapLine: null | TLSnapLineComponent -``` - -##### References - -[TLSnapLineComponent](/gen/editor/~TLSnapLineComponent-type) - ---- - -### `Spinner` \{#TLEditorComponents-Spinner-member} - -Public PropertySignature - -##### Signature - - -```ts -Spinner: null | TLSpinnerComponent -``` - -##### References - -[TLSpinnerComponent](/gen/editor/~TLSpinnerComponent-type) - ---- - -### `SvgDefs` \{#TLEditorComponents-SvgDefs-member} - -Public PropertySignature - -##### Signature - - -```ts -SvgDefs: null | TLSvgDefsComponent -``` - -##### References - -[TLSvgDefsComponent](/gen/editor/~TLSvgDefsComponent-type) - ---- - -### `ZoomBrush` \{#TLEditorComponents-ZoomBrush-member} - -Public PropertySignature - -##### Signature - - -```ts -ZoomBrush: null | TLBrushComponent -``` - -##### References - -[TLBrushComponent](/gen/editor/~TLBrushComponent-type) - ---- - diff --git a/docs/gen/TLEditorOptions-interface.mdx b/docs/gen/TLEditorOptions-interface.mdx deleted file mode 100644 index 3337bbd47..000000000 --- a/docs/gen/TLEditorOptions-interface.mdx +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: TLEditorOptions -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 126 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [getContainer](#TLEditorOptions-getContainer-member) - - [shapes](#TLEditorOptions-shapes-member) - - [store](#TLEditorOptions-store-member) - - [tools](#TLEditorOptions-tools-member) - - [user](#TLEditorOptions-user-member) -
- - - - -##### Signature - - -```ts -interface TLEditorOptions {} -``` - ---- - -## Properties - -### `getContainer` \{#TLEditorOptions-getContainer-member} - -Public PropertySignature - -Should return a containing html element which has all the styles applied to the editor. If not given, the body element will be used. - - -##### Signature - - -```ts -getContainer: () => HTMLElement -``` - -##### References - -[HTMLElement](/gen/HTMLElement-interface) - ---- - -### `shapes` \{#TLEditorOptions-shapes-member} - -Public PropertySignature - -An array of shapes to use in the editor. These will be used to create and manage shapes in the editor. - - -##### Signature - - -```ts -shapes: readonly AnyTLShapeInfo[] -``` - -##### References - -[AnyTLShapeInfo](/gen/editor/~AnyTLShapeInfo-type) - ---- - -### `store` \{#TLEditorOptions-store-member} - -Public PropertySignature - -The Store instance to use for keeping the app's data. This may be prepopulated, e.g. by loading from a server or database. - - -##### Signature - - -```ts -store: TLStore -``` - -##### References - -[TLStore](/gen/tlschema/TLStore-type) - ---- - -### `tools` \{#TLEditorOptions-tools-member} - -Public PropertySignature - -An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor. - - -##### Signature - - -```ts -tools: readonly TLStateNodeConstructor[] -``` - -##### References - -[TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface) - ---- - -### `user` \{#TLEditorOptions-user-member} - -Public PropertySignature - -A user defined externally to replace the default user. - - -##### Signature - - -```ts -user?: TLUser -``` - -##### References - -[TLUser](/gen/editor/~TLUser-interface) - ---- - diff --git a/docs/gen/TLEmbedResult-type.mdx b/docs/gen/TLEmbedResult-type.mdx deleted file mode 100644 index fd179a72f..000000000 --- a/docs/gen/TLEmbedResult-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLEmbedResult -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 127 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEmbedResult = - | { - definition: EmbedDefinition - url: string - embedUrl: string - } - | undefined -``` - -##### References - -[EmbedDefinition](/gen/tlschema/EmbedDefinition-type) - diff --git a/docs/gen/TLEmbedShape-type.mdx b/docs/gen/TLEmbedShape-type.mdx deleted file mode 100644 index 341ee702d..000000000 --- a/docs/gen/TLEmbedShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLEmbedShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 82 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEmbedShape = TLBaseShape<'embed', TLEmbedShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLEmbedShapeProps](/gen/tlschema/~TLEmbedShapeProps-type) - diff --git a/docs/gen/TLEmbedShapePermissions-type.mdx b/docs/gen/TLEmbedShapePermissions-type.mdx deleted file mode 100644 index d5068f28a..000000000 --- a/docs/gen/TLEmbedShapePermissions-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLEmbedShapePermissions -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 83 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEmbedShapePermissions = { - [K in keyof typeof embedShapePermissionDefaults]?: boolean -} -``` - -##### References - -[embedShapePermissionDefaults](/gen/tlschema/embedShapePermissionDefaults-var) - diff --git a/docs/gen/TLEnterEventHandler-type.mdx b/docs/gen/TLEnterEventHandler-type.mdx deleted file mode 100644 index 0cf61d496..000000000 --- a/docs/gen/TLEnterEventHandler-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLEnterEventHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 128 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEnterEventHandler = (info: any, from: string) => void -``` - diff --git a/docs/gen/TLErrorBoundaryProps-interface.mdx b/docs/gen/TLErrorBoundaryProps-interface.mdx deleted file mode 100644 index 8db52f70a..000000000 --- a/docs/gen/TLErrorBoundaryProps-interface.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: TLErrorBoundaryProps -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 129 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [children](#TLErrorBoundaryProps-children-member) - - [fallback](#TLErrorBoundaryProps-fallback-member) - - [onError](#TLErrorBoundaryProps-onError-member) -
- - - - -##### Signature - - -```ts -interface TLErrorBoundaryProps {} -``` - ---- - -## Properties - -### `children` \{#TLErrorBoundaryProps-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children: React.ReactNode -``` - -##### References - -[React.ReactNode](/gen/@types/react-React-ReactNode-type) - ---- - -### `fallback` \{#TLErrorBoundaryProps-fallback-member} - -Public PropertySignature - -##### Signature - - -```ts -fallback: (props: { error: unknown }) => any -``` - ---- - -### `onError` \{#TLErrorBoundaryProps-onError-member} - -Public PropertySignature - -##### Signature - - -```ts -onError?: ((error: unknown) => void) | null -``` - ---- - diff --git a/docs/gen/TLEventHandlers-interface.mdx b/docs/gen/TLEventHandlers-interface.mdx deleted file mode 100644 index a5afd0c81..000000000 --- a/docs/gen/TLEventHandlers-interface.mdx +++ /dev/null @@ -1,335 +0,0 @@ ---- -title: TLEventHandlers -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 130 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [onCancel](#TLEventHandlers-onCancel-member) - - [onComplete](#TLEventHandlers-onComplete-member) - - [onDoubleClick](#TLEventHandlers-onDoubleClick-member) - - [onInterrupt](#TLEventHandlers-onInterrupt-member) - - [onKeyDown](#TLEventHandlers-onKeyDown-member) - - [onKeyRepeat](#TLEventHandlers-onKeyRepeat-member) - - [onKeyUp](#TLEventHandlers-onKeyUp-member) - - [onMiddleClick](#TLEventHandlers-onMiddleClick-member) - - [onPointerDown](#TLEventHandlers-onPointerDown-member) - - [onPointerEnter](#TLEventHandlers-onPointerEnter-member) - - [onPointerLeave](#TLEventHandlers-onPointerLeave-member) - - [onPointerMove](#TLEventHandlers-onPointerMove-member) - - [onPointerUp](#TLEventHandlers-onPointerUp-member) - - [onQuadrupleClick](#TLEventHandlers-onQuadrupleClick-member) - - [onRightClick](#TLEventHandlers-onRightClick-member) - - [onTripleClick](#TLEventHandlers-onTripleClick-member) - - [onWheel](#TLEventHandlers-onWheel-member) -
- - - - -##### Signature - - -```ts -interface TLEventHandlers {} -``` - ---- - -## Properties - -### `onCancel` \{#TLEventHandlers-onCancel-member} - -Public PropertySignature - -##### Signature - - -```ts -onCancel: TLCancelEvent -``` - -##### References - -[TLCancelEvent](/gen/editor/TLCancelEvent-type) - ---- - -### `onComplete` \{#TLEventHandlers-onComplete-member} - -Public PropertySignature - -##### Signature - - -```ts -onComplete: TLCompleteEvent -``` - -##### References - -[TLCompleteEvent](/gen/editor/TLCompleteEvent-type) - ---- - -### `onDoubleClick` \{#TLEventHandlers-onDoubleClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onDoubleClick: TLClickEvent -``` - -##### References - -[TLClickEvent](/gen/editor/TLClickEvent-type) - ---- - -### `onInterrupt` \{#TLEventHandlers-onInterrupt-member} - -Public PropertySignature - -##### Signature - - -```ts -onInterrupt: TLInterruptEvent -``` - -##### References - -[TLInterruptEvent](/gen/editor/TLInterruptEvent-type) - ---- - -### `onKeyDown` \{#TLEventHandlers-onKeyDown-member} - -Public PropertySignature - -##### Signature - - -```ts -onKeyDown: TLKeyboardEvent -``` - -##### References - -[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type) - ---- - -### `onKeyRepeat` \{#TLEventHandlers-onKeyRepeat-member} - -Public PropertySignature - -##### Signature - - -```ts -onKeyRepeat: TLKeyboardEvent -``` - -##### References - -[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type) - ---- - -### `onKeyUp` \{#TLEventHandlers-onKeyUp-member} - -Public PropertySignature - -##### Signature - - -```ts -onKeyUp: TLKeyboardEvent -``` - -##### References - -[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type) - ---- - -### `onMiddleClick` \{#TLEventHandlers-onMiddleClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onMiddleClick: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onPointerDown` \{#TLEventHandlers-onPointerDown-member} - -Public PropertySignature - -##### Signature - - -```ts -onPointerDown: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onPointerEnter` \{#TLEventHandlers-onPointerEnter-member} - -Public PropertySignature - -##### Signature - - -```ts -onPointerEnter: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onPointerLeave` \{#TLEventHandlers-onPointerLeave-member} - -Public PropertySignature - -##### Signature - - -```ts -onPointerLeave: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onPointerMove` \{#TLEventHandlers-onPointerMove-member} - -Public PropertySignature - -##### Signature - - -```ts -onPointerMove: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onPointerUp` \{#TLEventHandlers-onPointerUp-member} - -Public PropertySignature - -##### Signature - - -```ts -onPointerUp: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onQuadrupleClick` \{#TLEventHandlers-onQuadrupleClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onQuadrupleClick: TLClickEvent -``` - -##### References - -[TLClickEvent](/gen/editor/TLClickEvent-type) - ---- - -### `onRightClick` \{#TLEventHandlers-onRightClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onRightClick: TLPointerEvent -``` - -##### References - -[TLPointerEvent](/gen/editor/TLPointerEvent-type) - ---- - -### `onTripleClick` \{#TLEventHandlers-onTripleClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onTripleClick: TLClickEvent -``` - -##### References - -[TLClickEvent](/gen/editor/TLClickEvent-type) - ---- - -### `onWheel` \{#TLEventHandlers-onWheel-member} - -Public PropertySignature - -##### Signature - - -```ts -onWheel: TLWheelEvent -``` - -##### References - -[TLWheelEvent](/gen/editor/TLWheelEvent-type) - ---- - diff --git a/docs/gen/TLEventInfo-type.mdx b/docs/gen/TLEventInfo-type.mdx deleted file mode 100644 index 9571c16fb..000000000 --- a/docs/gen/TLEventInfo-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TLEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 131 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEventInfo = - | TLCancelEventInfo - | TLClickEventInfo - | TLCompleteEventInfo - | TLInterruptEventInfo - | TLKeyboardEventInfo - | TLPinchEventInfo - | TLPointerEventInfo - | TLWheelEventInfo -``` - -##### References - -[TLCancelEventInfo](/gen/editor/TLCancelEventInfo-type), [TLClickEventInfo](/gen/editor/TLClickEventInfo-type), [TLCompleteEventInfo](/gen/editor/TLCompleteEventInfo-type), [TLInterruptEventInfo](/gen/editor/TLInterruptEventInfo-type), [TLKeyboardEventInfo](/gen/editor/TLKeyboardEventInfo-type), [TLPinchEventInfo](/gen/editor/TLPinchEventInfo-type), [TLPointerEventInfo](/gen/editor/TLPointerEventInfo-type), [TLWheelEventInfo](/gen/editor/TLWheelEventInfo-type) - diff --git a/docs/gen/TLEventMap-interface.mdx b/docs/gen/TLEventMap-interface.mdx deleted file mode 100644 index 42df851ad..000000000 --- a/docs/gen/TLEventMap-interface.mdx +++ /dev/null @@ -1,231 +0,0 @@ ---- -title: TLEventMap -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 132 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - ["change-history"](#TLEventMap-"change-history"-member) - - ["mark-history"](#TLEventMap-"mark-history"-member) - - ["max-shapes"](#TLEventMap-"max-shapes"-member) - - ["stop-camera-animation"](#TLEventMap-"stop-camera-animation"-member) - - ["stop-following"](#TLEventMap-"stop-following"-member) - - [change](#TLEventMap-change-member) - - [crash](#TLEventMap-crash-member) - - [event](#TLEventMap-event-member) - - [frame](#TLEventMap-frame-member) - - [mount](#TLEventMap-mount-member) - - [tick](#TLEventMap-tick-member) - - [update](#TLEventMap-update-member) -
- - - - -##### Signature - - -```ts -interface TLEventMap {} -``` - ---- - -## Properties - -### `"change-history"` \{#TLEventMap-"change-history"-member} - -Public PropertySignature - -##### Signature - - -```ts -'change-history': [ - | { - reason: 'bail' - markId?: string - } - | { - reason: 'push' | 'redo' | 'undo' - } -] -``` - ---- - -### `"mark-history"` \{#TLEventMap-"mark-history"-member} - -Public PropertySignature - -##### Signature - - -```ts -'mark-history': [ - { - id: string - } -] -``` - ---- - -### `"max-shapes"` \{#TLEventMap-"max-shapes"-member} - -Public PropertySignature - -##### Signature - - -```ts -'max-shapes': [ - { - name: string - pageId: TLPageId - count: number - } -] -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `"stop-camera-animation"` \{#TLEventMap-"stop-camera-animation"-member} - -Public PropertySignature - -##### Signature - - -```ts -'stop-camera-animation': [] -``` - ---- - -### `"stop-following"` \{#TLEventMap-"stop-following"-member} - -Public PropertySignature - -##### Signature - - -```ts -'stop-following': [] -``` - ---- - -### `change` \{#TLEventMap-change-member} - -Public PropertySignature - -##### Signature - - -```ts -change: [HistoryEntry] -``` - -##### References - -[HistoryEntry](/gen/store/HistoryEntry-type), [TLRecord](/gen/tlschema/TLRecord-type) - ---- - -### `crash` \{#TLEventMap-crash-member} - -Public PropertySignature - -##### Signature - - -```ts -crash: [ - { - error: unknown - } -] -``` - ---- - -### `event` \{#TLEventMap-event-member} - -Public PropertySignature - -##### Signature - - -```ts -event: [TLEventInfo] -``` - -##### References - -[TLEventInfo](/gen/editor/TLEventInfo-type) - ---- - -### `frame` \{#TLEventMap-frame-member} - -Public PropertySignature - -##### Signature - - -```ts -frame: [number] -``` - ---- - -### `mount` \{#TLEventMap-mount-member} - -Public PropertySignature - -##### Signature - - -```ts -mount: [] -``` - ---- - -### `tick` \{#TLEventMap-tick-member} - -Public PropertySignature - -##### Signature - - -```ts -tick: [number] -``` - ---- - -### `update` \{#TLEventMap-update-member} - -Public PropertySignature - -##### Signature - - -```ts -update: [] -``` - ---- - diff --git a/docs/gen/TLEventMapHandler-type.mdx b/docs/gen/TLEventMapHandler-type.mdx deleted file mode 100644 index 870427552..000000000 --- a/docs/gen/TLEventMapHandler-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLEventMapHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 133 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEventMapHandler = ( - ...args: TLEventMap[T] -) => void -``` - -##### References - -[TLEventMap](/gen/editor/TLEventMap-interface) - diff --git a/docs/gen/TLEventName-type.mdx b/docs/gen/TLEventName-type.mdx deleted file mode 100644 index f4c2f3bf9..000000000 --- a/docs/gen/TLEventName-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TLEventName -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 134 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLEventName = - | 'cancel' - | 'complete' - | 'interrupt' - | 'wheel' - | TLCLickEventName - | TLKeyboardEventName - | TLPinchEventName - | TLPointerEventName -``` - -##### References - -[TLCLickEventName](/gen/editor/TLCLickEventName-type), [TLKeyboardEventName](/gen/editor/TLKeyboardEventName-type), [TLPinchEventName](/gen/editor/TLPinchEventName-type), [TLPointerEventName](/gen/editor/TLPointerEventName-type) - diff --git a/docs/gen/TLExitEventHandler-type.mdx b/docs/gen/TLExitEventHandler-type.mdx deleted file mode 100644 index 1aa1d2de1..000000000 --- a/docs/gen/TLExitEventHandler-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLExitEventHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 135 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLExitEventHandler = (info: any, to: string) => void -``` - diff --git a/docs/gen/TLExportType-type.mdx b/docs/gen/TLExportType-type.mdx deleted file mode 100644 index 0456c003b..000000000 --- a/docs/gen/TLExportType-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLExportType -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 136 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLExportType = 'jpeg' | 'json' | 'png' | 'svg' | 'webp' -``` - diff --git a/docs/gen/TLExternalContent-type.mdx b/docs/gen/TLExternalContent-type.mdx deleted file mode 100644 index 6a793dada..000000000 --- a/docs/gen/TLExternalContent-type.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: TLExternalContent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 137 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLExternalContent = - | { - type: 'embed' - url: string - point?: VecLike - embed: EmbedDefinition - } - | { - type: 'files' - files: File[] - point?: VecLike - ignoreParent: boolean - } - | { - type: 'svg-text' - text: string - point?: VecLike - } - | { - type: 'text' - point?: VecLike - text: string - } - | { - type: 'url' - url: string - point?: VecLike - } -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [EmbedDefinition](/gen/tlschema/EmbedDefinition-type), [File](/gen/File-interface) - diff --git a/docs/gen/TLFrameShape-type.mdx b/docs/gen/TLFrameShape-type.mdx deleted file mode 100644 index ffbb12e51..000000000 --- a/docs/gen/TLFrameShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLFrameShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 84 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLFrameShape = TLBaseShape<'frame', TLFrameShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLFrameShapeProps](/gen/tlschema/~TLFrameShapeProps-type) - diff --git a/docs/gen/TLGeoShape-type.mdx b/docs/gen/TLGeoShape-type.mdx deleted file mode 100644 index aa7d93505..000000000 --- a/docs/gen/TLGeoShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLGeoShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 85 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLGeoShape = TLBaseShape<'geo', TLGeoShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLGeoShapeProps](/gen/tlschema/~TLGeoShapeProps-type) - diff --git a/docs/gen/TLGroupShape-type.mdx b/docs/gen/TLGroupShape-type.mdx deleted file mode 100644 index 543da0f72..000000000 --- a/docs/gen/TLGroupShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLGroupShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 86 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLGroupShape = TLBaseShape<'group', TLGroupShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLGroupShapeProps](/gen/tlschema/~TLGroupShapeProps-type) - diff --git a/docs/gen/TLHandle-interface.mdx b/docs/gen/TLHandle-interface.mdx deleted file mode 100644 index 502859bd1..000000000 --- a/docs/gen/TLHandle-interface.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: TLHandle -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 87 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [canBind](#TLHandle-canBind-member) - - [id](#TLHandle-id-member) - - [index](#TLHandle-index-member) - - [type](#TLHandle-type-member) - - [x](#TLHandle-x-member) - - [y](#TLHandle-y-member) -
- -A base interface for a shape's handles. - - -##### Signature - - -```ts -interface TLHandle {} -``` - ---- - -## Properties - -### `canBind` \{#TLHandle-canBind-member} - -Public PropertySignature - -##### Signature - - -```ts -canBind?: boolean -``` - ---- - -### `id` \{#TLHandle-id-member} - -Public PropertySignature - -A unique identifier for the handle. - - -##### Signature - - -```ts -id: string -``` - ---- - -### `index` \{#TLHandle-index-member} - -Public PropertySignature - -##### Signature - - -```ts -index: string -``` - ---- - -### `type` \{#TLHandle-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: TLHandleType -``` - -##### References - -[TLHandleType](/gen/tlschema/TLHandleType-type) - ---- - -### `x` \{#TLHandle-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#TLHandle-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - diff --git a/docs/gen/TLHandleType-type.mdx b/docs/gen/TLHandleType-type.mdx deleted file mode 100644 index 6146dfa2c..000000000 --- a/docs/gen/TLHandleType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLHandleType -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 88 ----Public TypeAlias - -A type for the handle types used by tldraw's default shapes. - - -##### Signature - - -```ts -type TLHandleType = SetValue -``` - -##### References - -[SetValue](/gen/tlschema/~SetValue-type), [TL_HANDLE_TYPES](/gen/tlschema/~TL_HANDLE_TYPES-var) - diff --git a/docs/gen/TLHighlightShape-type.mdx b/docs/gen/TLHighlightShape-type.mdx deleted file mode 100644 index 2b38ac39f..000000000 --- a/docs/gen/TLHighlightShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLHighlightShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 89 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLHighlightShape = TLBaseShape<'highlight', TLHighlightShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLHighlightShapeProps](/gen/tlschema/~TLHighlightShapeProps-type) - diff --git a/docs/gen/TLHistoryEntry-type.mdx b/docs/gen/TLHistoryEntry-type.mdx deleted file mode 100644 index 16dc2d46f..000000000 --- a/docs/gen/TLHistoryEntry-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLHistoryEntry -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 138 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLHistoryEntry = TLCommand | TLHistoryMark -``` - -##### References - -[TLCommand](/gen/editor/TLCommand-type), [TLHistoryMark](/gen/editor/TLHistoryMark-type) - diff --git a/docs/gen/TLHistoryMark-type.mdx b/docs/gen/TLHistoryMark-type.mdx deleted file mode 100644 index 9877ea7d0..000000000 --- a/docs/gen/TLHistoryMark-type.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: TLHistoryMark -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 139 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLHistoryMark = { - type: 'STOP' - id: string - onUndo: boolean - onRedo: boolean -} -``` - diff --git a/docs/gen/TLINSTANCE_ID-var.mdx b/docs/gen/TLINSTANCE_ID-var.mdx deleted file mode 100644 index e211a0f19..000000000 --- a/docs/gen/TLINSTANCE_ID-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLINSTANCE_ID -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 94 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TLINSTANCE_ID: TLInstanceId -``` - -##### References - -[TLInstanceId](/gen/tlschema/TLInstanceId-type) - diff --git a/docs/gen/TLImageAsset-type.mdx b/docs/gen/TLImageAsset-type.mdx deleted file mode 100644 index 66992f0ef..000000000 --- a/docs/gen/TLImageAsset-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TLImageAsset -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 90 ----Public TypeAlias - -An asset for images such as PNGs and JPEGs, used by the TLImageShape. - - -##### Signature - - -```ts -type TLImageAsset = TLBaseAsset< - 'image', - { - w: number - h: number - name: string - isAnimated: boolean - mimeType: null | string - src: null | string - } -> -``` - -##### References - -[TLBaseAsset](/gen/tlschema/TLBaseAsset-interface) - diff --git a/docs/gen/TLImageShape-type.mdx b/docs/gen/TLImageShape-type.mdx deleted file mode 100644 index ddfe5644b..000000000 --- a/docs/gen/TLImageShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLImageShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 91 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLImageShape = TLBaseShape<'image', TLImageShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLImageShapeProps](/gen/tlschema/TLImageShapeProps-type) - diff --git a/docs/gen/TLImageShapeCrop-type.mdx b/docs/gen/TLImageShapeCrop-type.mdx deleted file mode 100644 index 17f81e109..000000000 --- a/docs/gen/TLImageShapeCrop-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLImageShapeCrop -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 92 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLImageShapeCrop = T.TypeOf -``` - -##### References - -[T.TypeOf](/gen/validate/TypeOf-type), [ImageShapeCrop](/gen/tlschema/~ImageShapeCrop-var) - diff --git a/docs/gen/TLImageShapeProps-type.mdx b/docs/gen/TLImageShapeProps-type.mdx deleted file mode 100644 index 025ab2acb..000000000 --- a/docs/gen/TLImageShapeProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLImageShapeProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 93 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLImageShapeProps = ShapePropsType -``` - -##### References - -[ShapePropsType](/gen/tlschema/~ShapePropsType-type), [imageShapeProps](/gen/tlschema/imageShapeProps-var) - diff --git a/docs/gen/TLInstance-interface.mdx b/docs/gen/TLInstance-interface.mdx deleted file mode 100644 index b15771c6a..000000000 --- a/docs/gen/TLInstance-interface.mdx +++ /dev/null @@ -1,320 +0,0 @@ ---- -title: TLInstance -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 95 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [brush](#TLInstance-brush-member) - - [chatMessage](#TLInstance-chatMessage-member) - - [currentPageId](#TLInstance-currentPageId-member) - - [cursor](#TLInstance-cursor-member) - - [exportBackground](#TLInstance-exportBackground-member) - - [followingUserId](#TLInstance-followingUserId-member) - - [highlightedUserIds](#TLInstance-highlightedUserIds-member) - - [isChatting](#TLInstance-isChatting-member) - - [isDebugMode](#TLInstance-isDebugMode-member) - - [isFocusMode](#TLInstance-isFocusMode-member) - - [isGridMode](#TLInstance-isGridMode-member) - - [isPenMode](#TLInstance-isPenMode-member) - - [isToolLocked](#TLInstance-isToolLocked-member) - - [opacityForNextShape](#TLInstance-opacityForNextShape-member) - - [screenBounds](#TLInstance-screenBounds-member) - - [scribble](#TLInstance-scribble-member) - - [stylesForNextShape](#TLInstance-stylesForNextShape-member) - - [zoomBrush](#TLInstance-zoomBrush-member) -
- -TLInstance - - -State that is particular to a single browser tab - - -##### Signature - - -```ts -interface TLInstance extends BaseRecord<'instance', TLInstanceId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLInstanceId](/gen/tlschema/TLInstanceId-type) - ---- - -## Properties - -### `brush` \{#TLInstance-brush-member} - -Public PropertySignature - -##### Signature - - -```ts -brush: Box2dModel | null -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `chatMessage` \{#TLInstance-chatMessage-member} - -Public PropertySignature - -##### Signature - - -```ts -chatMessage: string -``` - ---- - -### `currentPageId` \{#TLInstance-currentPageId-member} - -Public PropertySignature - -##### Signature - - -```ts -currentPageId: TLPageId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `cursor` \{#TLInstance-cursor-member} - -Public PropertySignature - -##### Signature - - -```ts -cursor: TLCursor -``` - -##### References - -[TLCursor](/gen/tlschema/TLCursor-interface) - ---- - -### `exportBackground` \{#TLInstance-exportBackground-member} - -Public PropertySignature - -##### Signature - - -```ts -exportBackground: boolean -``` - ---- - -### `followingUserId` \{#TLInstance-followingUserId-member} - -Public PropertySignature - -##### Signature - - -```ts -followingUserId: null | string -``` - ---- - -### `highlightedUserIds` \{#TLInstance-highlightedUserIds-member} - -Public PropertySignature - -##### Signature - - -```ts -highlightedUserIds: string[] -``` - ---- - -### `isChatting` \{#TLInstance-isChatting-member} - -Public PropertySignature - -##### Signature - - -```ts -isChatting: boolean -``` - ---- - -### `isDebugMode` \{#TLInstance-isDebugMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isDebugMode: boolean -``` - ---- - -### `isFocusMode` \{#TLInstance-isFocusMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isFocusMode: boolean -``` - ---- - -### `isGridMode` \{#TLInstance-isGridMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isGridMode: boolean -``` - ---- - -### `isPenMode` \{#TLInstance-isPenMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isPenMode: boolean -``` - ---- - -### `isToolLocked` \{#TLInstance-isToolLocked-member} - -Public PropertySignature - -##### Signature - - -```ts -isToolLocked: boolean -``` - ---- - -### `opacityForNextShape` \{#TLInstance-opacityForNextShape-member} - -Public PropertySignature - -##### Signature - - -```ts -opacityForNextShape: TLOpacityType -``` - -##### References - -[TLOpacityType](/gen/tlschema/TLOpacityType-type) - ---- - -### `screenBounds` \{#TLInstance-screenBounds-member} - -Public PropertySignature - -##### Signature - - -```ts -screenBounds: Box2dModel -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `scribble` \{#TLInstance-scribble-member} - -Public PropertySignature - -##### Signature - - -```ts -scribble: null | TLScribble -``` - -##### References - -[TLScribble](/gen/tlschema/TLScribble-type) - ---- - -### `stylesForNextShape` \{#TLInstance-stylesForNextShape-member} - -Public PropertySignature - -##### Signature - - -```ts -stylesForNextShape: Record -``` - -##### References - -[Record](/gen/Record-type) - ---- - -### `zoomBrush` \{#TLInstance-zoomBrush-member} - -Public PropertySignature - -##### Signature - - -```ts -zoomBrush: Box2dModel | null -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - diff --git a/docs/gen/TLInstanceId-type.mdx b/docs/gen/TLInstanceId-type.mdx deleted file mode 100644 index ed9e99278..000000000 --- a/docs/gen/TLInstanceId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLInstanceId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 96 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLInstanceId = RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLInstance](/gen/tlschema/TLInstance-interface) - diff --git a/docs/gen/TLInstancePageState-interface.mdx b/docs/gen/TLInstancePageState-interface.mdx deleted file mode 100644 index 1930aeb74..000000000 --- a/docs/gen/TLInstancePageState-interface.mdx +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: TLInstancePageState -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 97 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [croppingId](#TLInstancePageState-croppingId-member) - - [editingId](#TLInstancePageState-editingId-member) - - [erasingIds](#TLInstancePageState-erasingIds-member) - - [focusLayerId](#TLInstancePageState-focusLayerId-member) - - [hintingIds](#TLInstancePageState-hintingIds-member) - - [hoveredId](#TLInstancePageState-hoveredId-member) - - [pageId](#TLInstancePageState-pageId-member) - - [selectedIds](#TLInstancePageState-selectedIds-member) -
- -TLInstancePageState - - -State that is unique to a particular page of the document in a particular browser tab - - -##### Signature - - -```ts -interface TLInstancePageState - extends BaseRecord<'instance_page_state', TLInstancePageStateId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLInstancePageStateId](/gen/tlschema/~TLInstancePageStateId-type) - ---- - -## Properties - -### `croppingId` \{#TLInstancePageState-croppingId-member} - -Public PropertySignature - -##### Signature - - -```ts -croppingId: null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `editingId` \{#TLInstancePageState-editingId-member} - -Public PropertySignature - -##### Signature - - -```ts -editingId: null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `erasingIds` \{#TLInstancePageState-erasingIds-member} - -Public PropertySignature - -##### Signature - - -```ts -erasingIds: TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `focusLayerId` \{#TLInstancePageState-focusLayerId-member} - -Public PropertySignature - -##### Signature - - -```ts -focusLayerId: null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `hintingIds` \{#TLInstancePageState-hintingIds-member} - -Public PropertySignature - -##### Signature - - -```ts -hintingIds: TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `hoveredId` \{#TLInstancePageState-hoveredId-member} - -Public PropertySignature - -##### Signature - - -```ts -hoveredId: null | TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `pageId` \{#TLInstancePageState-pageId-member} - -Public PropertySignature - -##### Signature - - -```ts -pageId: RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLPage](/gen/tlschema/TLPage-interface) - ---- - -### `selectedIds` \{#TLInstancePageState-selectedIds-member} - -Public PropertySignature - -##### Signature - - -```ts -selectedIds: TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - diff --git a/docs/gen/TLInstancePresence-interface.mdx b/docs/gen/TLInstancePresence-interface.mdx deleted file mode 100644 index 5227c8215..000000000 --- a/docs/gen/TLInstancePresence-interface.mdx +++ /dev/null @@ -1,249 +0,0 @@ ---- -title: TLInstancePresence -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 98 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [brush](#TLInstancePresence-brush-member) - - [camera](#TLInstancePresence-camera-member) - - [chatMessage](#TLInstancePresence-chatMessage-member) - - [color](#TLInstancePresence-color-member) - - [currentPageId](#TLInstancePresence-currentPageId-member) - - [cursor](#TLInstancePresence-cursor-member) - - [followingUserId](#TLInstancePresence-followingUserId-member) - - [lastActivityTimestamp](#TLInstancePresence-lastActivityTimestamp-member) - - [screenBounds](#TLInstancePresence-screenBounds-member) - - [scribble](#TLInstancePresence-scribble-member) - - [selectedIds](#TLInstancePresence-selectedIds-member) - - [userId](#TLInstancePresence-userId-member) - - [userName](#TLInstancePresence-userName-member) -
- - - - -##### Signature - - -```ts -interface TLInstancePresence - extends BaseRecord<'instance_presence', TLInstancePresenceID> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLInstancePresenceID](/gen/tlschema/~TLInstancePresenceID-type) - ---- - -## Properties - -### `brush` \{#TLInstancePresence-brush-member} - -Public PropertySignature - -##### Signature - - -```ts -brush: Box2dModel | null -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `camera` \{#TLInstancePresence-camera-member} - -Public PropertySignature - -##### Signature - - -```ts -camera: { - x: number - y: number - z: number -} -``` - ---- - -### `chatMessage` \{#TLInstancePresence-chatMessage-member} - -Public PropertySignature - -##### Signature - - -```ts -chatMessage: string -``` - ---- - -### `color` \{#TLInstancePresence-color-member} - -Public PropertySignature - -##### Signature - - -```ts -color: string -``` - ---- - -### `currentPageId` \{#TLInstancePresence-currentPageId-member} - -Public PropertySignature - -##### Signature - - -```ts -currentPageId: TLPageId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `cursor` \{#TLInstancePresence-cursor-member} - -Public PropertySignature - -##### Signature - - -```ts -cursor: { - x: number - y: number - type: TLCursor['type'] - rotation: number -} -``` - -##### References - -[TLCursor](/gen/tlschema/TLCursor-interface) - ---- - -### `followingUserId` \{#TLInstancePresence-followingUserId-member} - -Public PropertySignature - -##### Signature - - -```ts -followingUserId: null | string -``` - ---- - -### `lastActivityTimestamp` \{#TLInstancePresence-lastActivityTimestamp-member} - -Public PropertySignature - -##### Signature - - -```ts -lastActivityTimestamp: number -``` - ---- - -### `screenBounds` \{#TLInstancePresence-screenBounds-member} - -Public PropertySignature - -##### Signature - - -```ts -screenBounds: Box2dModel -``` - -##### References - -[Box2dModel](/gen/tlschema/Box2dModel-interface) - ---- - -### `scribble` \{#TLInstancePresence-scribble-member} - -Public PropertySignature - -##### Signature - - -```ts -scribble: null | TLScribble -``` - -##### References - -[TLScribble](/gen/tlschema/TLScribble-type) - ---- - -### `selectedIds` \{#TLInstancePresence-selectedIds-member} - -Public PropertySignature - -##### Signature - - -```ts -selectedIds: TLShapeId[] -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `userId` \{#TLInstancePresence-userId-member} - -Public PropertySignature - -##### Signature - - -```ts -userId: string -``` - ---- - -### `userName` \{#TLInstancePresence-userName-member} - -Public PropertySignature - -##### Signature - - -```ts -userName: string -``` - ---- - diff --git a/docs/gen/TLInterruptEvent-type.mdx b/docs/gen/TLInterruptEvent-type.mdx deleted file mode 100644 index 73ff3042e..000000000 --- a/docs/gen/TLInterruptEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLInterruptEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 140 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLInterruptEvent = (info: TLInterruptEventInfo) => void -``` - -##### References - -[TLInterruptEventInfo](/gen/editor/TLInterruptEventInfo-type) - diff --git a/docs/gen/TLInterruptEventInfo-type.mdx b/docs/gen/TLInterruptEventInfo-type.mdx deleted file mode 100644 index 6c34d2bdd..000000000 --- a/docs/gen/TLInterruptEventInfo-type.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: TLInterruptEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 141 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLInterruptEventInfo = { - type: 'misc' - name: 'interrupt' -} -``` - diff --git a/docs/gen/TLKeyboardEvent-type.mdx b/docs/gen/TLKeyboardEvent-type.mdx deleted file mode 100644 index 33a719cf5..000000000 --- a/docs/gen/TLKeyboardEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLKeyboardEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 142 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLKeyboardEvent = (info: TLKeyboardEventInfo) => void -``` - -##### References - -[TLKeyboardEventInfo](/gen/editor/TLKeyboardEventInfo-type) - diff --git a/docs/gen/TLKeyboardEventInfo-type.mdx b/docs/gen/TLKeyboardEventInfo-type.mdx deleted file mode 100644 index 77573e631..000000000 --- a/docs/gen/TLKeyboardEventInfo-type.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TLKeyboardEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 143 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLKeyboardEventInfo = TLBaseEventInfo & { - type: 'keyboard' - name: TLKeyboardEventName - key: string - code: string -} -``` - -##### References - -[TLBaseEventInfo](/gen/editor/TLBaseEventInfo-interface), [TLKeyboardEventName](/gen/editor/TLKeyboardEventName-type) - diff --git a/docs/gen/TLKeyboardEventName-type.mdx b/docs/gen/TLKeyboardEventName-type.mdx deleted file mode 100644 index 9c9a7e5e9..000000000 --- a/docs/gen/TLKeyboardEventName-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLKeyboardEventName -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 144 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLKeyboardEventName = 'key_down' | 'key_repeat' | 'key_up' -``` - diff --git a/docs/gen/TLLanguage-type.mdx b/docs/gen/TLLanguage-type.mdx deleted file mode 100644 index 5cc58444f..000000000 --- a/docs/gen/TLLanguage-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLLanguage -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 99 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLLanguage = (typeof LANGUAGES)[number] -``` - -##### References - -[LANGUAGES](/gen/tlschema/LANGUAGES-var) - diff --git a/docs/gen/TLLineShape-type.mdx b/docs/gen/TLLineShape-type.mdx deleted file mode 100644 index ffeb7165b..000000000 --- a/docs/gen/TLLineShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLLineShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 100 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLLineShape = TLBaseShape<'line', TLLineShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLLineShapeProps](/gen/tlschema/~TLLineShapeProps-type) - diff --git a/docs/gen/TLNoteShape-type.mdx b/docs/gen/TLNoteShape-type.mdx deleted file mode 100644 index 9a403bda6..000000000 --- a/docs/gen/TLNoteShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLNoteShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 101 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLNoteShape = TLBaseShape<'note', TLNoteShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLNoteShapeProps](/gen/tlschema/~TLNoteShapeProps-type) - diff --git a/docs/gen/TLOnBeforeCreateHandler-type.mdx b/docs/gen/TLOnBeforeCreateHandler-type.mdx deleted file mode 100644 index 27afeafe4..000000000 --- a/docs/gen/TLOnBeforeCreateHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnBeforeCreateHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 145 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnBeforeCreateHandler = (next: T) => T | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/TLOnBeforeUpdateHandler-type.mdx b/docs/gen/TLOnBeforeUpdateHandler-type.mdx deleted file mode 100644 index 6bb2db1f0..000000000 --- a/docs/gen/TLOnBeforeUpdateHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnBeforeUpdateHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 146 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnBeforeUpdateHandler = (prev: T, next: T) => T | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/TLOnChildrenChangeHandler-type.mdx b/docs/gen/TLOnChildrenChangeHandler-type.mdx deleted file mode 100644 index a0cde6a89..000000000 --- a/docs/gen/TLOnChildrenChangeHandler-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLOnChildrenChangeHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 147 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnChildrenChangeHandler = ( - shape: T -) => TLShapePartial[] | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnClickHandler-type.mdx b/docs/gen/TLOnClickHandler-type.mdx deleted file mode 100644 index 6c80c192d..000000000 --- a/docs/gen/TLOnClickHandler-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLOnClickHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 148 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnClickHandler = ( - shape: T -) => TLShapePartial | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnDoubleClickHandleHandler-type.mdx b/docs/gen/TLOnDoubleClickHandleHandler-type.mdx deleted file mode 100644 index 31938d99a..000000000 --- a/docs/gen/TLOnDoubleClickHandleHandler-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLOnDoubleClickHandleHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 149 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnDoubleClickHandleHandler = ( - shape: T, - handle: TLHandle -) => TLShapePartial | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLHandle](/gen/tlschema/TLHandle-interface), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnDoubleClickHandler-type.mdx b/docs/gen/TLOnDoubleClickHandler-type.mdx deleted file mode 100644 index bac054e6c..000000000 --- a/docs/gen/TLOnDoubleClickHandler-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLOnDoubleClickHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 150 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnDoubleClickHandler = ( - shape: T -) => TLShapePartial | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnDragHandler-type.mdx b/docs/gen/TLOnDragHandler-type.mdx deleted file mode 100644 index 0bc9088e7..000000000 --- a/docs/gen/TLOnDragHandler-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLOnDragHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 151 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnDragHandler = ( - shape: T, - shapes: TLShape[] -) => R -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/TLOnEditEndHandler-type.mdx b/docs/gen/TLOnEditEndHandler-type.mdx deleted file mode 100644 index d124f773b..000000000 --- a/docs/gen/TLOnEditEndHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnEditEndHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 152 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnEditEndHandler = (shape: T) => void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/TLOnHandleChangeHandler-type.mdx b/docs/gen/TLOnHandleChangeHandler-type.mdx deleted file mode 100644 index 345562850..000000000 --- a/docs/gen/TLOnHandleChangeHandler-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLOnHandleChangeHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 153 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnHandleChangeHandler = ( - shape: T, - info: { - handle: TLHandle - isPrecise: boolean - } -) => TLShapePartial | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLHandle](/gen/tlschema/TLHandle-interface), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnResizeEndHandler-type.mdx b/docs/gen/TLOnResizeEndHandler-type.mdx deleted file mode 100644 index ea0aec33d..000000000 --- a/docs/gen/TLOnResizeEndHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnResizeEndHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 154 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnResizeEndHandler = TLEventChangeHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventChangeHandler](/gen/editor/~TLEventChangeHandler-type) - diff --git a/docs/gen/TLOnResizeHandler-type.mdx b/docs/gen/TLOnResizeHandler-type.mdx deleted file mode 100644 index 839c30e39..000000000 --- a/docs/gen/TLOnResizeHandler-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLOnResizeHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 155 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnResizeHandler = ( - shape: T, - info: TLResizeInfo -) => Omit, 'id' | 'type'> | undefined | void -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLResizeInfo](/gen/editor/TLResizeInfo-type), [Omit](/gen/Omit-type), [TLShapePartial](/gen/tlschema/TLShapePartial-type) - diff --git a/docs/gen/TLOnResizeStartHandler-type.mdx b/docs/gen/TLOnResizeStartHandler-type.mdx deleted file mode 100644 index dda59063d..000000000 --- a/docs/gen/TLOnResizeStartHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnResizeStartHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 156 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnResizeStartHandler = TLEventStartHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventStartHandler](/gen/editor/~TLEventStartHandler-type) - diff --git a/docs/gen/TLOnRotateEndHandler-type.mdx b/docs/gen/TLOnRotateEndHandler-type.mdx deleted file mode 100644 index d93009aab..000000000 --- a/docs/gen/TLOnRotateEndHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnRotateEndHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 157 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnRotateEndHandler = TLEventChangeHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventChangeHandler](/gen/editor/~TLEventChangeHandler-type) - diff --git a/docs/gen/TLOnRotateHandler-type.mdx b/docs/gen/TLOnRotateHandler-type.mdx deleted file mode 100644 index aee34a9e2..000000000 --- a/docs/gen/TLOnRotateHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnRotateHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 158 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnRotateHandler = TLEventChangeHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventChangeHandler](/gen/editor/~TLEventChangeHandler-type) - diff --git a/docs/gen/TLOnRotateStartHandler-type.mdx b/docs/gen/TLOnRotateStartHandler-type.mdx deleted file mode 100644 index aedf338a3..000000000 --- a/docs/gen/TLOnRotateStartHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnRotateStartHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 159 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnRotateStartHandler = TLEventStartHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventStartHandler](/gen/editor/~TLEventStartHandler-type) - diff --git a/docs/gen/TLOnTranslateEndHandler-type.mdx b/docs/gen/TLOnTranslateEndHandler-type.mdx deleted file mode 100644 index b6dfe1a43..000000000 --- a/docs/gen/TLOnTranslateEndHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnTranslateEndHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 160 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnTranslateEndHandler = TLEventChangeHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventChangeHandler](/gen/editor/~TLEventChangeHandler-type) - diff --git a/docs/gen/TLOnTranslateHandler-type.mdx b/docs/gen/TLOnTranslateHandler-type.mdx deleted file mode 100644 index 2865ec945..000000000 --- a/docs/gen/TLOnTranslateHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnTranslateHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 161 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnTranslateHandler = TLEventChangeHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventChangeHandler](/gen/editor/~TLEventChangeHandler-type) - diff --git a/docs/gen/TLOnTranslateStartHandler-type.mdx b/docs/gen/TLOnTranslateStartHandler-type.mdx deleted file mode 100644 index f83d7efd2..000000000 --- a/docs/gen/TLOnTranslateStartHandler-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLOnTranslateStartHandler -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 162 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOnTranslateStartHandler = TLEventStartHandler -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLEventStartHandler](/gen/editor/~TLEventStartHandler-type) - diff --git a/docs/gen/TLOpacityType-type.mdx b/docs/gen/TLOpacityType-type.mdx deleted file mode 100644 index 402510a79..000000000 --- a/docs/gen/TLOpacityType-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLOpacityType -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 102 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLOpacityType = number -``` - diff --git a/docs/gen/TLPOINTER_ID-var.mdx b/docs/gen/TLPOINTER_ID-var.mdx deleted file mode 100644 index ecd4ac4ee..000000000 --- a/docs/gen/TLPOINTER_ID-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLPOINTER_ID -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 106 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TLPOINTER_ID: TLPointerId -``` - -##### References - -[TLPointerId](/gen/tlschema/~TLPointerId-type) - diff --git a/docs/gen/TLPage-interface.mdx b/docs/gen/TLPage-interface.mdx deleted file mode 100644 index 36e854e37..000000000 --- a/docs/gen/TLPage-interface.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: TLPage -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 103 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [index](#TLPage-index-member) - - [name](#TLPage-name-member) -
- -TLPage - - -##### Signature - - -```ts -interface TLPage extends BaseRecord<'page', TLPageId> {} -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [TLPageId](/gen/tlschema/TLPageId-type) - ---- - -## Properties - -### `index` \{#TLPage-index-member} - -Public PropertySignature - -##### Signature - - -```ts -index: string -``` - ---- - -### `name` \{#TLPage-name-member} - -Public PropertySignature - -##### Signature - - -```ts -name: string -``` - ---- - diff --git a/docs/gen/TLPageId-type.mdx b/docs/gen/TLPageId-type.mdx deleted file mode 100644 index c1d319b8d..000000000 --- a/docs/gen/TLPageId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLPageId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 104 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPageId = RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLPage](/gen/tlschema/TLPage-interface) - diff --git a/docs/gen/TLParentId-type.mdx b/docs/gen/TLParentId-type.mdx deleted file mode 100644 index 367df9dc2..000000000 --- a/docs/gen/TLParentId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLParentId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 105 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLParentId = TLPageId | TLShapeId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - diff --git a/docs/gen/TLPinchEvent-type.mdx b/docs/gen/TLPinchEvent-type.mdx deleted file mode 100644 index f6de76a8f..000000000 --- a/docs/gen/TLPinchEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLPinchEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 163 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPinchEvent = (info: TLPinchEventInfo) => void -``` - -##### References - -[TLPinchEventInfo](/gen/editor/TLPinchEventInfo-type) - diff --git a/docs/gen/TLPinchEventInfo-type.mdx b/docs/gen/TLPinchEventInfo-type.mdx deleted file mode 100644 index 462894ed3..000000000 --- a/docs/gen/TLPinchEventInfo-type.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TLPinchEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 164 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPinchEventInfo = TLBaseEventInfo & { - type: 'pinch' - name: TLPinchEventName - point: Vec2dModel - delta: Vec2dModel -} -``` - -##### References - -[TLBaseEventInfo](/gen/editor/TLBaseEventInfo-interface), [TLPinchEventName](/gen/editor/TLPinchEventName-type), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - diff --git a/docs/gen/TLPinchEventName-type.mdx b/docs/gen/TLPinchEventName-type.mdx deleted file mode 100644 index 97fc94899..000000000 --- a/docs/gen/TLPinchEventName-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLPinchEventName -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 165 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPinchEventName = 'pinch_end' | 'pinch_start' | 'pinch' -``` - diff --git a/docs/gen/TLPointerEvent-type.mdx b/docs/gen/TLPointerEvent-type.mdx deleted file mode 100644 index b54950ea3..000000000 --- a/docs/gen/TLPointerEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLPointerEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 166 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPointerEvent = (info: TLPointerEventInfo) => void -``` - -##### References - -[TLPointerEventInfo](/gen/editor/TLPointerEventInfo-type) - diff --git a/docs/gen/TLPointerEventInfo-type.mdx b/docs/gen/TLPointerEventInfo-type.mdx deleted file mode 100644 index 989a22a37..000000000 --- a/docs/gen/TLPointerEventInfo-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLPointerEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 167 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPointerEventInfo = TLBaseEventInfo & { - type: 'pointer' - name: TLPointerEventName - point: VecLike - pointerId: number - button: number - isPen: boolean -} & TLPointerEventTarget -``` - -##### References - -[TLBaseEventInfo](/gen/editor/TLBaseEventInfo-interface), [TLPointerEventName](/gen/editor/TLPointerEventName-type), [VecLike](/gen/primitives/VecLike-type), [TLPointerEventTarget](/gen/editor/TLPointerEventTarget-type) - diff --git a/docs/gen/TLPointerEventName-type.mdx b/docs/gen/TLPointerEventName-type.mdx deleted file mode 100644 index 424a7399f..000000000 --- a/docs/gen/TLPointerEventName-type.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TLPointerEventName -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 168 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPointerEventName = - | 'middle_click' - | 'pointer_down' - | 'pointer_enter' - | 'pointer_leave' - | 'pointer_move' - | 'pointer_up' - | 'right_click' -``` - diff --git a/docs/gen/TLPointerEventTarget-type.mdx b/docs/gen/TLPointerEventTarget-type.mdx deleted file mode 100644 index 0be23ded4..000000000 --- a/docs/gen/TLPointerEventTarget-type.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TLPointerEventTarget -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 169 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLPointerEventTarget = - | { - target: 'canvas' - shape?: undefined - } - | { - target: 'handle' - shape: TLShape - handle: TLHandle - } - | { - target: 'selection' - handle?: TLSelectionHandle - shape?: undefined - } - | { - target: 'shape' - shape: TLShape - } -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLHandle](/gen/tlschema/TLHandle-interface), [TLSelectionHandle](/gen/editor/TLSelectionHandle-type) - diff --git a/docs/gen/TLRecord-type.mdx b/docs/gen/TLRecord-type.mdx deleted file mode 100644 index 90c9ae947..000000000 --- a/docs/gen/TLRecord-type.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TLRecord -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 107 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLRecord = - | TLAsset - | TLCamera - | TLDocument - | TLInstance - | TLInstancePageState - | TLInstancePresence - | TLPage - | TLPointer - | TLShape -``` - -##### References - -[TLAsset](/gen/tlschema/TLAsset-type), [TLCamera](/gen/tlschema/TLCamera-interface), [TLDocument](/gen/tlschema/TLDocument-interface), [TLInstance](/gen/tlschema/TLInstance-interface), [TLInstancePageState](/gen/tlschema/TLInstancePageState-interface), [TLInstancePresence](/gen/tlschema/TLInstancePresence-interface), [TLPage](/gen/tlschema/TLPage-interface), [TLPointer](/gen/tlschema/~TLPointer-interface), [TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/TLResizeHandle-type.mdx b/docs/gen/TLResizeHandle-type.mdx deleted file mode 100644 index 4649e21f4..000000000 --- a/docs/gen/TLResizeHandle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLResizeHandle -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 170 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLResizeHandle = SelectionCorner | SelectionEdge -``` - -##### References - -[SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type) - diff --git a/docs/gen/TLResizeInfo-type.mdx b/docs/gen/TLResizeInfo-type.mdx deleted file mode 100644 index 38b7b4d27..000000000 --- a/docs/gen/TLResizeInfo-type.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: TLResizeInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 171 ----Public TypeAlias - -Info about a resize. - - -##### Parameters - - - - - - - -`newPoint` - - - - -The new local position of the shape. - - - - - - - - - -`handle` - - - - -The handle being dragged. - - - - - - - - - -`mode` - - - - -The type of resize. - - - - - - - - - -`scaleX` - - - - -The scale in the x-axis. - - - - - - - - - -`scaleY` - - - - -The scale in the y-axis. - - - - - - - - - -`initialBounds` - - - - -The bounds of the shape at the start of the resize. - - - - - - - - - -`initialShape` - - - - -The shape at the start of the resize. - - - - - - - - -##### Signature - - -```ts -type TLResizeInfo = { - newPoint: Vec2d - handle: TLResizeHandle - mode: TLResizeMode - scaleX: number - scaleY: number - initialBounds: Box2d - initialShape: T -} -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [Vec2d](/gen/primitives/Vec2d-class), [TLResizeHandle](/gen/editor/TLResizeHandle-type), [TLResizeMode](/gen/editor/TLResizeMode-type), [Box2d](/gen/primitives/Box2d-class) - diff --git a/docs/gen/TLResizeMode-type.mdx b/docs/gen/TLResizeMode-type.mdx deleted file mode 100644 index d6a11fa89..000000000 --- a/docs/gen/TLResizeMode-type.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TLResizeMode -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 172 ----Public TypeAlias - -The type of resize. - - -'scale_shape' - The shape is being scaled, usually as part of a larger selection. - - -'resize_bounds' - The user is directly manipulating an individual shape's bounds using a resize handle. It is up to shape util implementers to decide how they want to handle the two situations. - - -##### Signature - - -```ts -type TLResizeMode = 'resize_bounds' | 'scale_shape' -``` - diff --git a/docs/gen/TLSchema-type.mdx b/docs/gen/TLSchema-type.mdx deleted file mode 100644 index e4e9db020..000000000 --- a/docs/gen/TLSchema-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLSchema -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 108 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLSchema = StoreSchema -``` - -##### References - -[StoreSchema](/gen/store/StoreSchema-class), [TLRecord](/gen/tlschema/TLRecord-type), [TLStoreProps](/gen/tlschema/TLStoreProps-type) - diff --git a/docs/gen/TLScribble-type.mdx b/docs/gen/TLScribble-type.mdx deleted file mode 100644 index 006a833c3..000000000 --- a/docs/gen/TLScribble-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLScribble -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 109 ----Public TypeAlias - -A type for the scribble used by tldraw. - - -##### Signature - - -```ts -type TLScribble = { - points: Vec2dModel[] - size: number - color: TLCanvasUiColor - opacity: number - state: SetValue - delay: number -} -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface), [TLCanvasUiColor](/gen/tlschema/TLCanvasUiColor-type), [SetValue](/gen/tlschema/~SetValue-type), [TL_SCRIBBLE_STATES](/gen/tlschema/~TL_SCRIBBLE_STATES-var) - diff --git a/docs/gen/TLSelectionHandle-type.mdx b/docs/gen/TLSelectionHandle-type.mdx deleted file mode 100644 index 60f4c682b..000000000 --- a/docs/gen/TLSelectionHandle-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLSelectionHandle -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 173 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLSelectionHandle = RotateCorner | SelectionCorner | SelectionEdge -``` - -##### References - -[RotateCorner](/gen/primitives/RotateCorner-type), [SelectionCorner](/gen/primitives/SelectionCorner-type), [SelectionEdge](/gen/primitives/SelectionEdge-type) - diff --git a/docs/gen/TLSessionStateSnapshot-interface.mdx b/docs/gen/TLSessionStateSnapshot-interface.mdx deleted file mode 100644 index ecd39fcef..000000000 --- a/docs/gen/TLSessionStateSnapshot-interface.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: TLSessionStateSnapshot -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 174 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [currentPageId](#TLSessionStateSnapshot-currentPageId-member) - - [exportBackground](#TLSessionStateSnapshot-exportBackground-member) - - [isDebugMode](#TLSessionStateSnapshot-isDebugMode-member) - - [isFocusMode](#TLSessionStateSnapshot-isFocusMode-member) - - [isGridMode](#TLSessionStateSnapshot-isGridMode-member) - - [isToolLocked](#TLSessionStateSnapshot-isToolLocked-member) - - [pageStates](#TLSessionStateSnapshot-pageStates-member) - - [version](#TLSessionStateSnapshot-version-member) -
- -The state of the editor instance, not including any document state. - - -##### Signature - - -```ts -interface TLSessionStateSnapshot {} -``` - ---- - -## Properties - -### `currentPageId` \{#TLSessionStateSnapshot-currentPageId-member} - -Public PropertySignature - -##### Signature - - -```ts -currentPageId: TLPageId -``` - -##### References - -[TLPageId](/gen/tlschema/TLPageId-type) - ---- - -### `exportBackground` \{#TLSessionStateSnapshot-exportBackground-member} - -Public PropertySignature - -##### Signature - - -```ts -exportBackground: boolean -``` - ---- - -### `isDebugMode` \{#TLSessionStateSnapshot-isDebugMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isDebugMode: boolean -``` - ---- - -### `isFocusMode` \{#TLSessionStateSnapshot-isFocusMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isFocusMode: boolean -``` - ---- - -### `isGridMode` \{#TLSessionStateSnapshot-isGridMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isGridMode: boolean -``` - ---- - -### `isToolLocked` \{#TLSessionStateSnapshot-isToolLocked-member} - -Public PropertySignature - -##### Signature - - -```ts -isToolLocked: boolean -``` - ---- - -### `pageStates` \{#TLSessionStateSnapshot-pageStates-member} - -Public PropertySignature - -##### Signature - - -```ts -pageStates: Array<{ - pageId: TLPageId - camera: { - x: number - y: number - z: number - } - selectedIds: TLShapeId[] - focusLayerId: null | TLShapeId -}> -``` - -##### References - -[Array](/gen/Array-interface), [TLPageId](/gen/tlschema/TLPageId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `version` \{#TLSessionStateSnapshot-version-member} - -Public PropertySignature - -##### Signature - - -```ts -version: number -``` - ---- - diff --git a/docs/gen/TLShape-type.mdx b/docs/gen/TLShape-type.mdx deleted file mode 100644 index be0d21ecd..000000000 --- a/docs/gen/TLShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 110 ----Public TypeAlias - -The set of all shapes that are available in the editor, including unknown shapes. - - -##### Signature - - -```ts -type TLShape = TLDefaultShape | TLUnknownShape -``` - -##### References - -[TLDefaultShape](/gen/tlschema/TLDefaultShape-type), [TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - diff --git a/docs/gen/TLShapeId-type.mdx b/docs/gen/TLShapeId-type.mdx deleted file mode 100644 index 06f9f7336..000000000 --- a/docs/gen/TLShapeId-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLShapeId -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 111 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapeId = RecordId -``` - -##### References - -[RecordId](/gen/store/RecordId-type), [TLUnknownShape](/gen/tlschema/TLUnknownShape-type) - diff --git a/docs/gen/TLShapeInfo-type.mdx b/docs/gen/TLShapeInfo-type.mdx deleted file mode 100644 index 56574ba29..000000000 --- a/docs/gen/TLShapeInfo-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLShapeInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 175 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapeInfo = { - type: T['type'] - util: TLShapeUtilConstructor - props?: ShapeProps - migrations?: Migrations - tool?: TLStateNodeConstructor -} -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [TLShapeUtilConstructor](/gen/editor/TLShapeUtilConstructor-interface), [ShapeProps](/gen/tlschema/ShapeProps-type), [Migrations](/gen/store/Migrations-interface), [TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface) - diff --git a/docs/gen/TLShapePartial-type.mdx b/docs/gen/TLShapePartial-type.mdx deleted file mode 100644 index 16a451f15..000000000 --- a/docs/gen/TLShapePartial-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TLShapePartial -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 112 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapePartial = T extends T - ? { - id: TLShapeId - type: T['type'] - props?: Partial - } & Partial> - : never -``` - -##### References - -[TLShape](/gen/tlschema/TLShape-type), [TLShapeId](/gen/tlschema/TLShapeId-type), [Partial](/gen/Partial-type), [Omit](/gen/Omit-type) - diff --git a/docs/gen/TLShapeProp-type.mdx b/docs/gen/TLShapeProp-type.mdx deleted file mode 100644 index a08eb61ce..000000000 --- a/docs/gen/TLShapeProp-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLShapeProp -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 113 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapeProp = keyof TLShapeProps -``` - -##### References - -[TLShapeProps](/gen/tlschema/TLShapeProps-type) - diff --git a/docs/gen/TLShapeProps-type.mdx b/docs/gen/TLShapeProps-type.mdx deleted file mode 100644 index 150a7d233..000000000 --- a/docs/gen/TLShapeProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLShapeProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 114 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapeProps = Identity> -``` - -##### References - -[Identity](/gen/tlschema/~Identity-type), [UnionToIntersection](/gen/tlschema/~UnionToIntersection-type), [TLDefaultShape](/gen/tlschema/TLDefaultShape-type) - diff --git a/docs/gen/TLShapeUtilConstructor-interface.mdx b/docs/gen/TLShapeUtilConstructor-interface.mdx deleted file mode 100644 index dd849ace5..000000000 --- a/docs/gen/TLShapeUtilConstructor-interface.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: TLShapeUtilConstructor -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 176 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [type](#TLShapeUtilConstructor-type-member) -
- - - - -##### Signature - - -```ts -interface TLShapeUtilConstructor< - T extends TLUnknownShape, - U extends ShapeUtil = ShapeUtil -> {} -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [ShapeUtil](/gen/editor/ShapeUtil-class) - ---- - -### `(new)` \{#TLShapeUtilConstructor-new-1} - -Public ConstructSignature - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - - -`type` - - - - -```ts -T['type'] -``` - - - - - - - - -`styleProps` - - - - -```ts -ReadonlyMap, string> -``` - - - - - - - -##### Returns - - -```ts -U -``` - -##### References - -[Editor](/gen/editor/Editor-class), [ReadonlyMap](/gen/ReadonlyMap-interface), [StyleProp](/gen/tlschema/StyleProp-class) - ---- - -## Properties - -### `type` \{#TLShapeUtilConstructor-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: T['type'] -``` - ---- - diff --git a/docs/gen/TLShapeUtilFlag-type.mdx b/docs/gen/TLShapeUtilFlag-type.mdx deleted file mode 100644 index 6282eb75b..000000000 --- a/docs/gen/TLShapeUtilFlag-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLShapeUtilFlag -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 177 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLShapeUtilFlag = (shape: T) => boolean -``` - diff --git a/docs/gen/TLStateNodeConstructor-interface.mdx b/docs/gen/TLStateNodeConstructor-interface.mdx deleted file mode 100644 index ea8b65384..000000000 --- a/docs/gen/TLStateNodeConstructor-interface.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: TLStateNodeConstructor -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 178 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [children](#TLStateNodeConstructor-children-member) - - [id](#TLStateNodeConstructor-id-member) - - [initial](#TLStateNodeConstructor-initial-member) -
- - - - -##### Signature - - -```ts -interface TLStateNodeConstructor {} -``` - ---- - -### `(new)` \{#TLStateNodeConstructor-new-1} - -Public ConstructSignature - -##### Parameters - - - - - - - -`editor` - - - - -```ts -Editor -``` - - - - - - - - -`parent` - - (optional) - - - - -```ts -StateNode -``` - - - - - - - -##### Returns - - -```ts -StateNode -``` - -##### References - -[Editor](/gen/editor/Editor-class), [StateNode](/gen/editor/StateNode-class) - ---- - -## Properties - -### `children` \{#TLStateNodeConstructor-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children?: () => TLStateNodeConstructor[] -``` - -##### References - -[TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface) - ---- - -### `id` \{#TLStateNodeConstructor-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `initial` \{#TLStateNodeConstructor-initial-member} - -Public PropertySignature - -##### Signature - - -```ts -initial?: string -``` - ---- - diff --git a/docs/gen/TLStore-type.mdx b/docs/gen/TLStore-type.mdx deleted file mode 100644 index 891c0e83b..000000000 --- a/docs/gen/TLStore-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLStore -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 115 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStore = Store -``` - -##### References - -[Store](/gen/store/Store-class), [TLRecord](/gen/tlschema/TLRecord-type), [TLStoreProps](/gen/tlschema/TLStoreProps-type) - diff --git a/docs/gen/TLStoreEventInfo-type.mdx b/docs/gen/TLStoreEventInfo-type.mdx deleted file mode 100644 index e05ea5102..000000000 --- a/docs/gen/TLStoreEventInfo-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLStoreEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 179 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreEventInfo = HistoryEntry -``` - -##### References - -[HistoryEntry](/gen/store/HistoryEntry-type), [TLRecord](/gen/tlschema/TLRecord-type) - diff --git a/docs/gen/TLStoreOptions-type.mdx b/docs/gen/TLStoreOptions-type.mdx deleted file mode 100644 index 2a8a7512c..000000000 --- a/docs/gen/TLStoreOptions-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TLStoreOptions -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 180 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreOptions = { - initialData?: StoreSnapshot - defaultName?: string -} & ( - | { - schema: StoreSchema - } - | { - shapes: readonly AnyTLShapeInfo[] - } -) -``` - -##### References - -[StoreSnapshot](/gen/store/StoreSnapshot-type), [TLRecord](/gen/tlschema/TLRecord-type), [StoreSchema](/gen/store/StoreSchema-class), [TLStoreProps](/gen/tlschema/TLStoreProps-type), [AnyTLShapeInfo](/gen/editor/~AnyTLShapeInfo-type) - diff --git a/docs/gen/TLStoreProps-type.mdx b/docs/gen/TLStoreProps-type.mdx deleted file mode 100644 index c19c99918..000000000 --- a/docs/gen/TLStoreProps-type.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: TLStoreProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 116 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreProps = { - defaultName: string -} -``` - diff --git a/docs/gen/TLStoreSchema-type.mdx b/docs/gen/TLStoreSchema-type.mdx deleted file mode 100644 index 32ba9bc5a..000000000 --- a/docs/gen/TLStoreSchema-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLStoreSchema -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 117 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreSchema = StoreSchema -``` - -##### References - -[StoreSchema](/gen/store/StoreSchema-class), [TLRecord](/gen/tlschema/TLRecord-type), [TLStoreProps](/gen/tlschema/TLStoreProps-type) - diff --git a/docs/gen/TLStoreSnapshot-type.mdx b/docs/gen/TLStoreSnapshot-type.mdx deleted file mode 100644 index 3e2eaee2a..000000000 --- a/docs/gen/TLStoreSnapshot-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLStoreSnapshot -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 118 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreSnapshot = StoreSnapshot -``` - -##### References - -[StoreSnapshot](/gen/store/StoreSnapshot-type), [TLRecord](/gen/tlschema/TLRecord-type) - diff --git a/docs/gen/TLStoreWithStatus-type.mdx b/docs/gen/TLStoreWithStatus-type.mdx deleted file mode 100644 index ec48fee18..000000000 --- a/docs/gen/TLStoreWithStatus-type.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: TLStoreWithStatus -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 181 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLStoreWithStatus = - | { - readonly status: 'error' - readonly store?: undefined - readonly error: Error - } - | { - readonly status: 'loading' - readonly store?: undefined - readonly error?: undefined - } - | { - readonly status: 'not-synced' - readonly store: TLStore - readonly error?: undefined - } - | { - readonly status: 'synced-local' - readonly store: TLStore - readonly error?: undefined - } - | { - readonly status: 'synced-remote' - readonly connectionStatus: 'offline' | 'online' - readonly store: TLStore - readonly error?: undefined - } -``` - -##### References - -[Error](/gen/Error-interface), [TLStore](/gen/tlschema/TLStore-type) - diff --git a/docs/gen/TLTextShape-type.mdx b/docs/gen/TLTextShape-type.mdx deleted file mode 100644 index d374aff05..000000000 --- a/docs/gen/TLTextShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLTextShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 119 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLTextShape = TLBaseShape<'text', TLTextShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLTextShapeProps](/gen/tlschema/TLTextShapeProps-type) - diff --git a/docs/gen/TLTextShapeProps-type.mdx b/docs/gen/TLTextShapeProps-type.mdx deleted file mode 100644 index 808a95e96..000000000 --- a/docs/gen/TLTextShapeProps-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLTextShapeProps -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 120 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLTextShapeProps = ShapePropsType -``` - -##### References - -[ShapePropsType](/gen/tlschema/~ShapePropsType-type), [textShapeProps](/gen/tlschema/textShapeProps-var) - diff --git a/docs/gen/TLTickEvent-type.mdx b/docs/gen/TLTickEvent-type.mdx deleted file mode 100644 index 7e5caa419..000000000 --- a/docs/gen/TLTickEvent-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: TLTickEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 182 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLTickEvent = (elapsed: number) => void -``` - diff --git a/docs/gen/TLUiActionItem-interface.mdx b/docs/gen/TLUiActionItem-interface.mdx deleted file mode 100644 index e68c65cd0..000000000 --- a/docs/gen/TLUiActionItem-interface.mdx +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: TLUiActionItem -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 17 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [checkbox](#TLUiActionItem-checkbox-member) - - [contextMenuLabel](#TLUiActionItem-contextMenuLabel-member) - - [icon](#TLUiActionItem-icon-member) - - [id](#TLUiActionItem-id-member) - - [kbd](#TLUiActionItem-kbd-member) - - [label](#TLUiActionItem-label-member) - - [menuLabel](#TLUiActionItem-menuLabel-member) - - [onSelect](#TLUiActionItem-onSelect-member) - - [readonlyOk](#TLUiActionItem-readonlyOk-member) - - [shortcutsLabel](#TLUiActionItem-shortcutsLabel-member) - - [title](#TLUiActionItem-title-member) -
- - - - -##### Signature - - -```ts -interface TLUiActionItem {} -``` - ---- - -## Properties - -### `checkbox` \{#TLUiActionItem-checkbox-member} - -Public PropertySignature - -##### Signature - - -```ts -checkbox?: boolean -``` - ---- - -### `contextMenuLabel` \{#TLUiActionItem-contextMenuLabel-member} - -Public PropertySignature - -##### Signature - - -```ts -contextMenuLabel?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `icon` \{#TLUiActionItem-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon?: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `id` \{#TLUiActionItem-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `kbd` \{#TLUiActionItem-kbd-member} - -Public PropertySignature - -##### Signature - - -```ts -kbd?: string -``` - ---- - -### `label` \{#TLUiActionItem-label-member} - -Public PropertySignature - -##### Signature - - -```ts -label?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `menuLabel` \{#TLUiActionItem-menuLabel-member} - -Public PropertySignature - -##### Signature - - -```ts -menuLabel?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `onSelect` \{#TLUiActionItem-onSelect-member} - -Public PropertySignature - -##### Signature - - -```ts -onSelect: (source: TLUiEventSource) => Promise | void -``` - -##### References - -[TLUiEventSource](/gen/ui/TLUiEventSource-type), [Promise](/gen/Promise-interface) - ---- - -### `readonlyOk` \{#TLUiActionItem-readonlyOk-member} - -Public PropertySignature - -##### Signature - - -```ts -readonlyOk: boolean -``` - ---- - -### `shortcutsLabel` \{#TLUiActionItem-shortcutsLabel-member} - -Public PropertySignature - -##### Signature - - -```ts -shortcutsLabel?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `title` \{#TLUiActionItem-title-member} - -Public PropertySignature - -##### Signature - - -```ts -title?: string -``` - ---- - diff --git a/docs/gen/TLUiActionsContextType-type.mdx b/docs/gen/TLUiActionsContextType-type.mdx deleted file mode 100644 index e8acc410b..000000000 --- a/docs/gen/TLUiActionsContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiActionsContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 18 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiActionsContextType = Record -``` - -##### References - -[Record](/gen/Record-type), [TLUiActionItem](/gen/ui/TLUiActionItem-interface) - diff --git a/docs/gen/TLUiActionsMenuSchemaContextType-type.mdx b/docs/gen/TLUiActionsMenuSchemaContextType-type.mdx deleted file mode 100644 index 98b8519f6..000000000 --- a/docs/gen/TLUiActionsMenuSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiActionsMenuSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 19 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiActionsMenuSchemaContextType = TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/TLUiButtonProps-interface.mdx b/docs/gen/TLUiButtonProps-interface.mdx deleted file mode 100644 index 678b2661f..000000000 --- a/docs/gen/TLUiButtonProps-interface.mdx +++ /dev/null @@ -1,199 +0,0 @@ ---- -title: TLUiButtonProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 20 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [disabled](#TLUiButtonProps-disabled-member) - - [icon](#TLUiButtonProps-icon-member) - - [iconLeft](#TLUiButtonProps-iconLeft-member) - - [invertIcon](#TLUiButtonProps-invertIcon-member) - - [isChecked](#TLUiButtonProps-isChecked-member) - - [kbd](#TLUiButtonProps-kbd-member) - - [label](#TLUiButtonProps-label-member) - - [loading](#TLUiButtonProps-loading-member) - - [smallIcon](#TLUiButtonProps-smallIcon-member) - - [spinner](#TLUiButtonProps-spinner-member) - - [type](#TLUiButtonProps-type-member) -
- - - - -##### Signature - - -```ts -interface TLUiButtonProps extends React.HTMLAttributes {} -``` - -##### References - -[React.HTMLAttributes](/gen/@types/react-React-HTMLAttributes-interface), [HTMLButtonElement](/gen/HTMLButtonElement-interface) - ---- - -## Properties - -### `disabled` \{#TLUiButtonProps-disabled-member} - -Public PropertySignature - -##### Signature - - -```ts -disabled?: boolean -``` - ---- - -### `icon` \{#TLUiButtonProps-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon?: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `iconLeft` \{#TLUiButtonProps-iconLeft-member} - -Public PropertySignature - -##### Signature - - -```ts -iconLeft?: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `invertIcon` \{#TLUiButtonProps-invertIcon-member} - -Public PropertySignature - -##### Signature - - -```ts -invertIcon?: boolean -``` - ---- - -### `isChecked` \{#TLUiButtonProps-isChecked-member} - -Public PropertySignature - -##### Signature - - -```ts -isChecked?: boolean -``` - ---- - -### `kbd` \{#TLUiButtonProps-kbd-member} - -Public PropertySignature - -##### Signature - - -```ts -kbd?: string -``` - ---- - -### `label` \{#TLUiButtonProps-label-member} - -Public PropertySignature - -##### Signature - - -```ts -label?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `loading` \{#TLUiButtonProps-loading-member} - -Public PropertySignature - -##### Signature - - -```ts -loading?: boolean -``` - ---- - -### `smallIcon` \{#TLUiButtonProps-smallIcon-member} - -Public PropertySignature - -##### Signature - - -```ts -smallIcon?: boolean -``` - ---- - -### `spinner` \{#TLUiButtonProps-spinner-member} - -Public PropertySignature - -##### Signature - - -```ts -spinner?: boolean -``` - ---- - -### `type` \{#TLUiButtonProps-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type?: 'danger' | 'normal' | 'primary' -``` - ---- - diff --git a/docs/gen/TLUiContextMenuProps-interface.mdx b/docs/gen/TLUiContextMenuProps-interface.mdx deleted file mode 100644 index 63999599d..000000000 --- a/docs/gen/TLUiContextMenuProps-interface.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TLUiContextMenuProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 21 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [children](#TLUiContextMenuProps-children-member) -
- - - - -##### Signature - - -```ts -interface TLUiContextMenuProps {} -``` - ---- - -## Properties - -### `children` \{#TLUiContextMenuProps-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children: any -``` - ---- - diff --git a/docs/gen/TLUiContextTTLUiMenuSchemaContextType-type.mdx b/docs/gen/TLUiContextTTLUiMenuSchemaContextType-type.mdx deleted file mode 100644 index 1f6b30a0f..000000000 --- a/docs/gen/TLUiContextTTLUiMenuSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiContextTTLUiMenuSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 22 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiContextTTLUiMenuSchemaContextType = TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/TLUiCustomMenuItem-type.mdx b/docs/gen/TLUiCustomMenuItem-type.mdx deleted file mode 100644 index 540217248..000000000 --- a/docs/gen/TLUiCustomMenuItem-type.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: TLUiCustomMenuItem -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 23 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiCustomMenuItem = { - id: string - type: 'custom' - disabled: boolean - readonlyOk: boolean -} -``` - diff --git a/docs/gen/TLUiDialog-interface.mdx b/docs/gen/TLUiDialog-interface.mdx deleted file mode 100644 index 37cd04726..000000000 --- a/docs/gen/TLUiDialog-interface.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: TLUiDialog -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 24 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [component](#TLUiDialog-component-member) - - [id](#TLUiDialog-id-member) - - [onClose](#TLUiDialog-onClose-member) -
- - - - -##### Signature - - -```ts -interface TLUiDialog {} -``` - ---- - -## Properties - -### `component` \{#TLUiDialog-component-member} - -Public PropertySignature - -##### Signature - - -```ts -component: (props: TLUiDialogProps) => any -``` - -##### References - -[TLUiDialogProps](/gen/ui/TLUiDialogProps-interface) - ---- - -### `id` \{#TLUiDialog-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `onClose` \{#TLUiDialog-onClose-member} - -Public PropertySignature - -##### Signature - - -```ts -onClose?: () => void -``` - ---- - diff --git a/docs/gen/TLUiDialogProps-interface.mdx b/docs/gen/TLUiDialogProps-interface.mdx deleted file mode 100644 index 20453c4b0..000000000 --- a/docs/gen/TLUiDialogProps-interface.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TLUiDialogProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 25 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [onClose](#TLUiDialogProps-onClose-member) -
- - - - -##### Signature - - -```ts -interface TLUiDialogProps {} -``` - ---- - -## Properties - -### `onClose` \{#TLUiDialogProps-onClose-member} - -Public PropertySignature - -##### Signature - - -```ts -onClose: () => void -``` - ---- - diff --git a/docs/gen/TLUiDialogsContextType-type.mdx b/docs/gen/TLUiDialogsContextType-type.mdx deleted file mode 100644 index 0e880a33f..000000000 --- a/docs/gen/TLUiDialogsContextType-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TLUiDialogsContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 26 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiDialogsContextType = { - addDialog: ( - dialog: Omit & { - id?: string - } - ) => string - removeDialog: (id: string) => string - updateDialog: (id: string, newDialogData: Partial) => string - clearDialogs: () => void - dialogs: TLUiDialog[] -} -``` - -##### References - -[Omit](/gen/Omit-type), [TLUiDialog](/gen/ui/TLUiDialog-interface), [Partial](/gen/Partial-type) - diff --git a/docs/gen/TLUiEventContextType-type.mdx b/docs/gen/TLUiEventContextType-type.mdx deleted file mode 100644 index ec987e176..000000000 --- a/docs/gen/TLUiEventContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiEventContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 27 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiEventContextType = TLUiEventHandler -``` - -##### References - -[TLUiEventHandler](/gen/ui/TLUiEventHandler-type), [TLUiEventMap](/gen/ui/~TLUiEventMap-interface) - diff --git a/docs/gen/TLUiEventHandler-type.mdx b/docs/gen/TLUiEventHandler-type.mdx deleted file mode 100644 index 37813e2cc..000000000 --- a/docs/gen/TLUiEventHandler-type.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TLUiEventHandler -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 28 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiEventHandler = ( - name: T, - data: Join< - { - source: TLUiEventSource - }, - TLUiEventMap[T] - > -) => void -``` - -##### References - -[TLUiEventMap](/gen/ui/~TLUiEventMap-interface), [Join](/gen/ui/~Join-type), [TLUiEventSource](/gen/ui/TLUiEventSource-type) - diff --git a/docs/gen/TLUiEventSource-type.mdx b/docs/gen/TLUiEventSource-type.mdx deleted file mode 100644 index e32e415da..000000000 --- a/docs/gen/TLUiEventSource-type.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TLUiEventSource -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 29 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiEventSource = - | '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' -``` - diff --git a/docs/gen/TLUiHelpMenuSchemaContextType-type.mdx b/docs/gen/TLUiHelpMenuSchemaContextType-type.mdx deleted file mode 100644 index 9c40ef04e..000000000 --- a/docs/gen/TLUiHelpMenuSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiHelpMenuSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 30 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiHelpMenuSchemaContextType = TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/TLUiIconProps-interface.mdx b/docs/gen/TLUiIconProps-interface.mdx deleted file mode 100644 index 842ad616a..000000000 --- a/docs/gen/TLUiIconProps-interface.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: TLUiIconProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 31 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [children](#TLUiIconProps-children-member) - - [color](#TLUiIconProps-color-member) - - [crossOrigin](#TLUiIconProps-crossOrigin-member) - - [icon](#TLUiIconProps-icon-member) - - [invertIcon](#TLUiIconProps-invertIcon-member) - - [small](#TLUiIconProps-small-member) -
- - - - -##### Signature - - -```ts -interface TLUiIconProps extends React.HTMLProps {} -``` - -##### References - -[React.HTMLProps](/gen/@types/react-React-HTMLProps-interface), [HTMLDivElement](/gen/HTMLDivElement-interface) - ---- - -## Properties - -### `children` \{#TLUiIconProps-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children?: undefined -``` - ---- - -### `color` \{#TLUiIconProps-color-member} - -Public PropertySignature - -##### Signature - - -```ts -color?: string -``` - ---- - -### `crossOrigin` \{#TLUiIconProps-crossOrigin-member} - -Public PropertySignature - -##### Signature - - -```ts -crossOrigin?: 'anonymous' | 'use-credentials' -``` - ---- - -### `icon` \{#TLUiIconProps-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `invertIcon` \{#TLUiIconProps-invertIcon-member} - -Public PropertySignature - -##### Signature - - -```ts -invertIcon?: boolean -``` - ---- - -### `small` \{#TLUiIconProps-small-member} - -Public PropertySignature - -##### Signature - - -```ts -small?: boolean -``` - ---- - diff --git a/docs/gen/TLUiIconType-type.mdx b/docs/gen/TLUiIconType-type.mdx deleted file mode 100644 index 35069ee91..000000000 --- a/docs/gen/TLUiIconType-type.mdx +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: TLUiIconType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 32 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiIconType = - | '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-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' - | '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' -``` - diff --git a/docs/gen/TLUiInputProps-interface.mdx b/docs/gen/TLUiInputProps-interface.mdx deleted file mode 100644 index 2b12e2ce6..000000000 --- a/docs/gen/TLUiInputProps-interface.mdx +++ /dev/null @@ -1,268 +0,0 @@ ---- -title: TLUiInputProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 33 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [autofocus](#TLUiInputProps-autofocus-member) - - [autoselect](#TLUiInputProps-autoselect-member) - - [children](#TLUiInputProps-children-member) - - [className](#TLUiInputProps-className-member) - - [defaultValue](#TLUiInputProps-defaultValue-member) - - [disabled](#TLUiInputProps-disabled-member) - - [icon](#TLUiInputProps-icon-member) - - [iconLeft](#TLUiInputProps-iconLeft-member) - - [label](#TLUiInputProps-label-member) - - [onBlur](#TLUiInputProps-onBlur-member) - - [onCancel](#TLUiInputProps-onCancel-member) - - [onComplete](#TLUiInputProps-onComplete-member) - - [onValueChange](#TLUiInputProps-onValueChange-member) - - [placeholder](#TLUiInputProps-placeholder-member) - - [shouldManuallyMaintainScrollPositionWhenFocused](#TLUiInputProps-shouldManuallyMaintainScrollPositionWhenFocused-member) - - [value](#TLUiInputProps-value-member) -
- - - - -##### Signature - - -```ts -interface TLUiInputProps {} -``` - ---- - -## Properties - -### `autofocus` \{#TLUiInputProps-autofocus-member} - -Public PropertySignature - -##### Signature - - -```ts -autofocus?: boolean -``` - ---- - -### `autoselect` \{#TLUiInputProps-autoselect-member} - -Public PropertySignature - -##### Signature - - -```ts -autoselect?: boolean -``` - ---- - -### `children` \{#TLUiInputProps-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children?: any -``` - ---- - -### `className` \{#TLUiInputProps-className-member} - -Public PropertySignature - -##### Signature - - -```ts -className?: string -``` - ---- - -### `defaultValue` \{#TLUiInputProps-defaultValue-member} - -Public PropertySignature - -##### Signature - - -```ts -defaultValue?: string -``` - ---- - -### `disabled` \{#TLUiInputProps-disabled-member} - -Public PropertySignature - -##### Signature - - -```ts -disabled?: boolean -``` - ---- - -### `icon` \{#TLUiInputProps-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon?: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `iconLeft` \{#TLUiInputProps-iconLeft-member} - -Public PropertySignature - -##### Signature - - -```ts -iconLeft?: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `label` \{#TLUiInputProps-label-member} - -Public PropertySignature - -##### Signature - - -```ts -label?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `onBlur` \{#TLUiInputProps-onBlur-member} - -Public PropertySignature - -##### Signature - - -```ts -onBlur?: (value: string) => void -``` - ---- - -### `onCancel` \{#TLUiInputProps-onCancel-member} - -Public PropertySignature - -##### Signature - - -```ts -onCancel?: (value: string) => void -``` - ---- - -### `onComplete` \{#TLUiInputProps-onComplete-member} - -Public PropertySignature - -##### Signature - - -```ts -onComplete?: (value: string) => void -``` - ---- - -### `onValueChange` \{#TLUiInputProps-onValueChange-member} - -Public PropertySignature - -##### Signature - - -```ts -onValueChange?: (value: string) => void -``` - ---- - -### `placeholder` \{#TLUiInputProps-placeholder-member} - -Public PropertySignature - -##### Signature - - -```ts -placeholder?: string -``` - ---- - -### `shouldManuallyMaintainScrollPositionWhenFocused` \{#TLUiInputProps-shouldManuallyMaintainScrollPositionWhenFocused-member} - -Public PropertySignature - -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. - - -##### Signature - - -```ts -shouldManuallyMaintainScrollPositionWhenFocused?: boolean -``` - ---- - -### `value` \{#TLUiInputProps-value-member} - -Public PropertySignature - -##### Signature - - -```ts -value?: string -``` - ---- - diff --git a/docs/gen/TLUiKeyboardShortcutsSchemaContextType-type.mdx b/docs/gen/TLUiKeyboardShortcutsSchemaContextType-type.mdx deleted file mode 100644 index 358d97031..000000000 --- a/docs/gen/TLUiKeyboardShortcutsSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiKeyboardShortcutsSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 34 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiKeyboardShortcutsSchemaContextType = TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/TLUiKeyboardShortcutsSchemaProviderProps-type.mdx b/docs/gen/TLUiKeyboardShortcutsSchemaProviderProps-type.mdx deleted file mode 100644 index 428f064d9..000000000 --- a/docs/gen/TLUiKeyboardShortcutsSchemaProviderProps-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TLUiKeyboardShortcutsSchemaProviderProps -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 35 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiKeyboardShortcutsSchemaProviderProps = { - overrides?: ( - editor: Editor, - schema: TLUiKeyboardShortcutsSchemaContextType, - more: { - tools: TLUiToolsContextType - actions: TLUiActionsContextType - } - ) => TLUiKeyboardShortcutsSchemaContextType - children: any -} -``` - -##### References - -[Editor](/gen/editor/Editor-class), [TLUiKeyboardShortcutsSchemaContextType](/gen/ui/TLUiKeyboardShortcutsSchemaContextType-type), [TLUiToolsContextType](/gen/ui/TLUiToolsContextType-type), [TLUiActionsContextType](/gen/ui/TLUiActionsContextType-type) - diff --git a/docs/gen/TLUiMenuChild-type.mdx b/docs/gen/TLUiMenuChild-type.mdx deleted file mode 100644 index 46910caf6..000000000 --- a/docs/gen/TLUiMenuChild-type.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: TLUiMenuChild -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 36 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuChild = - | TLUiCustomMenuItem - | TLUiMenuGroup - | TLUiMenuItem - | TLUiSubMenu -``` - -##### References - -[TLUiCustomMenuItem](/gen/ui/TLUiCustomMenuItem-type), [TLUiMenuGroup](/gen/ui/TLUiMenuGroup-type), [TLUiMenuItem](/gen/ui/TLUiMenuItem-type), [TLUiSubMenu](/gen/ui/TLUiSubMenu-type) - diff --git a/docs/gen/TLUiMenuGroup-type.mdx b/docs/gen/TLUiMenuGroup-type.mdx deleted file mode 100644 index d7e0d3a8d..000000000 --- a/docs/gen/TLUiMenuGroup-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLUiMenuGroup -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 37 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuGroup = { - id: string - type: 'group' - checkbox: boolean - disabled: boolean - readonlyOk: boolean - children: TLUiMenuChild[] -} -``` - -##### References - -[TLUiMenuChild](/gen/ui/TLUiMenuChild-type) - diff --git a/docs/gen/TLUiMenuItem-type.mdx b/docs/gen/TLUiMenuItem-type.mdx deleted file mode 100644 index d8f2f5010..000000000 --- a/docs/gen/TLUiMenuItem-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLUiMenuItem -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 38 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuItem = { - id: string - type: 'item' - readonlyOk: boolean - actionItem: TLUiActionItem - disabled: boolean - checked: boolean -} -``` - -##### References - -[TLUiActionItem](/gen/ui/TLUiActionItem-interface) - diff --git a/docs/gen/TLUiMenuSchema-type.mdx b/docs/gen/TLUiMenuSchema-type.mdx deleted file mode 100644 index 15c5dd532..000000000 --- a/docs/gen/TLUiMenuSchema-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiMenuSchema -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 39 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuSchema = (TLUiCustomMenuItem | TLUiMenuGroup | TLUiMenuItem)[] -``` - -##### References - -[TLUiCustomMenuItem](/gen/ui/TLUiCustomMenuItem-type), [TLUiMenuGroup](/gen/ui/TLUiMenuGroup-type), [TLUiMenuItem](/gen/ui/TLUiMenuItem-type) - diff --git a/docs/gen/TLUiMenuSchemaContextType-type.mdx b/docs/gen/TLUiMenuSchemaContextType-type.mdx deleted file mode 100644 index 1b70eb711..000000000 --- a/docs/gen/TLUiMenuSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiMenuSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 40 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuSchemaContextType = TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/TLUiMenuSchemaProviderProps-type.mdx b/docs/gen/TLUiMenuSchemaProviderProps-type.mdx deleted file mode 100644 index 8d0c4676a..000000000 --- a/docs/gen/TLUiMenuSchemaProviderProps-type.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TLUiMenuSchemaProviderProps -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 41 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiMenuSchemaProviderProps = { - overrides?: ( - editor: Editor, - schema: TLUiMenuSchemaContextType, - helpers: { - actions: ReturnType - noneSelected: boolean - oneSelected: boolean - twoSelected: boolean - threeSelected: boolean - } - ) => TLUiMenuSchemaContextType - children: any -} -``` - -##### References - -[Editor](/gen/editor/Editor-class), [TLUiMenuSchemaContextType](/gen/ui/TLUiMenuSchemaContextType-type), [ReturnType](/gen/ReturnType-type), [useActions](/gen/ui/useActions-function) - diff --git a/docs/gen/TLUiOverrides-interface.mdx b/docs/gen/TLUiOverrides-interface.mdx deleted file mode 100644 index 79112f920..000000000 --- a/docs/gen/TLUiOverrides-interface.mdx +++ /dev/null @@ -1,203 +0,0 @@ ---- -title: TLUiOverrides -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 42 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [actions](#TLUiOverrides-actions-member) - - [actionsMenu](#TLUiOverrides-actionsMenu-member) - - [contextMenu](#TLUiOverrides-contextMenu-member) - - [helpMenu](#TLUiOverrides-helpMenu-member) - - [keyboardShortcutsMenu](#TLUiOverrides-keyboardShortcutsMenu-member) - - [menu](#TLUiOverrides-menu-member) - - [toolbar](#TLUiOverrides-toolbar-member) - - [tools](#TLUiOverrides-tools-member) - - [translations](#TLUiOverrides-translations-member) -
- - - - -##### Signature - - -```ts -interface TLUiOverrides {} -``` - ---- - -## Properties - -### `actions` \{#TLUiOverrides-actions-member} - -Public PropertySignature - -##### Signature - - -```ts -actions?: WithDefaultHelpers> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [ActionsProviderProps](/gen/ui/~ActionsProviderProps-type) - ---- - -### `actionsMenu` \{#TLUiOverrides-actionsMenu-member} - -Public PropertySignature - -##### Signature - - -```ts -actionsMenu?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [ActionsMenuSchemaProviderProps](/gen/ui/~ActionsMenuSchemaProviderProps-type) - ---- - -### `contextMenu` \{#TLUiOverrides-contextMenu-member} - -Public PropertySignature - -##### Signature - - -```ts -contextMenu?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiContextMenuSchemaProviderProps](/gen/ui/~TLUiContextMenuSchemaProviderProps-type) - ---- - -### `helpMenu` \{#TLUiOverrides-helpMenu-member} - -Public PropertySignature - -##### Signature - - -```ts -helpMenu?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiHelpMenuSchemaProviderProps](/gen/ui/~TLUiHelpMenuSchemaProviderProps-type) - ---- - -### `keyboardShortcutsMenu` \{#TLUiOverrides-keyboardShortcutsMenu-member} - -Public PropertySignature - -##### Signature - - -```ts -keyboardShortcutsMenu?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiKeyboardShortcutsSchemaProviderProps](/gen/ui/TLUiKeyboardShortcutsSchemaProviderProps-type) - ---- - -### `menu` \{#TLUiOverrides-menu-member} - -Public PropertySignature - -##### Signature - - -```ts -menu?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiMenuSchemaProviderProps](/gen/ui/TLUiMenuSchemaProviderProps-type) - ---- - -### `toolbar` \{#TLUiOverrides-toolbar-member} - -Public PropertySignature - -##### Signature - - -```ts -toolbar?: WithDefaultHelpers< - NonNullable -> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiToolbarSchemaProviderProps](/gen/ui/~TLUiToolbarSchemaProviderProps-type) - ---- - -### `tools` \{#TLUiOverrides-tools-member} - -Public PropertySignature - -##### Signature - - -```ts -tools?: WithDefaultHelpers> -``` - -##### References - -[WithDefaultHelpers](/gen/ui/~WithDefaultHelpers-type), [NonNullable](/gen/NonNullable-type), [TLUiToolsProviderProps](/gen/ui/TLUiToolsProviderProps-type) - ---- - -### `translations` \{#TLUiOverrides-translations-member} - -Public PropertySignature - -##### Signature - - -```ts -translations?: TLUiTranslationProviderProps['overrides'] -``` - -##### References - -[TLUiTranslationProviderProps](/gen/ui/~TLUiTranslationProviderProps-interface) - ---- - diff --git a/docs/gen/TLUiSubMenu-type.mdx b/docs/gen/TLUiSubMenu-type.mdx deleted file mode 100644 index 08ab5ff22..000000000 --- a/docs/gen/TLUiSubMenu-type.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TLUiSubMenu -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 43 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiSubMenu = { - id: string - type: 'submenu' - label: TLUiTranslationKey - disabled: boolean - readonlyOk: boolean - children: TLUiMenuChild[] -} -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type), [TLUiMenuChild](/gen/ui/TLUiMenuChild-type) - diff --git a/docs/gen/TLUiToast-interface.mdx b/docs/gen/TLUiToast-interface.mdx deleted file mode 100644 index f5888a564..000000000 --- a/docs/gen/TLUiToast-interface.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: TLUiToast -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 44 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [actions](#TLUiToast-actions-member) - - [closeLabel](#TLUiToast-closeLabel-member) - - [description](#TLUiToast-description-member) - - [icon](#TLUiToast-icon-member) - - [id](#TLUiToast-id-member) - - [keepOpen](#TLUiToast-keepOpen-member) - - [title](#TLUiToast-title-member) -
- - - - -##### Signature - - -```ts -interface TLUiToast {} -``` - ---- - -## Properties - -### `actions` \{#TLUiToast-actions-member} - -Public PropertySignature - -##### Signature - - -```ts -actions?: TLUiToastAction[] -``` - -##### References - -[TLUiToastAction](/gen/ui/TLUiToastAction-interface) - ---- - -### `closeLabel` \{#TLUiToast-closeLabel-member} - -Public PropertySignature - -##### Signature - - -```ts -closeLabel?: string -``` - ---- - -### `description` \{#TLUiToast-description-member} - -Public PropertySignature - -##### Signature - - -```ts -description?: string -``` - ---- - -### `icon` \{#TLUiToast-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon?: string -``` - ---- - -### `id` \{#TLUiToast-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `keepOpen` \{#TLUiToast-keepOpen-member} - -Public PropertySignature - -##### Signature - - -```ts -keepOpen?: boolean -``` - ---- - -### `title` \{#TLUiToast-title-member} - -Public PropertySignature - -##### Signature - - -```ts -title?: string -``` - ---- - diff --git a/docs/gen/TLUiToastAction-interface.mdx b/docs/gen/TLUiToastAction-interface.mdx deleted file mode 100644 index 350561ade..000000000 --- a/docs/gen/TLUiToastAction-interface.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: TLUiToastAction -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 45 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [label](#TLUiToastAction-label-member) - - [onClick](#TLUiToastAction-onClick-member) - - [type](#TLUiToastAction-type-member) -
- - - - -##### Signature - - -```ts -interface TLUiToastAction {} -``` - ---- - -## Properties - -### `label` \{#TLUiToastAction-label-member} - -Public PropertySignature - -##### Signature - - -```ts -label: string -``` - ---- - -### `onClick` \{#TLUiToastAction-onClick-member} - -Public PropertySignature - -##### Signature - - -```ts -onClick: () => void -``` - ---- - -### `type` \{#TLUiToastAction-type-member} - -Public PropertySignature - -##### Signature - - -```ts -type: 'primary' | 'secondary' | 'warn' -``` - ---- - diff --git a/docs/gen/TLUiToastsContextType-type.mdx b/docs/gen/TLUiToastsContextType-type.mdx deleted file mode 100644 index e99c3680f..000000000 --- a/docs/gen/TLUiToastsContextType-type.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TLUiToastsContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 46 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiToastsContextType = { - addToast: ( - toast: Omit & { - id?: string - } - ) => string - removeToast: (id: TLUiToast['id']) => string - clearToasts: () => void - toasts: TLUiToast[] -} -``` - -##### References - -[Omit](/gen/Omit-type), [TLUiToast](/gen/ui/TLUiToast-interface) - diff --git a/docs/gen/TLUiToolItem-interface.mdx b/docs/gen/TLUiToolItem-interface.mdx deleted file mode 100644 index 44bd68696..000000000 --- a/docs/gen/TLUiToolItem-interface.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: TLUiToolItem -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 49 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [icon](#TLUiToolItem-icon-member) - - [id](#TLUiToolItem-id-member) - - [kbd](#TLUiToolItem-kbd-member) - - [label](#TLUiToolItem-label-member) - - [meta](#TLUiToolItem-meta-member) - - [onSelect](#TLUiToolItem-onSelect-member) - - [readonlyOk](#TLUiToolItem-readonlyOk-member) - - [shortcutsLabel](#TLUiToolItem-shortcutsLabel-member) -
- - - - -##### Signature - - -```ts -interface TLUiToolItem {} -``` - ---- - -## Properties - -### `icon` \{#TLUiToolItem-icon-member} - -Public PropertySignature - -##### Signature - - -```ts -icon: TLUiIconType -``` - -##### References - -[TLUiIconType](/gen/ui/TLUiIconType-type) - ---- - -### `id` \{#TLUiToolItem-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `kbd` \{#TLUiToolItem-kbd-member} - -Public PropertySignature - -##### Signature - - -```ts -kbd?: string -``` - ---- - -### `label` \{#TLUiToolItem-label-member} - -Public PropertySignature - -##### Signature - - -```ts -label: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - -### `meta` \{#TLUiToolItem-meta-member} - -Public PropertySignature - -##### Signature - - -```ts -meta?: { - [key: string]: any -} -``` - ---- - -### `onSelect` \{#TLUiToolItem-onSelect-member} - -Public PropertySignature - -##### Signature - - -```ts -onSelect: (source: TLUiEventSource) => void -``` - -##### References - -[TLUiEventSource](/gen/ui/TLUiEventSource-type) - ---- - -### `readonlyOk` \{#TLUiToolItem-readonlyOk-member} - -Public PropertySignature - -##### Signature - - -```ts -readonlyOk: boolean -``` - ---- - -### `shortcutsLabel` \{#TLUiToolItem-shortcutsLabel-member} - -Public PropertySignature - -##### Signature - - -```ts -shortcutsLabel?: TLUiTranslationKey -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - ---- - diff --git a/docs/gen/TLUiToolbarItem-type.mdx b/docs/gen/TLUiToolbarItem-type.mdx deleted file mode 100644 index b377fd28e..000000000 --- a/docs/gen/TLUiToolbarItem-type.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TLUiToolbarItem -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 47 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiToolbarItem = { - id: string - type: 'item' - readonlyOk: boolean - toolItem: TLUiToolItem -} -``` - -##### References - -[TLUiToolItem](/gen/ui/TLUiToolItem-interface) - diff --git a/docs/gen/TLUiToolbarSchemaContextType-type.mdx b/docs/gen/TLUiToolbarSchemaContextType-type.mdx deleted file mode 100644 index 76283b301..000000000 --- a/docs/gen/TLUiToolbarSchemaContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiToolbarSchemaContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 48 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiToolbarSchemaContextType = TLUiToolbarItem[] -``` - -##### References - -[TLUiToolbarItem](/gen/ui/TLUiToolbarItem-type) - diff --git a/docs/gen/TLUiToolsContextType-type.mdx b/docs/gen/TLUiToolsContextType-type.mdx deleted file mode 100644 index 034cf1c61..000000000 --- a/docs/gen/TLUiToolsContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiToolsContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 50 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiToolsContextType = Record -``` - -##### References - -[Record](/gen/Record-type), [TLUiToolItem](/gen/ui/TLUiToolItem-interface) - diff --git a/docs/gen/TLUiToolsProviderProps-type.mdx b/docs/gen/TLUiToolsProviderProps-type.mdx deleted file mode 100644 index aa8ef60bd..000000000 --- a/docs/gen/TLUiToolsProviderProps-type.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TLUiToolsProviderProps -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 51 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiToolsProviderProps = { - overrides?: ( - editor: Editor, - tools: TLUiToolsContextType, - helpers: { - insertMedia: () => void - } - ) => TLUiToolsContextType - children: any -} -``` - -##### References - -[Editor](/gen/editor/Editor-class), [TLUiToolsContextType](/gen/ui/TLUiToolsContextType-type) - diff --git a/docs/gen/TLUiTranslation-type.mdx b/docs/gen/TLUiTranslation-type.mdx deleted file mode 100644 index da30eca7a..000000000 --- a/docs/gen/TLUiTranslation-type.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: TLUiTranslation -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 52 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiTranslation = { - readonly locale: string - readonly label: string - readonly messages: Record -} -``` - -##### References - -[Record](/gen/Record-type), [TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - diff --git a/docs/gen/TLUiTranslationContextType-type.mdx b/docs/gen/TLUiTranslationContextType-type.mdx deleted file mode 100644 index c943c94a5..000000000 --- a/docs/gen/TLUiTranslationContextType-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUiTranslationContextType -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 53 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiTranslationContextType = TLUiTranslation -``` - -##### References - -[TLUiTranslation](/gen/ui/TLUiTranslation-type) - diff --git a/docs/gen/TLUiTranslationKey-type.mdx b/docs/gen/TLUiTranslationKey-type.mdx deleted file mode 100644 index 274721c87..000000000 --- a/docs/gen/TLUiTranslationKey-type.mdx +++ /dev/null @@ -1,364 +0,0 @@ ---- -title: TLUiTranslationKey -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 54 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLUiTranslationKey = - | '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.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.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-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.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.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' - | '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.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' -``` - diff --git a/docs/gen/TLUnknownShape-type.mdx b/docs/gen/TLUnknownShape-type.mdx deleted file mode 100644 index 66fa14a13..000000000 --- a/docs/gen/TLUnknownShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLUnknownShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 121 ----Public TypeAlias - -A type for a shape that is available in the editor but whose type is unknown—either one of the editor's default shapes or else a custom shape. - - -##### Signature - - -```ts -type TLUnknownShape = TLBaseShape -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface) - diff --git a/docs/gen/TLUserPreferences-interface.mdx b/docs/gen/TLUserPreferences-interface.mdx deleted file mode 100644 index 7285dfe74..000000000 --- a/docs/gen/TLUserPreferences-interface.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: TLUserPreferences -status: published -category: editor -group: Interface -author: api -date: 06/23/2023 -order: 183 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [animationSpeed](#TLUserPreferences-animationSpeed-member) - - [color](#TLUserPreferences-color-member) - - [id](#TLUserPreferences-id-member) - - [isDarkMode](#TLUserPreferences-isDarkMode-member) - - [isSnapMode](#TLUserPreferences-isSnapMode-member) - - [locale](#TLUserPreferences-locale-member) - - [name](#TLUserPreferences-name-member) -
- -A user of tldraw - - -##### Signature - - -```ts -interface TLUserPreferences {} -``` - ---- - -## Properties - -### `animationSpeed` \{#TLUserPreferences-animationSpeed-member} - -Public PropertySignature - -##### Signature - - -```ts -animationSpeed: number -``` - ---- - -### `color` \{#TLUserPreferences-color-member} - -Public PropertySignature - -##### Signature - - -```ts -color: string -``` - ---- - -### `id` \{#TLUserPreferences-id-member} - -Public PropertySignature - -##### Signature - - -```ts -id: string -``` - ---- - -### `isDarkMode` \{#TLUserPreferences-isDarkMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isDarkMode: boolean -``` - ---- - -### `isSnapMode` \{#TLUserPreferences-isSnapMode-member} - -Public PropertySignature - -##### Signature - - -```ts -isSnapMode: boolean -``` - ---- - -### `locale` \{#TLUserPreferences-locale-member} - -Public PropertySignature - -##### Signature - - -```ts -locale: string -``` - ---- - -### `name` \{#TLUserPreferences-name-member} - -Public PropertySignature - -##### Signature - - -```ts -name: string -``` - ---- - diff --git a/docs/gen/TLVideoAsset-type.mdx b/docs/gen/TLVideoAsset-type.mdx deleted file mode 100644 index c02e3c88e..000000000 --- a/docs/gen/TLVideoAsset-type.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TLVideoAsset -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 122 ----Public TypeAlias - -An asset used for videos, used by the TLVideoShape. - - -##### Signature - - -```ts -type TLVideoAsset = TLBaseAsset< - 'video', - { - w: number - h: number - name: string - isAnimated: boolean - mimeType: null | string - src: null | string - } -> -``` - -##### References - -[TLBaseAsset](/gen/tlschema/TLBaseAsset-interface) - diff --git a/docs/gen/TLVideoShape-type.mdx b/docs/gen/TLVideoShape-type.mdx deleted file mode 100644 index 78e02a15a..000000000 --- a/docs/gen/TLVideoShape-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLVideoShape -status: published -category: tlschema -group: TypeAlias -author: api -date: 06/23/2023 -order: 123 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLVideoShape = TLBaseShape<'video', TLVideoShapeProps> -``` - -##### References - -[TLBaseShape](/gen/tlschema/TLBaseShape-interface), [TLVideoShapeProps](/gen/tlschema/~TLVideoShapeProps-type) - diff --git a/docs/gen/TLWheelEvent-type.mdx b/docs/gen/TLWheelEvent-type.mdx deleted file mode 100644 index 6fbd48ddf..000000000 --- a/docs/gen/TLWheelEvent-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TLWheelEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 184 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLWheelEvent = (info: TLWheelEventInfo) => void -``` - -##### References - -[TLWheelEventInfo](/gen/editor/TLWheelEventInfo-type) - diff --git a/docs/gen/TLWheelEventInfo-type.mdx b/docs/gen/TLWheelEventInfo-type.mdx deleted file mode 100644 index bb0d19e86..000000000 --- a/docs/gen/TLWheelEventInfo-type.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: TLWheelEventInfo -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 185 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TLWheelEventInfo = TLBaseEventInfo & { - type: 'wheel' - name: 'wheel' - delta: Vec2dModel -} -``` - -##### References - -[TLBaseEventInfo](/gen/editor/TLBaseEventInfo-interface), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - diff --git a/docs/gen/TL_CANVAS_UI_COLOR_TYPES-var.mdx b/docs/gen/TL_CANVAS_UI_COLOR_TYPES-var.mdx deleted file mode 100644 index fca2cac30..000000000 --- a/docs/gen/TL_CANVAS_UI_COLOR_TYPES-var.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TL_CANVAS_UI_COLOR_TYPES -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 52 ----Public Readonly Variable - -The colors used by tldraw's default shapes. - - -##### Signature - - -```ts -TL_CANVAS_UI_COLOR_TYPES: Set< - | 'accent' - | 'black' - | 'laser' - | 'muted-1' - | 'selection-fill' - | 'selection-stroke' - | 'white' -> -``` - -##### References - -[Set](/gen/Set-interface) - diff --git a/docs/gen/TextShape-var.mdx b/docs/gen/TextShape-var.mdx deleted file mode 100644 index 907e323c3..000000000 --- a/docs/gen/TextShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: TextShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 106 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TextShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLTextShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLTextShape](/gen/tlschema/TLTextShape-type) - diff --git a/docs/gen/TextShapeUtil-class.mdx b/docs/gen/TextShapeUtil-class.mdx deleted file mode 100644 index 460c5e384..000000000 --- a/docs/gen/TextShapeUtil-class.mdx +++ /dev/null @@ -1,578 +0,0 @@ ---- -title: TextShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 107 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canEdit](#TextShapeUtil-canEdit-member) - - [isAspectRatioLocked](#TextShapeUtil-isAspectRatioLocked-member) - - [onBeforeCreate](#TextShapeUtil-onBeforeCreate-member) - - [onBeforeUpdate](#TextShapeUtil-onBeforeUpdate-member) - - [onDoubleClickEdge](#TextShapeUtil-onDoubleClickEdge-member) - - [onEditEnd](#TextShapeUtil-onEditEnd-member) - - [onResize](#TextShapeUtil-onResize-member) - - [type](#TextShapeUtil-type-member) -- [Methods](#methods) - - [component](#TextShapeUtil-component-member-1) - - [getBounds](#TextShapeUtil-getBounds-member-1) - - [getDefaultProps](#TextShapeUtil-getDefaultProps-member-1) - - [getMinDimensions](#TextShapeUtil-getMinDimensions-member-1) - - [getOutline](#TextShapeUtil-getOutline-member-1) - - [indicator](#TextShapeUtil-indicator-member-1) - - [toSvg](#TextShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class TextShapeUtil extends ShapeUtil {} -``` - -##### References - -[ShapeUtil](/gen/editor/ShapeUtil-class), [TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -## Properties - -### `canEdit` \{#TextShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `isAspectRatioLocked` \{#TextShapeUtil-isAspectRatioLocked-member} - -Public Property - -##### Signature - - -```ts -isAspectRatioLocked: TLShapeUtilFlag -``` - -##### References - -[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -### `onBeforeCreate` \{#TextShapeUtil-onBeforeCreate-member} - -Public Property - -##### Signature - - -```ts -onBeforeCreate: (shape: TLTextShape) => - | { - x: number - y: number - type: 'text' - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - props: { - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - w: number - text: string - scale: number - autoSize: boolean - } - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onBeforeUpdate` \{#TextShapeUtil-onBeforeUpdate-member} - -Public Property - -##### Signature - - -```ts -onBeforeUpdate: ( - prev: TLTextShape, - next: TLTextShape -) => - | { - x: number - y: number - props: { - w: number - color: - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - size: 'l' | 'm' | 's' | 'xl' - font: 'draw' | 'mono' | 'sans' | 'serif' - align: - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - text: string - scale: number - autoSize: boolean - } - type: 'text' - rotation: number - index: string - parentId: import('@tldraw/tlschema').TLParentId - isLocked: boolean - opacity: number - id: import('@tldraw/tlschema').TLShapeId - typeName: 'shape' - } - | undefined -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onDoubleClickEdge` \{#TextShapeUtil-onDoubleClickEdge-member} - -Public Property - -##### Signature - - -```ts -onDoubleClickEdge: (shape: TLTextShape) => - | { - id: import('@tldraw/tlschema').TLShapeId - type: 'text' - props: { - autoSize: boolean - scale?: undefined - } - } - | { - id: import('@tldraw/tlschema').TLShapeId - type: 'text' - props: { - scale: number - autoSize?: undefined - } - } - | undefined -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [TLShapeId](/gen/tlschema/TLShapeId-type) - ---- - -### `onEditEnd` \{#TextShapeUtil-onEditEnd-member} - -Public Property - -##### Signature - - -```ts -onEditEnd: TLOnEditEndHandler -``` - -##### References - -[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -### `onResize` \{#TextShapeUtil-onResize-member} - -Public Property - -##### Signature - - -```ts -onResize: TLOnResizeHandler -``` - -##### References - -[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -### `type` \{#TextShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'text' -``` - ---- - -## Methods - -### `component()` \{#TextShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getBounds()` \{#TextShapeUtil-getBounds-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - -##### Returns - - -```ts -Box2d -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [Box2d](/gen/primitives/Box2d-class) - ---- - -### `getDefaultProps()` \{#TextShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLTextShape['props'] -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -### `getMinDimensions()` \{#TextShapeUtil-getMinDimensions-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - -##### Returns - - -```ts -{ - height: number - width: number -} -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type) - ---- - -### `getOutline()` \{#TextShapeUtil-getOutline-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `indicator()` \{#TextShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#TextShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLTextShape -``` - - - - - - - - -`font` - - - - -```ts -string | undefined -``` - - - - - - - - -`colors` - - - - -```ts -TLExportColors -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLTextShape](/gen/tlschema/TLTextShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/Tldraw-function-1.mdx b/docs/gen/Tldraw-function-1.mdx deleted file mode 100644 index fa35263d3..000000000 --- a/docs/gen/Tldraw-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Tldraw -status: published -category: tldraw -group: Function -author: api -date: 06/23/2023 -order: 0 ----Public Function - - - - -##### Parameters - - - - - - - -`props` - - - - -```ts -TldrawEditorProps & TldrawUiProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TldrawEditorProps](/gen/editor/TldrawEditorProps-type), [TldrawUiProps](/gen/ui/TldrawUiProps-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/TldrawEditor-var.mdx b/docs/gen/TldrawEditor-var.mdx deleted file mode 100644 index 8fcbc5248..000000000 --- a/docs/gen/TldrawEditor-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: TldrawEditor -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 122 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TldrawEditor: React.NamedExoticComponent -``` - -##### References - -[React.NamedExoticComponent](/gen/@types/react-React-NamedExoticComponent-interface), [TldrawEditorProps](/gen/editor/TldrawEditorProps-type) - diff --git a/docs/gen/TldrawEditorProps-type.mdx b/docs/gen/TldrawEditorProps-type.mdx deleted file mode 100644 index 0b2217f25..000000000 --- a/docs/gen/TldrawEditorProps-type.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TldrawEditorProps -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 123 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TldrawEditorProps = { - children?: any - shapes?: readonly AnyTLShapeInfo[] - tools?: readonly TLStateNodeConstructor[] - assetUrls?: RecursivePartial - autoFocus?: boolean - components?: Partial - onMount?: (editor: Editor) => (() => void) | undefined | void -} & ( - | { - store: TLStore | TLStoreWithStatus - } - | { - store?: undefined - initialData?: StoreSnapshot - persistenceKey?: string - sessionId?: string - defaultName?: string - } -) -``` - -##### References - -[AnyTLShapeInfo](/gen/editor/~AnyTLShapeInfo-type), [TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface), [RecursivePartial](/gen/utils/RecursivePartial-type), [TLEditorAssetUrls](/gen/editor/TLEditorAssetUrls-type), [Partial](/gen/Partial-type), [TLEditorComponents](/gen/editor/TLEditorComponents-interface), [Editor](/gen/editor/Editor-class), [TLStore](/gen/tlschema/TLStore-type), [TLStoreWithStatus](/gen/editor/TLStoreWithStatus-type), [StoreSnapshot](/gen/store/StoreSnapshot-type), [TLRecord](/gen/tlschema/TLRecord-type) - diff --git a/docs/gen/TldrawFile-interface.mdx b/docs/gen/TldrawFile-interface.mdx deleted file mode 100644 index 5c40efd10..000000000 --- a/docs/gen/TldrawFile-interface.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: TldrawFile -status: published -category: file-format -group: Interface -author: api -date: 06/23/2023 -order: 6 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [records](#TldrawFile-records-member) - - [schema](#TldrawFile-schema-member) - - [tldrawFileFormatVersion](#TldrawFile-tldrawFileFormatVersion-member) -
- - - - -##### Signature - - -```ts -interface TldrawFile {} -``` - ---- - -## Properties - -### `records` \{#TldrawFile-records-member} - -Public PropertySignature - -##### Signature - - -```ts -records: UnknownRecord[] -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type) - ---- - -### `schema` \{#TldrawFile-schema-member} - -Public PropertySignature - -##### Signature - - -```ts -schema: SerializedSchema -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface) - ---- - -### `tldrawFileFormatVersion` \{#TldrawFile-tldrawFileFormatVersion-member} - -Public PropertySignature - -##### Signature - - -```ts -tldrawFileFormatVersion: number -``` - ---- - diff --git a/docs/gen/TldrawFileParseError-type.mdx b/docs/gen/TldrawFileParseError-type.mdx deleted file mode 100644 index e47f0ebe5..000000000 --- a/docs/gen/TldrawFileParseError-type.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TldrawFileParseError -status: published -category: file-format -group: TypeAlias -author: api -date: 06/23/2023 -order: 7 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TldrawFileParseError = - | { - type: 'fileFormatVersionTooNew' - version: number - } - | { - type: 'invalidRecords' - cause: unknown - } - | { - type: 'migrationFailed' - reason: MigrationFailureReason - } - | { - type: 'notATldrawFile' - cause: unknown - } - | { - type: 'v1File' - data: any - } -``` - -##### References - -[MigrationFailureReason](/gen/store/MigrationFailureReason-enum) - diff --git a/docs/gen/TldrawUi-var.mdx b/docs/gen/TldrawUi-var.mdx deleted file mode 100644 index f524526a0..000000000 --- a/docs/gen/TldrawUi-var.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TldrawUi -status: published -category: ui -group: Variable -author: api -date: 06/23/2023 -order: 13 ----Public Readonly Variable - - - - -##### Signature - - -```ts -TldrawUi: React.NamedExoticComponent< - { - children?: ReactNode - hideUi?: boolean | undefined - shareZone?: ReactNode - topZone?: ReactNode - renderDebugMenuItems?: (() => React.ReactNode) | undefined - } & TldrawUiContextProviderProps -> -``` - -##### References - -[React.NamedExoticComponent](/gen/@types/react-React-NamedExoticComponent-interface), [ReactNode](/gen/@types/react-React-ReactNode-type), [React.ReactNode](/gen/@types/react-React-ReactNode-type), [TldrawUiContextProviderProps](/gen/ui/TldrawUiContextProviderProps-interface) - diff --git a/docs/gen/TldrawUiContextProvider-function-1.mdx b/docs/gen/TldrawUiContextProvider-function-1.mdx deleted file mode 100644 index 363db6ad1..000000000 --- a/docs/gen/TldrawUiContextProvider-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: TldrawUiContextProvider -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 14 ----Public Function - - - - -##### Parameters - - - - - - - -`{ overrides, assetUrls, onUiEvent, children, }` - - - - -```ts -TldrawUiContextProviderProps -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TldrawUiContextProviderProps](/gen/ui/TldrawUiContextProviderProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - diff --git a/docs/gen/TldrawUiContextProviderProps-interface.mdx b/docs/gen/TldrawUiContextProviderProps-interface.mdx deleted file mode 100644 index b05ad0e11..000000000 --- a/docs/gen/TldrawUiContextProviderProps-interface.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: TldrawUiContextProviderProps -status: published -category: ui -group: Interface -author: api -date: 06/23/2023 -order: 15 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [assetUrls](#TldrawUiContextProviderProps-assetUrls-member) - - [children](#TldrawUiContextProviderProps-children-member) - - [onUiEvent](#TldrawUiContextProviderProps-onUiEvent-member) - - [overrides](#TldrawUiContextProviderProps-overrides-member) -
- - - - -##### Signature - - -```ts -interface TldrawUiContextProviderProps {} -``` - ---- - -## Properties - -### `assetUrls` \{#TldrawUiContextProviderProps-assetUrls-member} - -Public PropertySignature - -##### Signature - - -```ts -assetUrls?: RecursivePartial -``` - -##### References - -[RecursivePartial](/gen/utils/RecursivePartial-type), [TLUiAssetUrls](/gen/ui/~TLUiAssetUrls-type) - ---- - -### `children` \{#TldrawUiContextProviderProps-children-member} - -Public PropertySignature - -##### Signature - - -```ts -children?: any -``` - ---- - -### `onUiEvent` \{#TldrawUiContextProviderProps-onUiEvent-member} - -Public PropertySignature - -##### Signature - - -```ts -onUiEvent?: TLUiEventHandler -``` - -##### References - -[TLUiEventHandler](/gen/ui/TLUiEventHandler-type) - ---- - -### `overrides` \{#TldrawUiContextProviderProps-overrides-member} - -Public PropertySignature - -##### Signature - - -```ts -overrides?: TLUiOverrides | TLUiOverrides[] -``` - -##### References - -[TLUiOverrides](/gen/ui/TLUiOverrides-interface) - ---- - diff --git a/docs/gen/TldrawUiProps-type.mdx b/docs/gen/TldrawUiProps-type.mdx deleted file mode 100644 index d242cc27e..000000000 --- a/docs/gen/TldrawUiProps-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: TldrawUiProps -status: published -category: ui -group: TypeAlias -author: api -date: 06/23/2023 -order: 16 ----Public TypeAlias - - - - -##### Signature - - -```ts -type TldrawUiProps = { - children?: ReactNode - hideUi?: boolean - shareZone?: ReactNode - topZone?: ReactNode - renderDebugMenuItems?: () => React.ReactNode -} & TldrawUiContextProviderProps -``` - -##### References - -[ReactNode](/gen/@types/react-React-ReactNode-type), [React.ReactNode](/gen/@types/react-React-ReactNode-type), [TldrawUiContextProviderProps](/gen/ui/TldrawUiContextProviderProps-interface) - diff --git a/docs/gen/UiEvent-type.mdx b/docs/gen/UiEvent-type.mdx deleted file mode 100644 index 324b1a1cb..000000000 --- a/docs/gen/UiEvent-type.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: UiEvent -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 187 ----Public TypeAlias - - - - -##### Signature - - -```ts -type UiEvent = - | TLCancelEvent - | TLClickEvent - | TLCompleteEvent - | TLKeyboardEvent - | TLPinchEvent - | TLPointerEvent -``` - -##### References - -[TLCancelEvent](/gen/editor/TLCancelEvent-type), [TLClickEvent](/gen/editor/TLClickEvent-type), [TLCompleteEvent](/gen/editor/TLCompleteEvent-type), [TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type), [TLPinchEvent](/gen/editor/TLPinchEvent-type), [TLPointerEvent](/gen/editor/TLPointerEvent-type) - diff --git a/docs/gen/UiEventType-type.mdx b/docs/gen/UiEventType-type.mdx deleted file mode 100644 index f1b2938cc..000000000 --- a/docs/gen/UiEventType-type.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: UiEventType -status: published -category: editor -group: TypeAlias -author: api -date: 06/23/2023 -order: 188 ----Public TypeAlias - - - - -##### Signature - - -```ts -type UiEventType = 'click' | 'keyboard' | 'pinch' | 'pointer' | 'wheel' | 'zoom' -``` - diff --git a/docs/gen/UnknownRecord-type.mdx b/docs/gen/UnknownRecord-type.mdx deleted file mode 100644 index f858c138b..000000000 --- a/docs/gen/UnknownRecord-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: UnknownRecord -status: published -category: store -group: TypeAlias -author: api -date: 06/23/2023 -order: 34 ----Public TypeAlias - - - - -##### Signature - - -```ts -type UnknownRecord = BaseRecord> -``` - -##### References - -[BaseRecord](/gen/store/BaseRecord-interface), [RecordId](/gen/store/RecordId-type), [UnknownRecord](/gen/store/UnknownRecord-type) - diff --git a/docs/gen/Vec2d-class.mdx b/docs/gen/Vec2d-class.mdx deleted file mode 100644 index 163dd47c5..000000000 --- a/docs/gen/Vec2d-class.mdx +++ /dev/null @@ -1,4893 +0,0 @@ ---- -title: Vec2d -status: published -category: primitives -group: Class -author: api -date: 06/23/2023 -order: 92 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [pressure](#Vec2d-pressure-member) - - [x](#Vec2d-x-member) - - [y](#Vec2d-y-member) - - [z](#Vec2d-z-member) -- [Methods](#methods) - - [abs](#Vec2d-abs-member-1) - - [Abs](#Vec2d-Abs-member-1) - - [add](#Vec2d-add-member-1) - - [Add](#Vec2d-Add-member-1) - - [addScalar](#Vec2d-addScalar-member-1) - - [AddScalar](#Vec2d-AddScalar-member-1) - - [addXY](#Vec2d-addXY-member-1) - - [AddXY](#Vec2d-AddXY-member-1) - - [angle](#Vec2d-angle-member-1) - - [Angle](#Vec2d-Angle-member-1) - - [Average](#Vec2d-Average-member-1) - - [Cast](#Vec2d-Cast-member-1) - - [clamp](#Vec2d-clamp-member-1) - - [Clamp](#Vec2d-Clamp-member-1) - - [Clockwise](#Vec2d-Clockwise-member-1) - - [clone](#Vec2d-clone-member-1) - - [cpr](#Vec2d-cpr-member-1) - - [Cpr](#Vec2d-Cpr-member-1) - - [cross](#Vec2d-cross-member-1) - - [Cross](#Vec2d-Cross-member-1) - - [dist](#Vec2d-dist-member-1) - - [Dist](#Vec2d-Dist-member-1) - - [Dist2](#Vec2d-Dist2-member-1) - - [distanceToLineSegment](#Vec2d-distanceToLineSegment-member-1) - - [DistanceToLineSegment](#Vec2d-DistanceToLineSegment-member-1) - - [DistanceToLineThroughPoint](#Vec2d-DistanceToLineThroughPoint-member-1) - - [div](#Vec2d-div-member-1) - - [Div](#Vec2d-Div-member-1) - - [divV](#Vec2d-divV-member-1) - - [DivV](#Vec2d-DivV-member-1) - - [dpr](#Vec2d-dpr-member-1) - - [Dpr](#Vec2d-Dpr-member-1) - - [equals](#Vec2d-equals-member-1) - - [Equals](#Vec2d-Equals-member-1) - - [equalsXY](#Vec2d-equalsXY-member-1) - - [EqualsXY](#Vec2d-EqualsXY-member-1) - - [From](#Vec2d-From-member-1) - - [FromArray](#Vec2d-FromArray-member-1) - - [len](#Vec2d-len-member-1) - - [Len](#Vec2d-Len-member-1) - - [len2](#Vec2d-len2-member-1) - - [Len2](#Vec2d-Len2-member-1) - - [lrp](#Vec2d-lrp-member-1) - - [Lrp](#Vec2d-Lrp-member-1) - - [Max](#Vec2d-Max-member-1) - - [Med](#Vec2d-Med-member-1) - - [Min](#Vec2d-Min-member-1) - - [mul](#Vec2d-mul-member-1) - - [Mul](#Vec2d-Mul-member-1) - - [mulV](#Vec2d-mulV-member-1) - - [MulV](#Vec2d-MulV-member-1) - - [NearestPointOnLineSegment](#Vec2d-NearestPointOnLineSegment-member-1) - - [NearestPointOnLineThroughPoint](#Vec2d-NearestPointOnLineThroughPoint-member-1) - - [neg](#Vec2d-neg-member-1) - - [Neg](#Vec2d-Neg-member-1) - - [norm](#Vec2d-norm-member-1) - - [nudge](#Vec2d-nudge-member-1) - - [Nudge](#Vec2d-Nudge-member-1) - - [per](#Vec2d-per-member-1) - - [Per](#Vec2d-Per-member-1) - - [PointsBetween](#Vec2d-PointsBetween-member-1) - - [pry](#Vec2d-pry-member-1) - - [Pry](#Vec2d-Pry-member-1) - - [Rescale](#Vec2d-Rescale-member-1) - - [rot](#Vec2d-rot-member-1) - - [Rot](#Vec2d-Rot-member-1) - - [rotWith](#Vec2d-rotWith-member-1) - - [RotWith](#Vec2d-RotWith-member-1) - - [ScaleWithOrigin](#Vec2d-ScaleWithOrigin-member-1) - - [set](#Vec2d-set-member-1) - - [setTo](#Vec2d-setTo-member-1) - - [slope](#Vec2d-slope-member-1) - - [Slope](#Vec2d-Slope-member-1) - - [Snap](#Vec2d-Snap-member-1) - - [snapToGrid](#Vec2d-snapToGrid-member-1) - - [SnapToGrid](#Vec2d-SnapToGrid-member-1) - - [sub](#Vec2d-sub-member-1) - - [Sub](#Vec2d-Sub-member-1) - - [subScalar](#Vec2d-subScalar-member-1) - - [SubScalar](#Vec2d-SubScalar-member-1) - - [subXY](#Vec2d-subXY-member-1) - - [SubXY](#Vec2d-SubXY-member-1) - - [tan](#Vec2d-tan-member-1) - - [Tan](#Vec2d-Tan-member-1) - - [toAngle](#Vec2d-toAngle-member-1) - - [ToAngle](#Vec2d-ToAngle-member-1) - - [toArray](#Vec2d-toArray-member-1) - - [ToArray](#Vec2d-ToArray-member-1) - - [toFixed](#Vec2d-toFixed-member-1) - - [ToFixed](#Vec2d-ToFixed-member-1) - - [toJson](#Vec2d-toJson-member-1) - - [ToJson](#Vec2d-ToJson-member-1) - - [toString](#Vec2d-toString-member-1) - - [ToString](#Vec2d-ToString-member-1) - - [uni](#Vec2d-uni-member-1) - - [Uni](#Vec2d-Uni-member-1) -
- - - - -##### Signature - - -```ts -class Vec2d {} -``` - ---- - -### `Constructor` - -Public Constructor - -Constructs a new instance of the `Vec2d` class - - -##### Parameters - - - - - - - -`x` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`y` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - - - - - - - ---- - -## Properties - -### `pressure` \{#Vec2d-pressure-member} - -Public Readonly Property - -##### Signature - - -```ts -get pressure(): number -``` - ---- - -### `x` \{#Vec2d-x-member} - -Public Property - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#Vec2d-y-member} - -Public Property - -##### Signature - - -```ts -y: number -``` - ---- - -### `z` \{#Vec2d-z-member} - -Public Property - -##### Signature - - -```ts -z: number -``` - ---- - -## Methods - -### `abs()` \{#Vec2d-abs-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `Abs()` \{#Vec2d-Abs-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `add()` \{#Vec2d-add-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Add()` \{#Vec2d-Add-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `addScalar()` \{#Vec2d-addScalar-member-1} - -Public Method - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `AddScalar()` \{#Vec2d-AddScalar-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `addXY()` \{#Vec2d-addXY-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `AddXY()` \{#Vec2d-AddXY-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `angle()` \{#Vec2d-angle-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Angle()` \{#Vec2d-Angle-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Average()` \{#Vec2d-Average-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`arr` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Cast()` \{#Vec2d-Cast-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `clamp()` \{#Vec2d-clamp-member-1} - -Public Method - -##### Parameters - - - - - - - -`min` - - - - -```ts -number -``` - - - - - - - - -`max` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `Clamp()` \{#Vec2d-Clamp-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -Vec2d -``` - - - - - - - - -`min` - - - - -```ts -number -``` - - - - - - - - -`max` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Clockwise()` \{#Vec2d-Clockwise-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`C` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `clone()` \{#Vec2d-clone-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `cpr()` \{#Vec2d-cpr-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Cpr()` \{#Vec2d-Cpr-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `cross()` \{#Vec2d-cross-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Cross()` \{#Vec2d-Cross-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `dist()` \{#Vec2d-dist-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Dist()` \{#Vec2d-Dist-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Dist2()` \{#Vec2d-Dist2-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `distanceToLineSegment()` \{#Vec2d-distanceToLineSegment-member-1} - -Public Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `DistanceToLineSegment()` \{#Vec2d-DistanceToLineSegment-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`P` - - - - -```ts -VecLike -``` - - - - - - - - -`clamp` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `DistanceToLineThroughPoint()` \{#Vec2d-DistanceToLineThroughPoint-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`u` - - - - -```ts -VecLike -``` - - - - - - - - -`P` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `div()` \{#Vec2d-div-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `Div()` \{#Vec2d-Div-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `divV()` \{#Vec2d-divV-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `DivV()` \{#Vec2d-DivV-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `dpr()` \{#Vec2d-dpr-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Dpr()` \{#Vec2d-Dpr-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `equals()` \{#Vec2d-equals-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Equals()` \{#Vec2d-Equals-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `equalsXY()` \{#Vec2d-equalsXY-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - ---- - -### `EqualsXY()` \{#Vec2d-EqualsXY-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `From()` \{#Vec2d-From-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`{ x, y, z }` - - - - -```ts -Vec2dModel -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `FromArray()` \{#Vec2d-FromArray-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`v` - - - - -```ts -number[] -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `len()` \{#Vec2d-len-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -number -``` - ---- - -### `Len()` \{#Vec2d-Len-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `len2()` \{#Vec2d-len2-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -number -``` - ---- - -### `Len2()` \{#Vec2d-Len2-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `lrp()` \{#Vec2d-lrp-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Lrp()` \{#Vec2d-Lrp-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Max()` \{#Vec2d-Max-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Med()` \{#Vec2d-Med-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Min()` \{#Vec2d-Min-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `mul()` \{#Vec2d-mul-member-1} - -Public Method - -##### Parameters - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `Mul()` \{#Vec2d-Mul-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`t` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `mulV()` \{#Vec2d-mulV-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `MulV()` \{#Vec2d-MulV-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `NearestPointOnLineSegment()` \{#Vec2d-NearestPointOnLineSegment-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`P` - - - - -```ts -VecLike -``` - - - - - - - - -`clamp` - - (optional) - - - - -```ts -boolean -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `NearestPointOnLineThroughPoint()` \{#Vec2d-NearestPointOnLineThroughPoint-member-1} - -Public Static Method - -Get the nearest point on a line with a known unit vector that passes through point A - - -```ts -Vec.nearestPointOnLineThroughPoint(A, u, Point) -``` - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -Any point on the line - - - - - - - - - -`u` - - - - -```ts -VecLike -``` - -The unit vector for the line. - - - - - - - - - -`P` - - - - -```ts -VecLike -``` - -A point not on the line to test. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `neg()` \{#Vec2d-neg-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `Neg()` \{#Vec2d-Neg-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `norm()` \{#Vec2d-norm-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `nudge()` \{#Vec2d-nudge-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`distance` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Nudge()` \{#Vec2d-Nudge-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`distance` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `per()` \{#Vec2d-per-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -this -``` - ---- - -### `Per()` \{#Vec2d-Per-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `PointsBetween()` \{#Vec2d-PointsBetween-member-1} - -Public Static Method - -Get an array of points (with simulated pressure) between two points. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -Vec2dModel -``` - -The first point. - - - - - - - - - -`B` - - - - -```ts -Vec2dModel -``` - -The second point. - - - - - - - - - -`steps` - - (optional) - - - - -```ts -number -``` - -The number of points to return. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `pry()` \{#Vec2d-pry-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Pry()` \{#Vec2d-Pry-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Rescale()` \{#Vec2d-Rescale-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `rot()` \{#Vec2d-rot-member-1} - -Public Method - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `Rot()` \{#Vec2d-Rot-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`r` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `rotWith()` \{#Vec2d-rotWith-member-1} - -Public Method - -##### Parameters - - - - - - - -`C` - - - - -```ts -VecLike -``` - - - - - - - - -`r` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `RotWith()` \{#Vec2d-RotWith-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`C` - - - - -```ts -VecLike -``` - - - - - - - - -`r` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `ScaleWithOrigin()` \{#Vec2d-ScaleWithOrigin-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`scale` - - - - -```ts -number -``` - - - - - - - - -`origin` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `set()` \{#Vec2d-set-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`y` - - (optional) - - - - -```ts -number -``` - - - - - - - - -`z` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `setTo()` \{#Vec2d-setTo-member-1} - -Public Method - -##### Parameters - - - - - - - -`{ x, y, z }` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `slope()` \{#Vec2d-slope-member-1} - -Public Method - -##### Parameters - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Slope()` \{#Vec2d-Slope-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Snap()` \{#Vec2d-Snap-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`step` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `snapToGrid()` \{#Vec2d-snapToGrid-member-1} - -Public Method - -##### Parameters - - - - - - - -`gridSize` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `SnapToGrid()` \{#Vec2d-SnapToGrid-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`gridSize` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `sub()` \{#Vec2d-sub-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -this -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `Sub()` \{#Vec2d-Sub-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `subScalar()` \{#Vec2d-subScalar-member-1} - -Public Method - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `SubScalar()` \{#Vec2d-SubScalar-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `subXY()` \{#Vec2d-subXY-member-1} - -Public Method - -##### Parameters - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -this -``` - ---- - -### `SubXY()` \{#Vec2d-SubXY-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`x` - - - - -```ts -number -``` - - - - - - - - -`y` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `tan()` \{#Vec2d-tan-member-1} - -Public Method - -##### Parameters - - - - - - - -`V` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Tan()` \{#Vec2d-Tan-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `toAngle()` \{#Vec2d-toAngle-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -number -``` - ---- - -### `ToAngle()` \{#Vec2d-ToAngle-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `toArray()` \{#Vec2d-toArray-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -number[] -``` - ---- - -### `ToArray()` \{#Vec2d-ToArray-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -number[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `toFixed()` \{#Vec2d-toFixed-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `ToFixed()` \{#Vec2d-ToFixed-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`n` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `toJson()` \{#Vec2d-toJson-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Vec2dModel -``` - -##### References - -[Vec2dModel](/gen/tlschema/Vec2dModel-interface) - ---- - -### `ToJson()` \{#Vec2d-ToJson-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -{ - x: number - y: number - z: number | undefined -} -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `toString()` \{#Vec2d-toString-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -string -``` - ---- - -### `ToString()` \{#Vec2d-ToString-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - ---- - -### `uni()` \{#Vec2d-uni-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - ---- - -### `Uni()` \{#Vec2d-Uni-member-1} - -Public Static Method - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - ---- - diff --git a/docs/gen/Vec2dModel-interface.mdx b/docs/gen/Vec2dModel-interface.mdx deleted file mode 100644 index 2dd4d18da..000000000 --- a/docs/gen/Vec2dModel-interface.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Vec2dModel -status: published -category: tlschema -group: Interface -author: api -date: 06/23/2023 -order: 124 ----Public Interface - -
- Table of Contents -- [Properties](#properties) - - [x](#Vec2dModel-x-member) - - [y](#Vec2dModel-y-member) - - [z](#Vec2dModel-z-member) -
- -A serializable model for 2D vectors. - - -##### Signature - - -```ts -interface Vec2dModel {} -``` - ---- - -## Properties - -### `x` \{#Vec2dModel-x-member} - -Public PropertySignature - -##### Signature - - -```ts -x: number -``` - ---- - -### `y` \{#Vec2dModel-y-member} - -Public PropertySignature - -##### Signature - - -```ts -y: number -``` - ---- - -### `z` \{#Vec2dModel-z-member} - -Public PropertySignature - -##### Signature - - -```ts -z?: number -``` - ---- - diff --git a/docs/gen/VecLike-type.mdx b/docs/gen/VecLike-type.mdx deleted file mode 100644 index 804299424..000000000 --- a/docs/gen/VecLike-type.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: VecLike -status: published -category: primitives -group: TypeAlias -author: api -date: 06/23/2023 -order: 93 ----Public TypeAlias - - - - -##### Signature - - -```ts -type VecLike = Vec2d | Vec2dModel -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - diff --git a/docs/gen/VideoShape-var.mdx b/docs/gen/VideoShape-var.mdx deleted file mode 100644 index c28a82979..000000000 --- a/docs/gen/VideoShape-var.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: VideoShape -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 194 ----Public Readonly Variable - - - - -##### Signature - - -```ts -VideoShape: import('../../../config/defineShape').TLShapeInfo< - import('@tldraw/tlschema').TLVideoShape -> -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLVideoShape](/gen/tlschema/TLVideoShape-type) - diff --git a/docs/gen/VideoShapeUtil-class.mdx b/docs/gen/VideoShapeUtil-class.mdx deleted file mode 100644 index 843a64da7..000000000 --- a/docs/gen/VideoShapeUtil-class.mdx +++ /dev/null @@ -1,224 +0,0 @@ ---- -title: VideoShapeUtil -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 195 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [canEdit](#VideoShapeUtil-canEdit-member) - - [isAspectRatioLocked](#VideoShapeUtil-isAspectRatioLocked-member) - - [type](#VideoShapeUtil-type-member) -- [Methods](#methods) - - [component](#VideoShapeUtil-component-member-1) - - [getDefaultProps](#VideoShapeUtil-getDefaultProps-member-1) - - [indicator](#VideoShapeUtil-indicator-member-1) - - [toSvg](#VideoShapeUtil-toSvg-member-1) -
- - - - -##### Signature - - -```ts -class VideoShapeUtil extends BaseBoxShapeUtil {} -``` - -##### References - -[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLVideoShape](/gen/tlschema/TLVideoShape-type) - ---- - -## Properties - -### `canEdit` \{#VideoShapeUtil-canEdit-member} - -Public Property - -##### Signature - - -```ts -canEdit: () => boolean -``` - ---- - -### `isAspectRatioLocked` \{#VideoShapeUtil-isAspectRatioLocked-member} - -Public Property - -##### Signature - - -```ts -isAspectRatioLocked: () => boolean -``` - ---- - -### `type` \{#VideoShapeUtil-type-member} - -Public Static Property - -##### Signature - - -```ts -static type: 'video' -``` - ---- - -## Methods - -### `component()` \{#VideoShapeUtil-component-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLVideoShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLVideoShape](/gen/tlschema/TLVideoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `getDefaultProps()` \{#VideoShapeUtil-getDefaultProps-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -TLVideoShape['props'] -``` - -##### References - -[TLVideoShape](/gen/tlschema/TLVideoShape-type) - ---- - -### `indicator()` \{#VideoShapeUtil-indicator-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLVideoShape -``` - - - - - - - -##### Returns - - -```ts -JSX.Element -``` - -##### References - -[TLVideoShape](/gen/tlschema/TLVideoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface) - ---- - -### `toSvg()` \{#VideoShapeUtil-toSvg-member-1} - -Public Method - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLVideoShape -``` - - - - - - - -##### Returns - - -```ts -SVGGElement -``` - -##### References - -[TLVideoShape](/gen/tlschema/TLVideoShape-type), [SVGGElement](/gen/SVGGElement-interface) - ---- - diff --git a/docs/gen/WeakMapCache-class.mdx b/docs/gen/WeakMapCache-class.mdx deleted file mode 100644 index 43789092b..000000000 --- a/docs/gen/WeakMapCache-class.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: WeakMapCache -status: published -category: editor -group: Class -author: api -date: 06/23/2023 -order: 196 ----Public Class - -
- Table of Contents -- [Properties](#properties) - - [items](#WeakMapCache-items-member) -- [Methods](#methods) - - [access](#WeakMapCache-access-member-1) - - [bust](#WeakMapCache-bust-member-1) - - [get](#WeakMapCache-get-member-1) - - [has](#WeakMapCache-has-member-1) - - [invalidate](#WeakMapCache-invalidate-member-1) - - [set](#WeakMapCache-set-member-1) -
- - - - -##### Signature - - -```ts -class WeakMapCache {} -``` - ---- - -## Properties - -### `items` \{#WeakMapCache-items-member} - -Public Property - -##### Signature - - -```ts -items: WeakMap -``` - -##### References - -[WeakMap](/gen/WeakMap-interface) - ---- - -## Methods - -### `access()` \{#WeakMapCache-access-member-1} - -Public Method - -##### Parameters - - - - - - - -`item` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -K | undefined -``` - ---- - -### `bust()` \{#WeakMapCache-bust-member-1} - -Public Method - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - ---- - -### `get()` \{#WeakMapCache-get-member-1} - -Public Method - -##### Parameters - - - - - - - -`item` - - - - -```ts -P -``` - - - - - - - - -`cb` - - - - -```ts -(item: P) => K -``` - - - - - - - -##### Returns - - -```ts -NonNullable -``` - -##### References - -[NonNullable](/gen/NonNullable-type) - ---- - -### `has()` \{#WeakMapCache-has-member-1} - -Public Method - -##### Parameters - - - - - - - -`item` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - ---- - -### `invalidate()` \{#WeakMapCache-invalidate-member-1} - -Public Method - -##### Parameters - - - - - - - -`item` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - -### `set()` \{#WeakMapCache-set-member-1} - -Public Method - -##### Parameters - - - - - - - -`item` - - - - -```ts -T -``` - - - - - - - - -`value` - - - - -```ts -K -``` - - - - - - - -##### Returns - - -```ts -void -``` - ---- - diff --git a/docs/gen/angleDelta-function-1.mdx b/docs/gen/angleDelta-function-1.mdx deleted file mode 100644 index bcc0cebe8..000000000 --- a/docs/gen/angleDelta-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: angleDelta -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 0 ----Public Function - -Get the short distance between two angles. - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The first angle. - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The second angle. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/approximately-function-1.mdx b/docs/gen/approximately-function-1.mdx deleted file mode 100644 index 828bad18f..000000000 --- a/docs/gen/approximately-function-1.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: approximately -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 1 ----Public Function - -Whether two numbers numbers a and b are approximately equal. - - -##### Parameters - - - - - - - -`a` - - - - -```ts -number -``` - -The first point. - - - - - - - - - -`b` - - - - -```ts -number -``` - -The second point. - - - - - - - - - -`precision` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/areAnglesCompatible-function-1.mdx b/docs/gen/areAnglesCompatible-function-1.mdx deleted file mode 100644 index 5b23024dc..000000000 --- a/docs/gen/areAnglesCompatible-function-1.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: areAnglesCompatible -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 2 ----Public Function - -Checks whether two angles are approximately at right-angles or parallel to each other - - -##### Parameters - - - - - - - -`a` - - - - -```ts -number -``` - -Angle a (radians) - - - - - - - - - -`b` - - - - -```ts -number -``` - -Angle b (radians) - - - - - - - - -##### Returns - - -```ts -boolean -``` - - True iff the angles are approximately at right-angles or parallel to each other - - diff --git a/docs/gen/arrowShapeProps-var.mdx b/docs/gen/arrowShapeProps-var.mdx deleted file mode 100644 index bb8e070a9..000000000 --- a/docs/gen/arrowShapeProps-var.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: arrowShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 2 ----Public Readonly Variable - - - - -##### Signature - - -```ts -arrowShapeProps: { - labelColor: import('../styles/StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - color: import('../styles/StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - fill: import('../styles/StyleProp').EnumStyleProp< - 'none' | 'pattern' | 'semi' | 'solid' - > - dash: import('../styles/StyleProp').EnumStyleProp< - 'dashed' | 'dotted' | 'draw' | 'solid' - > - size: import('../styles/StyleProp').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - arrowheadStart: import('../styles/StyleProp').EnumStyleProp< - | 'arrow' - | 'bar' - | 'diamond' - | 'dot' - | 'inverted' - | 'none' - | 'pipe' - | 'square' - | 'triangle' - > - arrowheadEnd: import('../styles/StyleProp').EnumStyleProp< - | 'arrow' - | 'bar' - | 'diamond' - | 'dot' - | 'inverted' - | 'none' - | 'pipe' - | 'square' - | 'triangle' - > - font: import('../styles/StyleProp').EnumStyleProp< - 'draw' | 'mono' | 'sans' | 'serif' - > - start: T.UnionValidator< - 'type', - { - binding: T.ObjectValidator<{ - type: 'binding' - boundShapeId: import('..').TLShapeId - normalizedAnchor: import('../misc/geometry-types').Vec2dModel - isExact: boolean - }> - point: T.ObjectValidator<{ - type: 'point' - x: number - y: number - }> - }, - never - > - end: T.UnionValidator< - 'type', - { - binding: T.ObjectValidator<{ - type: 'binding' - boundShapeId: import('..').TLShapeId - normalizedAnchor: import('../misc/geometry-types').Vec2dModel - isExact: boolean - }> - point: T.ObjectValidator<{ - type: 'point' - x: number - y: number - }> - }, - never - > - bend: T.Validator - text: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.UnionValidator](/gen/validate/UnionValidator-class), [T.ObjectValidator](/gen/validate/ObjectValidator-class), [TLShapeId](/gen/tlschema/TLShapeId-type), [Vec2dModel](/gen/tlschema/Vec2dModel-interface), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/assertIdType-function-1.mdx b/docs/gen/assertIdType-function-1.mdx deleted file mode 100644 index ab251a015..000000000 --- a/docs/gen/assertIdType-function-1.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: assertIdType -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 1 ----Public Function - -Assert whether an id correspond to a record type. - - - - -##### Example - - - - -```ts -assertIdType(myId, 'shape') -``` - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string | undefined -``` - -The id to check. - - - - - - - - - -`type` - - - - -```ts -RecordType -``` - -The type of the record. - - - - - - - - -##### Returns - - -```ts -asserts id is IdOf -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [RecordType](/gen/store/RecordType-class), [id](/gen/store/~id), [IdOf](/gen/store/IdOf-type) - diff --git a/docs/gen/assetIdValidator-var.mdx b/docs/gen/assetIdValidator-var.mdx deleted file mode 100644 index d10c87f1f..000000000 --- a/docs/gen/assetIdValidator-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: assetIdValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 3 ----Public Readonly Variable - -A validator for asset record type Ids. - - -##### Signature - - -```ts -assetIdValidator: T.Validator -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLAssetId](/gen/tlschema/TLAssetId-type) - diff --git a/docs/gen/blobAsString-function-1.mdx b/docs/gen/blobAsString-function-1.mdx deleted file mode 100644 index e38396b4f..000000000 --- a/docs/gen/blobAsString-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: blobAsString -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 7 ----Public Function - - - - -##### Parameters - - - - - - - -`blob` - - - - -```ts -Blob -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Blob](/gen/Blob-interface), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/bookmarkShapeProps-var.mdx b/docs/gen/bookmarkShapeProps-var.mdx deleted file mode 100644 index a7833ad7b..000000000 --- a/docs/gen/bookmarkShapeProps-var.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: bookmarkShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 5 ----Public Readonly Variable - - - - -##### Signature - - -```ts -bookmarkShapeProps: { - w: T.Validator - h: T.Validator - assetId: T.Validator - url: T.Validator -} -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLAssetId](/gen/tlschema/TLAssetId-type) - diff --git a/docs/gen/box2dModelValidator-var.mdx b/docs/gen/box2dModelValidator-var.mdx deleted file mode 100644 index 7da362c55..000000000 --- a/docs/gen/box2dModelValidator-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: box2dModelValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 7 ----Public Readonly Variable - - - - -##### Signature - - -```ts -box2dModelValidator: T.Validator -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [Box2dModel](/gen/tlschema/Box2dModel-interface) - diff --git a/docs/gen/canolicalizeRotation-function-1.mdx b/docs/gen/canolicalizeRotation-function-1.mdx deleted file mode 100644 index 22ff2757a..000000000 --- a/docs/gen/canolicalizeRotation-function-1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: canolicalizeRotation -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 4 ----Public Function - - - -##### Parameters - - - - - - - -`a` - - - - -```ts -number -``` - -Any angle in radians - - - - - - - - -##### Returns - - -```ts -number -``` - - A number between 0 and 2 * PI - - diff --git a/docs/gen/canvasUiColorTypeValidator-var.mdx b/docs/gen/canvasUiColorTypeValidator-var.mdx deleted file mode 100644 index fbf153769..000000000 --- a/docs/gen/canvasUiColorTypeValidator-var.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: canvasUiColorTypeValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 9 ----Public Readonly Variable - -A validator for the colors used by tldraw's default shapes. - - -##### Signature - - -```ts -canvasUiColorTypeValidator: T.Validator< - | 'accent' - | 'black' - | 'laser' - | 'muted-1' - | 'selection-fill' - | 'selection-stroke' - | 'white' -> -``` - -##### References - -[T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/checkFlag-var.mdx b/docs/gen/checkFlag-var.mdx deleted file mode 100644 index 3281b8963..000000000 --- a/docs/gen/checkFlag-var.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: checkFlag -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 11 ----Public Readonly Variable - - - - -##### Signature - - -```ts -checkFlag: ( - flag: (() => boolean) | boolean | undefined -) => boolean | undefined -``` - diff --git a/docs/gen/clamp-function-1.mdx b/docs/gen/clamp-function-1.mdx deleted file mode 100644 index 367a61f55..000000000 --- a/docs/gen/clamp-function-1.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: clamp -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 5 ----Public Function - -Clamp a value into a range. - - - - -##### Example - - - - -```ts -const A = clamp(0, 1) // 1 -``` - - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - -The number to clamp. - - - - - - - - - -`min` - - - - -```ts -number -``` - -The minimum value. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/clamp-function-2.mdx b/docs/gen/clamp-function-2.mdx deleted file mode 100644 index 75ef6b7ad..000000000 --- a/docs/gen/clamp-function-2.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: clamp -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 6 ----Public Function - -Clamp a value into a range. - - - - -##### Example - - - - -```ts -const A = clamp(0, 1, 10) // 1 -const B = clamp(11, 1, 10) // 10 -const C = clamp(5, 1, 10) // 5 -``` - - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - -The number to clamp. - - - - - - - - - -`min` - - - - -```ts -number -``` - -The minimum value. - - - - - - - - - -`max` - - - - -```ts -number -``` - -The maximum value. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/clampRadians-function-1.mdx b/docs/gen/clampRadians-function-1.mdx deleted file mode 100644 index d7e6f7234..000000000 --- a/docs/gen/clampRadians-function-1.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: clampRadians -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 7 ----Public Function - -Clamp radians within 0 and 2PI - - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - -The radian value. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/compactMenuItems-function-1.mdx b/docs/gen/compactMenuItems-function-1.mdx deleted file mode 100644 index 23ca836d1..000000000 --- a/docs/gen/compactMenuItems-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: compactMenuItems -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 2 ----Public Function - - - - -##### Parameters - - - - - - - -`arr` - - - - -```ts -T[] -``` - - - - - - - -##### Returns - - -```ts -Exclude[] -``` - -##### References - -[Exclude](/gen/Exclude-type) - diff --git a/docs/gen/compareRecordVersions-function-1.mdx b/docs/gen/compareRecordVersions-function-1.mdx deleted file mode 100644 index 9d2c37603..000000000 --- a/docs/gen/compareRecordVersions-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: compareRecordVersions -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 4 ----Public Function - - - - -##### Parameters - - - - - - - -`a` - - - - -```ts -RecordVersion -``` - - - - - - - - -`b` - - - - -```ts -RecordVersion -``` - - - - - - - -##### Returns - - -```ts --1 | 0 | 1 -``` - -##### References - -[RecordVersion](/gen/store/RecordVersion-type) - diff --git a/docs/gen/compareSchemas-var.mdx b/docs/gen/compareSchemas-var.mdx deleted file mode 100644 index 09f4442f9..000000000 --- a/docs/gen/compareSchemas-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: compareSchemas -status: published -category: store -group: Variable -author: api -date: 06/23/2023 -order: 5 ----Public Readonly Variable - - - - -##### Signature - - -```ts -compareSchemas: (a: SerializedSchema, b: SerializedSchema) => -1 | 0 | 1 -``` - -##### References - -[SerializedSchema](/gen/store/SerializedSchema-interface) - diff --git a/docs/gen/containBoxSize-function-1.mdx b/docs/gen/containBoxSize-function-1.mdx deleted file mode 100644 index 926609009..000000000 --- a/docs/gen/containBoxSize-function-1.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: containBoxSize -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 12 ----Public Function - -Contains the size within the given box size - - -##### Parameters - - - - - - - -`originalSize` - - - - -```ts -BoxWidthHeight -``` - -The size of the asset - - - - - - - - - -`containBoxSize` - - - - -```ts -BoxWidthHeight -``` - -The container size - - - - - - - - -##### Returns - - -```ts -BoxWidthHeight -``` - - Adjusted size - - -##### References - -[BoxWidthHeight](/gen/editor/~BoxWidthHeight-type) - diff --git a/docs/gen/coreShapes-var.mdx b/docs/gen/coreShapes-var.mdx deleted file mode 100644 index 639f3c636..000000000 --- a/docs/gen/coreShapes-var.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: coreShapes -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 13 ----Public Readonly Variable - - - - -##### Signature - - -```ts -coreShapes: readonly [ - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo -] -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [TLImageShape](/gen/tlschema/TLImageShape-type), [TLTextShape](/gen/tlschema/TLTextShape-type) - diff --git a/docs/gen/correctSpacesToNbsp-function-1.mdx b/docs/gen/correctSpacesToNbsp-function-1.mdx deleted file mode 100644 index 34f8ca947..000000000 --- a/docs/gen/correctSpacesToNbsp-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: correctSpacesToNbsp -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 14 ----Public Function - - - - -##### Parameters - - - - - - - -`input` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -string -``` - diff --git a/docs/gen/createAssetValidator-function-1.mdx b/docs/gen/createAssetValidator-function-1.mdx deleted file mode 100644 index 1ca296ecb..000000000 --- a/docs/gen/createAssetValidator-function-1.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: createAssetValidator -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 10 ----Public Function - -Create a validator for an asset record type. - - -##### Parameters - - - - - - - -`type` - - - - -```ts -Type -``` - -The type of the asset - - - - - - - - - -`props` - - - - -```ts -T.Validator -``` - -The validator for the asset's props - - - - - - - - -##### Returns - - -```ts -T.ObjectValidator<{ - id: TLAssetId - typeName: 'asset' - type: Type - props: Props -}> -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [T.ObjectValidator](/gen/validate/ObjectValidator-class), [TLAssetId](/gen/tlschema/TLAssetId-type) - diff --git a/docs/gen/createPresenceStateDerivation-var.mdx b/docs/gen/createPresenceStateDerivation-var.mdx deleted file mode 100644 index b25cb23ca..000000000 --- a/docs/gen/createPresenceStateDerivation-var.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: createPresenceStateDerivation -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 11 ----Public Readonly Variable - - - - -##### Signature - - -```ts -createPresenceStateDerivation: ( - $user: Signal<{ - id: string - color: string - name: string - }>, - instanceId?: TLInstancePresence['id'] -) => (store: TLStore) => Signal -``` - -##### References - -[Signal](/gen/state/Signal-interface), [TLInstancePresence](/gen/tlschema/TLInstancePresence-interface), [TLStore](/gen/tlschema/TLStore-type) - diff --git a/docs/gen/createRecordType-function-1.mdx b/docs/gen/createRecordType-function-1.mdx deleted file mode 100644 index 762425994..000000000 --- a/docs/gen/createRecordType-function-1.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: createRecordType -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 7 ----Public Function - -Create a record type. - - - - -##### Example - - - - -```ts -const Book = createRecordType('book') -``` - - -##### Parameters - - - - - - - -`typeName` - - - - -```ts -R['typeName'] -``` - -The name of the type to create. - - - - - - - - - -`config` - - - - -```ts -{ - migrations?: Migrations - validator?: StoreValidator - scope: RecordScope -} -``` - - - - - - - -##### Returns - - -```ts -RecordType> -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Migrations](/gen/store/Migrations-interface), [StoreValidator](/gen/store/StoreValidator-type), [RecordScope](/gen/store/~RecordScope-type), [RecordType](/gen/store/RecordType-class), [Omit](/gen/Omit-type) - diff --git a/docs/gen/createSessionStateSnapshotSignal-function-1.mdx b/docs/gen/createSessionStateSnapshotSignal-function-1.mdx deleted file mode 100644 index 3d43c8abf..000000000 --- a/docs/gen/createSessionStateSnapshotSignal-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: createSessionStateSnapshotSignal -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 15 ----Public Function - -Creates a signal of the instance state for a given store. - - -##### Parameters - - - - - - - -`store` - - - - -```ts -TLStore -``` - -The store to create the instance state snapshot signal for - - - - - - - - -##### Returns - - -```ts -Signal -``` - - - - -##### References - -[TLStore](/gen/tlschema/TLStore-type), [Signal](/gen/state/Signal-interface), [TLSessionStateSnapshot](/gen/editor/TLSessionStateSnapshot-interface) - diff --git a/docs/gen/createShapeId-function-1.mdx b/docs/gen/createShapeId-function-1.mdx deleted file mode 100644 index 344a4d2d7..000000000 --- a/docs/gen/createShapeId-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: createShapeId -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 12 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - (optional) - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -TLShapeId -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type) - diff --git a/docs/gen/createShapeValidator-function-1.mdx b/docs/gen/createShapeValidator-function-1.mdx deleted file mode 100644 index d467942ba..000000000 --- a/docs/gen/createShapeValidator-function-1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: createShapeValidator -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 13 ----Public Function - - - - -##### Parameters - - - - - - - -`type` - - - - -```ts -Type -``` - - - - - - - - -`props` - - (optional) - - - - -```ts -{ - [K in keyof Props]: T.Validatable -} -``` - - - - - - - -##### Returns - - -```ts -T.ObjectValidator<{ - id: TLShapeId - typeName: 'shape' - x: number - y: number - rotation: number - index: string - parentId: TLParentId - type: Type - isLocked: boolean - opacity: number - props: Props | Record -}> -``` - -##### References - -[T.Validatable](/gen/validate/Validatable-type), [T.ObjectValidator](/gen/validate/ObjectValidator-class), [TLShapeId](/gen/tlschema/TLShapeId-type), [TLParentId](/gen/tlschema/TLParentId-type), [Record](/gen/Record-type) - diff --git a/docs/gen/createTLSchema-function-1.mdx b/docs/gen/createTLSchema-function-1.mdx deleted file mode 100644 index 2ba2f36ef..000000000 --- a/docs/gen/createTLSchema-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: createTLSchema -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 14 ----Public Function - -Create a TLSchema with custom shapes. Custom shapes cannot override default shapes. - - -##### Parameters - - - - - - - -`{ shapes }` - - - - -```ts -{ - shapes: Record -} -``` - - - - - - - -##### Returns - - -```ts -TLSchema -``` - -##### References - -[Record](/gen/Record-type), [SchemaShapeInfo](/gen/tlschema/SchemaShapeInfo-type), [TLSchema](/gen/tlschema/TLSchema-type) - diff --git a/docs/gen/createTLStore-function-1.mdx b/docs/gen/createTLStore-function-1.mdx deleted file mode 100644 index f39baf99d..000000000 --- a/docs/gen/createTLStore-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: createTLStore -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 16 ----Public Function - -A helper for creating a TLStore. Custom shapes cannot override default shapes. - - -##### Parameters - - - - - - - -`{ initialData, defaultName, ...rest }` - - - - -```ts -TLStoreOptions -``` - - - - - - - -##### Returns - - -```ts -TLStore -``` - -##### References - -[TLStoreOptions](/gen/editor/TLStoreOptions-type), [TLStore](/gen/tlschema/TLStore-type) - diff --git a/docs/gen/createTLUser-function-1.mdx b/docs/gen/createTLUser-function-1.mdx deleted file mode 100644 index 0aef5c406..000000000 --- a/docs/gen/createTLUser-function-1.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: createTLUser -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 17 ----Public Function - - - - -##### Parameters - - - - - - - -`opts` - - (optional) - - - - -```ts -{ - derivePresenceState?: - | (( - store: TLStore - ) => Signal) - | undefined - userPreferences?: - | Signal - | undefined - setUserPreferences?: - | ((userPreferences: TLUserPreferences) => void) - | undefined -} -``` - - - - - - - -##### Returns - - -```ts -TLUser -``` - -##### References - -[TLStore](/gen/tlschema/TLStore-type), [Signal](/gen/state/Signal-interface), [TLInstancePresence](/gen/tlschema/TLInstancePresence-interface), [TLUserPreferences](/gen/editor/TLUserPreferences-interface), [TLUser](/gen/editor/~TLUser-interface) - diff --git a/docs/gen/dataTransferItemAsString-function-1.mdx b/docs/gen/dataTransferItemAsString-function-1.mdx deleted file mode 100644 index 5a81962e6..000000000 --- a/docs/gen/dataTransferItemAsString-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: dataTransferItemAsString -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 18 ----Public Function - - - - -##### Parameters - - - - - - - -`item` - - - - -```ts -DataTransferItem -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[DataTransferItem](/gen/DataTransferItem-interface), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/dataUrlToFile-function-1.mdx b/docs/gen/dataUrlToFile-function-1.mdx deleted file mode 100644 index ac26393c2..000000000 --- a/docs/gen/dataUrlToFile-function-1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: dataUrlToFile -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 19 ----Public Function - - - - -##### Parameters - - - - - - - -`url` - - - - -```ts -string -``` - - - - - - - - -`filename` - - - - -```ts -string -``` - - - - - - - - -`mimeType` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Promise](/gen/Promise-interface), [File](/gen/File-interface) - diff --git a/docs/gen/decomposeMatrix2d-function-1.mdx b/docs/gen/decomposeMatrix2d-function-1.mdx deleted file mode 100644 index 23d0fddb3..000000000 --- a/docs/gen/decomposeMatrix2d-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: decomposeMatrix2d -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 11 ----Public Function - - - - -##### Parameters - - - - - - - -`m` - - - - -```ts -MatLike -``` - - - - - - - -##### Returns - - -```ts -{ - x: number - y: number - scaleX: number - scaleY: number - rotation: number -} -``` - -##### References - -[MatLike](/gen/primitives/MatLike-type) - diff --git a/docs/gen/defaultEditorAssetUrls-var.mdx b/docs/gen/defaultEditorAssetUrls-var.mdx deleted file mode 100644 index a606eb197..000000000 --- a/docs/gen/defaultEditorAssetUrls-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: defaultEditorAssetUrls -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 20 ----Public Variable - - - - -##### Signature - - -```ts -defaultEditorAssetUrls: TLEditorAssetUrls -``` - -##### References - -[TLEditorAssetUrls](/gen/editor/TLEditorAssetUrls-type) - diff --git a/docs/gen/defaultEmptyAs-function-1.mdx b/docs/gen/defaultEmptyAs-function-1.mdx deleted file mode 100644 index b354df3f7..000000000 --- a/docs/gen/defaultEmptyAs-function-1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: defaultEmptyAs -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 21 ----Public Function - - - - -##### Parameters - - - - - - - -`str` - - - - -```ts -string -``` - - - - - - - - -`dflt` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -string -``` - diff --git a/docs/gen/defaultShapes-var.mdx b/docs/gen/defaultShapes-var.mdx deleted file mode 100644 index e7b3971ed..000000000 --- a/docs/gen/defaultShapes-var.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: defaultShapes -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 22 ----Public Readonly Variable - - - - -##### Signature - - -```ts -defaultShapes: readonly [ - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo, - TLShapeInfo -] -``` - -##### References - -[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLLineShape](/gen/tlschema/TLLineShape-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLVideoShape](/gen/tlschema/TLVideoShape-type) - diff --git a/docs/gen/defaultTools-var.mdx b/docs/gen/defaultTools-var.mdx deleted file mode 100644 index 9771f59a9..000000000 --- a/docs/gen/defaultTools-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: defaultTools -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 23 ----Public Readonly Variable - - - - -##### Signature - - -```ts -defaultTools: TLStateNodeConstructor[] -``` - -##### References - -[TLStateNodeConstructor](/gen/editor/TLStateNodeConstructor-interface) - diff --git a/docs/gen/defineMigrations-function-1.mdx b/docs/gen/defineMigrations-function-1.mdx deleted file mode 100644 index c0d5af83f..000000000 --- a/docs/gen/defineMigrations-function-1.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: defineMigrations -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 8 ----Public Function - - - - -##### Parameters - - - - - - - -`opts` - - - - -```ts -{ - firstVersion?: CurrentVersion extends number - ? FirstVersion - : never - currentVersion?: CurrentVersion - migrators?: CurrentVersion extends number - ? FirstVersion extends number - ? CurrentVersion extends FirstVersion - ? { - [version in Exclude< - Range<1, CurrentVersion>, - 0 - >]: Migration - } - : { - [version in Exclude< - Range, - FirstVersion - >]: Migration - } - : { - [version in Exclude< - Range<1, CurrentVersion>, - 0 - >]: Migration - } - : never - subTypeKey?: string - subTypeMigrations?: Record -} -``` - - - - - - - -##### Returns - - -```ts -Migrations -``` - -##### References - -[EMPTY_SYMBOL](/gen/store/~EMPTY_SYMBOL-type), [Exclude](/gen/Exclude-type), [Range](/gen/store/~Range_2-type), [Migration](/gen/store/Migration-type), [Record](/gen/Record-type), [BaseMigrationsInfo](/gen/store/~BaseMigrationsInfo-interface), [Migrations](/gen/store/Migrations-interface) - diff --git a/docs/gen/defineShape-function-1.mdx b/docs/gen/defineShape-function-1.mdx deleted file mode 100644 index caf9157c3..000000000 --- a/docs/gen/defineShape-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: defineShape -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 24 ----Public Function - - - - -##### Parameters - - - - - - - -`type` - - - - -```ts -T['type'] -``` - - - - - - - - -`opts` - - - - -```ts -Omit, 'type'> -``` - - - - - - - -##### Returns - - -```ts -TLShapeInfo -``` - -##### References - -[TLUnknownShape](/gen/tlschema/TLUnknownShape-type), [Omit](/gen/Omit-type), [TLShapeInfo](/gen/editor/TLShapeInfo-type) - diff --git a/docs/gen/degreesToRadians-function-1.mdx b/docs/gen/degreesToRadians-function-1.mdx deleted file mode 100644 index 73bbeeac5..000000000 --- a/docs/gen/degreesToRadians-function-1.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: degreesToRadians -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 12 ----Public Function - -Convert degrees to radians. - - -##### Parameters - - - - - - - -`d` - - - - -```ts -number -``` - -The degree in degrees. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/devFreeze-function-1.mdx b/docs/gen/devFreeze-function-1.mdx deleted file mode 100644 index 9568b9122..000000000 --- a/docs/gen/devFreeze-function-1.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: devFreeze -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 9 ----Public Function - -Freeze an object when in development mode. Copied from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze - - - - -##### Example - - - - -```ts -const frozen = devFreeze({ a: 1 }) -``` - - -##### Parameters - - - - - - - -`object` - - - - -```ts -T -``` - -The object to freeze. - - - - - - - - -##### Returns - - -```ts -T -``` - - The frozen object when in development mode, or else the object when in other modes. - - diff --git a/docs/gen/downloadDataURLAsFile-function-1.mdx b/docs/gen/downloadDataURLAsFile-function-1.mdx deleted file mode 100644 index 3727a2e7e..000000000 --- a/docs/gen/downloadDataURLAsFile-function-1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: downloadDataURLAsFile -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 25 ----Public Function - - - - -##### Parameters - - - - - - - -`dataUrl` - - - - -```ts -string -``` - - - - - - - - -`filename` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/drawShapeProps-var.mdx b/docs/gen/drawShapeProps-var.mdx deleted file mode 100644 index 333750d8c..000000000 --- a/docs/gen/drawShapeProps-var.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: drawShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 23 ----Public Readonly Variable - - - - -##### Signature - - -```ts -drawShapeProps: { - color: import('..').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - fill: import('..').EnumStyleProp<'none' | 'pattern' | 'semi' | 'solid'> - dash: import('..').EnumStyleProp<'dashed' | 'dotted' | 'draw' | 'solid'> - size: import('..').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - segments: T.ArrayOfValidator<{ - type: 'free' | 'straight' - points: import('../misc/geometry-types').Vec2dModel[] - }> - isComplete: T.Validator - isClosed: T.Validator - isPen: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.ArrayOfValidator](/gen/validate/ArrayOfValidator-class), [Vec2dModel](/gen/tlschema/Vec2dModel-interface), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/embedShapePermissionDefaults-var.mdx b/docs/gen/embedShapePermissionDefaults-var.mdx deleted file mode 100644 index 9b989e32d..000000000 --- a/docs/gen/embedShapePermissionDefaults-var.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: embedShapePermissionDefaults -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 26 ----Public Readonly Variable - -Permissions with note inline from https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox - - -##### Signature - - -```ts -embedShapePermissionDefaults: { - readonly 'allow-downloads-without-user-activation': false - readonly 'allow-downloads': false - readonly 'allow-modals': false - readonly 'allow-orientation-lock': false - readonly 'allow-pointer-lock': false - readonly 'allow-popups': true - readonly 'allow-popups-to-escape-sandbox': false - readonly 'allow-presentation': false - readonly 'allow-storage-access-by-user-activation': false - readonly 'allow-top-navigation': false - readonly 'allow-top-navigation-by-user-activation': false - readonly 'allow-scripts': true - readonly 'allow-same-origin': true - readonly 'allow-forms': true -} -``` - diff --git a/docs/gen/embedShapeProps-var.mdx b/docs/gen/embedShapeProps-var.mdx deleted file mode 100644 index be57f78c9..000000000 --- a/docs/gen/embedShapeProps-var.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: embedShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 27 ----Public Readonly Variable - - - - -##### Signature - - -```ts -embedShapeProps: { - w: T.Validator - h: T.Validator - url: T.Validator -} -``` - -##### References - -[T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/fileToBase64-function-1.mdx b/docs/gen/fileToBase64-function-1.mdx deleted file mode 100644 index 0f454205e..000000000 --- a/docs/gen/fileToBase64-function-1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: fileToBase64 -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 34 ----Public Function - -Convert a file to base64. - - - - -##### Example - - - - -```ts -const A = fileToBase64('./test.png') -``` - - -##### Parameters - - - - - - - -`file` - - - - -```ts -Blob -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Blob](/gen/Blob-interface), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/findMenuItem-function-1.mdx b/docs/gen/findMenuItem-function-1.mdx deleted file mode 100644 index 024416f00..000000000 --- a/docs/gen/findMenuItem-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: findMenuItem -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 6 ----Public Function - - - - -##### Parameters - - - - - - - -`menu` - - - - -```ts -TLUiMenuSchema -``` - - - - - - - - -`path` - - - - -```ts -string[] -``` - - - - - - - -##### Returns - - -```ts -TLUiMenuChild -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type), [TLUiMenuChild](/gen/ui/TLUiMenuChild-type) - diff --git a/docs/gen/flipSelectionHandleX-function-1.mdx b/docs/gen/flipSelectionHandleX-function-1.mdx deleted file mode 100644 index 8bfa6db31..000000000 --- a/docs/gen/flipSelectionHandleX-function-1.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: flipSelectionHandleX -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 16 ----Public Function - - - - -##### Parameters - - - - - - - -`handle` - - - - -```ts -SelectionHandle -``` - - - - - - - -##### Returns - - -```ts - | 'bottom_left' - | 'bottom_right' - | 'bottom' - | 'left' - | 'right' - | 'top_left' - | 'top_right' - | 'top' -``` - -##### References - -[SelectionHandle](/gen/primitives/SelectionHandle-type) - diff --git a/docs/gen/flipSelectionHandleY-function-1.mdx b/docs/gen/flipSelectionHandleY-function-1.mdx deleted file mode 100644 index 85333acd3..000000000 --- a/docs/gen/flipSelectionHandleY-function-1.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: flipSelectionHandleY -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 17 ----Public Function - - - - -##### Parameters - - - - - - - -`handle` - - - - -```ts -SelectionHandle -``` - - - - - - - -##### Returns - - -```ts - | 'bottom_left' - | 'bottom_right' - | 'bottom' - | 'left' - | 'right' - | 'top_left' - | 'top_right' - | 'top' -``` - -##### References - -[SelectionHandle](/gen/primitives/SelectionHandle-type) - diff --git a/docs/gen/frameShapeProps-var.mdx b/docs/gen/frameShapeProps-var.mdx deleted file mode 100644 index ad0697869..000000000 --- a/docs/gen/frameShapeProps-var.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: frameShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 29 ----Public Readonly Variable - - - - -##### Signature - - -```ts -frameShapeProps: { - w: T.Validator - h: T.Validator - name: T.Validator -} -``` - -##### References - -[T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/geoShapeProps-var.mdx b/docs/gen/geoShapeProps-var.mdx deleted file mode 100644 index f18374c79..000000000 --- a/docs/gen/geoShapeProps-var.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: geoShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 31 ----Public Readonly Variable - - - - -##### Signature - - -```ts -geoShapeProps: { - geo: import('../styles/StyleProp').EnumStyleProp< - | 'arrow-down' - | 'arrow-left' - | 'arrow-right' - | 'arrow-up' - | 'check-box' - | 'diamond' - | 'ellipse' - | 'hexagon' - | 'octagon' - | 'oval' - | 'pentagon' - | 'rectangle' - | 'rhombus-2' - | 'rhombus' - | 'star' - | 'trapezoid' - | 'triangle' - | 'x-box' - > - labelColor: import('../styles/StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - color: import('../styles/StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - fill: import('../styles/StyleProp').EnumStyleProp< - 'none' | 'pattern' | 'semi' | 'solid' - > - dash: import('../styles/StyleProp').EnumStyleProp< - 'dashed' | 'dotted' | 'draw' | 'solid' - > - size: import('../styles/StyleProp').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - font: import('../styles/StyleProp').EnumStyleProp< - 'draw' | 'mono' | 'sans' | 'serif' - > - align: import('../styles/StyleProp').EnumStyleProp< - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - > - verticalAlign: import('../styles/StyleProp').EnumStyleProp< - 'end' | 'middle' | 'start' - > - url: T.Validator - w: T.Validator - h: T.Validator - growY: T.Validator - text: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/getArcLength-function-1.mdx b/docs/gen/getArcLength-function-1.mdx deleted file mode 100644 index c4f2fcdfd..000000000 --- a/docs/gen/getArcLength-function-1.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: getArcLength -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 18 ----Public Function - -Get the length of an arc between two points on a circle's perimeter. - - -##### Parameters - - - - - - - -`C` - - - - -```ts -VecLike -``` - -The circle's center as [x, y]. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The circle's radius. - - - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The first point. - - - - - - - - - -`B` - - - - -```ts -VecLike -``` - -The second point. - - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getDefaultTranslationLocale-function-1.mdx b/docs/gen/getDefaultTranslationLocale-function-1.mdx deleted file mode 100644 index 8b2646c07..000000000 --- a/docs/gen/getDefaultTranslationLocale-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: getDefaultTranslationLocale -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 32 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLLanguage['locale'] -``` - -##### References - -[TLLanguage](/gen/tlschema/TLLanguage-type) - diff --git a/docs/gen/getDrawLinePathData-function-1.mdx b/docs/gen/getDrawLinePathData-function-1.mdx deleted file mode 100644 index c2d3415a4..000000000 --- a/docs/gen/getDrawLinePathData-function-1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: getDrawLinePathData -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 19 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`outline` - - - - -```ts -VecLike[] -``` - - - - - - - - -`strokeWidth` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -string[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getEmbedInfo-function-1.mdx b/docs/gen/getEmbedInfo-function-1.mdx deleted file mode 100644 index fcc5e7ff6..000000000 --- a/docs/gen/getEmbedInfo-function-1.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: getEmbedInfo -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 39 ----Public Function - -Tests whether an URL supports embedding and returns the result. If we encounter an error, we return undefined. - - -##### Parameters - - - - - - - -`inputUrl` - - - - -```ts -string -``` - -The URL to match - - - - - - - - -##### Returns - - -```ts -TLEmbedResult -``` - -##### References - -[TLEmbedResult](/gen/editor/TLEmbedResult-type) - diff --git a/docs/gen/getEmbedInfoUnsafely-function-1.mdx b/docs/gen/getEmbedInfoUnsafely-function-1.mdx deleted file mode 100644 index db62552e8..000000000 --- a/docs/gen/getEmbedInfoUnsafely-function-1.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: getEmbedInfoUnsafely -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 40 ----Public Function - -Tests whether an URL supports embedding and returns the result. - - -##### Parameters - - - - - - - -`inputUrl` - - - - -```ts -string -``` - -The URL to match - - - - - - - - -##### Returns - - -```ts -TLEmbedResult -``` - -##### References - -[TLEmbedResult](/gen/editor/TLEmbedResult-type) - diff --git a/docs/gen/getFileMetaData-function-1.mdx b/docs/gen/getFileMetaData-function-1.mdx deleted file mode 100644 index 9f92794a1..000000000 --- a/docs/gen/getFileMetaData-function-1.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: getFileMetaData -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 41 ----Public Function - -Get some metadata about the file - - -##### Parameters - - - - - - - -`file` - - - - -```ts -File -``` - -The file. - - - - - - - - -##### Returns - - -```ts -Promise<{ - isAnimated: boolean -}> -``` - -##### References - -[File](/gen/File-interface), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/getFreshUserPreferences-function-1.mdx b/docs/gen/getFreshUserPreferences-function-1.mdx deleted file mode 100644 index 02063097a..000000000 --- a/docs/gen/getFreshUserPreferences-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: getFreshUserPreferences -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 42 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUserPreferences -``` - -##### References - -[TLUserPreferences](/gen/editor/TLUserPreferences-interface) - diff --git a/docs/gen/getHeight-function-1.mdx b/docs/gen/getHeight-function-1.mdx deleted file mode 100644 index 33df487e3..000000000 --- a/docs/gen/getHeight-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getHeight -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 20 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getImageSizeFromSrc-function-1.mdx b/docs/gen/getImageSizeFromSrc-function-1.mdx deleted file mode 100644 index 7509a6e95..000000000 --- a/docs/gen/getImageSizeFromSrc-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: getImageSizeFromSrc -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 43 ----Public Function - -Get the size of an image from its source. - - -##### Parameters - - - - - - - -`dataURL` - - - - -```ts -string -``` - -The file as a string. - - - - - - - - -##### Returns - - -```ts -Promise<{ - w: number - h: number -}> -``` - -##### References - -[Promise](/gen/Promise-interface) - diff --git a/docs/gen/getIncrementedName-function-1.mdx b/docs/gen/getIncrementedName-function-1.mdx deleted file mode 100644 index 44f3eb5a1..000000000 --- a/docs/gen/getIncrementedName-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: getIncrementedName -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 44 ----Public Function - -Get an incremented name (e.g. New page (2)) from a name (e.g. New page), based on an array of existing names. - - -##### Parameters - - - - - - - -`name` - - - - -```ts -string -``` - -The name to increment. - - - - - - - - - -`others` - - - - -```ts -string[] -``` - -The array of existing names. - - - - - - - - -##### Returns - - -```ts -string -``` - diff --git a/docs/gen/getMaxX-function-1.mdx b/docs/gen/getMaxX-function-1.mdx deleted file mode 100644 index c205d174c..000000000 --- a/docs/gen/getMaxX-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMaxX -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 21 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getMaxY-function-1.mdx b/docs/gen/getMaxY-function-1.mdx deleted file mode 100644 index 1f5d4811e..000000000 --- a/docs/gen/getMaxY-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMaxY -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 22 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getMediaAssetFromFile-function-1.mdx b/docs/gen/getMediaAssetFromFile-function-1.mdx deleted file mode 100644 index 5e45ea64e..000000000 --- a/docs/gen/getMediaAssetFromFile-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: getMediaAssetFromFile -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 45 ----Public Function - -Get an asset from a file. - - -##### Parameters - - - - - - - -`file` - - - - -```ts -File -``` - -The file. - - - - - - - - -##### Returns - - -```ts -Promise -``` - - An image or video asset partial. - - -##### References - -[File](/gen/File-interface), [Promise](/gen/Promise-interface), [TLAsset](/gen/tlschema/TLAsset-type) - diff --git a/docs/gen/getMidX-function-1.mdx b/docs/gen/getMidX-function-1.mdx deleted file mode 100644 index d762803d2..000000000 --- a/docs/gen/getMidX-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMidX -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 23 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getMidY-function-1.mdx b/docs/gen/getMidY-function-1.mdx deleted file mode 100644 index ed29e8731..000000000 --- a/docs/gen/getMidY-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMidY -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 24 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getMinX-function-1.mdx b/docs/gen/getMinX-function-1.mdx deleted file mode 100644 index 9cd2ffd54..000000000 --- a/docs/gen/getMinX-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMinX -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 25 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getMinY-function-1.mdx b/docs/gen/getMinY-function-1.mdx deleted file mode 100644 index 7fc2f7f5d..000000000 --- a/docs/gen/getMinY-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getMinY -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 26 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getPointOnCircle-function-1.mdx b/docs/gen/getPointOnCircle-function-1.mdx deleted file mode 100644 index 7282bb3d6..000000000 --- a/docs/gen/getPointOnCircle-function-1.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: getPointOnCircle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 27 ----Public Function - -Get a point on the perimeter of a circle. - - -##### Parameters - - - - - - - -`cx` - - - - -```ts -number -``` - -The center x of the circle. - - - - - - - - - -`cy` - - - - -```ts -number -``` - -The center y of the circle. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The radius of the circle. - - - - - - - - - -`a` - - - - -```ts -number -``` - -The normalized point on the circle. - - - - - - - - -##### Returns - - -```ts -Vec2d -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/getPolygonVertices-function-1.mdx b/docs/gen/getPolygonVertices-function-1.mdx deleted file mode 100644 index 4e7dc3d26..000000000 --- a/docs/gen/getPolygonVertices-function-1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: getPolygonVertices -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 28 ----Public Function - - - - -##### Parameters - - - - - - - -`width` - - - - -```ts -number -``` - - - - - - - - -`height` - - - - -```ts -number -``` - - - - - - - - -`sides` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/getRecordVersion-function-1.mdx b/docs/gen/getRecordVersion-function-1.mdx deleted file mode 100644 index 75ab37eba..000000000 --- a/docs/gen/getRecordVersion-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: getRecordVersion -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 10 ----Public Function - - - - -##### Parameters - - - - - - - -`record` - - - - -```ts -UnknownRecord -``` - - - - - - - - -`serializedSchema` - - - - -```ts -SerializedSchema -``` - - - - - - - -##### Returns - - -```ts -RecordVersion -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [SerializedSchema](/gen/store/SerializedSchema-interface), [RecordVersion](/gen/store/RecordVersion-type) - diff --git a/docs/gen/getResizedImageDataUrl-function-1.mdx b/docs/gen/getResizedImageDataUrl-function-1.mdx deleted file mode 100644 index 7cd17edb3..000000000 --- a/docs/gen/getResizedImageDataUrl-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: getResizedImageDataUrl -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 46 ----Public Function - -Get the size of an image from its source. - - -##### Parameters - - - - - - - -`dataURLForImage` - - - - -```ts -string -``` - -The image file as a string. - - - - - - - - - -`width` - - - - -```ts -number -``` - -The desired width. - - - - - - - - - -`height` - - - - -```ts -number -``` - -The desired height. - - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Promise](/gen/Promise-interface) - diff --git a/docs/gen/getRotatedBoxShadow-function-1.mdx b/docs/gen/getRotatedBoxShadow-function-1.mdx deleted file mode 100644 index a73b4c3dd..000000000 --- a/docs/gen/getRotatedBoxShadow-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: getRotatedBoxShadow -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 47 ----Public Function - - - - -##### Parameters - - - - - - - -`rotation` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -string -``` - diff --git a/docs/gen/getRoundedInkyPolygonPath-function-1.mdx b/docs/gen/getRoundedInkyPolygonPath-function-1.mdx deleted file mode 100644 index 00a3e9ef2..000000000 --- a/docs/gen/getRoundedInkyPolygonPath-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getRoundedInkyPolygonPath -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 29 ----Public Function - - - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getRoundedPolygonPoints-function-1.mdx b/docs/gen/getRoundedPolygonPoints-function-1.mdx deleted file mode 100644 index 02949e00b..000000000 --- a/docs/gen/getRoundedPolygonPoints-function-1.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: getRoundedPolygonPoints -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 30 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`outline` - - - - -```ts -VecLike[] -``` - - - - - - - - -`offset` - - - - -```ts -number -``` - - - - - - - - -`roundness` - - - - -```ts -number -``` - - - - - - - - -`passes` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getSplineForLineShape-function-1.mdx b/docs/gen/getSplineForLineShape-function-1.mdx deleted file mode 100644 index cf62a911e..000000000 --- a/docs/gen/getSplineForLineShape-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getSplineForLineShape -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 48 ----Public Function - - - - -##### Parameters - - - - - - - -`shape` - - - - -```ts -TLLineShape -``` - - - - - - - -##### Returns - - -```ts -NonNullable -``` - -##### References - -[TLLineShape](/gen/tlschema/TLLineShape-type), [NonNullable](/gen/NonNullable-type), [CubicSpline2d](/gen/primitives/CubicSpline2d-class), [Polyline2d](/gen/primitives/Polyline2d-class) - diff --git a/docs/gen/getStarBounds-var.mdx b/docs/gen/getStarBounds-var.mdx deleted file mode 100644 index 11ad1b2e5..000000000 --- a/docs/gen/getStarBounds-var.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: getStarBounds -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 31 ----Public Readonly Variable - -Gets the width/height of a star given its input bounds. - - -##### Parameters - - - - - - - -`sides` - - - - -Number of sides - - - - - - - - - -`w` - - - - -T target width - - - - - - - - - -`h` - - - - -Target height - - - - - - - - -##### Signature - - -```ts -getStarBounds: (sides: number, w: number, h: number) => Box2d -``` - -##### References - -[Box2d](/gen/primitives/Box2d-class) - diff --git a/docs/gen/getStroke-function-1.mdx b/docs/gen/getStroke-function-1.mdx deleted file mode 100644 index 4b482f108..000000000 --- a/docs/gen/getStroke-function-1.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: getStroke -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 32 ----Public Function - -## getStroke - - -Get an array of points describing a polygon that surrounds the input points. - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -An array of points (as `[x, y, pressure]` or `{x, y, pressure}`). Pressure is optional in both cases. - - - - - - - - - -`options` - - (optional) - - - - -```ts -StrokeOptions -``` - -An object with options. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [StrokeOptions](/gen/primitives/StrokeOptions-interface), [Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/getStrokeOutlinePoints-function-1.mdx b/docs/gen/getStrokeOutlinePoints-function-1.mdx deleted file mode 100644 index c76ea681c..000000000 --- a/docs/gen/getStrokeOutlinePoints-function-1.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: getStrokeOutlinePoints -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 33 ----Public Function - -## getStrokeOutlinePoints - - -Get an array of points (as `[x, y]`) representing the outline of a stroke. - - -##### Parameters - - - - - - - -`strokePoints` - - - - -```ts -StrokePoint[] -``` - - - - - - - - -`options` - - (optional) - - - - -```ts -StrokeOptions -``` - -An object with options. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[StrokePoint](/gen/primitives/StrokePoint-interface), [StrokeOptions](/gen/primitives/StrokeOptions-interface), [Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/getStrokePoints-function-1.mdx b/docs/gen/getStrokePoints-function-1.mdx deleted file mode 100644 index b9cbf26c9..000000000 --- a/docs/gen/getStrokePoints-function-1.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: getStrokePoints -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 34 ----Public Function - -## getStrokePoints - - -Get an array of points as objects with an adjusted point, pressure, vector, distance, and runningLength. - - -##### Parameters - - - - - - - -`rawInputPoints` - - - - -```ts -VecLike[] -``` - - - - - - - - -`options` - - (optional) - - - - -```ts -StrokeOptions -``` - -An object with options. - - - - - - - - -##### Returns - - -```ts -StrokePoint[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [StrokeOptions](/gen/primitives/StrokeOptions-interface), [StrokePoint](/gen/primitives/StrokePoint-interface) - diff --git a/docs/gen/getSvgAsDataUrl-function-1.mdx b/docs/gen/getSvgAsDataUrl-function-1.mdx deleted file mode 100644 index a7b733f27..000000000 --- a/docs/gen/getSvgAsDataUrl-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getSvgAsDataUrl -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 49 ----Public Function - - - - -##### Parameters - - - - - - - -`svg` - - - - -```ts -SVGElement -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[SVGElement](/gen/SVGElement-interface), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/getSvgAsDataUrlSync-function-1.mdx b/docs/gen/getSvgAsDataUrlSync-function-1.mdx deleted file mode 100644 index 366a2520e..000000000 --- a/docs/gen/getSvgAsDataUrlSync-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getSvgAsDataUrlSync -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 50 ----Public Function - - - - -##### Parameters - - - - - - - -`node` - - - - -```ts -SVGElement -``` - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[SVGElement](/gen/SVGElement-interface) - diff --git a/docs/gen/getSvgAsImage-function-1.mdx b/docs/gen/getSvgAsImage-function-1.mdx deleted file mode 100644 index 4af3e163a..000000000 --- a/docs/gen/getSvgAsImage-function-1.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: getSvgAsImage -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 51 ----Public Function - - - - -##### Parameters - - - - - - - -`svg` - - - - -```ts -SVGElement -``` - - - - - - - - -`options` - - - - -```ts -{ - type: TLCopyType | TLExportType - quality: number - scale: number -} -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[SVGElement](/gen/SVGElement-interface), [TLCopyType](/gen/editor/TLCopyType-type), [TLExportType](/gen/editor/TLExportType-type), [Promise](/gen/Promise-interface), [Blob](/gen/Blob-interface) - diff --git a/docs/gen/getSvgAsString-function-1.mdx b/docs/gen/getSvgAsString-function-1.mdx deleted file mode 100644 index 9230517c8..000000000 --- a/docs/gen/getSvgAsString-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getSvgAsString -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 52 ----Public Function - - - - -##### Parameters - - - - - - - -`svg` - - - - -```ts -SVGElement -``` - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[SVGElement](/gen/SVGElement-interface) - diff --git a/docs/gen/getSvgPathFromStroke-function-1.mdx b/docs/gen/getSvgPathFromStroke-function-1.mdx deleted file mode 100644 index bdda1ff83..000000000 --- a/docs/gen/getSvgPathFromStroke-function-1.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: getSvgPathFromStroke -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 53 ----Public Function - -Turn an array of points into a path of quadradic curves. - - -##### Parameters - - - - - - - -`points` - - - - -```ts -Vec2d[] -``` - -The points returned from perfect-freehand - - - - - - - - - -`closed` - - (optional) - - - - -```ts -boolean -``` - -Whether the stroke is closed - - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/getSvgPathFromStrokePoints-function-1.mdx b/docs/gen/getSvgPathFromStrokePoints-function-1.mdx deleted file mode 100644 index efd08b037..000000000 --- a/docs/gen/getSvgPathFromStrokePoints-function-1.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: getSvgPathFromStrokePoints -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 54 ----Public Function - -Turn an array of stroke points into a path of quadradic curves. - - -##### Parameters - - - - - - - -`points` - - - - -```ts -StrokePoint[] -``` - -The stroke points returned from perfect-freehand - - - - - - - - - -`closed` - - (optional) - - - - -```ts -boolean -``` - -Whether the shape is closed - - - - - - - - -##### Returns - - -```ts -string -``` - -##### References - -[StrokePoint](/gen/primitives/StrokePoint-interface) - diff --git a/docs/gen/getSweep-function-1.mdx b/docs/gen/getSweep-function-1.mdx deleted file mode 100644 index da1d18740..000000000 --- a/docs/gen/getSweep-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: getSweep -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 35 ----Public Function - -Get the "sweep" or short distance between two points on a circle's perimeter. - - -##### Parameters - - - - - - - -`C` - - - - -```ts -VecLike -``` - -The center of the circle. - - - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The first point. - - - - - - - - - -`B` - - - - -```ts -VecLike -``` - -The second point. - - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/getTextBoundingBox-function-1.mdx b/docs/gen/getTextBoundingBox-function-1.mdx deleted file mode 100644 index 61cb9cb7b..000000000 --- a/docs/gen/getTextBoundingBox-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getTextBoundingBox -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 55 ----Public Function - - - - -##### Parameters - - - - - - - -`text` - - - - -```ts -SVGTextElement -``` - - - - - - - -##### Returns - - -```ts -DOMRect -``` - -##### References - -[SVGTextElement](/gen/SVGTextElement-interface), [DOMRect](/gen/DOMRect-interface) - diff --git a/docs/gen/getUserPreferences-function-1.mdx b/docs/gen/getUserPreferences-function-1.mdx deleted file mode 100644 index ff98db263..000000000 --- a/docs/gen/getUserPreferences-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: getUserPreferences -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 56 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUserPreferences -``` - -##### References - -[TLUserPreferences](/gen/editor/TLUserPreferences-interface) - diff --git a/docs/gen/getValidHttpURLList-var.mdx b/docs/gen/getValidHttpURLList-var.mdx deleted file mode 100644 index 43bbcefb9..000000000 --- a/docs/gen/getValidHttpURLList-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: getValidHttpURLList -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 57 ----Public Readonly Variable - - - - -##### Signature - - -```ts -getValidHttpURLList: (url: string) => string[] | undefined -``` - diff --git a/docs/gen/getVideoSizeFromSrc-function-1.mdx b/docs/gen/getVideoSizeFromSrc-function-1.mdx deleted file mode 100644 index 84ad65cd4..000000000 --- a/docs/gen/getVideoSizeFromSrc-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: getVideoSizeFromSrc -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 58 ----Public Function - -Get the size of a video from its source. - - -##### Parameters - - - - - - - -`src` - - - - -```ts -string -``` - -The source of the video. - - - - - - - - -##### Returns - - -```ts -Promise<{ - w: number - h: number -}> -``` - -##### References - -[Promise](/gen/Promise-interface) - diff --git a/docs/gen/getWidth-function-1.mdx b/docs/gen/getWidth-function-1.mdx deleted file mode 100644 index c2b4f5311..000000000 --- a/docs/gen/getWidth-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: getWidth -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 36 ----Public Function - - - - -##### Parameters - - - - - - - -`pts` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -number -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/hardReset-function-1.mdx b/docs/gen/hardReset-function-1.mdx deleted file mode 100644 index bc7606743..000000000 --- a/docs/gen/hardReset-function-1.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: hardReset -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 62 ----Public Function - -Clear the database of all data associated with tldraw. - - -##### Parameters - - - - - - - -`{ shouldReload }` - - (optional) - - - - -```ts -{ - shouldReload?: boolean | undefined -} -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[Promise](/gen/Promise-interface) - diff --git a/docs/gen/hardResetEditor-function-1.mdx b/docs/gen/hardResetEditor-function-1.mdx deleted file mode 100644 index aaef46e39..000000000 --- a/docs/gen/hardResetEditor-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: hardResetEditor -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 63 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/highlightShapeProps-var.mdx b/docs/gen/highlightShapeProps-var.mdx deleted file mode 100644 index 687815c31..000000000 --- a/docs/gen/highlightShapeProps-var.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: highlightShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 33 ----Public Readonly Variable - - - - -##### Signature - - -```ts -highlightShapeProps: { - color: import('..').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - size: import('..').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - segments: T.ArrayOfValidator<{ - type: 'free' | 'straight' - points: import('..').Vec2dModel[] - }> - isComplete: T.Validator - isPen: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.ArrayOfValidator](/gen/validate/ArrayOfValidator-class), [Vec2dModel](/gen/tlschema/Vec2dModel-interface), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/imageShapeProps-var.mdx b/docs/gen/imageShapeProps-var.mdx deleted file mode 100644 index 2e1441085..000000000 --- a/docs/gen/imageShapeProps-var.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: imageShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 34 ----Public Readonly Variable - - - - -##### Signature - - -```ts -imageShapeProps: { - w: T.Validator - h: T.Validator - playing: T.Validator - url: T.Validator - assetId: T.Validator - crop: T.Validator<{ - topLeft: import('../misc/geometry-types').Vec2dModel - bottomRight: import('../misc/geometry-types').Vec2dModel - } | null> -} -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLAssetId](/gen/tlschema/TLAssetId-type), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - diff --git a/docs/gen/intersectCircleCircle-function-1.mdx b/docs/gen/intersectCircleCircle-function-1.mdx deleted file mode 100644 index 30b8c2cb2..000000000 --- a/docs/gen/intersectCircleCircle-function-1.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: intersectCircleCircle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 37 ----Public Function - -Find the intersections between a circle and a circle. - - -##### Parameters - - - - - - - -`c1` - - - - -```ts -VecLike -``` - -The first circle's center. - - - - - - - - - -`r1` - - - - -```ts -number -``` - -The first circle's radius. - - - - - - - - - -`c2` - - - - -```ts -VecLike -``` - -The second circle's center. - - - - - - - - - -`r2` - - - - -```ts -number -``` - -The second circle's radius. - - - - - - - - -##### Returns - - -```ts -Vec2d[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/intersectCirclePolygon-function-1.mdx b/docs/gen/intersectCirclePolygon-function-1.mdx deleted file mode 100644 index feb945e03..000000000 --- a/docs/gen/intersectCirclePolygon-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: intersectCirclePolygon -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 38 ----Public Function - -Find the intersections between a circle and a bounding box. - - -##### Parameters - - - - - - - -`c` - - - - -```ts -VecLike -``` - -The circle's center. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The circle's radius. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points in the polygon. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/intersectCirclePolyline-function-1.mdx b/docs/gen/intersectCirclePolyline-function-1.mdx deleted file mode 100644 index 4cf667795..000000000 --- a/docs/gen/intersectCirclePolyline-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: intersectCirclePolyline -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 39 ----Public Function - -Find the intersections between a circle and a bounding box. - - -##### Parameters - - - - - - - -`c` - - - - -```ts -VecLike -``` - -The circle's center. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The circle's radius. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points in the polyline. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/intersectLineSegmentCircle-function-1.mdx b/docs/gen/intersectLineSegmentCircle-function-1.mdx deleted file mode 100644 index 6587f9dcf..000000000 --- a/docs/gen/intersectLineSegmentCircle-function-1.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: intersectLineSegmentCircle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 40 ----Public Function - -Find the intersections between a line segment and a circle. - - -##### Parameters - - - - - - - -`a1` - - - - -```ts -VecLike -``` - -The segment's first point. - - - - - - - - - -`a2` - - - - -```ts -VecLike -``` - -The segment's second point. - - - - - - - - - -`c` - - - - -```ts -VecLike -``` - -The circle's center. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The circle's radius. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/intersectLineSegmentLineSegment-function-1.mdx b/docs/gen/intersectLineSegmentLineSegment-function-1.mdx deleted file mode 100644 index 8689d3b3d..000000000 --- a/docs/gen/intersectLineSegmentLineSegment-function-1.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: intersectLineSegmentLineSegment -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 41 ----Public Function - -Find the intersection between a line segment and a line segment. - - -##### Parameters - - - - - - - -`a1` - - - - -```ts -VecLike -``` - -The first segment's first point. - - - - - - - - - -`a2` - - - - -```ts -VecLike -``` - -The first segment's second point. - - - - - - - - - -`b1` - - - - -```ts -VecLike -``` - -The second segment's first point. - - - - - - - - - -`b2` - - - - -```ts -VecLike -``` - -The second segment's second point. - - - - - - - - -##### Returns - - -```ts -null | Vec2d -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class) - diff --git a/docs/gen/intersectLineSegmentPolygon-function-1.mdx b/docs/gen/intersectLineSegmentPolygon-function-1.mdx deleted file mode 100644 index 7c4c821e0..000000000 --- a/docs/gen/intersectLineSegmentPolygon-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: intersectLineSegmentPolygon -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 42 ----Public Function - -Find the intersections between a line segment and a closed polygon. - - -##### Parameters - - - - - - - -`a1` - - - - -```ts -VecLike -``` - -The segment's first point. - - - - - - - - - -`a2` - - - - -```ts -VecLike -``` - -The segment's second point. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points in the polygon. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/intersectLineSegmentPolyline-function-1.mdx b/docs/gen/intersectLineSegmentPolyline-function-1.mdx deleted file mode 100644 index 03675a325..000000000 --- a/docs/gen/intersectLineSegmentPolyline-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: intersectLineSegmentPolyline -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 43 ----Public Function - -Find the intersections between a line segment and a polyline. - - -##### Parameters - - - - - - - -`a1` - - - - -```ts -VecLike -``` - -The segment's first point. - - - - - - - - - -`a2` - - - - -```ts -VecLike -``` - -The segment's second point. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points in the polyline. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/intersectPolygonBounds-function-1.mdx b/docs/gen/intersectPolygonBounds-function-1.mdx deleted file mode 100644 index 606b7b6e9..000000000 --- a/docs/gen/intersectPolygonBounds-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: intersectPolygonBounds -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 44 ----Public Function - -Find the intersections between a polygon and a bounding box. - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`bounds` - - - - -```ts -Box2d -``` - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Box2d](/gen/primitives/Box2d-class) - diff --git a/docs/gen/intersectPolygonPolygon-function-1.mdx b/docs/gen/intersectPolygonPolygon-function-1.mdx deleted file mode 100644 index b94887a2f..000000000 --- a/docs/gen/intersectPolygonPolygon-function-1.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: intersectPolygonPolygon -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 45 ----Public Function - -Create a new convex polygon as the intersection of two convex polygons. - - -##### Parameters - - - - - - - -`polygonA` - - - - -```ts -VecLike[] -``` - -An array of points representing the first polygon. - - - - - - - - - -`polygonB` - - - - -```ts -VecLike[] -``` - -An array of points representing the second polygon. - - - - - - - - -##### Returns - - -```ts -null | VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/isAngleBetween-function-1.mdx b/docs/gen/isAngleBetween-function-1.mdx deleted file mode 100644 index 5ad3edabe..000000000 --- a/docs/gen/isAngleBetween-function-1.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: isAngleBetween -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 46 ----Public Function - -Is angle c between angles a and b? - - -##### Parameters - - - - - - - -`a` - - - - -```ts -number -``` - -The first angle. - - - - - - - - - -`b` - - - - -```ts -number -``` - -The second angle. - - - - - - - - - -`c` - - - - -```ts -number -``` - -The third angle. - - - - - - - - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/isAnimated-function-1.mdx b/docs/gen/isAnimated-function-1.mdx deleted file mode 100644 index 94359ccdf..000000000 --- a/docs/gen/isAnimated-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: isAnimated -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 71 ----Public Function - -Checks if buffer contains animated GIF image - - -##### Parameters - - - - - - - -`buffer` - - - - -```ts -ArrayBuffer -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[ArrayBuffer](/gen/ArrayBuffer-interface) - diff --git a/docs/gen/isGIF-function-1.mdx b/docs/gen/isGIF-function-1.mdx deleted file mode 100644 index a0fe7326e..000000000 --- a/docs/gen/isGIF-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: isGIF -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 72 ----Public Function - -Checks if buffer contains GIF image - - -##### Parameters - - - - - - - -`buffer` - - - - -```ts -ArrayBuffer -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[ArrayBuffer](/gen/ArrayBuffer-interface) - diff --git a/docs/gen/isImage-var.mdx b/docs/gen/isImage-var.mdx deleted file mode 100644 index 0d482192d..000000000 --- a/docs/gen/isImage-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: isImage -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 73 ----Public Readonly Variable - - - - -##### Signature - - -```ts -isImage: (ext: string) => boolean -``` - diff --git a/docs/gen/isPageId-function-1.mdx b/docs/gen/isPageId-function-1.mdx deleted file mode 100644 index 4557a2779..000000000 --- a/docs/gen/isPageId-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: isPageId -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 37 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -id is TLPageId -``` - -##### References - -[id](/gen/tlschema/~id), [TLPageId](/gen/tlschema/TLPageId-type) - diff --git a/docs/gen/isSafeFloat-var.mdx b/docs/gen/isSafeFloat-var.mdx deleted file mode 100644 index b2460407e..000000000 --- a/docs/gen/isSafeFloat-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: isSafeFloat -status: published -category: primitives -group: Variable -author: api -date: 06/23/2023 -order: 47 ----Public Readonly Variable - -Check if a float is safe to use. ie: Not too big or small. - - -##### Signature - - -```ts -isSafeFloat: (n: number) => boolean -``` - diff --git a/docs/gen/isSelectionCorner-function-1.mdx b/docs/gen/isSelectionCorner-function-1.mdx deleted file mode 100644 index 71156ab37..000000000 --- a/docs/gen/isSelectionCorner-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: isSelectionCorner -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 48 ----Public Function - - - - -##### Parameters - - - - - - - -`selection` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -selection is SelectionCorner -``` - -##### References - -[selection](/gen/primitives/~selection), [SelectionCorner](/gen/primitives/SelectionCorner-type) - diff --git a/docs/gen/isSerializable-function-1.mdx b/docs/gen/isSerializable-function-1.mdx deleted file mode 100644 index 17c4859b9..000000000 --- a/docs/gen/isSerializable-function-1.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: isSerializable -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 74 ----Public Function - -Get whether a value is serializable. - - - - -##### Example - - - - -```ts -const A = isSerializable(1) // true -const B = isSerializable('a') // true -const C = isSerializable(true) // true -const D = isSerializable(undefined) // false -``` - - -##### Parameters - - - - - - - -`value` - - - - -```ts -any -``` - -The value to check. - - - - - - - - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/isShape-function-1.mdx b/docs/gen/isShape-function-1.mdx deleted file mode 100644 index 1b0a03db2..000000000 --- a/docs/gen/isShape-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: isShape -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 38 ----Public Function - - - - -##### Parameters - - - - - - - -`record` - - (optional) - - - - -```ts -UnknownRecord -``` - - - - - - - -##### Returns - - -```ts -record is TLShape -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [record](/gen/tlschema/~record), [TLShape](/gen/tlschema/TLShape-type) - diff --git a/docs/gen/isShapeId-function-1.mdx b/docs/gen/isShapeId-function-1.mdx deleted file mode 100644 index 9332e9a34..000000000 --- a/docs/gen/isShapeId-function-1.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: isShapeId -status: published -category: tlschema -group: Function -author: api -date: 06/23/2023 -order: 39 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - (optional) - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -id is TLShapeId -``` - -##### References - -[id](/gen/tlschema/~id), [TLShapeId](/gen/tlschema/TLShapeId-type) - diff --git a/docs/gen/isSvgText-var.mdx b/docs/gen/isSvgText-var.mdx deleted file mode 100644 index 9277bf004..000000000 --- a/docs/gen/isSvgText-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: isSvgText -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 75 ----Public Readonly Variable - - - - -##### Signature - - -```ts -isSvgText: (text: string) => boolean -``` - diff --git a/docs/gen/isV1File-function-1.mdx b/docs/gen/isV1File-function-1.mdx deleted file mode 100644 index 576318d3a..000000000 --- a/docs/gen/isV1File-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: isV1File -status: published -category: file-format -group: Function -author: api -date: 06/23/2023 -order: 0 ----Public Function - - - - -##### Parameters - - - - - - - -`data` - - - - -```ts -any -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/isValidHttpURL-var.mdx b/docs/gen/isValidHttpURL-var.mdx deleted file mode 100644 index 59a07e316..000000000 --- a/docs/gen/isValidHttpURL-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: isValidHttpURL -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 76 ----Public Readonly Variable - - - - -##### Signature - - -```ts -isValidHttpURL: (url: string) => boolean -``` - diff --git a/docs/gen/isValidUrl-function-1.mdx b/docs/gen/isValidUrl-function-1.mdx deleted file mode 100644 index f78914028..000000000 --- a/docs/gen/isValidUrl-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: isValidUrl -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 77 ----Public Function - - - - -##### Parameters - - - - - - - -`url` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/lerpAngles-function-1.mdx b/docs/gen/lerpAngles-function-1.mdx deleted file mode 100644 index 38b9b830b..000000000 --- a/docs/gen/lerpAngles-function-1.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: lerpAngles -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 49 ----Public Function - -Interpolate an angle between two angles. - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The first angle. - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The second angle. - - - - - - - - - -`t` - - - - -```ts -number -``` - -The interpolation value. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/lineShapeProps-var.mdx b/docs/gen/lineShapeProps-var.mdx deleted file mode 100644 index f2b85d720..000000000 --- a/docs/gen/lineShapeProps-var.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: lineShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 41 ----Public Readonly Variable - - - - -##### Signature - - -```ts -lineShapeProps: { - color: import('../styles/StyleProp').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - dash: import('../styles/StyleProp').EnumStyleProp< - 'dashed' | 'dotted' | 'draw' | 'solid' - > - size: import('../styles/StyleProp').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - spline: import('../styles/StyleProp').EnumStyleProp<'cubic' | 'line'> - handles: T.DictValidator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.DictValidator](/gen/validate/DictValidator-class), [TLHandle](/gen/tlschema/TLHandle-interface) - diff --git a/docs/gen/linesIntersect-function-1.mdx b/docs/gen/linesIntersect-function-1.mdx deleted file mode 100644 index 844ad6673..000000000 --- a/docs/gen/linesIntersect-function-1.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: linesIntersect -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 52 ----Public Function - - - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`B` - - - - -```ts -VecLike -``` - - - - - - - - -`C` - - - - -```ts -VecLike -``` - - - - - - - - -`D` - - - - -```ts -VecLike -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/loadSessionStateSnapshotIntoStore-function-1.mdx b/docs/gen/loadSessionStateSnapshotIntoStore-function-1.mdx deleted file mode 100644 index e8da1ecb9..000000000 --- a/docs/gen/loadSessionStateSnapshotIntoStore-function-1.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: loadSessionStateSnapshotIntoStore -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 81 ----Public Function - -Loads a snapshot of the editor's instance state into the store of a new editor instance. - - -##### Parameters - - - - - - - -`store` - - - - -```ts -TLStore -``` - -The store to load the instance state into - - - - - - - - - -`snapshot` - - - - -```ts -TLSessionStateSnapshot -``` - -The instance state snapshot to load - - - - - - - - -##### Returns - - -```ts -void -``` - - - - -##### References - -[TLStore](/gen/tlschema/TLStore-type), [TLSessionStateSnapshot](/gen/editor/TLSessionStateSnapshot-interface) - diff --git a/docs/gen/longAngleDist-function-1.mdx b/docs/gen/longAngleDist-function-1.mdx deleted file mode 100644 index e3e7b2cdb..000000000 --- a/docs/gen/longAngleDist-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: longAngleDist -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 53 ----Public Function - -Get the long angle distance between two angles. - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The first angle. - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The second angle. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/loopToHtmlElement-function-1.mdx b/docs/gen/loopToHtmlElement-function-1.mdx deleted file mode 100644 index f3c054244..000000000 --- a/docs/gen/loopToHtmlElement-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: loopToHtmlElement -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 82 ----Public Function - - - - -##### Parameters - - - - - - - -`elm` - - - - -```ts -Element -``` - - - - - - - -##### Returns - - -```ts -HTMLElement -``` - -##### References - -[Element](/gen/Element-interface), [HTMLElement](/gen/HTMLElement-interface) - diff --git a/docs/gen/matchEmbedUrl-function-1.mdx b/docs/gen/matchEmbedUrl-function-1.mdx deleted file mode 100644 index 099634d26..000000000 --- a/docs/gen/matchEmbedUrl-function-1.mdx +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: matchEmbedUrl -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 83 ----Public Function - - - - -##### Parameters - - - - - - - -`url` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts - | { - definition: - | { - readonly type: 'codepen' - readonly title: 'Codepen' - readonly hostnames: readonly ['codepen.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 520 - readonly height: 400 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'codesandbox' - readonly title: 'CodeSandbox' - readonly hostnames: readonly ['codesandbox.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'excalidraw' - readonly title: 'Excalidraw' - readonly hostnames: readonly ['excalidraw.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'felt' - readonly title: 'Felt' - readonly hostnames: readonly ['felt.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'figma' - readonly title: 'Figma' - readonly hostnames: readonly ['figma.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'github_gist' - readonly title: 'GitHub Gist' - readonly hostnames: readonly ['gist.github.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_calendar' - readonly title: 'Google Calendar' - readonly hostnames: readonly ['calendar.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly instructionLink: 'https://support.google.com/calendar/answer/41207?hl=en' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_maps' - readonly title: 'Google Maps' - readonly hostnames: readonly ['google.*'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_slides' - readonly title: 'Google Slides' - readonly hostnames: readonly ['docs.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'observable' - readonly title: 'Observable' - readonly hostnames: readonly ['observablehq.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: false - readonly backgroundColor: '#fff' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'replit' - readonly title: 'Replit' - readonly hostnames: readonly ['replit.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'scratch' - readonly title: 'Scratch' - readonly hostnames: readonly ['scratch.mit.edu'] - readonly width: 520 - readonly height: 400 - readonly doesResize: false - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'spotify' - readonly title: 'Spotify' - readonly hostnames: readonly ['open.spotify.com'] - readonly width: 720 - readonly height: 500 - readonly minHeight: 500 - readonly overrideOutlineRadius: 12 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'tldraw' - readonly title: 'tldraw' - readonly hostnames: readonly [ - 'beta.tldraw.com', - 'lite.tldraw.com', - 'www.tldraw.com' - ] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'vimeo' - readonly title: 'Vimeo' - readonly hostnames: readonly ['vimeo.com', 'player.vimeo.com'] - readonly width: 640 - readonly height: 360 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'youtube' - readonly title: 'YouTube' - readonly hostnames: readonly [ - '*.youtube.com', - 'youtube.com', - 'youtu.be' - ] - readonly width: 800 - readonly height: 450 - readonly doesResize: true - readonly canUnmount: false - readonly overridePermissions: { - readonly 'allow-presentation': true - } - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - url: string - embedUrl: string - } - | undefined -``` - diff --git a/docs/gen/matchUrl-function-1.mdx b/docs/gen/matchUrl-function-1.mdx deleted file mode 100644 index 1907d56e7..000000000 --- a/docs/gen/matchUrl-function-1.mdx +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: matchUrl -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 84 ----Public Function - - - - -##### Parameters - - - - - - - -`url` - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts - | { - definition: - | { - readonly type: 'codepen' - readonly title: 'Codepen' - readonly hostnames: readonly ['codepen.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 520 - readonly height: 400 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'codesandbox' - readonly title: 'CodeSandbox' - readonly hostnames: readonly ['codesandbox.io'] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'excalidraw' - readonly title: 'Excalidraw' - readonly hostnames: readonly ['excalidraw.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'felt' - readonly title: 'Felt' - readonly hostnames: readonly ['felt.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'figma' - readonly title: 'Figma' - readonly hostnames: readonly ['figma.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'github_gist' - readonly title: 'GitHub Gist' - readonly hostnames: readonly ['gist.github.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_calendar' - readonly title: 'Google Calendar' - readonly hostnames: readonly ['calendar.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly instructionLink: 'https://support.google.com/calendar/answer/41207?hl=en' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_maps' - readonly title: 'Google Maps' - readonly hostnames: readonly ['google.*'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'google_slides' - readonly title: 'Google Slides' - readonly hostnames: readonly ['docs.google.*'] - readonly width: 720 - readonly height: 500 - readonly minWidth: 460 - readonly minHeight: 360 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'observable' - readonly title: 'Observable' - readonly hostnames: readonly ['observablehq.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: false - readonly backgroundColor: '#fff' - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'replit' - readonly title: 'Replit' - readonly hostnames: readonly ['replit.com'] - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'scratch' - readonly title: 'Scratch' - readonly hostnames: readonly ['scratch.mit.edu'] - readonly width: 520 - readonly height: 400 - readonly doesResize: false - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'spotify' - readonly title: 'Spotify' - readonly hostnames: readonly ['open.spotify.com'] - readonly width: 720 - readonly height: 500 - readonly minHeight: 500 - readonly overrideOutlineRadius: 12 - readonly doesResize: true - readonly canUnmount: false - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'tldraw' - readonly title: 'tldraw' - readonly hostnames: readonly [ - 'beta.tldraw.com', - 'lite.tldraw.com', - 'www.tldraw.com' - ] - readonly minWidth: 300 - readonly minHeight: 300 - readonly width: 720 - readonly height: 500 - readonly doesResize: true - readonly canUnmount: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'vimeo' - readonly title: 'Vimeo' - readonly hostnames: readonly ['vimeo.com', 'player.vimeo.com'] - readonly width: 640 - readonly height: 360 - readonly doesResize: true - readonly canUnmount: false - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - | { - readonly type: 'youtube' - readonly title: 'YouTube' - readonly hostnames: readonly [ - '*.youtube.com', - 'youtube.com', - 'youtu.be' - ] - readonly width: 800 - readonly height: 450 - readonly doesResize: true - readonly canUnmount: false - readonly overridePermissions: { - readonly 'allow-presentation': true - } - readonly isAspectRatioLocked: true - readonly toEmbedUrl: (url: string) => string | undefined - readonly fromEmbedUrl: (url: string) => string | undefined - } - embedUrl: string - url: string - } - | undefined -``` - diff --git a/docs/gen/menuCustom-function-1.mdx b/docs/gen/menuCustom-function-1.mdx deleted file mode 100644 index ea248f10f..000000000 --- a/docs/gen/menuCustom-function-1.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: menuCustom -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 9 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -Partial<{ - readonlyOk: boolean - disabled: boolean -}> -``` - - - - - - - -##### Returns - - -```ts -{ - id: string - type: 'custom' - disabled: boolean - readonlyOk: boolean -} -``` - -##### References - -[Partial](/gen/Partial-type) - diff --git a/docs/gen/menuGroup-function-1.mdx b/docs/gen/menuGroup-function-1.mdx deleted file mode 100644 index fc29b7893..000000000 --- a/docs/gen/menuGroup-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: menuGroup -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 10 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`children` - - - - -```ts -(false | null | TLUiMenuChild)[] -``` - - - - - - - -##### Returns - - -```ts -null | TLUiMenuGroup -``` - -##### References - -[TLUiMenuChild](/gen/ui/TLUiMenuChild-type), [TLUiMenuGroup](/gen/ui/TLUiMenuGroup-type) - diff --git a/docs/gen/menuItem-function-1.mdx b/docs/gen/menuItem-function-1.mdx deleted file mode 100644 index 37527b64f..000000000 --- a/docs/gen/menuItem-function-1.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: menuItem -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 11 ----Public Function - - - - -##### Parameters - - - - - - - -`actionItem` - - - - -```ts -TLUiActionItem | TLUiToolItem -``` - - - - - - - - -`opts` - - (optional) - - - - -```ts -Partial<{ - checked: boolean - disabled: boolean -}> -``` - - - - - - - -##### Returns - - -```ts -TLUiMenuItem -``` - -##### References - -[TLUiActionItem](/gen/ui/TLUiActionItem-interface), [TLUiToolItem](/gen/ui/TLUiToolItem-interface), [Partial](/gen/Partial-type), [TLUiMenuItem](/gen/ui/TLUiMenuItem-type) - diff --git a/docs/gen/menuSubmenu-function-1.mdx b/docs/gen/menuSubmenu-function-1.mdx deleted file mode 100644 index 90be610dc..000000000 --- a/docs/gen/menuSubmenu-function-1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: menuSubmenu -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 12 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`label` - - - - -```ts -TLUiTranslationKey -``` - - - - - - - - -`children` - - - - -```ts -(false | null | TLUiMenuChild)[] -``` - - - - - - - -##### Returns - - -```ts -null | TLUiSubMenu -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type), [TLUiMenuChild](/gen/ui/TLUiMenuChild-type), [TLUiSubMenu](/gen/ui/TLUiSubMenu-type) - diff --git a/docs/gen/migrate-function-1.mdx b/docs/gen/migrate-function-1.mdx deleted file mode 100644 index 8fbb8ee52..000000000 --- a/docs/gen/migrate-function-1.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: migrate -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 13 ----Public Function - - - - -##### Parameters - - - - - - - -`{ value, migrations, fromVersion, toVersion, }` - - - - -```ts -{ - value: unknown - migrations: Migrations - fromVersion: number - toVersion: number -} -``` - - - - - - - -##### Returns - - -```ts -MigrationResult -``` - -##### References - -[Migrations](/gen/store/Migrations-interface), [MigrationResult](/gen/store/MigrationResult-type) - diff --git a/docs/gen/migrateRecord-function-1.mdx b/docs/gen/migrateRecord-function-1.mdx deleted file mode 100644 index 2275d4ab4..000000000 --- a/docs/gen/migrateRecord-function-1.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: migrateRecord -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 14 ----Public Function - - - - -##### Parameters - - - - - - - -`{ record, migrations, fromVersion, toVersion, }` - - - - -```ts -{ - record: unknown - migrations: Migrations - fromVersion: number - toVersion: number -} -``` - - - - - - - -##### Returns - - -```ts -MigrationResult -``` - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [Migrations](/gen/store/Migrations-interface), [MigrationResult](/gen/store/MigrationResult-type) - diff --git a/docs/gen/normalizeWheel-function-1.mdx b/docs/gen/normalizeWheel-function-1.mdx deleted file mode 100644 index d1c7df76d..000000000 --- a/docs/gen/normalizeWheel-function-1.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: normalizeWheel -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 85 ----Public Function - - - - -##### Parameters - - - - - - - -`event` - - - - -```ts -React.WheelEvent | WheelEvent -``` - - - - - - - -##### Returns - - -```ts -{ - x: number - y: number - z: number -} -``` - -##### References - -[React.WheelEvent](/gen/@types/react-React-WheelEvent-interface), [HTMLElement](/gen/HTMLElement-interface), [WheelEvent](/gen/WheelEvent-interface) - diff --git a/docs/gen/noteShapeProps-var.mdx b/docs/gen/noteShapeProps-var.mdx deleted file mode 100644 index ce83d0017..000000000 --- a/docs/gen/noteShapeProps-var.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: noteShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 43 ----Public Readonly Variable - - - - -##### Signature - - -```ts -noteShapeProps: { - color: import('..').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - size: import('..').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - font: import('..').EnumStyleProp<'draw' | 'mono' | 'sans' | 'serif'> - align: import('..').EnumStyleProp< - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - > - verticalAlign: import('..').EnumStyleProp<'end' | 'middle' | 'start'> - growY: T.Validator - url: T.Validator - text: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/openWindow-function-1.mdx b/docs/gen/openWindow-function-1.mdx deleted file mode 100644 index 10146776d..000000000 --- a/docs/gen/openWindow-function-1.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: openWindow -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 88 ----Public Function - - - - -##### Parameters - - - - - - - -`url` - - - - -```ts -string -``` - - - - - - - - -`target` - - (optional) - - - - -```ts -string -``` - - - - - - - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/parentIdValidator-var.mdx b/docs/gen/parentIdValidator-var.mdx deleted file mode 100644 index e12bad04c..000000000 --- a/docs/gen/parentIdValidator-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: parentIdValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 45 ----Public Readonly Variable - - - - -##### Signature - - -```ts -parentIdValidator: T.Validator -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLParentId](/gen/tlschema/TLParentId-type) - diff --git a/docs/gen/parseTldrawJsonFile-function-1.mdx b/docs/gen/parseTldrawJsonFile-function-1.mdx deleted file mode 100644 index 297da6b1c..000000000 --- a/docs/gen/parseTldrawJsonFile-function-1.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: parseTldrawJsonFile -status: published -category: file-format -group: Function -author: api -date: 06/23/2023 -order: 1 ----Public Function - - - - -##### Parameters - - - - - - - -`{ json, schema, }` - - - - -```ts -{ - schema: TLSchema - json: string -} -``` - - - - - - - -##### Returns - - -```ts -Result -``` - -##### References - -[TLSchema](/gen/tlschema/TLSchema-type), [Result](/gen/utils/Result-type), [TLStore](/gen/tlschema/TLStore-type), [TldrawFileParseError](/gen/file-format/TldrawFileParseError-type) - diff --git a/docs/gen/perimeterOfEllipse-function-1.mdx b/docs/gen/perimeterOfEllipse-function-1.mdx deleted file mode 100644 index d9590e934..000000000 --- a/docs/gen/perimeterOfEllipse-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: perimeterOfEllipse -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 58 ----Public Function - -Find the approximate perimeter of an ellipse. - - -##### Parameters - - - - - - - -`rx` - - - - -```ts -number -``` - -The ellipse's x radius. - - - - - - - - - -`ry` - - - - -```ts -number -``` - -The ellipse's y radius. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/pointInBounds-function-1.mdx b/docs/gen/pointInBounds-function-1.mdx deleted file mode 100644 index dff2a7403..000000000 --- a/docs/gen/pointInBounds-function-1.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: pointInBounds -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 61 ----Public Function - -Get whether a point is inside of a bounds. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`b` - - - - -```ts -Box2d -``` - -The bounds to check. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Boolean - - -##### References - -[VecLike](/gen/primitives/VecLike-type), [Box2d](/gen/primitives/Box2d-class) - diff --git a/docs/gen/pointInCircle-function-1.mdx b/docs/gen/pointInCircle-function-1.mdx deleted file mode 100644 index caca8fbf7..000000000 --- a/docs/gen/pointInCircle-function-1.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: pointInCircle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 62 ----Public Function - -Get whether a point is inside of a circle. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`C` - - - - -```ts -VecLike -``` - -The circle's center point as [x, y]. - - - - - - - - - -`r` - - - - -```ts -number -``` - -The circle's radius. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Boolean - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointInEllipse-function-1.mdx b/docs/gen/pointInEllipse-function-1.mdx deleted file mode 100644 index eaa0693c5..000000000 --- a/docs/gen/pointInEllipse-function-1.mdx +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: pointInEllipse -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 63 ----Public Function - -Get whether a point is inside of an ellipse. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`C` - - - - -```ts -VecLike -``` - - - - - - - - -`rx` - - - - -```ts -number -``` - -The ellipse's x radius. - - - - - - - - - -`ry` - - - - -```ts -number -``` - -The ellipse's y radius. - - - - - - - - - -`rotation` - - (optional) - - - - -```ts -number -``` - -The ellipse's rotation. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Boolean - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointInPolygon-function-1.mdx b/docs/gen/pointInPolygon-function-1.mdx deleted file mode 100644 index a7e7d0dbb..000000000 --- a/docs/gen/pointInPolygon-function-1.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: pointInPolygon -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 64 ----Public Function - -Get whether a point is inside of a polygon. - - -```ts -const result = pointInPolygon(myPoint, myPoints) -``` - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointInPolyline-function-1.mdx b/docs/gen/pointInPolyline-function-1.mdx deleted file mode 100644 index bd5781680..000000000 --- a/docs/gen/pointInPolyline-function-1.mdx +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: pointInPolyline -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 65 ----Public Function - -Hit test a point and a polyline using a minimum distance. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points that make up the polyline. - - - - - - - - - -`distance` - - (optional) - - - - -```ts -number -``` - -The mininum distance that qualifies a hit. - - - - - - - - -##### Returns - - -```ts -boolean -``` - - Boolean - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointInRect-function-1.mdx b/docs/gen/pointInRect-function-1.mdx deleted file mode 100644 index 79cfff08b..000000000 --- a/docs/gen/pointInRect-function-1.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: pointInRect -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 66 ----Public Function - -Get whether a point is inside of a rectangle. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`point` - - - - -```ts -VecLike -``` - -The rectangle's top left point as [x, y]. - - - - - - - - - -`size` - - - - -```ts -VecLike -``` - -The rectangle's size as [width, height]. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointNearToLineSegment-function-1.mdx b/docs/gen/pointNearToLineSegment-function-1.mdx deleted file mode 100644 index bec184662..000000000 --- a/docs/gen/pointNearToLineSegment-function-1.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: pointNearToLineSegment -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 67 ----Public Function - -Get whether a point is within a certain distance from a line segment. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`p1` - - - - -```ts -VecLike -``` - -The polyline's first point. - - - - - - - - - -`p2` - - - - -```ts -VecLike -``` - -The polyline's second point. - - - - - - - - - -`distance` - - (optional) - - - - -```ts -number -``` - -The mininum distance that qualifies a hit. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/pointNearToPolyline-function-1.mdx b/docs/gen/pointNearToPolyline-function-1.mdx deleted file mode 100644 index d82a396ba..000000000 --- a/docs/gen/pointNearToPolyline-function-1.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: pointNearToPolyline -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 68 ----Public Function - -Get whether a point is within a certain distance from a polyline. - - -##### Parameters - - - - - - - -`A` - - - - -```ts -VecLike -``` - -The point to check. - - - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -The points that make up the polyline. - - - - - - - - - -`distance` - - (optional) - - - - -```ts -number -``` - -The mininum distance that qualifies a hit. - - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/polygonsIntersect-function-1.mdx b/docs/gen/polygonsIntersect-function-1.mdx deleted file mode 100644 index d75999b7f..000000000 --- a/docs/gen/polygonsIntersect-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: polygonsIntersect -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 69 ----Public Function - - - - -##### Parameters - - - - - - - -`a` - - - - -```ts -VecLike[] -``` - - - - - - - - -`b` - - - - -```ts -VecLike[] -``` - - - - - - - -##### Returns - - -```ts -boolean -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/preventDefault-function-1.mdx b/docs/gen/preventDefault-function-1.mdx deleted file mode 100644 index de78a4852..000000000 --- a/docs/gen/preventDefault-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: preventDefault -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 90 ----Public Function - -This function calls `event.preventDefault()` for you. Why is that useful? - - -Beacuase if you enable `window.preventDefaultLogging = true` it'll log out a message when it happens. Because we use console.warn rather than (log) you'll get a stack trace in the inspector telling you exactly where it happened. This is important because `e.preventDefault()` is the source of many bugs, but unfortuantly it can't be avoided because it also stops a lot of default behaviour which doesn't make sense in our UI - - -##### Parameters - - - - - - - -`event` - - - - -```ts -Event | React.BaseSyntheticEvent -``` - -To prevent default on - - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Event](/gen/Event-interface), [React.BaseSyntheticEvent](/gen/@types/react-React-BaseSyntheticEvent-interface) - diff --git a/docs/gen/radiansToDegrees-function-1.mdx b/docs/gen/radiansToDegrees-function-1.mdx deleted file mode 100644 index 547fa1a4a..000000000 --- a/docs/gen/radiansToDegrees-function-1.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: radiansToDegrees -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 71 ----Public Function - -Convert radians to degrees. - - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - -The degree in radians. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/rangeIntersection-function-1.mdx b/docs/gen/rangeIntersection-function-1.mdx deleted file mode 100644 index f996f863a..000000000 --- a/docs/gen/rangeIntersection-function-1.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: rangeIntersection -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 72 ----Public Function - -Finds the intersection of two ranges. - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The start point in the A range - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The end point in the A range - - - - - - - - - -`b0` - - - - -```ts -number -``` - -The start point in the B range - - - - - - - - - -`b1` - - - - -```ts -number -``` - -The end point in the B range - - - - - - - - -##### Returns - - -```ts -[number, number] | null -``` - - The intersection of the ranges, or null if no intersection - - diff --git a/docs/gen/rangesOverlap-function-1.mdx b/docs/gen/rangesOverlap-function-1.mdx deleted file mode 100644 index bccc44bdc..000000000 --- a/docs/gen/rangesOverlap-function-1.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: rangesOverlap -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 73 ----Public Function - - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The start point in the A range - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The end point in the A range - - - - - - - - - -`b0` - - - - -```ts -number -``` - -The start point in the B range - - - - - - - - - -`b1` - - - - -```ts -number -``` - -The end point in the B range - - - - - - - - -##### Returns - - -```ts -boolean -``` - - True if the ranges overlap - - diff --git a/docs/gen/refreshPage-function-1.mdx b/docs/gen/refreshPage-function-1.mdx deleted file mode 100644 index d746a3c44..000000000 --- a/docs/gen/refreshPage-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: refreshPage -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 92 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/releasePointerCapture-function-1.mdx b/docs/gen/releasePointerCapture-function-1.mdx deleted file mode 100644 index ae4cfde11..000000000 --- a/docs/gen/releasePointerCapture-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: releasePointerCapture -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 93 ----Public Function - - - - -##### Parameters - - - - - - - -`element` - - - - -```ts -Element -``` - - - - - - - - -`event` - - - - -```ts -PointerEvent | React.PointerEvent -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Element](/gen/Element-interface), [PointerEvent](/gen/PointerEvent-interface), [React.PointerEvent](/gen/@types/react-React-PointerEvent-interface) - diff --git a/docs/gen/reverseRecordsDiff-function-1.mdx b/docs/gen/reverseRecordsDiff-function-1.mdx deleted file mode 100644 index b649d8def..000000000 --- a/docs/gen/reverseRecordsDiff-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: reverseRecordsDiff -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 23 ----Public Function - - - - -##### Parameters - - - - - - - -`diff` - - - - -```ts -RecordsDiff -``` - - - - - - - -##### Returns - - -```ts -RecordsDiff -``` - -##### References - -[RecordsDiff](/gen/store/RecordsDiff-type) - diff --git a/docs/gen/rotateSelectionHandle-function-1.mdx b/docs/gen/rotateSelectionHandle-function-1.mdx deleted file mode 100644 index 48e7248a4..000000000 --- a/docs/gen/rotateSelectionHandle-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: rotateSelectionHandle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 76 ----Public Function - - - - -##### Parameters - - - - - - - -`handle` - - - - -```ts -SelectionHandle -``` - - - - - - - - -`rotation` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -SelectionHandle -``` - -##### References - -[SelectionHandle](/gen/primitives/SelectionHandle-type) - diff --git a/docs/gen/runtime-var.mdx b/docs/gen/runtime-var.mdx deleted file mode 100644 index 380c49e89..000000000 --- a/docs/gen/runtime-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: runtime -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 95 ----Public Readonly Variable - - - - -##### Signature - - -```ts -runtime: { - openWindow: (url: string, target: string) => void - refreshPage: () => void - hardReset: () => void -} -``` - diff --git a/docs/gen/serializeTldrawJson-function-1.mdx b/docs/gen/serializeTldrawJson-function-1.mdx deleted file mode 100644 index be5ed068f..000000000 --- a/docs/gen/serializeTldrawJson-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: serializeTldrawJson -status: published -category: file-format -group: Function -author: api -date: 06/23/2023 -order: 2 ----Public Function - - - - -##### Parameters - - - - - - - -`store` - - - - -```ts -TLStore -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[TLStore](/gen/tlschema/TLStore-type), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/serializeTldrawJsonBlob-function-1.mdx b/docs/gen/serializeTldrawJsonBlob-function-1.mdx deleted file mode 100644 index 0102679cd..000000000 --- a/docs/gen/serializeTldrawJsonBlob-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: serializeTldrawJsonBlob -status: published -category: file-format -group: Function -author: api -date: 06/23/2023 -order: 3 ----Public Function - - - - -##### Parameters - - - - - - - -`store` - - - - -```ts -TLStore -``` - - - - - - - -##### Returns - - -```ts -Promise -``` - -##### References - -[TLStore](/gen/tlschema/TLStore-type), [Promise](/gen/Promise-interface), [Blob](/gen/Blob-interface) - diff --git a/docs/gen/setPointerCapture-function-1.mdx b/docs/gen/setPointerCapture-function-1.mdx deleted file mode 100644 index 011e39944..000000000 --- a/docs/gen/setPointerCapture-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: setPointerCapture -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 96 ----Public Function - - - - -##### Parameters - - - - - - - -`element` - - - - -```ts -Element -``` - - - - - - - - -`event` - - - - -```ts -PointerEvent | React.PointerEvent -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Element](/gen/Element-interface), [PointerEvent](/gen/PointerEvent-interface), [React.PointerEvent](/gen/@types/react-React-PointerEvent-interface) - diff --git a/docs/gen/setRuntimeOverrides-function-1.mdx b/docs/gen/setRuntimeOverrides-function-1.mdx deleted file mode 100644 index 43f9a4aca..000000000 --- a/docs/gen/setRuntimeOverrides-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: setRuntimeOverrides -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 97 ----Public Function - - - - -##### Parameters - - - - - - - -`input` - - - - -```ts -Partial -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[Partial](/gen/Partial-type), [runtime](/gen/editor/runtime-var) - diff --git a/docs/gen/setStrokePointRadii-function-1.mdx b/docs/gen/setStrokePointRadii-function-1.mdx deleted file mode 100644 index 1d26eeae7..000000000 --- a/docs/gen/setStrokePointRadii-function-1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: setStrokePointRadii -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 80 ----Public Function - - - - -##### Parameters - - - - - - - -`strokePoints` - - - - -```ts -StrokePoint[] -``` - - - - - - - - -`options` - - - - -```ts -StrokeOptions -``` - - - - - - - -##### Returns - - -```ts -StrokePoint[] -``` - -##### References - -[StrokePoint](/gen/primitives/StrokePoint-interface), [StrokeOptions](/gen/primitives/StrokeOptions-interface) - diff --git a/docs/gen/setUserPreferences-function-1.mdx b/docs/gen/setUserPreferences-function-1.mdx deleted file mode 100644 index e24d10ebf..000000000 --- a/docs/gen/setUserPreferences-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: setUserPreferences -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 98 ----Public Function - - - - -##### Parameters - - - - - - - -`user` - - - - -```ts -TLUserPreferences -``` - - - - - - - -##### Returns - - -```ts -void -``` - -##### References - -[TLUserPreferences](/gen/editor/TLUserPreferences-interface) - diff --git a/docs/gen/shapeIdValidator-var.mdx b/docs/gen/shapeIdValidator-var.mdx deleted file mode 100644 index 9fc4cb402..000000000 --- a/docs/gen/shapeIdValidator-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: shapeIdValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 48 ----Public Readonly Variable - - - - -##### Signature - - -```ts -shapeIdValidator: T.Validator -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLShapeId](/gen/tlschema/TLShapeId-type) - diff --git a/docs/gen/shortAngleDist-function-1.mdx b/docs/gen/shortAngleDist-function-1.mdx deleted file mode 100644 index bdc5c76ec..000000000 --- a/docs/gen/shortAngleDist-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: shortAngleDist -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 81 ----Public Function - -Get the short angle distance between two angles. - - -##### Parameters - - - - - - - -`a0` - - - - -```ts -number -``` - -The first angle. - - - - - - - - - -`a1` - - - - -```ts -number -``` - -The second angle. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/simplify-function-1.mdx b/docs/gen/simplify-function-1.mdx deleted file mode 100644 index 45e0e9913..000000000 --- a/docs/gen/simplify-function-1.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: simplify -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 82 ----Public Function - -Simplify a line (using Ramer-Douglas-Peucker algorithm). - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - -An array of points as [x, y, ...][] - - - - - - - - - -`tolerance` - - (optional) - - - - -```ts -number -``` - -The minimum line distance (also called epsilon). - - - - - - - - -##### Returns - - -```ts -VecLike[] -``` - - Simplified array as [x, y, ...][] - - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/simplify2-function-1.mdx b/docs/gen/simplify2-function-1.mdx deleted file mode 100644 index 65a4c382c..000000000 --- a/docs/gen/simplify2-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: simplify2 -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 83 ----Public Function - - - - -##### Parameters - - - - - - - -`points` - - - - -```ts -VecLike[] -``` - - - - - - - - -`tolerance` - - (optional) - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -VecLike[] -``` - -##### References - -[VecLike](/gen/primitives/VecLike-type) - diff --git a/docs/gen/snapAngle-function-1.mdx b/docs/gen/snapAngle-function-1.mdx deleted file mode 100644 index 3c53f447d..000000000 --- a/docs/gen/snapAngle-function-1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: snapAngle -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 85 ----Public Function - -Clamp rotation to even segments. - - -##### Parameters - - - - - - - -`r` - - - - -```ts -number -``` - -The rotation in radians. - - - - - - - - - -`segments` - - - - -```ts -number -``` - -The number of segments. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/snapToGrid-function-1.mdx b/docs/gen/snapToGrid-function-1.mdx deleted file mode 100644 index 9f1bb1e68..000000000 --- a/docs/gen/snapToGrid-function-1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: snapToGrid -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 101 ----Public Function - - - - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - - - - - - - - -`gridSize` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/squashRecordDiffs-function-1.mdx b/docs/gen/squashRecordDiffs-function-1.mdx deleted file mode 100644 index ef3d154de..000000000 --- a/docs/gen/squashRecordDiffs-function-1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: squashRecordDiffs -status: published -category: store -group: Function -author: api -date: 06/23/2023 -order: 25 ----Public Function - -Squash a collection of diffs into a single diff. - - -##### Parameters - - - - - - - -`diffs` - - - - -```ts -RecordsDiff[] -``` - -An array of diffs to squash. - - - - - - - - -##### Returns - - -```ts -RecordsDiff -``` - - A single diff that represents the squashed diffs. - - -##### References - -[UnknownRecord](/gen/store/UnknownRecord-type), [RecordsDiff](/gen/store/RecordsDiff-type) - diff --git a/docs/gen/textShapeProps-var.mdx b/docs/gen/textShapeProps-var.mdx deleted file mode 100644 index 88046b305..000000000 --- a/docs/gen/textShapeProps-var.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: textShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 51 ----Public Readonly Variable - - - - -##### Signature - - -```ts -textShapeProps: { - color: import('..').EnumStyleProp< - | 'black' - | 'blue' - | 'green' - | 'grey' - | 'light-blue' - | 'light-green' - | 'light-red' - | 'light-violet' - | 'orange' - | 'red' - | 'violet' - | 'yellow' - > - size: import('..').EnumStyleProp<'l' | 'm' | 's' | 'xl'> - font: import('..').EnumStyleProp<'draw' | 'mono' | 'sans' | 'serif'> - align: import('..').EnumStyleProp< - | 'end-legacy' - | 'end' - | 'middle-legacy' - | 'middle' - | 'start-legacy' - | 'start' - > - w: T.Validator - text: T.Validator - scale: T.Validator - autoSize: T.Validator -} -``` - -##### References - -[EnumStyleProp](/gen/tlschema/EnumStyleProp-class), [T.Validator](/gen/validate/Validator-class) - diff --git a/docs/gen/toDomPrecision-function-1.mdx b/docs/gen/toDomPrecision-function-1.mdx deleted file mode 100644 index 59773518e..000000000 --- a/docs/gen/toDomPrecision-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: toDomPrecision -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 89 ----Public Function - -The DOM likes values to be fixed to 3 decimal places - - -##### Parameters - - - - - - - -`v` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/toFixed-function-1.mdx b/docs/gen/toFixed-function-1.mdx deleted file mode 100644 index a915882b9..000000000 --- a/docs/gen/toFixed-function-1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: toFixed -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 90 ----Public Function - - - - -##### Parameters - - - - - - - -`v` - - - - -```ts -number -``` - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/toPrecision-function-1.mdx b/docs/gen/toPrecision-function-1.mdx deleted file mode 100644 index 88c0dbe01..000000000 --- a/docs/gen/toPrecision-function-1.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: toPrecision -status: published -category: primitives -group: Function -author: api -date: 06/23/2023 -order: 91 ----Public Function - -Get a number to a precision. - - -##### Parameters - - - - - - - -`n` - - - - -```ts -number -``` - -The number. - - - - - - - - - -`precision` - - (optional) - - - - -```ts -number -``` - -The precision. - - - - - - - - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/toolbarItem-function-1.mdx b/docs/gen/toolbarItem-function-1.mdx deleted file mode 100644 index f724b38db..000000000 --- a/docs/gen/toolbarItem-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: toolbarItem -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 55 ----Public Function - - - - -##### Parameters - - - - - - - -`toolItem` - - - - -```ts -TLUiToolItem -``` - - - - - - - -##### Returns - - -```ts -TLUiToolbarItem -``` - -##### References - -[TLUiToolItem](/gen/ui/TLUiToolItem-interface), [TLUiToolbarItem](/gen/ui/TLUiToolbarItem-type) - diff --git a/docs/gen/truncateStringWithEllipsis-var.mdx b/docs/gen/truncateStringWithEllipsis-var.mdx deleted file mode 100644 index 56fbc2f2f..000000000 --- a/docs/gen/truncateStringWithEllipsis-var.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: truncateStringWithEllipsis -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 186 ----Public Readonly Variable - - - - -##### Signature - - -```ts -truncateStringWithEllipsis: (str: string, maxLength: number) => string -``` - diff --git a/docs/gen/uniqueId-function-1.mdx b/docs/gen/uniqueId-function-1.mdx deleted file mode 100644 index daa5a5fd8..000000000 --- a/docs/gen/uniqueId-function-1.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: uniqueId -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 189 ----Public Function - -Generate a unique id. - - - - -##### Example - - - - -```ts -const id = uniqueId() -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -string -``` - diff --git a/docs/gen/useActions-function-1.mdx b/docs/gen/useActions-function-1.mdx deleted file mode 100644 index 2f803d8b7..000000000 --- a/docs/gen/useActions-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useActions -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 56 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiActionsContextType -``` - -##### References - -[TLUiActionsContextType](/gen/ui/TLUiActionsContextType-type) - diff --git a/docs/gen/useActionsMenuSchema-function-1.mdx b/docs/gen/useActionsMenuSchema-function-1.mdx deleted file mode 100644 index 2f5ec32ac..000000000 --- a/docs/gen/useActionsMenuSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useActionsMenuSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 57 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/useBreakpoint-function-1.mdx b/docs/gen/useBreakpoint-function-1.mdx deleted file mode 100644 index c5e0cc2e1..000000000 --- a/docs/gen/useBreakpoint-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useBreakpoint -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 58 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -number -``` - diff --git a/docs/gen/useCanRedo-function-1.mdx b/docs/gen/useCanRedo-function-1.mdx deleted file mode 100644 index 8641c8869..000000000 --- a/docs/gen/useCanRedo-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useCanRedo -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 59 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/useCanUndo-function-1.mdx b/docs/gen/useCanUndo-function-1.mdx deleted file mode 100644 index d828d0c3a..000000000 --- a/docs/gen/useCanUndo-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useCanUndo -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 60 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/useContainer-function-1.mdx b/docs/gen/useContainer-function-1.mdx deleted file mode 100644 index b82a57631..000000000 --- a/docs/gen/useContainer-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useContainer -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 190 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -HTMLDivElement -``` - -##### References - -[HTMLDivElement](/gen/HTMLDivElement-interface) - diff --git a/docs/gen/useContextMenuSchema-function-1.mdx b/docs/gen/useContextMenuSchema-function-1.mdx deleted file mode 100644 index 45362ad63..000000000 --- a/docs/gen/useContextMenuSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useContextMenuSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 61 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/useCopyAs-function-1.mdx b/docs/gen/useCopyAs-function-1.mdx deleted file mode 100644 index 74a7c16e8..000000000 --- a/docs/gen/useCopyAs-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useCopyAs -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 62 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -(ids?: TLShapeId[], format?: TLCopyType) => void -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLCopyType](/gen/editor/TLCopyType-type) - diff --git a/docs/gen/useDefaultHelpers-function-1.mdx b/docs/gen/useDefaultHelpers-function-1.mdx deleted file mode 100644 index 4818b3423..000000000 --- a/docs/gen/useDefaultHelpers-function-1.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: useDefaultHelpers -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 63 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -{ - addToast: ( - toast: Omit & { - id?: string | undefined - } - ) => string - removeToast: (id: string) => string - clearToasts: () => void - addDialog: ( - dialog: Omit & { - id?: string | undefined - } - ) => string - clearDialogs: () => void - removeDialog: (id: string) => string - updateDialog: ( - id: string, - newDialogData: Partial - ) => string - msg: (id: import('..').TLUiTranslationKey) => string - isMobile: boolean -} -``` - -##### References - -[Omit](/gen/Omit-type), [TLUiToast](/gen/ui/TLUiToast-interface), [TLUiDialog](/gen/ui/TLUiDialog-interface), [Partial](/gen/Partial-type), [TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - diff --git a/docs/gen/useDialogs-function-1.mdx b/docs/gen/useDialogs-function-1.mdx deleted file mode 100644 index 3c73e5e08..000000000 --- a/docs/gen/useDialogs-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useDialogs -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 64 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiDialogsContextType -``` - -##### References - -[TLUiDialogsContextType](/gen/ui/TLUiDialogsContextType-type) - diff --git a/docs/gen/useEditor-var.mdx b/docs/gen/useEditor-var.mdx deleted file mode 100644 index 2a040c291..000000000 --- a/docs/gen/useEditor-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: useEditor -status: published -category: editor -group: Variable -author: api -date: 06/23/2023 -order: 191 ----Public Readonly Variable - - - - -##### Signature - - -```ts -useEditor: () => Editor -``` - -##### References - -[Editor](/gen/editor/Editor-class) - diff --git a/docs/gen/useEvents-function-1.mdx b/docs/gen/useEvents-function-1.mdx deleted file mode 100644 index 8a109008c..000000000 --- a/docs/gen/useEvents-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useEvents -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 65 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiEventContextType -``` - -##### References - -[TLUiEventContextType](/gen/ui/TLUiEventContextType-type) - diff --git a/docs/gen/useExportAs-function-1.mdx b/docs/gen/useExportAs-function-1.mdx deleted file mode 100644 index dbabdcddb..000000000 --- a/docs/gen/useExportAs-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useExportAs -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 66 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -(ids?: TLShapeId[], format?: TLExportType) => Promise -``` - -##### References - -[TLShapeId](/gen/tlschema/TLShapeId-type), [TLExportType](/gen/editor/TLExportType-type), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/useHelpMenuSchema-function-1.mdx b/docs/gen/useHelpMenuSchema-function-1.mdx deleted file mode 100644 index e0b7c4369..000000000 --- a/docs/gen/useHelpMenuSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useHelpMenuSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 67 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/useKeyboardShortcuts-function-1.mdx b/docs/gen/useKeyboardShortcuts-function-1.mdx deleted file mode 100644 index 4442c7645..000000000 --- a/docs/gen/useKeyboardShortcuts-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useKeyboardShortcuts -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 68 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/useKeyboardShortcutsSchema-function-1.mdx b/docs/gen/useKeyboardShortcutsSchema-function-1.mdx deleted file mode 100644 index e83848a1e..000000000 --- a/docs/gen/useKeyboardShortcutsSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useKeyboardShortcutsSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 69 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiKeyboardShortcutsSchemaContextType -``` - -##### References - -[TLUiKeyboardShortcutsSchemaContextType](/gen/ui/TLUiKeyboardShortcutsSchemaContextType-type) - diff --git a/docs/gen/useLocalStorageState-function-1.mdx b/docs/gen/useLocalStorageState-function-1.mdx deleted file mode 100644 index f922b0661..000000000 --- a/docs/gen/useLocalStorageState-function-1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: useLocalStorageState -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 70 ----Public Function - - - - -##### Parameters - - - - - - - -`key` - - - - -```ts -string -``` - - - - - - - - -`defaultValue` - - - - -```ts -T -``` - - - - - - - -##### Returns - - -```ts -readonly [T, (setter: ((value: T) => T) | T) => void] -``` - diff --git a/docs/gen/useMenuClipboardEvents-function-1.mdx b/docs/gen/useMenuClipboardEvents-function-1.mdx deleted file mode 100644 index 99f362b10..000000000 --- a/docs/gen/useMenuClipboardEvents-function-1.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: useMenuClipboardEvents -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 71 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -{ - copy: (source: TLUiEventSource) => void - cut: (source: TLUiEventSource) => void - paste: ( - data: ClipboardItem[] | DataTransfer, - source: TLUiEventSource, - point?: VecLike - ) => Promise -} -``` - -##### References - -[TLUiEventSource](/gen/ui/TLUiEventSource-type), [ClipboardItem](/gen/ClipboardItem-interface), [DataTransfer](/gen/DataTransfer-interface), [VecLike](/gen/primitives/VecLike-type), [Promise](/gen/Promise-interface) - diff --git a/docs/gen/useMenuIsOpen-function-1.mdx b/docs/gen/useMenuIsOpen-function-1.mdx deleted file mode 100644 index 849126773..000000000 --- a/docs/gen/useMenuIsOpen-function-1.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: useMenuIsOpen -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 72 ----Public Function - - - - -##### Parameters - - - - - - - -`id` - - - - -```ts -string -``` - - - - - - - - -`cb` - - (optional) - - - - -```ts -(isOpen: boolean) => void -``` - - - - - - - -##### Returns - - -```ts -readonly [boolean, (isOpen: boolean) => void] -``` - diff --git a/docs/gen/useMenuSchema-function-1.mdx b/docs/gen/useMenuSchema-function-1.mdx deleted file mode 100644 index b6df28f3f..000000000 --- a/docs/gen/useMenuSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useMenuSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 73 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiMenuSchema -``` - -##### References - -[TLUiMenuSchema](/gen/ui/TLUiMenuSchema-type) - diff --git a/docs/gen/useNativeClipboardEvents-function-1.mdx b/docs/gen/useNativeClipboardEvents-function-1.mdx deleted file mode 100644 index 14cf975a7..000000000 --- a/docs/gen/useNativeClipboardEvents-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useNativeClipboardEvents -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 74 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -void -``` - diff --git a/docs/gen/usePrefersReducedMotion-function-1.mdx b/docs/gen/usePrefersReducedMotion-function-1.mdx deleted file mode 100644 index a6f579f3a..000000000 --- a/docs/gen/usePrefersReducedMotion-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: usePrefersReducedMotion -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 192 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/useReadonly-function-1.mdx b/docs/gen/useReadonly-function-1.mdx deleted file mode 100644 index acf9c58c7..000000000 --- a/docs/gen/useReadonly-function-1.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: useReadonly -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 75 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -boolean -``` - diff --git a/docs/gen/useTLStore-function-1.mdx b/docs/gen/useTLStore-function-1.mdx deleted file mode 100644 index 54918f755..000000000 --- a/docs/gen/useTLStore-function-1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: useTLStore -status: published -category: editor -group: Function -author: api -date: 06/23/2023 -order: 193 ----Public Function - - - - -##### Parameters - - - - - - - -`opts` - - - - -```ts -TLStoreOptions -``` - - - - - - - -##### Returns - - -```ts -import('@tldraw/tlschema').TLStore -``` - -##### References - -[TLStoreOptions](/gen/editor/TLStoreOptions-type), [TLStore](/gen/tlschema/TLStore-type) - diff --git a/docs/gen/useToasts-function-1.mdx b/docs/gen/useToasts-function-1.mdx deleted file mode 100644 index 8013acaf7..000000000 --- a/docs/gen/useToasts-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useToasts -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 76 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiToastsContextType -``` - -##### References - -[TLUiToastsContextType](/gen/ui/TLUiToastsContextType-type) - diff --git a/docs/gen/useToolbarSchema-function-1.mdx b/docs/gen/useToolbarSchema-function-1.mdx deleted file mode 100644 index 0826565b9..000000000 --- a/docs/gen/useToolbarSchema-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useToolbarSchema -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 77 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiToolbarSchemaContextType -``` - -##### References - -[TLUiToolbarSchemaContextType](/gen/ui/TLUiToolbarSchemaContextType-type) - diff --git a/docs/gen/useTools-function-1.mdx b/docs/gen/useTools-function-1.mdx deleted file mode 100644 index 7f025ae6d..000000000 --- a/docs/gen/useTools-function-1.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: useTools -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 78 ----Public Function - - - - -##### Parameters - - -None - -##### Returns - - -```ts -TLUiToolsContextType -``` - -##### References - -[TLUiToolsContextType](/gen/ui/TLUiToolsContextType-type) - diff --git a/docs/gen/useTranslation-function-1.mdx b/docs/gen/useTranslation-function-1.mdx deleted file mode 100644 index 409dabe3a..000000000 --- a/docs/gen/useTranslation-function-1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: useTranslation -status: published -category: ui -group: Function -author: api -date: 06/23/2023 -order: 79 ----Public Function - -Returns a function to translate a translation key into a string based on the current translation. - - - - -##### Example - - - - -```ts -const msg = useTranslation() -const label = msg('style-panel.styles') -``` - - -##### Parameters - - -None - -##### Returns - - -```ts -(id: TLUiTranslationKey) => string -``` - -##### References - -[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type) - diff --git a/docs/gen/vec2dModelValidator-var.mdx b/docs/gen/vec2dModelValidator-var.mdx deleted file mode 100644 index 8bf449763..000000000 --- a/docs/gen/vec2dModelValidator-var.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: vec2dModelValidator -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 125 ----Public Readonly Variable - - - - -##### Signature - - -```ts -vec2dModelValidator: T.Validator -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [Vec2dModel](/gen/tlschema/Vec2dModel-interface) - diff --git a/docs/gen/videoShapeProps-var.mdx b/docs/gen/videoShapeProps-var.mdx deleted file mode 100644 index b87d6aea1..000000000 --- a/docs/gen/videoShapeProps-var.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: videoShapeProps -status: published -category: tlschema -group: Variable -author: api -date: 06/23/2023 -order: 126 ----Public Readonly Variable - - - - -##### Signature - - -```ts -videoShapeProps: { - w: T.Validator - h: T.Validator - time: T.Validator - playing: T.Validator - url: T.Validator - assetId: T.Validator -} -``` - -##### References - -[T.Validator](/gen/validate/Validator-class), [TLAssetId](/gen/tlschema/TLAssetId-type) - diff --git a/lazy.config.ts b/lazy.config.ts index 88f2bfd09..82f638009 100644 --- a/lazy.config.ts +++ b/lazy.config.ts @@ -21,10 +21,6 @@ export function generateSharedScripts(bublic: '' | '/bublic') cache: 'none', workspaceOverrides: { '{bublic/,}apps/vscode/*': { runsAfter: { build: { in: 'self-only' } } }, - '{bublic/,}apps/webdriver': { - runsAfter: { 'refresh-assets': {}, prebuild: {} }, - cache: 'none', - }, }, }, test: { diff --git a/package.json b/package.json index e3433b9d6..41de38e39 100644 --- a/package.json +++ b/package.json @@ -59,8 +59,12 @@ "prettier --write" ] }, - "dependencies": { + "devDependencies": { + "@microsoft/api-extractor": "^7.35.4", "@next/eslint-plugin-next": "^13.3.0", + "@swc/core": "^1.3.55", + "@swc/jest": "^0.2.26", + "@types/glob": "^8.1.0", "@types/jest": "^28.1.2", "@types/node": "18.7.3", "@types/react": "^18.0.24", @@ -75,23 +79,17 @@ "eslint-plugin-no-only-tests": "^3.1.0", "eslint-plugin-react": "^7.32.2", "eslint-plugin-react-hooks": "^4.6.0", + "fs-extra": "^11.1.0", "husky": "^8.0.0", "jest": "^28.1.1", + "json5": "^2.2.3", + "lazyrepo": "0.0.0-alpha.27", "lint-staged": ">=10", "prettier": "^2.8.6", "prettier-plugin-organize-imports": "^3.2.2", - "typescript": "^5.0.2" - }, - "devDependencies": { - "@microsoft/api-extractor": "^7.35.4", - "@swc/core": "^1.3.55", - "@swc/jest": "^0.2.26", - "@types/glob": "^8.1.0", - "fs-extra": "^11.1.0", - "json5": "^2.2.3", - "lazyrepo": "0.0.0-alpha.27", "rimraf": "^4.4.0", "tsx": "^3.12.2", + "typescript": "^5.0.2", "vercel": "^28.16.15" }, "resolutions": {