Represents a custom layout component.

  • Type Parameters

    • Data extends unknown = any

      The type of data to be rendered in the layout.

    Parameters

    • props: ICustomLayoutProps<Data, any> & ICustomLayoutPrivate<Data>

      The component props.

      Represents a layout with various properties that control its visibility, disabled state, and other features.

      • 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
      • OptionalcustomLayout?: (
            props: PropsWithChildren<
                Data & {
                    _fieldData: Data;
                    _fieldParams: IField;
                    _payload: Payload;
                    onChange: (data: Partial<Data>) => void;
                },
            >,
        ) => ReactElement
      • 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 to be rendered inside the layout.

      • className

        The CSS class name for the layout.

      • style

        The inline styles for the layout.

      • sx

        The theme styling object for the layout (sx prop from Theme-UI).

      • customLayout

        The custom layout component to be used (defaults to Fragment).

      • otherProps

        Other props specific to the custom layout.

    Returns Element

    The rendered custom layout component.

Properties

Properties

displayName: string