react / useRef

Function: useRef()#

useRef(initialValue)#

function useRef<T>(initialValue: T): MutableRefObject<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#

Parameters#

Returns#

MutableRefObject<T>

Version#

16.8.0

See#

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

Defined in#

.pnpm/@types+react@18.3.11/node_modules/@types/react/ts5.0/index.d.ts:1986

useRef(initialValue)#

function useRef<T>(initialValue: null | 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.

Usage note: if you need the result of useRef to be directly mutable, include | null in the type of the generic argument.

Type Parameters#

Parameters#

Returns#

RefObject<T>

Version#

16.8.0

See#

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

Defined in#

.pnpm/@types+react@18.3.11/node_modules/@types/react/ts5.0/index.d.ts:2001

useRef()#

function useRef<T>(): MutableRefObject<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#

Returns#

MutableRefObject<T | undefined>

Version#

16.8.0

See#

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

Defined in#

.pnpm/@types+react@18.3.11/node_modules/@types/react/ts5.0/index.d.ts:2014