Package @reatom/preact

Reatom adapter for preact.

Installation

npm i @reatom/preact

Read the handbook first for production usage.

Binding Atoms to Components

Reatom offers powerful ways to integrate state management directly into your Preact components, ensuring reactivity and proper lifecycle management.

reatomComponent

The primary API to bind atoms and actions to a component’s lifetime is reatomComponent. It wraps your regular Preact component function, placing it within a Reatom reactive context.

Features:

• Reactive Reads: Simply call an atom (myAtom()) within the component function to read its value and subscribe to updates. The component will automatically re-render when the atom changes.
• Standard Preact: Use any other Preact hooks (useState, useEffect, etc.), accept props, and return any valid ReactNode as usual.
• Context Preservation: Event handlers should be wrapped with wrap() (e.g., onClick={wrap(myAction)}) to preserve the reactive context, especially for async operations or actions updating state.
• No Hooks Rules for Atoms: Call and subscribe to atoms conditionally within your render logic without violating Preact’s rules of hooks.
• Automatic Cleanup: Integrates with Reatom’s abort context. Effects or async operations triggered from within the component (using wrap or implicitly by actions) are automatically aborted if the component unmounts before completion, preventing race conditions and memory leaks.

import { atom, wrap } from '@reatom/core'
import { reatomComponent } from '@reatom/preact'

export const page = atom(0, 'page').extend((target) => ({
  next: () => target((state) => state + 1),
  prev: () => target((state) => Math.max(0, state - 1)),
}))

// Simple component reading and updating global state
export const Paging = reatomComponent(
  () => (
    <span>
      <button onClick={wrap(page.prev)}>prev</button> {/* Use wrap */}
      {page()} {/* Read atom value */}
      <button onClick={wrap(page.next)}>next</button> {/* Use wrap */}
    </span>
  ),
  'Paging',
) // Naming the component is crucial for debugging!

// Component accepting props (including atoms)
type CounterProps = {
  label: string
  count: Atom<number>
  increment: Action<[], number>
}

export const Counter = reatomComponent<CounterProps>(
  ({ label, count, increment }) => (
    <div>
      {label}: {count()}
      <button onClick={wrap(increment)}> + </button>
    </div>
  ),
  'Counter',
)

// Conditional rendering based on atom values
export const SomeList = reatomComponent(
  () =>
    isLoading() ? ( // Read atom conditionally
      <span>Loading...</span>
    ) : (
      <ul>
        {list().map(
          (
            el, // Read another atom
          ) => (
            <li key={el.id}>{el.text}</li>
          ),
        )}
      </ul>
    ),
  'SomeList',
)

Do not forget to put the component name to the second argument, it will increase your feature debug experience a lot!

Unmount Behavior

A key feature of reatomComponent is its integration with Reatom’s abort mechanism. When a reatomComponent unmounts:

1. Its associated reactive context is aborted.
2. Any pending async operations initiated within that context (e.g., await wrap(fetch(...)), await wrap(sleep(...))) are automatically cancelled.
3. Any active effect primitives created within its context are automatically cleaned up.

This robust cleanup prevents common issues like trying to update state on unmounted components and avoids memory leaks from lingering subscriptions or timers. If you need an operation to survive component unmount (e.g., analytics), use spawn from the core package.

reatomFactoryComponent (Recommended for Local State/Effects)

While reatomComponent is great for reading atoms state, reatomFactoryComponent is the recommended pattern for components that need their own local, encapsulated state and side effects.

It separates the component logic into two parts:

1. Factory Function: Runs once when the component instance is created. This is where you define local atoms, actions, and effects specific to this component instance. It receives the component’s initial props.
2. Render Function: Runs on every render, just like a regular Preact component function. It has access to the atoms and actions created in the factory scope and the current props.

Benefits:

• True Encapsulation: Local state and effects are tied to the component instance, not shared globally.
• Lifecycle Management: The factory scope provides a natural place for setup logic.
• Perfect for effect: effect primitives created in the factory are automatically cleaned up when the component unmounts, making it ideal for managing local subscriptions, timers, animations, etc.
• Stable References: Atoms, actions or any other functions created in the factory have stable references across renders.

import { atom, action, effect, wrap, sleep } from '@reatom/core'
import { reatomFactoryComponent } from '@reatom/preact'

// Example: A self-contained counter component
const Counter = reatomFactoryComponent<{ initialCount: number; step?: number }>(
  // 1. Factory Function (runs once per instance)
  (initProps) => {
    // Note that the props will not change in this initialization scope.
    const step = initProps.step ?? 1
    // Create local atom specific to this Counter instance
    const count = atom(initProps.initialCount, 'localCount')
    // Create local action
    const increment = action(() => count((c) => c + step), 'increment')
    const decrement = action(() => count((c) => c - step), 'decrement')

    // Example: Log changes (effect cleans up automatically)
    effect(() => {
      const currentCount = count()
      console.log(`Counter ${initProps.initialCount} changed to:`, currentCount)
      // Cleanup function (optional, runs before next effect run or on unmount)
      return () =>
        console.log(
          `Counter ${initProps.initialCount} leaving state:`,
          currentCount,
        )
    }, 'logEffect')

    // Return the render function
    return (props) => (
      <div>
        Count (Initial: {props.initialCount}, Step: {props.step ?? 1}):{' '}
        {count()}
        <button onClick={wrap(decrement)}>-</button>
        <button onClick={wrap(increment)}>+</button>
      </div>
    )
  },
  'Counter', // Name the factory component!
)

// Usage:
// <Counter initialCount={10} />
// <Counter initialCount={0} step={5} />

Example: Using effect for Auto-Cleaning

reatomFactoryComponent combined with effect is excellent for managing resources that need cleanup. It is more powerful and precise primitive than useEffect, as it isn’t coupled with rerenders.

import { atom, effect, wrap, sleep, isAbort } from '@reatom/core'
import { reatomFactoryComponent } from '@reatom/preact'

const IntervalLogger = reatomFactoryComponent<{ intervalMs: number }>(
  ({ intervalMs }) => {
    const tick = atom(0, 'tick')

    // This effect runs a timer and cleans it up automatically on unmount
    effect(async () => {
      while (true) {
        // sleep respects the abort context
        await wrap(sleep(intervalMs))
        tick((t) => t + 1)
      }
    }, 'intervalEffect')

    return (props) => (
      <div>
        Interval ({props.intervalMs}ms) Ticks: {tick()}
      </div>
    )
  },
  'IntervalLogger',
)

// Usage:
// <IntervalLogger intervalMs={1000} />
// When this component unmounts, the interval stops automatically.

reatomFactoryComponent provides a robust and elegant way to build stateful, effectful components with automatic lifecycle management, leveraging the power of Reatom’s core primitives like atom and effect.

Setup context

Optionally, you need to set up the main context once and wrap your application in a provider at the top level. This is required if you have called clearStack() (recommended).

import { context, connectLogger, clearStack } from '@reatom/core'
import { reatomContext } from '@reatom/preact'
import { Main } from './path/to/an/Main'

// Recommended: Disable default context for predictability
clearStack()

const rootFrame = context.start()
if (import.meta.env.DEV) {
  rootFrame.run(connectLogger)
}

export const App = () => (
  <reatomContext.Provider value={rootFrame}>
    <Main />
  </reatomContext.Provider>
)

Variables

reatomContext

reatomContext: Context<null | Frame<any, any[], any>>

Defined in: index.ts:23

Functions

isSuspense()

isSuspense(thing): boolean

Defined in: index.ts:68

Parameters

thing

unknown

Returns

boolean

---

reatomComponent()

reatomComponent<Props>(Component, name?): (props) => ComponentChild

Defined in: index.ts:72

Type Parameters

Props

Props extends Rec

Parameters

Component

(props) => ComponentChild

name?

string

Returns

(props): ComponentChild

Parameters

props

Props

Returns

ComponentChild

---

reatomFactoryComponent()

reatomFactoryComponent<Props>(init, name?): (props) => ComponentChild

Defined in: index.ts:117

Type Parameters

Props

Props extends Rec

Parameters

init

(initProps) => (props) => ComponentChild

name?

string

Returns

(props): ComponentChild

Parameters

props

Props

Returns

ComponentChild

---

useFrame()

useFrame(): Frame

Defined in: index.ts:25

Returns

Frame

---

useWrap()

useWrap<Params, Payload>(callback): (…params) => Payload

Defined in: index.ts:37

Type Parameters

Params

Params extends any[]

Payload

Payload

Parameters

callback

(…params) => Payload

Returns

(…params): Payload

Parameters

params

…Params

Returns

Payload