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

@traxjs/trax-preact

v1.0.0

Published

Preact bindings for Trax: create reactive components

Downloads

5

Readme

Trax Preact Bindings

This package contains trax bindings for preact only, with no dependencies to react (this can be useful to load it through an import map)

They allow to wrap components into trax processors and have them automatically re-rendered when one of their dependencies change (no need to re-render the preact tree from the root);

This library mainly exports 4 functions

  • component(...): to wrap a preact function component into a trax processor
  • useTraxState(...): to create a simple reactive state object
  • useStore(...): to instantiate a store and associate it to a component
  • componentId(): to retrieve the processor id associated to a given component (this function must be called in the component render function)

component()

function component<T>(name: string, reactFunctionCpt: (props: T) => JSX.Element): (props: T) => JSX.Element {...}

Wrap a preact function component into a trax processor. Note: the function component will be then considered as a pure component (Memo) and will only be re-rendered if

  • one of its trax dependencies changed (these dependencies can be passed by any means, e.g. props, contexts or even global variables)
  • a property reference changes (i.e. new reference for objects) - like for any preact component

Parameters:

  • name the compontent name - usually the same as the component function
  • reactFunctionCpt the functional component

Example:

export const TodoList = component("TodoList", () => {
    const tds = useStore(createTodoStore);

    return <div data-id={componentId()} className='todoList'>
        ...
    </div>
});

useTraxState()

function useTraxState<T extends Object>(state: T): T

Create a trax state object to hold state values associated to a component. Note: this function should only be called once in a given component as multiple state values can be set in a given state object

Behind the scenes, useTraxState creates a simple store object and calls useStore - this is why it it is visible in the Store section in the dev tools.

useStore()

function useStore<T = any>(factory: () => T): T {...}

Helper function to create or retrieve a store instance attached to the caller component

  • factory a factory function to create the store instance
  • returns the store object

Example:

<div className="my-component" data-id={componentId()}> ... </div>

componentId()

function componentId(): string {...}

Return the id of the trax processor associated to a preact component when called in in the component render function. Useful to insert the component id in the component HTML (e.g. through the data-id attribute) to ease troubleshooting

Example:

<div className="my-component" data-id={componentId()}> ... </div>

resetReactEnv()

function resetPreactEnv() {...}

Reset the internal "Preact" data store to restart from a blank state (Test environment only)