A custom component for layouting its children in a box.

  • The type of the data object that can be passed to the layout.
  • Type Parameters

    • Data extends unknown = any

    Parameters

    • props: IBoxLayoutProps<Data, any> & IBoxLayoutPrivate<Data>

      The properties for the BoxLayout component.

      Interface for specifying props for the IBoxLayout class.

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

        Retrieves the 'features' property from a given variable.

        The type of the variable.

        The property name to retrieve.

        The variable to extract the property from.

        • The extracted 'features' property.
      • 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.

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

        Represents the phoneHidden property of a field object.

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

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

      • OptionaltestId?: string

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

      • children

        The children elements to be rendered within the box layout.

      • className

        The optional CSS class for styling the box layout.

      • style

        The optional inline style object for further customization.

      • sx

        The optional theme-ui style object for additional theming.

    Returns Element

    • A JSX element representing the box layout component.

Properties

Properties

displayName: string