Function: useHistory()
@roomful/react / useHistory
Function: useHistory()
Section titled “Function: useHistory()”useHistory<
TPresence>(options?):UseHistoryResult
Defined in: react/src/index.ts:1581
Subscribes to the collaborative history engine: a reactive shared timeline
plus reactive canUndo/canRedo, with stable capture/transaction/undo/redo
controls.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Parameters
Section titled “Parameters”options?
Section titled “options?”HistoryOptions
Optional history configuration.
Returns
Section titled “Returns”The timeline, undo/redo availability, and history controls.