Reactivity

Framework agnostic library for building reactive applications.

Warning

The APIs implemented in this repository are still under active development and may change based on feedback.

Reactivity-API

See the README of the @conterra/reactivity-core package.

The API docs for the latest release are hosted here. Click here for the API docs of the current main branch.

Setup

Install pnpm, for example by running npm install -g pnpm.

Install dependencies:

$ pnpm install

Tests

# Runs all tests
$ pnpm test

$ cd packages/reactivity-core
$ pnpm test # watch mode

Watch TypeScript errors:

$ pnpm watch-types

Playground

You can try this library together with Vue3 in the playground directory. See README for more details.

Render typedoc

Build typedoc output (to dist/docs).

$ pnpm build-docs

Then, use any local web server to serve the documentation. The following example uses serve:

$ pnpm install -g serve # global installation; only necessary once
$ serve dist/docs

Releasing

The release process is semi-automatic at this time. To prepare for a new release:

1. Set the version of @conterra/reactivity-core (in packages/reactivity-core) to the desired new version.
2. Ensure the CHANGELOG.md in that package is up to date.
3. Commit and push your changes.
4. Trigger the Build Action (via run workflow) and tick the RELEASE checkbox. This action will build the package, tag the commit and publish it to npm.

License

Apache-2.0 (see LICENSE file)