Skip to main content

Interface: UiVisibilityConfig

Configuration for controlling the visibility of UI elements in the configurator.

This interface provides a comprehensive set of flags that determine which UI elements are shown or hidden in the configurator interface. These settings are typically configured when embedding the configurator and can be used to customize the user experience for different contexts and requirements.

Each property is a boolean flag where:

  • true means the element is hidden (or in some cases, the behavior is enabled)
  • false means the element is visible (or the behavior is disabled)

Properties

adjustToContainer

adjustToContainer: boolean

When true, adjusts the configurator size to fit its container element.


cartLoaderOnly

cartLoaderOnly: boolean

When true, shows only the cart loader and hides other UI elements.


customFooter

customFooter: boolean

When true, enables the use of a custom footer instead of the default one.


customUi?

optional customUi: boolean

When true, enables the use of a fully custom UI instead of the default interface.


hideARIcon

hideARIcon: boolean

When true, hides the AR (Augmented Reality) viewing option.


hideCollectionName

hideCollectionName: boolean

When true, hides the collection name display.


hideConfigurator

hideConfigurator: boolean

When true, hides the entire configurator interface.


hideControls

hideControls: boolean

When true, hides the canvas controls (zoom, rotate, etc.).


hideDelivery

hideDelivery: boolean

When true, hides the delivery time information.


hideDimensions

hideDimensions: boolean

When true, hides the dimensions display on the 3D model.


hideDragInfo

hideDragInfo: boolean

When true, hides the drag operation information tooltip.


hideExport

hideExport: boolean

When true, hides the 3D model export functionality.


hideExportImage

hideExportImage: boolean

When true, hides the export image button that allows saving the current view.


hideFavourites

hideFavourites: boolean

When true, hides the favorites functionality.


hideFavouritesButton

hideFavouritesButton: boolean

When true, specifically hides the favorites button.


hideFinish

hideFinish: boolean

When true, hides the finish/complete configuration button.


hideFinishScreen

hideFinishScreen: boolean

When true, hides the finish screen that appears after completing configuration.


hideFooter

hideFooter: boolean

When true, hides the footer element.


hideFullScreen

hideFullScreen: boolean

When true, hides the fullscreen toggle button.


hideHeader

hideHeader: boolean

When true, hides the header element.


hideHistory

hideHistory: boolean

When true, hides the configuration history panel.


hideHotSpots

hideHotSpots: boolean

When true, hides the hotspot indicators on the 3D model.


hideMeshHighlight

hideMeshHighlight: boolean

When true, disables highlighting of meshes on hover or selection.


hideOptionPanel

hideOptionPanel: boolean

When true, hides the options configuration panel.


hidePdfOnCanvas

hidePdfOnCanvas: boolean

When true, hides the PDF generation button on the canvas view.


hidePdfOnFinish

hidePdfOnFinish: boolean

When true, hides the PDF generation option on the finish screen.


hidePrice

hidePrice: boolean

When true, hides the price display.


hideProductName

hideProductName: boolean

When true, hides the product name display.


hideQty

hideQty: boolean

When true, hides the quantity selector.


hideRedo

hideRedo: boolean

When true, hides the redo button.


hideRelated

hideRelated: boolean

When true, hides the related products section.


hideReset

hideReset: boolean

When true, hides the reset button that returns to default configuration.


hideShareOnCanvas

hideShareOnCanvas: boolean

When true, hides the share button on the canvas view.


hideShareOnFinish

hideShareOnFinish: boolean

When true, hides the share button on the finish screen.


hideTabs

hideTabs: boolean

When true, hides the product tabs section.


hideUndo

hideUndo: boolean

When true, hides the undo button.


hideWarning3d

hideWarning3d: boolean

When true, hides the 3D warning message for users.


hideWarningIcons

hideWarningIcons: boolean

When true, hides warning icons throughout the interface.


hideZoom

hideZoom: boolean

When true, hides the zoom controls.


hideZoomButtons

hideZoomButtons: boolean

When true, hides the zoom in/out buttons.


pdf?

optional pdf: Partial<EmbedTemplatePDFSettings>

Settings for PDF generation and export.


showFavourites

showFavourites: boolean

When true, shows the favorites functionality. Note: This overrides hideFavourites if both are set.


showMenuControls

showMenuControls: boolean

When true, shows additional menu controls.


withModal

withModal: boolean

When true, displays the configurator in a modal dialog.