useEntityAttributesErrors

The useEntityAttributesErrors hook subscribes to all attribute error updates of a given entity and returns the selected result. It provides fine-grained control over reactivity and re-renders by allowing a selector and comparator to be passed.

Reference

useEntityAttributesErrors(entity, selector?, comparator?)

Use the useEntityAttributesErrors function to access and subscribe to the current validation errors of all attributes on an entity instance.

import {
  useEntityAttributesErrors,
  useEntityAttributesValues,
  type BuilderEntityComponentProps,
} from "@coltorapps/builder-react";

import { textFieldEntity } from "./text-field-entity";

export function BuilderTextFieldEntity(
  props: BuilderEntityComponentProps<typeof textFieldEntity>,
) {
  const attributesValues = useEntityAttributesValues(props.entity);

  const attributesErrors = useEntityAttributesErrors(props.entity);

  return (
    <div>
      <label>
        {attributesValues.label} {attributesValues.required ? "*" : null}
        {Object.keys(attributesErrors).length > 0
          ? "Some attributes are invalid"
          : null}
      </label>
      <input />
    </div>
  );
}

Parameters

useEntityAttributesErrors accepts three parameters:

Returns

The useEntityAttributesErrors hook returns the selected validation errors of all attributes on the given entity. If a selector is provided, it returns the derived value instead.