Interface ITreeFieldProps<Data, Payload>

Interface for the props of the ITreeField component.

interface ITreeFieldProps<Data = IAnything, Payload = IAnything> {
    description?: string;
    disabled?: boolean;
    itemTree?:
        | ITreeNode[]
        | (data: Data, payload: Payload) => ITreeNode[]
        | (data: Data, payload: Payload) => Promise<ITreeNode[]>;
    outlined?: boolean;
    placeholder?: string;
    readonly?: boolean;
    title?: string;
    validation?: IValidation;
    watchItemTree?: boolean;
}

Type Parameters

  • Data = IAnything

    The type of data in the field.

  • Payload = IAnything

    The type of payload in the field.

Properties

description? disabled? itemTree? outlined? placeholder? readonly? title? validation? watchItemTree?

Properties

Optionaldescription

description?: 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

disabled?: 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

itemTree?:
    | 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

outlined?: boolean

Type declaration for the PickProp utility function.

Optionalplaceholder

placeholder?: 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

readonly?: 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

title?: 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

validation?: 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

watchItemTree?: boolean

Represents the change detection flag for item tree

Settings

Member Visibility

On This Page

Properties