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 | null
chatMessage
chatMessage: string
currentPageId
currentPageId: TLPageId
cursor
cursor: TLCursor
devicePixelRatio
devicePixelRatio: number
duplicateProps
duplicateProps: {
offset: {
x: number
y: number
}
shapeIds: TLShapeId[]
} | null
exportBackground
exportBackground: boolean
followingUserId
followingUserId: null | string
highlightedUserIds
highlightedUserIds: string[]
id
readonly
from BaseRecord
readonly id: Id
insets
insets: boolean[]
isChangingStyle
isChangingStyle: boolean
isChatting
isChatting: boolean
isCoarsePointer
This is whether the primary input mechanism includes a pointing device of limited accuracy, such as a finger on a touchscreen.
isCoarsePointer: boolean
isDebugMode
isDebugMode: boolean
isFocused
isFocused: boolean
isFocusMode
isFocusMode: boolean
isGridMode
isGridMode: boolean
isHoveringCanvas
Will be null if the pointer doesn't support hovering (e.g. touch), but true or false otherwise
isHoveringCanvas: boolean | null
isPenMode
isPenMode: boolean
isReadonly
isReadonly: boolean
isToolLocked
isToolLocked: boolean
meta
meta: JsonObject
opacityForNextShape
opacityForNextShape: TLOpacityType
openMenus
openMenus: string[]
screenBounds
screenBounds: BoxModel
scribbles
scribbles: TLScribble[]
stylesForNextShape
stylesForNextShape: Record<string, unknown>
typeName
readonly
from BaseRecord
readonly typeName: TypeName
zoomBrush
zoomBrush: BoxModel | null
Prev
TLImageShapePropsNext
TLInstancePageState