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

flight-with-state

v8.1.0

Published

A Flight mixin for storing and reacting to change in a component's internal state.

Downloads

747

Readme

flight-with-state

Build Status

A Flight mixin for storing and reacting to change in a component's internal state.

Installation

npm install --save flight-with-state

This module requires lodash.merge as a peer dependency.

Example

Here's an example component that uses with withState.

var ToggleButton = flight.component(
    // Use `withState` before your component definition.
    withState,
    function toggleButton() {
        this.attributes({
            initiallyActive: false
        });

        // Define an instance's `initialState`
        this.initialState({
            active: false
        });

        this.after('initialize', function () {
            this.on('click', this.toggle);

            // Track changes to the state using advice
            this.after('stateChanged', this.update);

            // Transition the state using `replaceState`
            this.replaceState({
                active: this.attr.initiallyActive
            });
        });

        this.toggle = function () {
            // Merge changes onto the state using `mergeState`
            this.mergeState({
                // Access the current state using `this.state`
                active: !this.state.active
            });
        };

        this.update = function (state, previousState) {
            this.$node.toggleClass('is-active', state.active);
        };
    }
);

Tracking changes to your state should be done with advice on stateChanged:

this.after('stateChanged', this.reactToStateChange);

API

initialState

initialState, like attributes, takes an object to set up the first state of an instance of a component. If you can pass a function, it will be called at initialize-time to produce the initial value. This allows you to react to the attrs or node of a component to produce the initial state.

For example:

this.initialState({
    active: false,
    id: function () {
        return this.attr.id;
    }
})

Warning: data structures as values in initialState will be shared by instances of a component. If you need a new data structure each time, return it from a function.

replaceState

replaceState changes the component's state to a new value. You can react to a change to state using this.after('replaceState', this.doSomething).

this.replaceState({
    active: false
});
// this.state.active === false
this.replaceState({
    id: '123'
});
// this.state.id === '123'
// this.state.active === undefined

mergeState

mergeState shallow merges an object into the component's state.

this.mergeState({
    active: false
});
// this.state.active === false
this.mergeState({
    id: '123'
});
// this.state.id === '123'
// this.state.active === false

fromState

Make a function that returns the piece of state specified by the key passed.

var getActive = this.fromState('active');
...
getActive.call(this); // returns this.state.active

toState

Make a function that sets the state at key to the value it is called with.

var setActive = this.toState('active');
...
setActive.call(this, false); // sets this.state.active to false

fromAttr

Make a function that returns a components attributes, specified by the key passed.

var id = this.fromAttr('id');
...
id.call(this); // returns this.attr.id

fromAttr is most useful when used with initialState:

this.attributes({
    isActive: false
});

this.initialState({
    active: this.fromAttr('isActive')
});

Development

To develop this module, clone the repository and run:

$ npm install && npm test

If the tests pass, you have a working environment. You shouldn't need any external dependencies.

Contributing to this project

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing.