Interface: CursorBasePosition
@roomful/core / CursorBasePosition
Interface: CursorBasePosition
Section titled “Interface: CursorBasePosition”Defined in: packages/core/src/types.ts:804
Describes the built-in cursor position fields shared by all peers.
Properties
Section titled “Properties”color:
string
Defined in: packages/core/src/types.ts:818
Supplies the peer color.
element?
Section titled “element?”
optionalelement:string
Defined in: packages/core/src/types.ts:843
Identifies the focused element when available.
idle:
boolean
Defined in: packages/core/src/types.ts:848
Indicates whether the cursor is currently idle.
name:
string
Defined in: packages/core/src/types.ts:813
Supplies the peer display name.
userId
Section titled “userId”userId:
string
Defined in: packages/core/src/types.ts:808
Identifies the peer that owns the cursor.
x:
number
Defined in: packages/core/src/types.ts:823
Supplies the normalized X coordinate within the mounted element.
xAbsolute
Section titled “xAbsolute”xAbsolute:
number
Defined in: packages/core/src/types.ts:833
Supplies the absolute X coordinate within the mounted element.
y:
number
Defined in: packages/core/src/types.ts:828
Supplies the normalized Y coordinate within the mounted element.
yAbsolute
Section titled “yAbsolute”yAbsolute:
number
Defined in: packages/core/src/types.ts:838
Supplies the absolute Y coordinate within the mounted element.