Function: useHistory()
@roomful/vue / useHistory
Function: useHistory()
Section titled “Function: useHistory()”useHistory<
TPresence>(options?):UseHistoryResult
Defined in: vue/src/index.ts:1539
Subscribes to the collaborative history engine: a reactive shared timeline
plus reactive canUndo/canRedo, with 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?”Optional history configuration.
Returns
Section titled “Returns”Readonly refs for the timeline and undo/redo availability plus controls.