README.md

containrz

containrz is a simpe hook to help you manage your global and local states without any need for configuration and no dependency on context.

How to use it

In order to use containrz, you need to create a class that extends Container, provided on the package.

import { Container } from 'containrz'

interface User {
  name: string
  email: string
  phoneNumber: string
}

export class UserContainer extends Container<User> {
  public state = {
    name: '',
    email: '',
    phoneNumber: '',
  }

  public setUser = (user: User) => this.setState(user)

  public setName = (name) => this.setState({ name })

  public setEmail = (email) => this.setState({ email })

  // ...
}

Once you have your container, you can now start sharing its state:

import * as React from 'react'
import { useContainer } from 'containrz'
import { UserContainer } from './UserContainer'

export const App = () => {
  const user = useContainer(UserContainer)

  React.useEffect(() => {
    fetch('/user')
      .then(response => response.json)
      .then(data => user.setUser(data))
  }, [])

  return <input value={user.state.name} onChange={e => user.setName(e.target.value)} />
}

Share globally and locally

If your intention is to share the state globally, you can then use simply the reference to the class inside the useContainer call. However, you can create local states by creating instances of those classes.

export const App = () => {
  // uses the global state for UserContainer
  const user = useContainer(UserContainer)

  return (
    // ...
  )
}

export const App = () => {
  // creates a local state for UserContainer
  const[localUser] = React.useState(new UserContainer())
  const user = useContainer(localUser)

  return (
    // ...
  )
}

If your state should be exclusively local, and you want to make sure it cease to exist after your component unmounts, you can pass a second parameter to the useContainer hook, to delete the created container on unmount.

export const App = () => {
  const[localUser] = React.useState(new UserContainer())
  const user = useContainer(localUser, true) // delete container on unmount

  return (
    // ...
  )
}