Interface ISurfacesFromFolder

A structure holding settings to create a set of template-based surfaces.

Inheritance

IModelComponent

IBaseSurfaceDefinition

IBaseSurfacesDefinition

ISurfacesFromFolder

Package: @aurigma/design-editor-iframe

Remarks

This interface uses PSD templates that are grouped by folders. For details, see the Loading Pages from a Folder topic.

Examples

const productDefinition = {
   surfaces: {
       // Get surfaces from the folder.
       designFolder: "myphotoBook",
       // Name surfaces as "Page 1", "Page 2", and so on.
       name: "Page {0}",
       // Get mockups from the folder.
       mockupFolder: { up: "photoBookMockups" }
   }
};

Properties

designFolder

A name of the folder containing PSD page templates of the multipage product.

Declaration

designFolder?: string;

Property Value

Type	Description
string	A name of the folder containing PSD page templates of the multipage product.

mockupFolder

A name of the folder containing mockup files.

Declaration

mockupFolder?: IMockupFolders;

Property Value

Type	Description
IMockupFolders	A name of the folder containing mockup files.

previewMockupFolder

A name of the folder containing preview mockup files.

Declaration

previewMockupFolder?: string | IMockupFolders;

Property Value

Type	Description
string | IMockupFolders	A name of the folder containing preview mockup files.