Function TreeField

Parameters

• props: ITreeFieldProps<any, any> & ITreeFieldPrivate<any>

  The props object containing the necessary data for rendering the TreeField.

  Interface for the props of the ITreeField component.

  • Optionaldescription?: string

    Returns the "description" property of a given object.

    Template: T

    The type of the object.

    Template: K

    The literal key type.

    Param: obj

    The object from which to extract the property.

    Param: key

    The literal key representing the property to extract.

    Returns

    • The value of the specified property.

  • Optionaldisabled?: boolean

    Represents the disabled property of a field in a form.

    Template: Data

    The type of data stored in the form.

    Template: Payload

    The type of payload used for form submission.

  • OptionalitemTree?:
        | ITreeNode[]
        | (data: Data, payload: Payload) => ITreeNode[]
        | (data: Data, payload: Payload) => Promise<ITreeNode[]>

    Represents the item tree of a specific field in the data payload.

  • Optionaloutlined?: boolean

    Type declaration for the PickProp utility function.

  • Optionalplaceholder?: string

    Type definition for the variable placeholder.

    Template: Data

    The type of data for the field.

    Template: Payload

    The type of payload for the field.

  • Optionalreadonly?: boolean

    Specifies if a field is readOnly.

    Param: readonly

    The field being checked for readOnly status.

    Returns

    • A boolean value indicating if the field is readOnly.

  • Optionaltitle?: string

    Type definition for the "title" property picked from the given object type.

    Template: IField

    The object type that contains the "title" property.

    Template: Data

    The data type of the "title" property.

    Template: Payload

    The payload type of the "title" property.

    Param: -

    The object from which the "title" property will be picked.

    Returns

    • The resulting object that only contains the "title" property.

  • Optionalvalidation?: IValidation

    Validation factory config

    Template: IField

    Type representing the field object.

    Template: Data

    Type representing the data object.

    Template: Payload

    Type representing the payload object.

    Returns

    The value of the "validation" property.

  • OptionalwatchItemTree?: boolean

    Represents the change detection flag for item tree

  Represents the private interface for the TreeField component.

  • dirty: boolean

  • disabled: boolean

  • incorrect: null | string

  • invalid: null | string

  • loading: boolean

  • name: string

  • onChange: (v: any, config?: { skipReadonly?: boolean }) => void

  • value: any

  • withContextMenu: undefined | true