UNPKG

@aurigma/ui-framework

Version:

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

customerscanvas.com

147 lines (80 loc) • 2.27 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
141
142
143
144
145
146
147
# Class: AuOptionBase Provides properties for options obtained from the e-commerce driver. For details, you can refer to the [Option widget](https://customerscanvas.com/dev/editors/ui-framework/widgets/option.html) topic. An **element** of the [AuWidgetOption](auwidgetoption.md) class implements properties of this abstract class. ## Hierarchy * any ↳ **AuOptionBase** ## Index ### Properties * [applyEmptyValues](auoptionbase.md#applyemptyvalues) * [description](auoptionbase.md#description) * [disabled](auoptionbase.md#disabled) * [driver](auoptionbase.md#driver) * [emptyValuesText](auoptionbase.md#emptyvaluestext) * [id](auoptionbase.md#id) * [isActive](auoptionbase.md#isactive) * [isVisible](auoptionbase.md#isvisible) * [order](auoptionbase.md#order) * [prompt](auoptionbase.md#prompt) * [props](auoptionbase.md#props) * [required](auoptionbase.md#required) * [title](auoptionbase.md#title) * [type](auoptionbase.md#type) * [value](auoptionbase.md#abstract-value) ## Properties ### applyEmptyValues • **applyEmptyValues**: *boolean* ___ ### description • **description**: *string* The option description. ___ ### disabled • **disabled**: *boolean* = false If `true`, disables this option. ___ ### driver • **driver**: *IDriver* The e-commerce driver. ___ ### emptyValuesText • **emptyValuesText**: *string* ___ ### id • **id**: *string* The option identifier. If there is no such an option in the ecommerce, the editor will create a new option with this `id`. ___ ### isActive • **isActive**: *boolean* = true ___ ### isVisible • **isVisible**: *boolean* = true ___ ### order • **order**: *IOrder* An order in the e-commerce driver. ___ ### prompt • **prompt**: *string* A text message associated with this option. ___ ### props • **props**: *any* An object defining the option-specific properties. ___ ### required • **required**: *boolean* This property is `true` for options that must be selected by the user. ___ ### title • **title**: *string* The option title. ___ ### type • **type**: *string* The option type, either `radio`, `image`, `color`, `list`, `checkbox`, or `text`. ___ ### `Abstract` value • **value**: *any* The option value.