@kentico/xperience-admin-base 31.7.4 → 31.8.1

package/dist/entry.d.ts

@@ -127,7 +127,13 @@ declare enum ActionType {
  * Represents basic set of additional action properties.
  */
 declare interface AdditionalActionProps {
+    /**
+     * Unique identifier of the action.
+     */
     readonly identifier: string;
+    /**
+     * Name of the client component that renders the action.
+     */
     readonly componentName?: string;
 }
 
@@ -182,21 +188,69 @@ export declare interface AssetUploadPlaceholderData {
 }
 
 declare interface BaseButtonProps extends UITestProps {
+    /**
+     * Render callback producing the interactive element, receiving the computed classes and content.
+     */
     readonly renderComponent: (props: InjectedProps) => React.ReactNode;
+    /**
+     * Size of the button. Defaults to M.
+     */
     readonly size?: ButtonSize;
+    /**
+     * Visual variant of the button. Defaults to Secondary.
+     */
     readonly color?: ButtonColor;
+    /**
+     * Text of the button. Without it the button renders icon-only.
+     */
     readonly label?: string;
+    /**
+     * Icon rendered before the label. Destructive buttons default to the bin icon.
+     */
     readonly icon?: IconName;
+    /**
+     * Icon rendered after the label.
+     */
     readonly trailingIcon?: IconName;
+    /**
+     * Applies the pressed visual state.
+     */
     readonly active?: boolean;
+    /**
+     * Renders a notification dot in the corner of the button.
+     */
     readonly badge?: boolean;
+    /**
+     * Stretches the button to the full width of its parent.
+     */
     readonly fillContainer?: boolean;
+    /**
+     * Applies the destructive styling.
+     */
     readonly destructive?: boolean;
+    /**
+     * Shows a spinner instead of the icon and disables the button.
+     */
     readonly inProgress?: boolean;
+    /**
+     * Disables the button.
+     */
     readonly disabled?: boolean;
+    /**
+     * Applies the flat borderless styling.
+     */
     readonly borderless?: boolean;
+    /**
+     * Tab index of the button element.
+     */
     readonly tabIndex?: number;
+    /**
+     * Drag handle props from @hello-pangea/dnd making the button act as a drag handle.
+     */
     readonly dragHandleProps?: DraggableProvidedDragHandleProps | null;
+    /**
+     * Additional class name of the button element.
+     */
     readonly className?: string;
 }
 
@@ -208,8 +262,17 @@ declare enum ButtonColor {
 }
 
 declare interface ButtonProps extends HTMLButtonProps, Omit<BaseButtonProps, 'renderComponent'> {
+    /**
+     * HTML type of the button element. Defaults to 'button'.
+     */
     readonly type?: ButtonType;
+    /**
+     * Ref to the button element, typically used to anchor drop-down menus.
+     */
     readonly buttonRef?: RefObject<HTMLButtonElement>;
+    /**
+     * Element the tooltip popup is appended to.
+     */
     readonly tooltipAppendTo?: Element;
 }
 
@@ -326,7 +389,13 @@ declare interface DialogAction extends Omit<DialogFooterActionProps, 'color'> {}
 
 declare interface DialogFooterActionProps
 extends Pick<ButtonProps, 'icon' | 'trailingIcon' | 'destructive' | 'disabled' | 'inProgress' | 'color' | 'onClick'>, UITestProps {
+    /**
+     * Label of the action button.
+     */
     readonly label: string;
+    /**
+     * Tooltip of the action button.
+     */
     readonly tooltipText?: string;
 }
 
@@ -342,7 +411,13 @@ declare interface DialogHandlers {
  * Represents information about form field.
  */
 export declare interface FieldInfo<TValues extends FieldInfoValueType = FieldInfoValueType> {
+    /**
+     * Name of the field. Serves as the field's key in the form value store.
+     */
     readonly name: string;
+    /**
+     * Snapshot of all current form field values keyed by field name. Supplied by the form runtime for cross-field logic such as validation rules.
+     */
     readonly fieldValues: TValues;
 }
 
@@ -421,7 +496,8 @@ export declare interface FormComponentProps<TValue extends FormFieldValue = Form
     readonly labelActionsElement?: React.ReactNode;
     /**
      * The callback function called when the value of the form component changes.
-     * * @argument value changed value of the form component.
+     *
+     * @param value Changed value of the form component.
      */
     readonly onChange?: (value?: TValue) => void;
     /**
@@ -970,8 +1046,17 @@ export declare interface ValidationRule<P extends ValidationRuleProps, TValue ex
  * Represents basic set of validation rule properties.
  */
 export declare interface ValidationRuleProps {
+    /**
+     * Name of the validation rule.
+     */
     readonly ruleName: string;
+    /**
+     * Indicates whether the rule is currently satisfied.
+     */
     readonly isValid: boolean;
+    /**
+     * Error message displayed when the rule is not satisfied.
+     */
     readonly errorMessage: string | null;
 }