@aurigma/ui-framework
Version:
A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.
103 lines (59 loc) • 1.78 kB
Markdown
Provides the main configuration for the Data-Driven Editor.
Example:
```
{
"access": { "tenantId": "tenant1", "userId": "user1", "token": "token1" },
"design": { "designId": "design1", "dataSetId": "dataset1" },
"api": { "designAtoms": "https://api.example.com/design-atoms" },
"settings": { "lang": "en", "allowManipulations": false },
"renderer": { "width": 800, "height": 600, "format": "Pdf" }
}
```
* **IEditorConfig**
* [access](ieditorconfig.md
* [api](ieditorconfig.md
* [design](ieditorconfig.md
* [preview](ieditorconfig.md
* [renderer](ieditorconfig.md
* [settings](ieditorconfig.md
* [translation](ieditorconfig.md
* [userInfo](ieditorconfig.md
• **access**: *Partial‹[IEditorAccess](ieditoraccess.md)›*
Access credentials for the editor.
___
• **api**: *[IEditorAPI](ieditorapi.md)*
API endpoints for the editor services.
___
• **design**: *Partial‹[IDesignConfig](idesignconfig.md)›*
Design configuration.
___
• **preview**: *object*
Preview image dimensions.
* **height**: *number*
* **width**: *number*
___
• **renderer**: *[IRendererConfig](irendererconfig.md)*
Rendering configuration.
___
• **settings**? : *[IEditorSettings](ieditorsettings.md)*
Editor settings.
___
• **translation**? : *Record‹string, any›*
Interface translation configuration.
___
• **userInfo**? : *Record‹string, string›*
User information for automatic form filling.