Represents a layout component used for grouping and organizing child components.

  • Type Parameters

    • Data extends unknown = any

      The type of data passed to the component.

    Parameters

    • props: IGroupLayoutProps<Data, any> & IGroupLayoutPrivate

      The props to configure the GroupLayout component.

      Interface for defining the props of GroupLayout component.

      • Optionalbaseline?: boolean

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

        The type of data associated with the field.

        The type of payload associated with the field.

      • OptionalclassName?: string
      • Optionalcolumns?: string

        Retrieves the specific columns from a given object.

      • OptionalcolumnsOverride?: string

        Represents override columns configuration for a field.

      • OptionaldesktopColumns?: string

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

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

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

      • Optionaldisabled?: boolean

        Represents the disabled property of a field.

      • Optionalfeatures?: string[]

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

        The type of data.

        The type of payload.

        The type of the variable.

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

        • The picked 'features' property.
      • OptionalfieldBottomMargin?: string

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

      • OptionalfieldRightMargin?: string

        Represents the right margin of a field.

      • Optionalhidden?: boolean | (payload: Payload) => boolean

        Represents the 'hidden' property of an object.

        The type of the field object.

        The type of the data object.

        The type of the payload object.

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

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

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

        Represents the isVisible property of a field in a form.

      • OptionalnoBaseline?: boolean

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

        The type of data associated with the field.

        The type of payload associated with the field.

      • OptionalphoneColumns?: string

        Represents the phone columns configuration for a field

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

        Represents the phoneHidden property of a field object.

      • Optionalstyle?: any
      • Optionalsx?: any

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

      • OptionaltabletColumns?: string

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

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

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

      • OptionaltestId?: string

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

      • columns

        The number of columns for the component.

      • columnsOverride

        The number of columns to override for specific items.

      • sx

        The sx value to pass to the component.

      • phoneColumns

        The number of phone columns for the component.

      • tabletColumns

        The number of tablet columns for the component.

      • desktopColumns

        The number of desktop columns for the component.

      • isBaselineAlign

        Indicates whether the items should be baseline aligned.

      • fieldRightMargin

        The right margin value for fields.

      • fieldBottomMargin

        The bottom margin value for fields.

      • style

        The inline style object for the component.

      • className

        The CSS class for the component.

      • children

        The child components to be rendered.

    Returns Element

    The rendered GroupLayout component.

Properties

Properties

displayName: string