@open-pioneer/reactivity

This package provides hooks and helpers to work with the reactivity API provided by @conterra/reactivity-core.

NOTE: This package and @conterra/reactivity-core are still actively being worked on. There may be breaking changes based on user feedback; stability can not yet be guaranteed.

Usage

Rendering reactive values

The hook useReactiveSnapshot(callback, deps) is integrated with the reactivity API of @conterra/reactivity-core. The hook will continuously invoke the provided callback and return the current result. For this mechanism to work, the values used inside the callback should be based on the reactivity API (or be declared as deps).

Example:

// YourComponent.tsx
import { useReactiveSnapshot } from "@open-pioneer/reactivity";
import { Model } from "./Model";

export interface YourComponentProps {
    // Some model class or interface based on the reactivity API.
    // In this case, the model has the properties `firstName` and `lastName`, both are (reactive) strings.
    model: Model;
}

export function YourComponent({ model }: YourComponentProps) {
    const fullName = useReactiveSnapshot(() => {
        // You can compute arbitrary values based on your model, even objects or array.
        // This callback is called whenever any dependency changed, this case if firstName or
        // lastName are updated.
        // Keep in mind that this callback should not have any side effects, because it may run any number of times.
        return `${model.firstName} ${model.lastName}`;
    }, [model]);

    // Name is automatically kept up-to-date.
    return <div>Hello {fullName}</div>;
}

• callback is a function that accesses reactive values which are based on signals (see example below) and returns some computed result. In the example above, we used the values of firstName and lastName. The access to those values was tracked by useReactiveSnapshot; updates will result in the React component rendering with the updated fullName.
• deps are an array of React dependencies (such as props or local variables), very similar to useEffect or useMemo. The hook cannot detect changes of values that are not based on the reactivity API (such as react props), so they need to be listed here. In this case we had to specify the model itself (it may change as well!) but not its properties.

To complete the example from above, here is the full source of a compatible Model implementation:

// Model.ts
import { reactive } from "@conterra/reactivity-core";

export class Model {
    // Private storage. Signals are not exposed in this example.
    #firstName = reactive("John");
    #lastName = reactive("Doe");

    // Public getters to access the current values, with a convenient API.
    get firstName(): string {
        return this.#firstName.value;
    }

    get lastName(): string {
        return this.#lastName.value;
    }

    // Update the name values.
    // Any UI connected to the model via useReactiveSnapshot() will automatically update.
    updateName(newFirstName: string, newLastName: string): void {
        this.#firstName.value = newFirstName;
        this.#lastName.value = newLastName;
    }
}

Rendering a single reactive value

If you have a single signal at hand, there is no need to use the more complex useReactiveSnapshot hook. You can use the more primitive useReactiveValue hook instead:

import { useReactiveValue } from "@open-pioneer/reactivity";

function YourComponent({ signal }) {
    const value = useReactiveValue(signal); // Subscribes to `signal.value` and re-renders on changes.
    return <div>{value}</div>;
}

More details are available in this package's API documentation and the README of @conterra/reactivity-core.

ESLint configuration

You can use React's exhaustive-deps linting rule to check the dependencies of useReactiveSnapshot and useComputed (see Documentation). This will apply the same rules used by useEffect etc. to the configured hooks.

Example:

// .eslintrc
{
    // ...
    "rules": {
        // ...
        "react-hooks/exhaustive-deps": [
            "warn",
            {
                "additionalHooks": "(useReactiveSnapshot|useComputed)"
            }
        ]
    }
}

License

Apache-2.0 (see LICENSE file)