merge-refs-hook
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Merge refs hook

Build Status npm

The goal of this package is to make it easy to have a component which requires a ref but also wants to support forwarding refs.

Example

const myComponent = React.forwardRef((props, ref) => {
    const local = React.createRef()
 
    // Create local ref
    useHookWhichNeedsRef(local)
 
    // mergeRefs allows you to pass both your local, and forwarded ref
    // and gives you a ref back which can be passed down
    const mergedRef = useMergeRefs(ref, local)
 
    // You can now use mergedRef and both forwarded and local ref will
    // be updated
    return <div ref={mergedRef} />
})

Readme

Keywords

none

Package Sidebar

Install

npm i merge-refs-hook

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

13 kB

Total Files

20

Last publish

Collaborators

  • jakeginnivan