@aurigma/ui-framework
Version:
A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.
49 lines (32 loc) • 1.08 kB
Markdown
# Interface: IWidgetDataDrivenParams
Provides configuration for the Data-Driven Editor widget.
You can use this interface to define the **params** of the widget.
```
{
"name": "dd-editor",
"type": "data-driven-editor",
"params": {
"config": {
"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 }
},
"onReady": "{{#function \$['dd-editor'].setUserInfo({ 'Name': 'John' }) }}"
}
}
```
## Hierarchy
* **IWidgetDataDrivenParams**
## Index
### Properties
* [config](iwidgetdatadrivenparams.md#config)
* [onReady](iwidgetdatadrivenparams.md#onready)
## Properties
### config
• **config**: *[IEditorConfig](ieditorconfig.md)*
Configuration object for the Data-Driven Editor.
___
### onReady
• **onReady**: *Function | Array‹Function›*
Function or array of functions to be called when the editor is ready.