@suprasmooth/react-set-multiple-refs v1.0.1

react-set-multiple-refs

setRefs is a utility function for React or React-based frameworks like NextJS that allows you to combine multiple refs into a single ref callback. This is particularly useful when you need to pass multiple refs to a single DOM element.

Installation

npm install react-set-multiple-refs

Usage

Importing the Function

To use the setRefs function, you need to import it into your React component file:

import setRefs from 'react-set-multiple-refs';

Combining Refs

You can use setRefs to combine multiple refs, whether they are callback refs or React.createRef refs.

Example with React.createRef and Callback Ref

import React, { useRef, useEffect } from 'react';
import setRefs from 'react-set-multiple-refs';

const MyComponent = () => {
    const ref1 = useRef(null);
    const ref2 = (element) => {
        console.log('Callback ref:', element);
    };

    useEffect(() => {
        console.log('ref1 current:', ref1.current);
    }, []);

    return <div ref={setRefs(ref1, ref2)}>Hello, world!</div>;
};

export default MyComponent;

In this example, setRefs combines ref1 and ref2, so both refs will be set when the <div> element is rendered.

Example with Multiple React.createRef Refs

import React, { useRef, useEffect } from 'react';
import setRefs from 'react-set-multiple-refs';

const AnotherComponent = () => {
    const ref1 = useRef(null);
    const ref2 = useRef(null);

    useEffect(() => {
        console.log('ref1 current:', ref1.current);
        console.log('ref2 current:', ref2.current);
    }, []);

    return <div ref={setRefs(ref1, ref2)}>Hello, world!</div>;
};

export default AnotherComponent;

In this example, setRefs combines ref1 and ref2, and both refs will point to the <div> element when it is rendered.

TypeScript Support

This package includes TypeScript types for better development experience. You can use it in your TypeScript projects as shown below:

import React, { useRef, useEffect, MutableRefObject } from 'react';
import setRefs from 'react-set-multiple-refs';

type MyComponentProps = {
  name: string;
};

const MyComponent: React.FC<MyComponentProps> = ({ name }) => {
  const ref1: MutableRefObject<HTMLDivElement | null> = useRef(null);
  const ref2 = (element: HTMLDivElement | null) => {
    console.log('Callback ref:', element);
  };

  useEffect(() => {
    console.log('ref1 current:', ref1.current);
  }, []);

  return <div ref={setRefs<HTMLDivElement>(ref1, ref2)}>Hello, {name}!</div>;
};

export default MyComponent;

API

setRefs<T>(...references: Reference<T>[]): (element: T | null) => void

Parameters

• references: An array of refs which can be callback refs or React.createRef refs.

Returns

A function that takes an element of type T or null and sets all provided refs to this element.

Issues

If you encounter any issues, please report them here.

Contributing

Open source welcomes contributions! Please follow these steps to contribute:

• Fork the repository.
• Create a new branch for your feature or bugfix.
• Make your changes and commit them.
• Push your changes to your fork.
• Submit a pull request describing your changes.

License

Released under BSD 3-Clause License by @SupraSmooth.