ReactLynx logo
ReactLynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

react / forwardRef

Function: forwardRef()

function forwardRef<T, P>(render: ForwardRefRenderFunction<T, PropsWithoutRef<P>>): ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>

Lets your component expose an element node to a parent component using a ref.

Type Parameters

Type Parameter Default type Description
T - The type of the element node.
P object The props the component accepts, if any.

Parameters

Parameter Type Description
render ForwardRefRenderFunction<T, PropsWithoutRef<P>> See the ForwardRefRenderFunction.

Returns

ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>

See

Example

interface Props {
  children?: ReactNode;
  type: "submit" | "button";
}

export const FancyButton = forwardRef<HTMLButtonElement, Props>((props, ref) => (
  <button ref={ref} className="MyClassName" type={props.type}>
    {props.children}
  </button>
));

Defined in

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

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.