React Form Builder | AttributeInstance

This interface describes the properties of a builder entity's attribute instance, which is usually is part of the attributes property of a builder entity instance.

Reference

`AttributeInstance<TAttribute>`

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

import { labelAttribute } from "./label-attribute";

type LabelAttributeInstance = AttributeInstance<typeof labelAttribute>;

Properties

The AttributeInstance interfaces has the following properties:

Prop	Type	Description
`type`	string	The type identifier of the attribute. Corresponds to the key of the attribute definition in the entity definition.
`getValue`	function	Returns the current value of the attribute.
`setValue`	function	Sets the value of the attribute.
`getError`	function	Returns the current validation error associated with the attribute, if any.
`validate`	function	Validates the attribute’s value. Returns a promise that resolves with the validation result.
`setError`	function	Sets a validation error for the attribute.
`subscribeToValue`	function	Subscribes to changes in the attribute's value. Optionally accepts a comparator. Returns an unsubscribe function.
`subscribeToError`	function	Subscribes to changes in the attribute's error state. Optionally accepts a comparator. Returns an unsubscribe function.