@kentico/xperience-admin-base 30.4.1 → 30.5.0

package/dist/entry.d.ts

@@ -314,11 +314,29 @@ declare interface FormCategoryProps {
  * Represents basic set of form component properties.
  */
 export declare interface FormComponentProps extends FieldInfo {
+    /**
+     * Name of the component.
+     */
     readonly componentName: string;
+    /**
+     * Indicates whether evaluation of a visibility condition of some other component depends on this component's value.
+     */
     readonly hasDependencies: boolean;
+    /**
+     * Label of the form component.
+     */
     readonly label?: string;
+    /**
+     * Status text of the form component.
+     */
     readonly statusText?: string;
+    /**
+     * Explanation text of the form component.
+     */
     readonly explanationText?: string;
+    /**
+     * Tooltip of the form component.
+     */
     readonly tooltip?: string;
     /**
      * @deprecated Property is deprecated and will be removed in the next version. Use `editMode` set to `FormEditMode.Disabled` instead.
@@ -328,15 +346,46 @@ export declare interface FormComponentProps extends FieldInfo {
      * Edit mode of the form component.
      */
     readonly editMode?: FormEditMode;
+    /**
+     * Value of the form component.
+     */
     readonly value?: any;
+    /**
+     * Indicates if the form component is in invalid state.
+     */
     readonly invalid?: boolean;
+    /**
+     * Validation message displayed when the form component is in invalid state.
+     */
     readonly validationMessage?: string;
+    /**
+     * Form component's validation rules.
+     */
     readonly validationRules?: ValidationRuleProps[];
+    /**
+     * Additional actions associated with the form component.
+     */
     readonly additionalActions?: AdditionalActionProps[];
+    /**
+     * Action element to be displayed in the label of the form component.
+     */
     readonly labelActionsElement?: React.ReactNode;
+    /**
+     * The callback function called when the value of the form component changes.
+     * * @argument value changed value of the form component.
+     */
     readonly onChange?: (value: OnChangeValueType) => void;
+    /**
+     * Indicates whether the value of the form component is required.
+     */
     readonly required?: boolean;
+    /**
+     * Tooltip message displayed when the form component is disabled.
+     */
     readonly inactiveMessage?: string;
+    /**
+     * GUID of the form component.
+     */
     readonly guid: string;
     /**
      * Dangerously sets tooltip as inner HTML.