Getting started

Installation

WARNING

effector-reform is not production ready yet and still may have bugs and unstable API. If you found bug — please report it on GitHub.

npm

npm install @effector-reform/core

yarn

yarn add @effector-reform/core

pnpm

pnpm add @effector-reform/core

TIP

In SSR project you must add @effector-reform/core in "factories" list in effector babel plugin

React bindings

npm

npm install @effector-reform/react

yarn

yarn add @effector-reform/react

pnpm

pnpm add @effector-reform/react

Writing first form

As an example, we will write a simple form with name and age fields.

import { createForm } from "@effector-reform/core";
import { allSettled, createEvent, fork, sample } from "effector";

const scope = fork();

const form = createForm({
  schema: {
    name: '',
    age: 0
  },
});

const nameChanged = createEvent<string>();

sample({
  clock: nameChanged,
  target: form.fields.name.change,
});

await allSettled(nameChanged, { scope, params: 'Edward' });

console.log(scope.getState(form.fields.name.$value)); // Edward