UNPKG

@aurigma/ui-framework

Version:

A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.

customerscanvas.com

132 lines (72 loc) • 3.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# Interface: ICanvasDefinitionParams Provides commands used in the `canvas` widget. ## Hierarchy * **ICanvasDefinitionParams** ## Index ### Properties * [actionsErrorToast](icanvasdefinitionparams.md#actionserrortoast) * [changeLayout](icanvasdefinitionparams.md#optional-changelayout) * [changeMockup](icanvasdefinitionparams.md#optional-changemockup) * [initial](icanvasdefinitionparams.md#optional-initial) * [modifyItems](icanvasdefinitionparams.md#optional-modifyitems) * [onChange](icanvasdefinitionparams.md#optional-onchange) * [preloader](icanvasdefinitionparams.md#optional-preloader) * [replaceInterpolationPlaceholders](icanvasdefinitionparams.md#optional-replaceinterpolationplaceholders) * [setBackground](icanvasdefinitionparams.md#optional-setbackground) * [setPrintArea](icanvasdefinitionparams.md#optional-setprintarea) * [setRemoteMockup](icanvasdefinitionparams.md#optional-setremotemockup) * [setTheme](icanvasdefinitionparams.md#optional-settheme) * [setViewerSettings](icanvasdefinitionparams.md#optional-setviewersettings) ## Properties ### actionsErrorToast • **actionsErrorToast**: *[ActionsErrorToastConfig](../classes/actionserrortoastconfig.md)* Enables a toast to display errors. ___ ### `Optional` changeLayout • **changeLayout**? : *[ICanvasDefinitionChangeLayout](icanvasdefinitionchangelayout.md)* Replaces design elements. ___ ### `Optional` changeMockup • **changeMockup**? : *[ICanvasDefinitionChangeMockup](icanvasdefinitionchangemockup.md)* Changes mockup images in the editor. This command uses images from the Customer's Canvas back end. ___ ### `Optional` initial • **initial**? : *[ICanvasDefinitionInitial](icanvasdefinitioninitial.md)* Initializes the editor. ___ ### `Optional` modifyItems • **modifyItems**? : *[ICanvasDefinitionModifyItems](icanvasdefinitionmodifyitems.md)* Changes properties of design elements in the editor. ___ ### `Optional` onChange • **onChange**? : *Function* Runs a command when a value changes. ___ ### `Optional` preloader • **preloader**? : *[ICanvasPreloaderConfig](icanvaspreloaderconfig.md)* preloader messages for initial loading and actions executing ___ ### `Optional` replaceInterpolationPlaceholders • **replaceInterpolationPlaceholders**? : *boolean* If `true`, executes the replaceInterloationPlaceholders() method after initialization to convert interpolation placeholders to in-string placeholders. ___ ### `Optional` setBackground • **setBackground**? : *[ICanvasDefinitionSetBackground](icanvasdefinitionsetbackground.md)* Sets a new background image. ___ ### `Optional` setPrintArea • **setPrintArea**? : *[ICanvasDefinitionSetPrintArea](icanvasdefinitionsetprintarea.md)* Applies a new print area definition to the product. ___ ### `Optional` setRemoteMockup • **setRemoteMockup**? : *[ISetRemoteMockupParams](../README.md#isetremotemockupparams)* Changes mockup images in the editor. This command uses remote images through URLs. ___ ### `Optional` setTheme • **setTheme**? : *[ICanvasDefinitionSetTheme](icanvasdefinitionsettheme.md)* Applies a product theme. ___ ### `Optional` setViewerSettings • **setViewerSettings**? : *[ICanvasDefinitionSetViewerSettings](icanvasdefinitionsetviewersettings.md)* Changes product zoom properties in the editor.