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
181 lines
2.8 KiB
Text
181 lines
2.8 KiB
Text
---
|
|
title: TLInstancePageState
|
|
status: published
|
|
category: tlschema
|
|
group: Interface
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 102
|
|
---<Small>Public Interface</Small>
|
|
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
- [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)
|
|
</details>
|
|
|
|
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)
|
|
|
|
---
|
|
|
|
## Properties
|
|
|
|
### `croppingId` \{#TLInstancePageState-croppingId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
croppingId: null | TLShapeId
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `editingId` \{#TLInstancePageState-editingId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
editingId: null | TLShapeId
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `erasingIds` \{#TLInstancePageState-erasingIds-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
erasingIds: TLShapeId[]
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `focusLayerId` \{#TLInstancePageState-focusLayerId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
focusLayerId: null | TLShapeId
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `hintingIds` \{#TLInstancePageState-hintingIds-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
hintingIds: TLShapeId[]
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `hoveredId` \{#TLInstancePageState-hoveredId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
hoveredId: null | TLShapeId
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
### `pageId` \{#TLInstancePageState-pageId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
pageId: RecordId<TLPage>
|
|
```
|
|
|
|
##### References
|
|
|
|
[RecordId](/gen/store/RecordId-type), [TLPage](/gen/tlschema/TLPage-interface)
|
|
|
|
---
|
|
|
|
### `selectedIds` \{#TLInstancePageState-selectedIds-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
selectedIds: TLShapeId[]
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|