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-obstate

v0.1.3

Published

React hooks for the generic object state management library

Downloads

939

Readme

React Obstate

React hooks for the generic object state management library obstate

react-obstate Tests

obstate is a generic state management library that uses proxies to wrap objects to allow for easy state change notifications. These notifications are used in the hooks provided by this library so that obstate states can be used in React projects with ease. It's primarily designed to allow for a global state instance to be used both manually and via React components.

Installation

Install by running: npm install react-obstate obstate --save-dev.

obstate is a peer dependency of this library.

Usage

In your component simply import the hook you desire and pass a (global) obstate state instance to it:

import React from "react";
import { createStateObject } from "obstate";
import { useSingleState } from "react-obstate";

const globalState = createStateObject({
    test: 100
});

export function ReactComponent(props) {
    const [currentValue, setValue] = useSingleState(globalState, "test");
    return (
        <div>
            <p>The current value is: {currentValue}</p>
            <button onClick={() => setValue(currentValue + 1)}>Increment</button>
        </div>
    );
}

The useSingleState hook allows for reading and updating a single property in an obstate instance.

You can also work with a full state object just as easily:

import React from "react";
import { createStateObject } from "obstate";
import { useState } from "react-obstate";

const globalState = createStateObject({
    test: 100,
    on: false
});

export function ReactComponent(props) {
    const [state, setPartial /*, setFull */] = useState(globalState);
    return (
        <div>
            <p>The current value is: {state.test}</p>
            <p>Power is <strong></strong></p>
            <button onClick={() => setPartial({ test: state.test + 1 })}>Increment</button>
            <button onClick={() => setPartial({ on: !state.on })}>Toggle</button>
        </div>
    );
}

The useState hook allows for reading and updating an entire obstate instance. The first parameter returned is the full state value at the current point in time (minus the obstate event emitter interface). The second is a partial-update method and the third is a full-update method.

Partial updates allow for specifying only the properties you wish to update, whereas full updates completely rewrite the state object.