c893a02878
Highlighter is autolocked, so we shouldn't show the lock icon ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - We no longer show the tool lock option for highlighter - it didn't do anything anyway
281 lines
4.6 KiB
Text
281 lines
4.6 KiB
Text
---
|
|
title: TLEditorComponents
|
|
status: published
|
|
category: editor
|
|
group: Interface
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 125
|
|
---<Small>Public Interface</Small>
|
|
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
- [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)
|
|
</details>
|
|
|
|
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
interface TLEditorComponents {}
|
|
```
|
|
|
|
---
|
|
|
|
## Properties
|
|
|
|
### `Background` \{#TLEditorComponents-Background-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Background: null | TLBackgroundComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Brush` \{#TLEditorComponents-Brush-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Brush: null | TLBrushComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `CollaboratorBrush` \{#TLEditorComponents-CollaboratorBrush-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
CollaboratorBrush: null | TLBrushComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `CollaboratorCursor` \{#TLEditorComponents-CollaboratorCursor-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
CollaboratorCursor: null | TLCursorComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `CollaboratorHint` \{#TLEditorComponents-CollaboratorHint-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
CollaboratorHint: null | TLCollaboratorHintComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `CollaboratorScribble` \{#TLEditorComponents-CollaboratorScribble-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
CollaboratorScribble: null | TLScribbleComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `CollaboratorShapeIndicator` \{#TLEditorComponents-CollaboratorShapeIndicator-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
CollaboratorShapeIndicator: null | TLShapeIndicatorComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Cursor` \{#TLEditorComponents-Cursor-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Cursor: null | TLCursorComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `ErrorFallback` \{#TLEditorComponents-ErrorFallback-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
ErrorFallback: TLErrorFallbackComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Grid` \{#TLEditorComponents-Grid-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Grid: null | TLGridComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Handle` \{#TLEditorComponents-Handle-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Handle: null | TLHandleComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Scribble` \{#TLEditorComponents-Scribble-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Scribble: null | TLScribbleComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `ShapeErrorFallback` \{#TLEditorComponents-ShapeErrorFallback-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
ShapeErrorFallback: TLShapeErrorFallbackComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `ShapeIndicatorErrorFallback` \{#TLEditorComponents-ShapeIndicatorErrorFallback-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
ShapeIndicatorErrorFallback: TLShapeIndicatorErrorFallbackComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `SnapLine` \{#TLEditorComponents-SnapLine-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
SnapLine: null | TLSnapLineComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `Spinner` \{#TLEditorComponents-Spinner-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
Spinner: null | TLSpinnerComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `SvgDefs` \{#TLEditorComponents-SvgDefs-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
SvgDefs: null | TLSvgDefsComponent
|
|
```
|
|
|
|
---
|
|
|
|
### `ZoomBrush` \{#TLEditorComponents-ZoomBrush-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
ZoomBrush: null | TLBrushComponent
|
|
```
|
|
|
|
---
|
|
|