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/Hooks/useRef.md.
  • English
  • Function: useRef()

    Call Signature

    useRef<T>(initialValue: T): RefObject<T>

    useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    Type Parameters

    Type Parameter
    T

    Parameters

    ParameterType
    initialValueT

    Returns

    RefObject<T>

    Version

    16.8.0

    See

    https://react.dev/reference/react/useRef

    Call Signature

    useRef<T>(initialValue: T | null): RefObject<T | null>

    useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    Type Parameters

    Type Parameter
    T

    Parameters

    ParameterType
    initialValueT | null

    Returns

    RefObject<T | null>

    Version

    16.8.0

    See

    https://react.dev/reference/react/useRef

    Call Signature

    useRef<T>(initialValue: T | undefined): RefObject<T | undefined>

    useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    Type Parameters

    Type Parameter
    T

    Parameters

    ParameterType
    initialValueT | undefined

    Returns

    RefObject<T | undefined>

    Version

    16.8.0

    See

    https://react.dev/reference/react/useRef

    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.