UNPKG

@aurigma/ui-framework

Version:

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

customerscanvas.com

133 lines (71 loc) • 2.67 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
# Interface: IOrderInitModel Provides properites for the order model. ## Hierarchy * [IOrderConfig](iorderconfig.md) ↳ **IOrderInitModel** ## Index ### Properties * [customPrice](iorderinitmodel.md#customprice) * [data](iorderinitmodel.md#data) * [downloadUrls](iorderinitmodel.md#downloadurls) * [images](iorderinitmodel.md#images) * [logRequest](iorderinitmodel.md#logrequest) * [product](iorderinitmodel.md#product) * [props](iorderinitmodel.md#props) * [quantity](iorderinitmodel.md#quantity) * [settings](iorderinitmodel.md#settings) * [sku](iorderinitmodel.md#sku) * [useBackOffice](iorderinitmodel.md#usebackoffice) ## Properties ### customPrice • **customPrice**: *number* *Inherited from [IOrderConfig](iorderconfig.md).[customPrice](iorderconfig.md#customprice)* The custom price for the order. ___ ### data • **data**: *Object* *Inherited from [IOrderConfig](iorderconfig.md).[data](iorderconfig.md#data)* Custom data (as a JSON object). ___ ### downloadUrls • **downloadUrls**: *Array‹string›* *Inherited from [IOrderConfig](iorderconfig.md).[downloadUrls](iorderconfig.md#downloadurls)* An array of the print-ready files, which should be stored along with the order in your e-commerce system. ___ ### images • **images**: *Array‹string›* *Inherited from [IOrderConfig](iorderconfig.md).[images](iorderconfig.md#images)* An array of URLs to preview images which should be stored along with the order in your e-commerce system. ___ ### logRequest • **logRequest**: *boolean* *Inherited from [IOrderConfig](iorderconfig.md).[logRequest](iorderconfig.md#logrequest)* If `true`, logging 'add-to-cart' requests (for Shopify only). ___ ### product • **product**: *IProduct* A product to initialize the order. ___ ### props • **props**: *Object* *Inherited from [IOrderConfig](iorderconfig.md).[props](iorderconfig.md#props)* Custom properties. They don't appear in the order, but are available in the `onSubmitting` callback. ___ ### quantity • **quantity**: *number* *Inherited from [IOrderConfig](iorderconfig.md).[quantity](iorderconfig.md#quantity)* The number of ordered products. The default value is `1`. ___ ### settings • **settings**: *IPluginSettings* Settings of the e-commerce plugin. ___ ### sku • **sku**: *string* *Inherited from [IOrderConfig](iorderconfig.md).[sku](iorderconfig.md#sku)* Order line item SKU (for option-based product). ___ ### useBackOffice • **useBackOffice**: *boolean* *Inherited from [IOrderConfig](iorderconfig.md).[useBackOffice](iorderconfig.md#usebackoffice)* Indicates if driver should perform some BackOffice actions.