Interface IWrappedLayout<Data, Payload>

Represents a layout with various properties that control its visibility, disabled state, and other features.

interface IWrappedLayout<Data = IAnything, Payload = IAnything> {
    baseline?: boolean;
    desktopHidden?: boolean | (payload: Payload) => boolean;
    disabled?: boolean;
    features?: string[];
    hidden?: boolean | (payload: Payload) => boolean;
    isDisabled?: (v: Data, payload: Payload) => boolean;
    isReadonly?: (v: Data, payload: Payload) => boolean;
    isVisible?: (v: Data, payload: Payload) => boolean;
    noBaseline?: boolean;
    phoneHidden?: boolean | (payload: Payload) => boolean;
    tabletHidden?: boolean | (payload: Payload) => boolean;
    testId?: string;
}

Type Parameters

  • Data = IAnything

    The data type used by the layout.

  • Payload = IAnything

    The payload type used by the layout.

Hierarchy (View Summary)

Properties

baseline? desktopHidden? disabled? features? hidden? isDisabled? isReadonly? isVisible? noBaseline? phoneHidden? tabletHidden? testId?

Properties

Optionalbaseline

baseline?: boolean

Represents an optional property baseline that is picked from the interface IField using the PickProp utility type.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

OptionaldesktopHidden

desktopHidden?: boolean | (payload: Payload) => boolean

Represents the optional property desktopHidden of type PickProp<IField<Data, Payload>, 'desktopHidden'>.

Optionaldisabled

disabled?: boolean

Represents the disabled property of a field.

Optionalfeatures

features?: string[]

Retrieves the 'features' property from a given variable.

Template: T

The type of the variable.

Template: K

The property name to retrieve.

Param: variable

The variable to extract the property from.

Returns

  • The extracted 'features' property.

Optionalhidden

hidden?: boolean | (payload: Payload) => boolean

Represents the 'hidden' property of an object.

Template: IField

The type of the field object.

Template: Data

The type of the data object.

Template: Payload

The type of the payload object.

OptionalisDisabled

isDisabled?: (v: Data, payload: Payload) => boolean

Represents the isDisabled property of a field in a form. The isDisabled property determines whether the field is disabled or not.

OptionalisReadonly

isReadonly?: (v: Data, payload: Payload) => boolean

Retrieves the value of the 'isReadonly' property from the given variable.

Type declaration

    • (v: Data, payload: Payload): boolean

    • Parameters

      Returns boolean

      The value of the 'isReadonly' property.

OptionalisVisible

isVisible?: (v: Data, payload: Payload) => boolean

Represents the isVisible property of a field in a form.

OptionalnoBaseline

noBaseline?: boolean

Represents an optional property noBaseline that is picked from the interface IField using the PickProp utility type.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

OptionalphoneHidden

phoneHidden?: boolean | (payload: Payload) => boolean

Represents the phoneHidden property of a field object.

OptionaltabletHidden

tabletHidden?: boolean | (payload: Payload) => boolean

Represents the optional property 'tabletHidden' in a field object.

OptionaltestId

testId?: string

Идентификатор для отладки json шаблона

Settings

Member Visibility

On This Page

Properties