tldraw/apps/docs/content/gen/TLEventHandlers-interface.mdx
alex c893a02878
remove lock option from highlighter (#1703)
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
2023-07-04 10:41:14 +00:00

335 lines
5.1 KiB
Text

---
title: TLEventHandlers
status: published
category: editor
group: Interface
author: api
date: 06/23/2023
order: 130
---<Small>Public Interface</Small>
<details>
<summary>Table of Contents</summary>
- [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)
</details>
##### Signature
```ts
interface TLEventHandlers {}
```
---
## Properties
### `onCancel` \{#TLEventHandlers-onCancel-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onCancel: TLCancelEvent
```
##### References
[TLCancelEvent](/gen/editor/TLCancelEvent-type)
---
### `onComplete` \{#TLEventHandlers-onComplete-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onComplete: TLCompleteEvent
```
##### References
[TLCompleteEvent](/gen/editor/TLCompleteEvent-type)
---
### `onDoubleClick` \{#TLEventHandlers-onDoubleClick-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onDoubleClick: TLClickEvent
```
##### References
[TLClickEvent](/gen/editor/TLClickEvent-type)
---
### `onInterrupt` \{#TLEventHandlers-onInterrupt-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onInterrupt: TLInterruptEvent
```
##### References
[TLInterruptEvent](/gen/editor/TLInterruptEvent-type)
---
### `onKeyDown` \{#TLEventHandlers-onKeyDown-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onKeyDown: TLKeyboardEvent
```
##### References
[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type)
---
### `onKeyRepeat` \{#TLEventHandlers-onKeyRepeat-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onKeyRepeat: TLKeyboardEvent
```
##### References
[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type)
---
### `onKeyUp` \{#TLEventHandlers-onKeyUp-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onKeyUp: TLKeyboardEvent
```
##### References
[TLKeyboardEvent](/gen/editor/TLKeyboardEvent-type)
---
### `onMiddleClick` \{#TLEventHandlers-onMiddleClick-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onMiddleClick: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onPointerDown` \{#TLEventHandlers-onPointerDown-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onPointerDown: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onPointerEnter` \{#TLEventHandlers-onPointerEnter-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onPointerEnter: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onPointerLeave` \{#TLEventHandlers-onPointerLeave-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onPointerLeave: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onPointerMove` \{#TLEventHandlers-onPointerMove-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onPointerMove: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onPointerUp` \{#TLEventHandlers-onPointerUp-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onPointerUp: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onQuadrupleClick` \{#TLEventHandlers-onQuadrupleClick-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onQuadrupleClick: TLClickEvent
```
##### References
[TLClickEvent](/gen/editor/TLClickEvent-type)
---
### `onRightClick` \{#TLEventHandlers-onRightClick-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onRightClick: TLPointerEvent
```
##### References
[TLPointerEvent](/gen/editor/TLPointerEvent-type)
---
### `onTripleClick` \{#TLEventHandlers-onTripleClick-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onTripleClick: TLClickEvent
```
##### References
[TLClickEvent](/gen/editor/TLClickEvent-type)
---
### `onWheel` \{#TLEventHandlers-onWheel-member}
<Small>Public PropertySignature</Small>
##### Signature
```ts
onWheel: TLWheelEvent
```
##### References
[TLWheelEvent](/gen/editor/TLWheelEvent-type)
---