@lexical/react/useLexicalSubscription
Type Aliases
LexicalSubscription<T>
LexicalSubscription<
T
> =object
Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:15
Type Parameters
T
T
Properties
initialValueFn()
initialValueFn: () =>
T
Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:16
Returns
T
subscribe()
subscribe: (
callback
) => () =>void
Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:17
Parameters
callback
(value
) => void
Returns
():
void
Returns
void
Functions
useLexicalSubscription()
useLexicalSubscription<
T
>(subscription
):T
Defined in: packages/lexical-react/src/useLexicalSubscription.tsx:24
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