Git Product home page Git Product logo

lit-state's Introduction

lit-state

npm npm bundle size

A helpful wrapper for creating functional components with lit-html templating. It requires lit-html to be installed

Install

$ npm install lit-state

Usage

lit-state lets you hold state in functional components. To create such component you have to connect it to higher order function connectState.

import { html } from 'lit-html'
import { connectState } from 'lit-state'

const initialState = {
  name: 'John'
}

const greeter = ({ state }) => html`<p>Hello ${state.name}!</p>`

export default connectState(greeter, initialState)

It returns a function to initialize the component. State is passed to component through an object so you can easily extract it with destructuring. The returned state is immutable though, changing it will have no effect on a component and can cause some problems by having local state "desynced" with the real state of a component.

You can change the state by using another supplyed function, setState.

const initialState = {
  decision: false,
  someOther: 'value'
}

const hesitant = ({ state, setState }) => {
  const changeMind = () => setState({ decision: !state.decision })

  return html`
  <div>
    <p>Are you sure?</p>
    <button @click=${changeMind}>Change</button>
  </div>`
}

The state will be changed this way and triggier a rerender. It is alse worth noting, that the state will change only properties specified in setState function, without touching other values.

To pass props to a component, you can just provide an object when calling the function and extract it the same way as state.

const showMe = connectState(({ props }) => {
  return html`<p>I can see... ${props.thing}</p>`
}, {})

const exposer = () => {
  return html`${showMe({ thing: 'banana' })}`
}

Rerendering the page with setState will only take place when the root component is mounted to the DOM with renderDOM function.

import { html } from 'lit-html'
import { renderDOM } from 'lit-state'

const App = () => html`<div>Hello World!</div>`

renderDOM(App(), '#root')

You have to only supply the root component and a query selector, where to mount it in the document. If no selector was provided, component will be mounted to the document body.

lit-state's People

Contributors

amoroth avatar dependabot[bot] avatar

Stargazers

Marius Orcsik avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.