Skip to main content

@lexical/react/useLexicalSubscription

Type Aliases​

LexicalSubscription​

LexicalSubscription<T> = object

Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:21

Describes how useLexicalSubscription reads a value from the editor: an initialValueFn that computes the current value, and a subscribe function that registers a listener for changes and returns an unsubscribe callback.

Type Parameters​

T​

T

Properties​

initialValueFn​

initialValueFn: () => T

Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:22

Returns​

T

subscribe​

subscribe: (callback) => () => void

Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:23

Parameters​
callback​

(value) => void

Returns​

() => void

Functions​

useLexicalSubscription()​

useLexicalSubscription<T>(subscription): T

Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:30

Shortcut to Lexical subscriptions when values are used for render.

Type Parameters​

T​

T

Parameters​

subscription​

(editor) => LexicalSubscription<T>

The function to create the LexicalSubscription. This function's identity must be stable (e.g. defined at module scope or with useCallback).

Returns​

T