blackbox.js
v1.0.3
Published
Blackbox.js is a library for handling state inside your React application. ๐ฆ
Downloads
7
Maintainers
asynchedReadme
Blackbox.js
Blackbox is a predictable, boilerplate free state management library for React. ๐ฆ
It's designed specifically for React applications, so you don't have to worry about installing other third party packages.
And it's tiny! ๐ค
Index
Installation
Assuming your using npm as your package manager, install it typing the command below in your terminal:
$ npm i blackbox.jsLearn ๐ค
Blackbox is a library designed for you to deal with globally shared state as easily as possible, without introducing any boiler plate code like reducers, switch statements or providers. With it, you're encouraged to do things as simple as possible.
Similar to other flux-like libraries, it's architecture is based on the single source of truth principle, where the state is a single global instance in your app, making it easier to reason about where the state and actions are coming from.
The gist ๐ง
As said previously, blackbox is designed to give you a simple and boilerplate free API for dealing with your state. All you have to do is to create a globally available box object to share between your components.
The example below shows the usage of it with a simple counter app.
import createBox from 'blackbox.js'
// Creates a reactive box object that'll
// update and trigger any subscribers.
const counterBox = createBox(0)
/**
* This is an action, an action is the preferred way to
* interact with your state.
*
* We define them as functions that when triggered,
* updated the internal state of a box.
*
* In this case, then the function "increment" is called we
* increment the counter by the parameter "incrementBy".
*
* Declaring well defined actions will make your life easier
* in the long run, since everything will be mapped to a
* function. ๐ธ
*
*/
function increment(incrementBy = 1) {
counterBox.set((counter) => counter + incrementBy)
}
/**
* Since we've defined an action to increment the counter previously, the
* "decrement" can call the "increment" with a negative value.
*
* In this function you can see that actions can call other actions or either
* call themselves!
*/
function decrement() {
increment(-1)
}
counterBox.subscribe(console.log) // This will log any changes in the internal box state for us.
/**
* As seen below, both calls are independent of the component
* context and don't need a hook to be triggered.
*
* We'll see how it's used inside a component in the section below.
*/
increment() // Increments the counter
decrement() // Decrements the counterReact โ๏ธ
Building on the previous example, blackbox provides you with hooks you can use to flatten a box object to it's original state and make it reactive. We'll build a counter app with the previous actions to show you how easy it is.
import React from 'react'
import createBox, { useBox } from 'blackbox.js'
// As shown in the previous example, you can
// create a box from any value. We are using
// zero as the initial state for the box.
const counterBox = useBox(0)
/**
* Our user-defined action to increment the
* counter by a value (which defaults to one).
*/
function increment(incrementBy = 1) {
counterBox.set((counter) => counter + incrementBy)
}
/**
* Another action to decrement the counter by one.
*/
function decrement() {
increment(-1)
}
/**
* In here, we're using the "useBox" hook to flatten the
* box object to it's original value (zero).
*
* This hook makes the counter reactive to triggered actions
* and deals automatically with the subscription management
* and cleanup.
*/
export default function App() {
const counter = useBox(counterBox) // This will flatten the box to the zero value.
return (
<div>
<h1>Counter is: {counter}</h1>
<div>
<button onClick={() => increment()}>Increment</button>
<button onClick={() => decrement()}>Decrement</button>
</div>
</div>
)
}Examples ๐
License ๐ผ
Author
| 
|
| ------------------------------------------------------ |
| Eder Lima |