Interface ISurfaceSwitchConfig

A structure defining the configuration of the navigation area in the Bottom toolbar.

Package: @aurigma/design-editor-iframe

Examples

configuration = {
   widgets: {
       BottomToolbar: {
           zoomValueEnabled: false,
           zoomButtonsEnabled: false,
           fullWindowButtonEnabled: false,
           fullScreenButtonEnabled: false,

           // Enable only page names in the navigation area by default.
           surfaceSwitch: {
               enabled: true,
               showThumbnails: false,
               showSurfaceNames: true,
               scrollPageButtonsEnabled: false,
               toggleSurfaceButtonsEnabled: false,
               firstAndLastButtonsEnabled: false,
               specificForSurfaceCount: {
                   // Disable the navigation area for single-page products.
                   1: {
                       enabled: false
                   },
                   // Enable only page names for two-page products.
                   2: {
                       showSurfaceNames: true,
                       showThumbnails: false,
                       scrollPageButtonsEnabled: false,
                       toggleSurfaceButtonsEnabled: false,
                       firstAndLastButtonsEnabled: false
                   }
               }
           }
       }
   }
};

Properties

enabled

Enables the pagination control. The default value is true.

Declaration

enabled?: boolean;

Property Value

Type	Description
boolean	Enables the pagination control. The default value is true.

firstAndLastButtonsEnabled

Displays the **First** and **Last** buttons for the page navigation. The default value is true.

Declaration

firstAndLastButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **First** and **Last** buttons for the page navigation. The default value is true.

scrollPageButtonsEnabled

Displays the **Next** and **Previous** buttons, which allow for scrolling the page selector. The default value is true.

Declaration

scrollPageButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Next** and **Previous** buttons, which allow for scrolling the page selector. The default value is true.

showSurfaceNames

Displays page names in the pagination control. If it is true and you name your product surfaces, then these names are shown in the navigation area. Otherwise, surface indexes are shown. The default value is false.

Declaration

showSurfaceNames?: boolean;

Property Value

Type	Description
boolean	Displays page names in the pagination control. If it is true and you name your product surfaces, then these names are shown in the navigation area. Otherwise, surface indexes are shown. The default value is false.

showThumbnails

Displays page thumbnails. The default value is false.

Declaration

showThumbnails?: boolean;

Property Value

Type	Description
boolean	Displays page thumbnails. The default value is false.

specificForSurfaceCount

Defines the pagination control for products consisting of the certain number of pages. There are the default settings for single-page, two-page, and three-page products.

Declaration

specificForSurfaceCount?: {
        [countOfSurfaces: string]: ISurfaceSwitchConfig;
    };

Property Value

Type	Description
{ [countOfSurfaces: string]: ISurfaceSwitchConfig; }	Defines the pagination control for products consisting of the certain number of pages. There are the default settings for single-page, two-page, and three-page products.

toggleSurfaceButtonsEnabled

Displays the **Next** and **Previous** buttons, which allow for switching between pages. The default value is false.

Declaration

toggleSurfaceButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Next** and **Previous** buttons, which allow for switching between pages. The default value is false.