npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-pure-events

v1.0.0

Published

A HOC wrapper that makes events props passed to React PureComponents pure

Downloads

97

Readme

React Pure Events

npm MIT dependencies devDependencies Build Status Codecov

A HOC wrapper that makes events props passed to React PureComponents pure.

React Pure Events can be used to make event properties "pure" no matter what is passed to your component.

Normally if someone passes onEvent={() => {}} in a render method to your PureComponent it will completely break the PureComponent optimization. Every single render a new function instance will be created so nextProps.onEvent === prevProps.onEvent will never be true.

React Pure Events wraps your PureComponent in a Higher Order Component (HOC) that replaces the function values for any props you define as an event prop with a function that will still call the function passed as a prop, but will not change between renders. Guaranteeing that your PureComponent optimizations work no matter how the caller defines the event.

The guard version also guarantees that the prop will never be a non-function, so you can safely call this.props.onEvent() without testing the type or providing your own noop.

Installation

npm install --save react-pure-events

Using

wrapPureEventProps(...events)

wrapPureEventProps wraps a PureComponent with a HOC that replaces a set of event props with functions that call the event prop, but if passed are the same on every render() call even if the actual function passed to the HOC changes.

This guarantees that even if a caller uses onEvent={() => {}} which causes a new function instance to be passed every render the PureComponent will always receive the same prop and remain purely optimized.

import React, {PureComponent} from 'react';
import {wrapPureEventProps} from 'react-pure-events';

// As a decorator
@wrapPureEventProps('onEvent', 'onEvent2')
export default class MyComponent extends PureComponent {
    onSomethingFinished() {
        if ( this.props.onEvent ) {
            this.props.onEvent();
        }
    }
    // ...
}

// As a function
class MyComponent extends PureComponent {
    // ...
}

export default wrapPureEventProps('onEvent', 'onEvent2')(MyComponent);

guardPureEventProps(...events)

guardPureEventProps does the same as wrapPureEventProps, but also guarantees that if an event prop is not a function (not passed or invalid) a noop function will be passed instead.

import React, {PureComponent} from 'react';
import {guardPureEventProps} from 'react-pure-events';

// As a decorator
@guardPureEventProps('onEvent', 'onEvent2')
export default class MyComponent extends PureComponent {
    onSomethingFinished() {
        this.props.onEvent();
    }
    // ...
}

// As a function
class MyComponent extends PureComponent {
    // ...
}

export default guardPureEventProps('onEvent', 'onEvent2')(MyComponent);