@progress/kendo-react-form/interfaces/FieldArrayRenderProps.d.ts

React Form is a small and fast package for form state management with zero dependencies. KendoReact Form package

/**
 * @license
 *-------------------------------------------------------------------------------------------
 * Copyright © 2026 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the package root for more information
 *-------------------------------------------------------------------------------------------
 */
/**
 * Contains props that are passed to components rendered inside FieldArray components.
 */
export interface FieldArrayRenderProps {
    /**
     * Represents the current value of the FieldArray
     * ([see example](https://www.telerik.com/kendo-react-ui/components/form/custom-components#toc-using-basic-properties)).
     */
    value: any;
    /**
     * Contains the error message from validation.
     * The field is valid when this is empty.
     */
    validationMessage: string | null;
    /**
     * Shows whether the user has interacted with the field.
     * Becomes true when the field loses focus.
     */
    touched: boolean;
    /**
     * Shows whether the field value has changed from its initial value.
     * Becomes true when the field value changes for the first time.
     */
    modified: boolean;
    /**
     * Shows whether the user has focused on the field.
     * Becomes true when the field receives focus.
     */
    visited: boolean;
    /**
     * Shows whether the field passes validation and has been touched.
     */
    valid: boolean;
    /**
     * Contains child elements that are passed to the FieldArray.
     */
    children: any;
    /**
     * Contains the field name in the form state.
     */
    name: string;
    /**
     * Adds a value to the beginning of the array.
     */
    onUnshift: (options: {
        value: any;
    }) => number;
    /**
     * Adds a value to the end of the array.
     */
    onPush: (options: {
        value: any;
    }) => void;
    /**
     * Inserts a value at a specific position in the array.
     */
    onInsert: (options: {
        value: any;
        index: number;
    }) => void;
    /**
     * Removes and returns the last value from the array.
     */
    onPop: () => any;
    /**
     * Removes a value at a specific position in the array.
     */
    onRemove: (options: {
        index: number;
    }) => any;
    /**
     * Replaces a value at a specific position in the array.
     */
    onReplace: (options: {
        value: any;
        index: number;
    }) => void;
    /**
     * Moves a value from one position to another in the array.
     */
    onMove: (options: {
        prevIndex: number;
        nextIndex: number;
    }) => void;
    /**
     * @hidden
     */
    [customProp: string]: any;
}