react / forwardRef

Function: forwardRef()#

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

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

Type Parameters#

Parameters#

Returns#

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

See#

• React Docs
• React TypeScript Cheatsheet

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