Interface IGroupLayoutProps<Data, Payload>

Interface for defining the props of GroupLayout component.

interface IGroupLayoutProps<Data = IAnything, Payload = IAnything> {
    baseline?: boolean;
    className?: string;
    columns?: string;
    columnsOverride?: string;
    desktopColumns?: string;
    desktopHidden?: boolean | (payload: Payload) => boolean;
    disabled?: boolean;
    features?: string[];
    fieldBottomMargin?: string;
    fieldRightMargin?: 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;
    phoneColumns?: string;
    phoneHidden?: boolean | (payload: Payload) => boolean;
    style?: any;
    sx?: any;
    tabletColumns?: string;
    tabletHidden?: boolean | (payload: Payload) => boolean;
    testId?: string;
}

Type Parameters

  • Data = IAnything

    The type of data associated with the group.

  • Payload = IAnything

    The type of payload associated with the group.

Hierarchy (View Summary)

Properties

baseline? className? columns? columnsOverride? desktopColumns? desktopHidden? disabled? features? fieldBottomMargin? fieldRightMargin? hidden? isDisabled? isReadonly? isVisible? noBaseline? phoneColumns? phoneHidden? style? sx? tabletColumns? 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.

OptionalclassName

className?: string

Optionalcolumns

columns?: string

Retrieves the specific columns from a given object.

OptionalcolumnsOverride

columnsOverride?: string

Represents override columns configuration for a field.

OptionaldesktopColumns

desktopColumns?: string

Represents the number of columns on a desktop layout for a field in a data payload object.

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[]

Returns the picked 'features' property from the given variable.

Template: Data

The type of data.

Template: Payload

The type of payload.

Template: T

The type of the variable.

Param: variable

The variable from which to pick the 'features' property.

Returns

  • The picked 'features' property.

OptionalfieldBottomMargin

fieldBottomMargin?: string

Represents the optional configuration for the bottom margin of a field.

OptionalfieldRightMargin

fieldRightMargin?: string

Represents the right margin of a field.

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.

OptionalphoneColumns

phoneColumns?: string

Represents the phone columns configuration for a field

OptionalphoneHidden

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

Represents the phoneHidden property of a field object.

Optionalstyle

style?: any

Optionalsx

sx?: any

Represents the 'sx' property of the 'PickProp' type.

OptionaltabletColumns

tabletColumns?: string

Represents the number of columns for the "tablet" viewport size of a field. This property is optional.

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