Interface IHeroLayoutProps<Data, Payload>

Interface representing the properties for the HeroLayout component.

interface IHeroLayoutProps<Data = IAnything, Payload = IAnything> {
    baseline?: boolean;
    bottom?: string | ISizeCallback<Data>;
    className?: string;
    columns?: string;
    columnsOverride?: string;
    desktopBottom?: string | ISizeCallback<Data>;
    desktopColumns?: string;
    desktopHeight?: string | ISizeCallback<Data>;
    desktopHidden?: boolean | (payload: any) => boolean;
    desktopLeft?: string | ISizeCallback<Data>;
    desktopMaxHeight?: string | ISizeCallback<Data>;
    desktopMaxWidth?: string | ISizeCallback<Data>;
    desktopMinHeight?: string | ISizeCallback<Data>;
    desktopMinWidth?: string | ISizeCallback<Data>;
    desktopRight?: string | ISizeCallback<Data>;
    desktopTop?: string | ISizeCallback<Data>;
    desktopWidth?: string | ISizeCallback<Data>;
    disabled?: boolean;
    features?: string[];
    height?: string | ISizeCallback<Data>;
    heroInnerDesktopStyle?: any;
    heroInnerPhoneStyle?: any;
    heroInnerStyle?: any;
    heroInnerTabletStyle?: any;
    heroOuterDesktopStyle?: any;
    heroOuterPhoneStyle?: any;
    heroOuterStyle?: any;
    heroOuterTabletStyle?: any;
    hidden?: boolean | (payload: any) => boolean;
    isDisabled?: (v: Data, payload: any) => boolean;
    isReadonly?: (v: Data, payload: any) => boolean;
    isVisible?: (v: Data, payload: any) => boolean;
    left?: string | ISizeCallback<Data>;
    maxHeight?: string | ISizeCallback<Data>;
    maxWidth?: string | ISizeCallback<Data>;
    minHeight?: string | ISizeCallback<Data>;
    minWidth?: string | ISizeCallback<Data>;
    noBaseline?: boolean;
    object: Data;
    phoneBottom?: string | ISizeCallback<Data>;
    phoneColumns?: string;
    phoneHeight?: string | ISizeCallback<Data>;
    phoneHidden?: boolean | (payload: any) => boolean;
    phoneLeft?: string | ISizeCallback<Data>;
    phoneMaxHeight?: string | ISizeCallback<Data>;
    phoneMaxWidth?: string | ISizeCallback<Data>;
    phoneMinHeight?: string | ISizeCallback<Data>;
    phoneMinWidth?: string | ISizeCallback<Data>;
    phoneRight?: string | ISizeCallback<Data>;
    phoneTop?: string | ISizeCallback<Data>;
    phoneWidth?: string | ISizeCallback<Data>;
    right?: string | ISizeCallback<Data>;
    style?: any;
    sx?: any;
    tabletBottom?: string | ISizeCallback<Data>;
    tabletColumns?: string;
    tabletHeight?: string | ISizeCallback<Data>;
    tabletHidden?: boolean | (payload: any) => boolean;
    tabletLeft?: string | ISizeCallback<Data>;
    tabletMaxHeight?: string | ISizeCallback<Data>;
    tabletMaxWidth?: string | ISizeCallback<Data>;
    tabletMinHeight?: string | ISizeCallback<Data>;
    tabletMinWidth?: string | ISizeCallback<Data>;
    tabletRight?: string | ISizeCallback<Data>;
    tabletTop?: string | ISizeCallback<Data>;
    tabletWidth?: string | ISizeCallback<Data>;
    testId?: string;
    top?: string | ISizeCallback<Data>;
    width?: string | ISizeCallback<Data>;
}

Type Parameters

  • Data = IAnything

    The type of data associated with the component.

  • Payload = IAnything

    The type of payload associated with the component.

Hierarchy (View Summary)

Properties

baseline? bottom? className? columns? columnsOverride? desktopBottom? desktopColumns? desktopHeight? desktopHidden? desktopLeft? desktopMaxHeight? desktopMaxWidth? desktopMinHeight? desktopMinWidth? desktopRight? desktopTop? desktopWidth? disabled? features? height? heroInnerDesktopStyle? heroInnerPhoneStyle? heroInnerStyle? heroInnerTabletStyle? heroOuterDesktopStyle? heroOuterPhoneStyle? heroOuterStyle? heroOuterTabletStyle? hidden? isDisabled? isReadonly? isVisible? left? maxHeight? maxWidth? minHeight? minWidth? noBaseline? object phoneBottom? phoneColumns? phoneHeight? phoneHidden? phoneLeft? phoneMaxHeight? phoneMaxWidth? phoneMinHeight? phoneMinWidth? phoneRight? phoneTop? phoneWidth? right? style? sx? tabletBottom? tabletColumns? tabletHeight? tabletHidden? tabletLeft? tabletMaxHeight? tabletMaxWidth? tabletMinHeight? tabletMinWidth? tabletRight? tabletTop? tabletWidth? testId? top? width?

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.

