Renders a paper layout component.

  • Type Parameters

    • Data extends unknown = any

      The type of data to be used.

    Parameters

    • props: IPaperLayoutProps<Data, any> & IPaperLayoutPrivate

      The props object.

      Interface representing the props for the IPaperLayout 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.

      • OptionalinnerPadding?: string
      • 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.

      • OptionaloutlinePaper?: boolean
      • 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 шаблона

      • OptionaltransparentPaper?: boolean
      • columns

        The number of columns to display.

      • columnsOverride

        The number of columns to override the default value.

      • 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.

      • style

        The CSS styles to be applied.

      • className

        The class name to be applied.

      • children

        The children components to be rendered.

      • isBaselineAlign

        Determines if items should be aligned to the baseline.

      • fieldRightMargin

        The right margin of each field.

      • fieldBottomMargin

        The bottom margin of each field.

      • innerPadding

        The inner padding of the paper layout.

      • outlinePaper

        Determines if the paper should have an outline.

      • transparentPaper

        Determines if the paper should be transparent.

    Returns Element

    • The rendered paper layout component.

Properties

Properties

displayName: string