Socket
Socket
Sign inDemoInstall

lstate

Package Overview
Dependencies
3
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    lstate

A simple, super-efficient and small (just 2.4kb) global state for React/Typescript applications


Version published
Weekly downloads
2
increased by100%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

lstate

Node.js CI Coverage Status

A simple, super-efficient and small (just 2.4kb) global state for React/Typescript applications. A greater alternative to redux, MobX, Zustand...

install

npm install --save lstate

usage

// sample.ts

import React from 'react';
import { createLState, useLState } from "lstate";

export const sample = createLState({
    initial: {count: 0},
    reducers: (setter) => ({
        inc() {
            setter((old) => ({count: old.count + 1}))
        },
    })
})

export function Sample() {
  const { count } = useLState(sample)
  return  <div className="App">
    <p>count: {count}</p>
    <button onClick={sample.inc}>+</button>
  </div>
}

Click here to see a running demo

why?

LState was created with these directives:

  • Reduce the boilerplate of UI external state
  • Avoid unnecessary rendering
  • Best Typescript integration

Advanced features

computed states

// computed.ts
import React from 'react';
import { createLState, useLState } from "lstate";
import { sample } from './sample'

const double = createLState({
  default: {doubleOfCount: 0},
  dependencies: [sample],
  debounce: 3000,
  compute: (setter, sampleValue) => {
      setter((old) => ({doubleOfCount: sampleValue.count * 2}))
  }
})

export function Computed() {
  const { doubleOfCount } = useLState(double)
  const { count } = useLState(sample)
  return  <div className="App">
    <p>count: {count}</p>
    <p>doubleOfCount: {doubleOfCount}</p>
    <button onClick={sample.inc}>+</button>
  </div>
}

collections of items

// collection.ts
import React from 'react';
import { createLState, useLState } from "lstate";

interface Employee {
    _id: number
    name: string
    salary: number
}
const sampleEmployees: Employee[] = [
    { _id: 1, name: 'one', salary: 100 },
    { _id: 2, name: 'two', salary: 200 }
]

export employeeState = sample = createLState({
    id: '_id', // the id field of the collection
    items: sampleEmployees,
    reducers: ({ update }) => ({
        raiseSalary (id: number, amount:number) {
            update(id, (old) => ({ salary: (old.salary || 0) + amount }))
        }
    })
})

export function App() {
  const employees = useLState(employeeState)
  const specificEmployee = useLState(employeeState, 1)
  return  <div className="App">
    <h1>Testing lstate collections</h1>
    <div>
      listing all employees
      <ul>
      {employees.map( employee => (
        <li>{employee.id} {employee.name} {employee.salary}</li>
      ))}
      </ul>
    </div>
    <div>
      Specific employee salary = {employeeOne?.salary || 'not found'}
    </div>
    <button onClick={sample.inc}>raise salary of employee one</button>
  </div>
}

FAQs

Last updated on 01 Feb 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc