We are Coltor Apps ― a software development agency behind this OSS. Need a reliable tech partner?

Let’s talk

React API Reference

useEntityDeleted

The useEntityDeleted hook calls the provided callback whenever an entity is deleted from the given builder store's schema.

Reference

useEntityDeleted(builderStore, callback)

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

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

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

  useEntityDeleted(builderStore, (entity) => {
    console.log("Entity deleted:", entity);
  });

  return null;
}

Parameters

useEntityDeleted accepts two parameters:

ParameterTypeDescription
builderStoreobjectThe builder store instance to monitor.
callbackfunctionA function called whenever an entity is deleted. Receives the deleted entity.

Returns

This hook does not return a value. It registers a side effect that triggers the provided callback whenever an entity is deleted from the store.

Previous
useEntityAdded

Canary Branch