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:
Parameter | Type | Description |
---|---|---|
builderStore | object | The builder store instance to monitor. |
callback | function | A 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.