Interface IObjectInspectorConfig

A structure containing the configuration of the Object inspector.

Package: @aurigma/design-editor-iframe

Examples

configuration = {
    widgets: {
        ObjectInspector: {
            bgItemEnabled: false,
            dndEnabled: false,
            toggleEnabled: true,
            inStringPlaceholderMode: "Single",
            violationWarningsEnabled: false
        }
    }
};

Properties

aboveCanvasOnSmallScreenEnabled

Allows you to show the Object Inspector above the canvas. If true, the Object Inspector appears above the canvas when you work on small-screen devices; otherwise, it appears from the left side of the canvas. The default value is true.

Declaration

aboveCanvasOnSmallScreenEnabled?: boolean;

Property Value

Type	Description
boolean	Allows you to show the Object Inspector above the canvas. If true, the Object Inspector appears above the canvas when you work on small-screen devices; otherwise, it appears from the left side of the canvas. The default value is true.

bgItemEnabled

Displays the background element in the Object inspector. The default value is true.

Declaration

bgItemEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the background element in the Object inspector. The default value is true.

dndEnabled

Allows your users to drag-and-drop layers in the Object inspector. The default value is true.

Declaration

dndEnabled?: boolean;

Property Value

Type	Description
boolean	Allows your users to drag-and-drop layers in the Object inspector. The default value is true.

emptyListTextEnabled

Enables the message displayed in the Object inspector when loaded template has no customizable layers.

Declaration

emptyListTextEnabled?: boolean;

Property Value

Type	Description
boolean	Enables the message displayed in the Object inspector when loaded template has no customizable layers.

expandNestedGroups

If true, allows the user to expand all nested groups when clicking the parent group in the Object Inspector. If false, the user has to click the groups one by one to expand them all. The value in the config is false.

Declaration

expandNestedGroups?: boolean;

Property Value

Type	Description
boolean	If true, allows the user to expand all nested groups when clicking the parent group in the Object Inspector. If false, the user has to click the groups one by one to expand them all. The value in the config is false.

groupRenameEnabled

If true, the user can rename group names in the Object Inspector. The default value is true.

Declaration

groupRenameEnabled?: boolean;

Property Value

Type	Description
boolean	If true, the user can rename group names in the Object Inspector. The default value is true.

groupsExpandedByDefault

If true, automatically expands groups in the Object Inspector when loading a product. If false, groups of design elements appear collapsed. The default value is false.

Declaration

groupsExpandedByDefault?: boolean;

Property Value

Type	Description
boolean	If true, automatically expands groups in the Object Inspector when loading a product. If false, groups of design elements appear collapsed. The default value is false.

inStringPlaceholderMode

Defines how the Object Inspector displays in-string placeholders. In the "Single" mode, all items appear at the top of the item list. In the "Multiple" mode, linked in-string placeholders appear separately and keep the order defined in PSD templates. The default value is "Multiple".

Declaration

inStringPlaceholderMode?: InStringPlaceholderMode.InStringPlaceholderModeType;

Property Value

Type	Description
InStringPlaceholderModeType	Defines how the Object Inspector displays in-string placeholders. In the "Single" mode, all items appear at the top of the item list. In the "Multiple" mode, linked in-string placeholders appear separately and keep the order defined in PSD templates. The default value is "Multiple".

isHidden

Allows for hiding the Object Inspector. The default value is false.

Declaration

isHidden?: boolean;

Property Value

Type	Description
boolean	Allows for hiding the Object Inspector. The default value is false.

position

Defines where the Object Inspector shows - on the left or on the right side of the canvas. The default value is Left.

Declaration

position?: ObjectInspectorPosition.ObjectInspectorPositionType;

Property Value

Type	Description
ObjectInspectorPositionType	Defines where the Object Inspector shows - on the left or on the right side of the canvas. The default value is Left.

showItemName

Enables text labels for design elements in the Object Inspector. The default value is false. For details, see the Element Names topic.

Declaration

showItemName?: boolean;

Property Value

Type	Description
boolean	Enables text labels for design elements in the Object Inspector. The default value is false. For details, see the Element Names topic.

toggleEnabled

Enables the Toggle button, which allows your users to toggle the Object Inspector. The default value is false.

Declaration

toggleEnabled?: boolean;

Property Value

Type	Description
boolean	Enables the Toggle button, which allows your users to toggle the Object Inspector. The default value is false.

variableItemsEnabled

Enables variable data printing for texts and images. If true, you can mark design elements as variable items in the editor and then customize them in your e-commerce system. The default value is false.

Declaration

variableItemsEnabled?: boolean;

Property Value

Type	Description
boolean	Enables variable data printing for texts and images. If true, you can mark design elements as variable items in the editor and then customize them in your e-commerce system. The default value is false.

violationWarningsEnabled

Enables preflight of user designs and displaying warnings in the Object inspector. The default value is true. For details, see User interface overview.

Declaration

violationWarningsEnabled?: boolean;

Property Value

Type	Description
boolean	Enables preflight of user designs and displaying warnings in the Object inspector. The default value is true. For details, see User interface overview.