@univerjs/facade v0.2.14 • Docs
Class: FHooks
Constructors
new FHooks()
new FHooks(_injector, _lifecycleService): FHooksParameters
| Parameter | Type |
|---|---|
_injector | Injector |
_lifecycleService | LifecycleService |
Returns
Defined in
submodules/univer/packages/facade/src/apis/f-hooks.ts:24 (opens in a new tab)
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
_injector | readonly | Injector | - | submodules/univer/packages/facade/src/apis/f-hooks.ts:25 (opens in a new tab) |
onBeforeCopy | public | (...args: [() => void]) => IDisposable | The onBeforeCopy event is fired before a copy operation is performed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:100 (opens in a new tab) |
onBeforePaste | public | (...args: [() => void]) => IDisposable | The onBeforePaste event is fired before a paste operation is performed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:114 (opens in a new tab) |
onBeforeRedo | public | (...args: [(action) => void]) => IDisposable | Hook that fires before a redo operation is executed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:86 (opens in a new tab) |
onBeforeUndo | public | (...args: [(action) => void]) => IDisposable | Hook that fires before an undo operation is executed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:72 (opens in a new tab) |
onCopy | public | (...args: [() => void]) => IDisposable | The onCopy event is fired after a copy operation is performed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:107 (opens in a new tab) |
onPaste | public | (...args: [() => void]) => IDisposable | The onPaste event is fired after a paste operation is performed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:121 (opens in a new tab) |
onRedo | public | (...args: [(action) => void]) => IDisposable | Hook that fires after a redo operation is executed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:93 (opens in a new tab) |
onUndo | public | (...args: [(action) => void]) => IDisposable | Hook that fires after an undo operation is executed. | submodules/univer/packages/facade/src/apis/f-hooks.ts:79 (opens in a new tab) |
Methods
onReady()
onReady(callback): IDisposableThe onReady event is fired when lifecycle stage is Ready.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | () => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/facade/src/apis/f-hooks.ts:45 (opens in a new tab)
onRendered()
onRendered(callback): IDisposableThe onRendered event is fired when lifecycle stage is Rendered.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | () => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/facade/src/apis/f-hooks.ts:54 (opens in a new tab)
onStarting()
onStarting(callback): IDisposableThe onStarting event is fired when lifecycle stage is Starting.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | () => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/facade/src/apis/f-hooks.ts:36 (opens in a new tab)
onSteady()
onSteady(callback): IDisposableThe onSteady event is fired when lifecycle stage is Steady.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | () => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
submodules/univer/packages/facade/src/apis/f-hooks.ts:63 (opens in a new tab)