React Form Builder | useBuilderStore

This React hook creates a builder store.

Reference

`useBuilderStore(builder, options?)`

Use the useBuilderStore function to create a builder store.

import { useBuilderStore } from "@coltorapps/builder-react";

import { formBuilder } from "./form-builder";

export function App() {
  const builderStore = useBuilderStore(formBuilder);
}

Parameters

useBuilderStore accepts two parameters:

Parameter	Type	Description
`builder`	object	The builder definition.
`options`	object optional	An optional partial object with initialization options.

The options parameter properties:

Property	Type	Description
`initialData`	object optional	The optional partial initial data of the builder store.
`events`	object optional	An optional partial object with events callbacks.

Returns

The useBuilderStore function essentially creates and returns a builder store.

Events Callbacks

Each event emitted by the builder store is available as a callback within the events key of the options parameter. Every callback receives a specific payload based on the event.

Callback	Description
`onEntityAdded`	An entity was added.
`onEntityUpdated`	An entity was updated.
`onEntityAttributeUpdated`	An entity's attribute was updated.
`onEntityDeleted`	An entity was deleted.
`onEntityCloned`	An entity was cloned.
`onRootUpdated`	The root was updated.
`onEntityAttributeErrorUpdated`	An entity's attribute error was updated.
`onSchemaErrorUpdated`	The schema's error was updated.
`onSchemaUpdated`	The schema was updated.
`onDataSet`	The data was manually set.