TLInstance
See source codeTable of contents
- brush
- chatMessage
- currentPageId
- cursor
- devicePixelRatio
- duplicateProps
- exportBackground
- followingUserId
- highlightedUserIds
- id
- insets
- isChangingStyle
- isChatting
- isCoarsePointer
- isDebugMode
- isFocused
- isFocusMode
- isGridMode
- isHoveringCanvas
- isPenMode
- isReadonly
- isToolLocked
- meta
- opacityForNextShape
- openMenus
- screenBounds
- scribbles
- stylesForNextShape
- typeName
- zoomBrush
- Properties
Extends BaseRecord<'instance', TLInstanceId>.
TLInstance
State that is particular to a single browser tab
interface TLInstance extends BaseRecord<'instance', TLInstanceId> {}Properties
brush
brush: BoxModel | nullchatMessage
chatMessage: stringcurrentPageId
currentPageId: TLPageIdcursor
cursor: TLCursordevicePixelRatio
devicePixelRatio: numberduplicateProps
duplicateProps: {
offset: {
x: number
y: number
}
shapeIds: TLShapeId[]
} | nullexportBackground
exportBackground: booleanfollowingUserId
followingUserId: null | stringhighlightedUserIds
highlightedUserIds: string[]id
readonly
from BaseRecord
readonly id: Idinsets
insets: boolean[]isChangingStyle
isChangingStyle: booleanisChatting
isChatting: booleanisCoarsePointer
This is whether the primary input mechanism includes a pointing device of limited accuracy, such as a finger on a touchscreen.
isCoarsePointer: booleanisDebugMode
isDebugMode: booleanisFocused
isFocused: booleanisFocusMode
isFocusMode: booleanisGridMode
isGridMode: booleanisHoveringCanvas
Will be null if the pointer doesn't support hovering (e.g. touch), but true or false otherwise
isHoveringCanvas: boolean | nullisPenMode
isPenMode: booleanisReadonly
isReadonly: booleanisToolLocked
isToolLocked: booleanmeta
meta: JsonObjectopacityForNextShape
opacityForNextShape: TLOpacityTypeopenMenus
openMenus: string[]screenBounds
screenBounds: BoxModelscribbles
scribbles: TLScribble[]stylesForNextShape
stylesForNextShape: Record<string, unknown>typeName
readonly
from BaseRecord
readonly typeName: TypeNamezoomBrush
zoomBrush: BoxModel | nullPrev
TLImageShapePropsNext
TLInstancePageState