UNPKG

@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
# Interface: IEditorConfig 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" } } ``` ## Hierarchy * **IEditorConfig** ## Index ### Properties * [access](ieditorconfig.md#access) * [api](ieditorconfig.md#api) * [design](ieditorconfig.md#design) * [preview](ieditorconfig.md#preview) * [renderer](ieditorconfig.md#renderer) * [settings](ieditorconfig.md#optional-settings) * [translation](ieditorconfig.md#optional-translation) * [userInfo](ieditorconfig.md#optional-userinfo) ## Properties ### access • **access**: *Partial‹[IEditorAccess](ieditoraccess.md)›* Access credentials for the editor. ___ ### api • **api**: *[IEditorAPI](ieditorapi.md)* API endpoints for the editor services. ___ ### design • **design**: *Partial‹[IDesignConfig](idesignconfig.md)›* Design configuration. ___ ### preview • **preview**: *object* Preview image dimensions. #### Type declaration: * **height**: *number* * **width**: *number* ___ ### renderer • **renderer**: *[IRendererConfig](irendererconfig.md)* Rendering configuration. ___ ### `Optional` settings • **settings**? : *[IEditorSettings](ieditorsettings.md)* Editor settings. ___ ### `Optional` translation • **translation**? : *Record‹string, any›* Interface translation configuration. ___ ### `Optional` userInfo • **userInfo**? : *Record‹string, string›* User information for automatic form filling.