Function HeroLayout

Parameters

• props: IHeroLayoutProps<Data, any> & IHeroLayoutPrivate

  The props for the HeroLayout component.

  Interface representing the properties for the HeroLayout component.

  • Optionalbaseline?: 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?: string | ISizeCallback<Data>

  • OptionalclassName?: string

  • Optionalcolumns?: string

    Retrieves the specific columns from a given object.

  • OptionalcolumnsOverride?: string

    Represents override columns configuration for a field.

  • OptionaldesktopBottom?: string | ISizeCallback<Data>

  • OptionaldesktopColumns?: string

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

  • OptionaldesktopHeight?: string | ISizeCallback<Data>

  • OptionaldesktopHidden?: boolean | (payload: any) => boolean

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

  • OptionaldesktopLeft?: string | ISizeCallback<Data>

  • OptionaldesktopMaxHeight?: string | ISizeCallback<Data>

  • OptionaldesktopMaxWidth?: string | ISizeCallback<Data>

  • OptionaldesktopMinHeight?: string | ISizeCallback<Data>

  • OptionaldesktopMinWidth?: string | ISizeCallback<Data>

  • OptionaldesktopRight?: string | ISizeCallback<Data>

  • OptionaldesktopTop?: string | ISizeCallback<Data>

  • OptionaldesktopWidth?: string | ISizeCallback<Data>

  • Optionaldisabled?: boolean

    Represents the disabled property of a field.

  • Optionalfeatures?: 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?: string | ISizeCallback<Data>

  • OptionalheroInnerDesktopStyle?: any

  • OptionalheroInnerPhoneStyle?: any

  • OptionalheroInnerStyle?: any

  • OptionalheroInnerTabletStyle?: any

  • OptionalheroOuterDesktopStyle?: any

  • OptionalheroOuterPhoneStyle?: any

  • OptionalheroOuterStyle?: any

  • OptionalheroOuterTabletStyle?: any

  • Optionalhidden?: 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?: (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?: (v: Data, payload: any) => boolean

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

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

    Represents the isVisible property of a field in a form.

  • Optionalleft?: string | ISizeCallback<Data>

  • OptionalmaxHeight?: string | ISizeCallback<Data>

  • OptionalmaxWidth?: string | ISizeCallback<Data>

  • OptionalminHeight?: string | ISizeCallback<Data>

  • OptionalminWidth?: string | ISizeCallback<Data>

  • OptionalnoBaseline?: 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: Data

  • OptionalphoneBottom?: string | ISizeCallback<Data>

  • OptionalphoneColumns?: string

    Represents the phone columns configuration for a field

  • OptionalphoneHeight?: string | ISizeCallback<Data>

  • OptionalphoneHidden?: boolean | (payload: any) => boolean

    Represents the phoneHidden property of a field object.

  • OptionalphoneLeft?: string | ISizeCallback<Data>

  • OptionalphoneMaxHeight?: string | ISizeCallback<Data>

  • OptionalphoneMaxWidth?: string | ISizeCallback<Data>

  • OptionalphoneMinHeight?: string | ISizeCallback<Data>

  • OptionalphoneMinWidth?: string | ISizeCallback<Data>

  • OptionalphoneRight?: string | ISizeCallback<Data>

  • OptionalphoneTop?: string | ISizeCallback<Data>

  • OptionalphoneWidth?: string | ISizeCallback<Data>

  • Optionalright?: string | ISizeCallback<Data>

  • Optionalstyle?: any

  • Optionalsx?: any

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

  • OptionaltabletBottom?: string | ISizeCallback<Data>

  • OptionaltabletColumns?: string

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

  • OptionaltabletHeight?: string | ISizeCallback<Data>

  • OptionaltabletHidden?: boolean | (payload: any) => boolean

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

  • OptionaltabletLeft?: string | ISizeCallback<Data>

  • OptionaltabletMaxHeight?: string | ISizeCallback<Data>

  • OptionaltabletMaxWidth?: string | ISizeCallback<Data>

  • OptionaltabletMinHeight?: string | ISizeCallback<Data>

  • OptionaltabletMinWidth?: string | ISizeCallback<Data>

  • OptionaltabletRight?: string | ISizeCallback<Data>

  • OptionaltabletTop?: string | ISizeCallback<Data>

  • OptionaltabletWidth?: string | ISizeCallback<Data>

  • OptionaltestId?: string

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

  • Optionaltop?: string | ISizeCallback<Data>

  • Optionalwidth?: string | ISizeCallback<Data>

  • children

    The children of the hero layout.

  • className

    The custom CSS class name for the hero layout.

  • style

    The custom inline style for the hero layout.

  • object

    The data object for the hero layout.

  • columns

    The number of columns to display in the hero layout.

  • columnsOverride

    An array of numbers to override the number of columns at different breakpoints.

  • isBaselineAlign

    Determines whether the items in the hero layout should be baseline aligned.

  • sx

    The custom style object for the hero layout.

  • phoneColumns

    The number of columns to display on phones.

  • tabletColumns

    The number of columns to display on tablets.

  • desktopColumns

    The number of columns to display on desktops.

  • otherProps

    Other props to pass to the hero layout component.