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

@evanminto/lit-directive-stateful

v0.1.0

Published

Lit directive to make a subtree reactive, enabling the use of ReactiveControllers

Downloads

3

Readme

Stateful - Lit Directive

Lit directive to make a subtree reactive, enabling the use of ReactiveControllers.

Getting Started

Install with NPM...

npm install @evanminto/lit-directive-stateful

... or Yarn.

yarn add @evanminto/lit-directive-stateful

Then import it into your JavaScript file:

import { stateful } from '@evanminto/lit-directive-stateful';

How It Works

Normally in Lit, LitElements manage all reactive state via properties. This directive enables you to create a stateful sub-section of your application, with access to the same flexible ReactiveController and ReactiveControllerHost APIs available for full-fledged LitElement components, without registering a new element.

Let’s look at a code sample:

import { html } from 'lit';
import { stateful } from '@evanminto/lit-directive-stateful';

function MyComponent({ initialValue = 0 } = {}) {
  return html`
    ${stateful(
      (host) => new MyReactiveController(host),
      (controller) => html`
        <button type="button" @click=${() => controller.someMethod()}>Click me</button>
        <output>${controller.someValue}</output>
      `
    )}
  `;
}

The first argument is an init function that runs only the first time the directive is connected to the DOM, and returns a state value that persists between renders. It accepts a single argument: a ReactiveControllerHost that allows the init function to hook into the reactive lifecycle. Of course that means you can return a ReactiveController (or multiple) that hook into the host.

The second argument is a render function that runs every render and accepts the state as an argument. It should return whatever you want to render (probably a Lit template or string).

Notably, the directive only attempts to re-render its own contents (the return value of the render function). If you want it to trigger re-renders further up the tree, you’ll need to manage that state elsewhere.

Why Do This?

In my own application I found Lit’s assumption that reactivity lives at the custom element level a bit limiting, but I really like the ReactiveController pattern. I found it useful to attach controllers even to smaller functional components or sub-templates.