Interface: UseFieldPresenceResult
@roomful/solid / UseFieldPresenceResult
Interface: UseFieldPresenceResult
Section titled “Interface: UseFieldPresenceResult”Defined in: solid/src/index.ts:454
Describes the return value of useFieldPresence.
Properties
Section titled “Properties”fields
Section titled “fields”fields:
Accessor<FieldPresenceState[]>
Defined in: solid/src/index.ts:459
Exposes every field with at least one remote peer, ordered by field id. Reactive: updates when peers enter or leave a field.
setActiveField()
Section titled “setActiveField()”setActiveField: (
fieldId) =>void
Defined in: solid/src/index.ts:464
Declares the field the local peer is active on, or null to clear it.
Declares the field the local peer is active on, or null to clear it (e.g. on blur).
Parameters
Section titled “Parameters”fieldId
Section titled “fieldId”The active field id, or null.
string | null
Returns
Section titled “Returns”void
Nothing.
Methods
Section titled “Methods”getFieldPeers()
Section titled “getFieldPeers()”getFieldPeers(
fieldId):Peer[]
Defined in: solid/src/index.ts:469
Returns the remote peers on a field from the current snapshot.
Parameters
Section titled “Parameters”fieldId
Section titled “fieldId”string
Returns
Section titled “Returns”Peer[]