Interface: PeerCursorProps
@roomful/cursors / PeerCursorProps
Interface: PeerCursorProps
Section titled “Interface: PeerCursorProps”Defined in: peer-cursor.types.ts:9
Configures the peer cursor component.
Properties
Section titled “Properties”color:
string
Defined in: peer-cursor.types.ts:28
Supplies the peer color.
idle:
boolean
Defined in: peer-cursor.types.ts:33
Indicates whether the peer is idle.
name:
string
Defined in: peer-cursor.types.ts:23
Supplies the peer display name.
style:
PeerCursorStyle
Defined in: peer-cursor.types.ts:38
Selects the cursor marker style.
x:
number
Defined in: peer-cursor.types.ts:13
Supplies the normalized horizontal coordinate.
y:
number
Defined in: peer-cursor.types.ts:18
Supplies the normalized vertical coordinate.