UNPKG

@aurigma/ui-framework

Version:

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

customerscanvas.com

140 lines (78 loc) • 4.34 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
133
134
135
136
137
138
139
140
# Interface: ISwapSurfacesCommandDefinition Provides properties for swapping surfaces through the [swapSurfaces](https://customerscanvas.com/dev/editors/ui-framework/widgets/design-editor-commands/swap-surfaces.html) command. ## Hierarchy * [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md) ↳ **ISwapSurfacesCommandDefinition** ## Index ### Properties * [after](iswapsurfacescommanddefinition.md#optional-after) * [autoCompile](iswapsurfacescommanddefinition.md#optional-autocompile) * [executeOnce](iswapsurfacescommanddefinition.md#optional-executeonce) * [executeOnlyAfter](iswapsurfacescommanddefinition.md#optional-executeonlyafter) * [lhsSurfaceIndex](iswapsurfacescommanddefinition.md#lhssurfaceindex) * [lock](iswapsurfacescommanddefinition.md#optional-lock) * [message](iswapsurfacescommanddefinition.md#optional-message) * [onExecuted](iswapsurfacescommanddefinition.md#optional-onexecuted) * [rhsSurfaceIndex](iswapsurfacescommanddefinition.md#rhssurfaceindex) * [showPreloader](iswapsurfacescommanddefinition.md#optional-showpreloader) * [timeout](iswapsurfacescommanddefinition.md#optional-timeout) ## Properties ### `Optional` after • **after**? : *string | string[]* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[after](idesigneditorcommanddefinition.md#optional-after)* The next commands to be executed after this command completes. ___ ### `Optional` autoCompile • **autoCompile**? : *boolean* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[autoCompile](idesigneditorcommanddefinition.md#optional-autocompile)* If `false`, action will never execute automatically. ___ ### `Optional` executeOnce • **executeOnce**? : *boolean* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[executeOnce](idesigneditorcommanddefinition.md#optional-executeonce)* If `true`, this command will be executed only once. You can use it for `initial` command. For example, we need to change surface depending on the option value. We write for `initial` and for `updateSurfaces` the same productDefinition with $['option]._ And set `executeOnce = true` for `initial`. And initial will be executed only once. ___ ### `Optional` executeOnlyAfter • **executeOnlyAfter**? : *string[]* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[executeOnlyAfter](idesigneditorcommanddefinition.md#optional-executeonlyafter)* Current command will be executed in a next update only after all commands executed in this param. The same example from `executeOnce` param. We need to execute `updateSurface` on all next updates, exclude the first one. And we set `executeOnlyAfter = ['initial']` for `updateSurface` command. ___ ### lhsSurfaceIndex • **lhsSurfaceIndex**: *number* Index of the first surface (page) to swap. ___ ### `Optional` lock • **lock**? : *string[]* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[lock](idesigneditorcommanddefinition.md#optional-lock)* Name of widgets that show preloader when command executed. ___ ### `Optional` message • **message**? : *string | string[]* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[message](idesigneditorcommanddefinition.md#optional-message)* The message for preloader. ___ ### `Optional` onExecuted • **onExecuted**? : *Function | Function[]* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[onExecuted](idesigneditorcommanddefinition.md#optional-onexecuted)* Functions that executed after command ___ ### rhsSurfaceIndex • **rhsSurfaceIndex**: *number* Index of the second surface (page) to swap. ___ ### `Optional` showPreloader • **showPreloader**? : *boolean* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[showPreloader](idesigneditorcommanddefinition.md#optional-showpreloader)* If `true`, displays the preloader while executing this command. ___ ### `Optional` timeout • **timeout**? : *number* *Inherited from [IDesignEditorCommandDefinition](idesigneditorcommanddefinition.md).[timeout](idesigneditorcommanddefinition.md#optional-timeout)* The timeout for switching preloader messages.