For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/react/Function.useImperativeHandle.md.
  • English
  • @lynx-js/react / useImperativeHandle

    Function: useImperativeHandle()

    function useImperativeHandle<T, R>(
       ref: undefined | Ref<T>, 
       init: () => R, 
       deps?: DependencyList): void

    useImperativeHandle customizes the instance value that is exposed to parent components when using ref. As always, imperative code using refs should be avoided in most cases.

    useImperativeHandle should be used with React.forwardRef.

    Type Parameters

    Type Parameter
    T
    R

    Parameters

    ParameterType
    refundefined | Ref<T>
    init() => R
    deps?DependencyList

    Returns

    void

    Version

    16.8.0

    See

    https://react.dev/reference/react/useImperativeHandle

    Defined in

    .pnpm/@types+react@18.3.28/node_modules/@types/react/ts5.0/index.d.ts:2057

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.