Optionalbottom

bottom?: string | ISizeCallback<Data>

OptionalclassName

className?: string

Optionalcolumns

columns?: string

Retrieves the specific columns from a given object.

OptionalcolumnsOverride

columnsOverride?: string

Represents override columns configuration for a field.

OptionaldesktopBottom

desktopBottom?: string | ISizeCallback<Data>

OptionaldesktopColumns

desktopColumns?: string

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

OptionaldesktopHeight

desktopHeight?: string | ISizeCallback<Data>

OptionaldesktopHidden

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

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

OptionaldesktopLeft

desktopLeft?: string | ISizeCallback<Data>

OptionaldesktopMaxHeight

desktopMaxHeight?: string | ISizeCallback<Data>

OptionaldesktopMaxWidth

desktopMaxWidth?: string | ISizeCallback<Data>

OptionaldesktopMinHeight

desktopMinHeight?: string | ISizeCallback<Data>

OptionaldesktopMinWidth

desktopMinWidth?: string | ISizeCallback<Data>

OptionaldesktopRight

desktopRight?: string | ISizeCallback<Data>

OptionaldesktopTop

desktopTop?: string | ISizeCallback<Data>

OptionaldesktopWidth

desktopWidth?: string | ISizeCallback<Data>

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.

Optionalheight

height?: string | ISizeCallback<Data>

OptionalheroInnerDesktopStyle

heroInnerDesktopStyle?: any

OptionalheroInnerPhoneStyle

heroInnerPhoneStyle?: any

OptionalheroInnerStyle

heroInnerStyle?: any

OptionalheroInnerTabletStyle

heroInnerTabletStyle?: any

OptionalheroOuterDesktopStyle

heroOuterDesktopStyle?: any

OptionalheroOuterPhoneStyle

heroOuterPhoneStyle?: any

OptionalheroOuterStyle

heroOuterStyle?: any

OptionalheroOuterTabletStyle

heroOuterTabletStyle?: any

Optionalhidden

hidden?: boolean | (payload: any) => 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: any) => 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: any) => boolean

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

Type declaration

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

    • Parameters

      Returns boolean

      The value of the 'isReadonly' property.

OptionalisVisible

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

Represents the isVisible property of a field in a form.

Optionalleft

left?: string | ISizeCallback<Data>

OptionalmaxHeight

maxHeight?: string | ISizeCallback<Data>

OptionalmaxWidth

maxWidth?: string | ISizeCallback<Data>

OptionalminHeight

minHeight?: string | ISizeCallback<Data>

OptionalminWidth

minWidth?: string | ISizeCallback<Data>

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.

object

object: Data

OptionalphoneBottom

phoneBottom?: string | ISizeCallback<Data>

OptionalphoneColumns

phoneColumns?: string

Represents the phone columns configuration for a field

OptionalphoneHeight

phoneHeight?: string | ISizeCallback<Data>

OptionalphoneHidden

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

Represents the phoneHidden property of a field object.

OptionalphoneLeft

phoneLeft?: string | ISizeCallback<Data>

OptionalphoneMaxHeight

phoneMaxHeight?: string | ISizeCallback<Data>

OptionalphoneMaxWidth

phoneMaxWidth?: string | ISizeCallback<Data>

OptionalphoneMinHeight

phoneMinHeight?: string | ISizeCallback<Data>

OptionalphoneMinWidth

phoneMinWidth?: string | ISizeCallback<Data>

OptionalphoneRight

phoneRight?: string | ISizeCallback<Data>

OptionalphoneTop

phoneTop?: string | ISizeCallback<Data>

OptionalphoneWidth

phoneWidth?: string | ISizeCallback<Data>

Optionalright

right?: string | ISizeCallback<Data>

Optionalstyle

style?: any

Optionalsx

sx?: any

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

OptionaltabletBottom

tabletBottom?: string | ISizeCallback<Data>

OptionaltabletColumns

tabletColumns?: string

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

OptionaltabletHeight

tabletHeight?: string | ISizeCallback<Data>

OptionaltabletHidden

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

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

OptionaltabletLeft

tabletLeft?: string | ISizeCallback<Data>

OptionaltabletMaxHeight

tabletMaxHeight?: string | ISizeCallback<Data>

OptionaltabletMaxWidth

tabletMaxWidth?: string | ISizeCallback<Data>

OptionaltabletMinHeight

tabletMinHeight?: string | ISizeCallback<Data>

OptionaltabletMinWidth

tabletMinWidth?: string | ISizeCallback<Data>

OptionaltabletRight

tabletRight?: string | ISizeCallback<Data>

OptionaltabletTop

tabletTop?: string | ISizeCallback<Data>

OptionaltabletWidth

tabletWidth?: string | ISizeCallback<Data>

OptionaltestId

testId?: string

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

Optionaltop

top?: string | ISizeCallback<Data>

Optionalwidth

width?: string | ISizeCallback<Data>

Settings

Member Visibility

On This Page

Properties