Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

linkref

1.1.0 • Public • Published

linkref NPM travis-ci

Like Preact's Linked State, but for refs.

This gives you the ease of String Refs (unavailable in Preact core, deprecated in React), using Function Refs.

Calling linkRef('name') creates an optimized ref handler function that populates this.refs.name on your component for you. The trick is that linkRef() is memoized - this means you can call it as many times as you want (inline, in render!) and it won't create any new closures. 🌈

Note: You can accomplish this with function refs just fine! It's important to understand how function refs work, since linkRef() is just generating a function ref on your behalf. Here is an unoptimized implementation of linkRef() - be sure to understand how it works:

function linkRef(component, name) {
  if (!component.refs) component.refs = {};
  return (ref) => component.refs[name] = ref;
}

Installation

Available as linkref on npm:

npm install --save linkref

Simple Example

import linkRef from 'linkref';
 
class Foo extends Component {
    componentDidMount() {
        // log the <div /> to the console:
        console.log(this.refs.foo);
    }
    render() {
        return (
            <div ref={linkRef(this, 'foo')}>
                some text
            </div>
        );
    }
}

Preact Polyfill

Preact's Component class is extensible, so linkref provides a polyfill to integrate more tightly:

import 'linkref/polyfill';
 
class Foo extends Component {
    componentDidMount() {
        // log the <div /> to the console:
        console.log(this.refs.foo);
    }
    render() {
        return (
            <div ref={this.linkRef('foo')}>
                some text
            </div>
        );
    }
}

Babel Plugin

There's also a Babel plugin available as linkref/babel:

// .babelrc
{
  "plugins": [
    "linkref/babel",
 
    // all options are optional - here are the defaults:
    ["linkref/babel", {
      "module": "linkref",
      "importName": "_createStringRef"
    }]
  ]
}

It's also useful as a one-off codemod for upgrading from string refs to linkref:

npm i --save linkref
 
# run babel on all files in ./src, changing them in-place: 
npx babel --no-babelrc --plugins=linkref/babel src -d src
Don't have npx?

Update to the latest npm version to get it, or do this instead:

# get babel cli: 
npm i @babel/core @babel/cli
# you'll be using linkref as a library now: 
npm i --save linkref
# run babel on all files in ./src, changing them in-place: 
./node_modules/.bin/babel --no-babelrc --plugins=linkref/babel src -d src

License

MIT

Install

npm i linkref

DownloadsWeekly Downloads

36

Version

1.1.0

License

MIT

Unpacked Size

9.62 kB

Total Files

10

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar