Logo for jsDocs.io

react-merge-refs

  • Version 3.0.2
  • Published
  • 5.99 kB
  • No dependencies
  • MIT license

Install

npm i react-merge-refs
yarn add react-merge-refs
pnpm add react-merge-refs

Overview

React utility to merge refs.

Index

Variables

Functions

Variables

variable mergeRefs

const mergeRefs: <T>(refs: any[]) => Ref<T>;

  • Merges multiple refs into a single one.

    Parameter refs

    List of refs to merge.

    Returns

    Merged ref.

Functions

function assignRef

assignRef: <T>(
    ref: Ref<T> | undefined | null,
    value: T | null
) => ReturnType<RefCallback<T>>;

  • Assigns a value to a ref.

    Parameter ref

    The ref to assign the value to.

    Parameter value

    The value to assign to the ref.

    Returns

    The ref cleanup callback, if any.

function mergeRefsReact19

mergeRefsReact19: <T>(refs: (Ref<T> | undefined)[]) => Ref<T>;

    function useMergeRefs

    useMergeRefs: <T>(refs: (Ref<T> | undefined)[]) => Ref<T>;

    • Merges multiple refs into a single one and memoizes the result to avoid refs execution on each render.

      Parameter refs

      List of refs to merge.

      Returns

      Merged ref.

    Package Files (1)

    Dependencies (0)

    No dependencies.

    Dev Dependencies (19)

    Peer Dependencies (1)

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-merge-refs.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-merge-refs)
    • HTML
      <a href="https://www.jsdocs.io/package/react-merge-refs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>