@windwalker-io/unicorn-next 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/generate-docs.js +33 -0
- package/dist/chunks/field-single-image-drag.js +2 -1
- package/dist/chunks/field-single-image-drag.js.map +1 -1
- package/dist/chunks/grid.js +12 -0
- package/dist/chunks/grid.js.map +1 -1
- package/dist/chunks/s3-multipart-uploader.js +23 -2
- package/dist/chunks/s3-multipart-uploader.js.map +1 -1
- package/dist/chunks/unicorn.js +4 -0
- package/dist/chunks/unicorn.js.map +1 -1
- package/dist/index.d.ts +38 -12
- package/docs/functions.md +3855 -0
- package/package.json +3 -2
- package/src/composable/useUniDirective.ts +19 -8
- package/src/module/field-single-image-drag.ts +3 -1
- package/src/module/grid.ts +14 -0
- package/src/module/s3-multipart-uploader.ts +36 -6
|
@@ -0,0 +1,3855 @@
|
|
|
1
|
+
## :toolbox: Functions
|
|
2
|
+
|
|
3
|
+
- [isPlainObject](#gear-isplainobject)
|
|
4
|
+
- [mergeDeep](#gear-mergedeep)
|
|
5
|
+
- [getData](#gear-getdata)
|
|
6
|
+
- [setData](#gear-setdata)
|
|
7
|
+
- [defData](#gear-defdata)
|
|
8
|
+
- [removeData](#gear-removedata)
|
|
9
|
+
- [prepareData](#gear-preparedata)
|
|
10
|
+
- [domready](#gear-domready)
|
|
11
|
+
- [selectOne](#gear-selectone)
|
|
12
|
+
- [selectOne](#gear-selectone)
|
|
13
|
+
- [selectOne](#gear-selectone)
|
|
14
|
+
- [selectOne](#gear-selectone)
|
|
15
|
+
- [selectOne](#gear-selectone)
|
|
16
|
+
- [selectAll](#gear-selectall)
|
|
17
|
+
- [selectAll](#gear-selectall)
|
|
18
|
+
- [selectAll](#gear-selectall)
|
|
19
|
+
- [selectAll](#gear-selectall)
|
|
20
|
+
- [selectAll](#gear-selectall)
|
|
21
|
+
- [getBoundedInstance](#gear-getboundedinstance)
|
|
22
|
+
- [getBoundedInstance](#gear-getboundedinstance)
|
|
23
|
+
- [getBoundedInstance](#gear-getboundedinstance)
|
|
24
|
+
- [getBoundedInstanceList](#gear-getboundedinstancelist)
|
|
25
|
+
- [module](#gear-module)
|
|
26
|
+
- [module](#gear-module)
|
|
27
|
+
- [module](#gear-module)
|
|
28
|
+
- [module](#gear-module)
|
|
29
|
+
- [module](#gear-module)
|
|
30
|
+
- [h](#gear-h)
|
|
31
|
+
- [h](#gear-h)
|
|
32
|
+
- [html](#gear-html)
|
|
33
|
+
- [delegate](#gear-delegate)
|
|
34
|
+
- [injectCssToDocument](#gear-injectcsstodocument)
|
|
35
|
+
- [injectCssToDocument](#gear-injectcsstodocument)
|
|
36
|
+
- [injectCssToDocument](#gear-injectcsstodocument)
|
|
37
|
+
- [animateTo](#gear-animateto)
|
|
38
|
+
- [base64UrlEncode](#gear-base64urlencode)
|
|
39
|
+
- [base64UrlDecode](#gear-base64urldecode)
|
|
40
|
+
- [serial](#gear-serial)
|
|
41
|
+
- [watchAttributes](#gear-watchattributes)
|
|
42
|
+
- [forceArray](#gear-forcearray)
|
|
43
|
+
- [debounce](#gear-debounce)
|
|
44
|
+
- [throttle](#gear-throttle)
|
|
45
|
+
- [isDebug](#gear-isdebug)
|
|
46
|
+
- [nextTick](#gear-nexttick)
|
|
47
|
+
- [wait](#gear-wait)
|
|
48
|
+
- [useLang](#gear-uselang)
|
|
49
|
+
- [trans](#gear-trans)
|
|
50
|
+
- [__](#gear-__)
|
|
51
|
+
- [useScriptImport](#gear-usescriptimport)
|
|
52
|
+
- [doImport](#gear-doimport)
|
|
53
|
+
- [useImport](#gear-useimport)
|
|
54
|
+
- [useImport](#gear-useimport)
|
|
55
|
+
- [useImport](#gear-useimport)
|
|
56
|
+
- [useImport](#gear-useimport)
|
|
57
|
+
- [useImport](#gear-useimport)
|
|
58
|
+
- [useSeriesImport](#gear-useseriesimport)
|
|
59
|
+
- [useSeriesImport](#gear-useseriesimport)
|
|
60
|
+
- [useSeriesImport](#gear-useseriesimport)
|
|
61
|
+
- [useSeriesImport](#gear-useseriesimport)
|
|
62
|
+
- [useSeriesImport](#gear-useseriesimport)
|
|
63
|
+
- [useCssIncludes](#gear-usecssincludes)
|
|
64
|
+
- [useCssImport](#gear-usecssimport)
|
|
65
|
+
- [useCheckboxesMultiSelect](#gear-usecheckboxesmultiselect)
|
|
66
|
+
- [useCheckboxesMultiSelect](#gear-usecheckboxesmultiselect)
|
|
67
|
+
- [useCheckboxesMultiSelect](#gear-usecheckboxesmultiselect)
|
|
68
|
+
- [useFieldCascadeSelect](#gear-usefieldcascadeselect)
|
|
69
|
+
- [useFieldFileDrag](#gear-usefieldfiledrag)
|
|
70
|
+
- [useFieldFlatpickr](#gear-usefieldflatpickr)
|
|
71
|
+
- [createCallback](#gear-createcallback)
|
|
72
|
+
- [useFieldModalSelect](#gear-usefieldmodalselect)
|
|
73
|
+
- [useFieldModalTree](#gear-usefieldmodaltree)
|
|
74
|
+
- [useFieldRepeatable](#gear-usefieldrepeatable)
|
|
75
|
+
- [createHttpClient](#gear-createhttpclient)
|
|
76
|
+
- [useFieldSingleImageDrag](#gear-usefieldsingleimagedrag)
|
|
77
|
+
- [useFormAsync](#gear-useformasync)
|
|
78
|
+
- [useFormAsync](#gear-useformasync)
|
|
79
|
+
- [useFormAsync](#gear-useformasync)
|
|
80
|
+
- [useForm](#gear-useform)
|
|
81
|
+
- [useForm](#gear-useform)
|
|
82
|
+
- [useForm](#gear-useform)
|
|
83
|
+
- [useFormComponent](#gear-useformcomponent)
|
|
84
|
+
- [useGridAsync](#gear-usegridasync)
|
|
85
|
+
- [useGrid](#gear-usegrid)
|
|
86
|
+
- [useGridComponent](#gear-usegridcomponent)
|
|
87
|
+
- [useHttpClient](#gear-usehttpclient)
|
|
88
|
+
- [useIframeModal](#gear-useiframemodal)
|
|
89
|
+
- [useListDependent](#gear-uselistdependent)
|
|
90
|
+
- [useListDependent](#gear-uselistdependent)
|
|
91
|
+
- [useListDependent](#gear-uselistdependent)
|
|
92
|
+
- [useQueue](#gear-usequeue)
|
|
93
|
+
- [createQueue](#gear-createqueue)
|
|
94
|
+
- [get](#gear-get)
|
|
95
|
+
- [get](#gear-get)
|
|
96
|
+
- [create](#gear-create)
|
|
97
|
+
- [destroy](#gear-destroy)
|
|
98
|
+
- [useS3Uploader](#gear-uses3uploader)
|
|
99
|
+
- [useS3Uploader](#gear-uses3uploader)
|
|
100
|
+
- [useS3Uploader](#gear-uses3uploader)
|
|
101
|
+
- [useS3MultipartUploader](#gear-uses3multipartuploader)
|
|
102
|
+
- [useS3MultipartUploader](#gear-uses3multipartuploader)
|
|
103
|
+
- [useS3MultipartUploader](#gear-uses3multipartuploader)
|
|
104
|
+
- [useShowOn](#gear-useshowon)
|
|
105
|
+
- [useStack](#gear-usestack)
|
|
106
|
+
- [createStack](#gear-createstack)
|
|
107
|
+
- [useTomSelect](#gear-usetomselect)
|
|
108
|
+
- [get](#gear-get)
|
|
109
|
+
- [create](#gear-create)
|
|
110
|
+
- [destroy](#gear-destroy)
|
|
111
|
+
- [addHook](#gear-addhook)
|
|
112
|
+
- [clearHooks](#gear-clearhooks)
|
|
113
|
+
- [useTinymce](#gear-usetinymce)
|
|
114
|
+
- [useTinymce](#gear-usetinymce)
|
|
115
|
+
- [useTinymce](#gear-usetinymce)
|
|
116
|
+
- [useTinymceHook](#gear-usetinymcehook)
|
|
117
|
+
- [useUIBootstrap5](#gear-useuibootstrap5)
|
|
118
|
+
- [useBs5Tooltip](#gear-usebs5tooltip)
|
|
119
|
+
- [useBs5KeepTab](#gear-usebs5keeptab)
|
|
120
|
+
- [useBs5ButtonRadio](#gear-usebs5buttonradio)
|
|
121
|
+
- [useWebDirective](#gear-usewebdirective)
|
|
122
|
+
- [useWebDirective](#gear-usewebdirective)
|
|
123
|
+
- [useWebDirective](#gear-usewebdirective)
|
|
124
|
+
- [useUniDirective](#gear-useunidirective)
|
|
125
|
+
- [useFormValidation](#gear-useformvalidation)
|
|
126
|
+
- [useFormValidation](#gear-useformvalidation)
|
|
127
|
+
- [useFormValidation](#gear-useformvalidation)
|
|
128
|
+
- [useFormValidationInstance](#gear-useformvalidationinstance)
|
|
129
|
+
- [useFieldValidationInstance](#gear-usefieldvalidationinstance)
|
|
130
|
+
- [addGlobalValidator](#gear-addglobalvalidator)
|
|
131
|
+
- [useAlertAdapter](#gear-usealertadapter)
|
|
132
|
+
- [useUI](#gear-useui)
|
|
133
|
+
- [useUITheme](#gear-useuitheme)
|
|
134
|
+
- [loadAlpine](#gear-loadalpine)
|
|
135
|
+
- [initAlpineComponent](#gear-initalpinecomponent)
|
|
136
|
+
- [prepareAlpine](#gear-preparealpine)
|
|
137
|
+
- [prepareAlpineDefer](#gear-preparealpinedefer)
|
|
138
|
+
- [renderMessage](#gear-rendermessage)
|
|
139
|
+
- [clearMessages](#gear-clearmessages)
|
|
140
|
+
- [mark](#gear-mark)
|
|
141
|
+
- [slideUp](#gear-slideup)
|
|
142
|
+
- [slideDown](#gear-slidedown)
|
|
143
|
+
- [slideToggle](#gear-slidetoggle)
|
|
144
|
+
- [fadeOut](#gear-fadeout)
|
|
145
|
+
- [fadeIn](#gear-fadein)
|
|
146
|
+
- [highlight](#gear-highlight)
|
|
147
|
+
- [useColorPicker](#gear-usecolorpicker)
|
|
148
|
+
- [useDisableOnSubmit](#gear-usedisableonsubmit)
|
|
149
|
+
- [useDisableIfStackNotEmpty](#gear-usedisableifstacknotempty)
|
|
150
|
+
- [useKeepAlive](#gear-usekeepalive)
|
|
151
|
+
- [useVueComponentField](#gear-usevuecomponentfield)
|
|
152
|
+
- [useSystemUri](#gear-usesystemuri)
|
|
153
|
+
- [useSystemUri](#gear-usesystemuri)
|
|
154
|
+
- [useSystemUri](#gear-usesystemuri)
|
|
155
|
+
- [useAssetUri](#gear-useasseturi)
|
|
156
|
+
- [useAssetUri](#gear-useasseturi)
|
|
157
|
+
- [useAssetUri](#gear-useasseturi)
|
|
158
|
+
- [addUriBase](#gear-adduribase)
|
|
159
|
+
- [addRoute](#gear-addroute)
|
|
160
|
+
- [route](#gear-route)
|
|
161
|
+
- [hasRoute](#gear-hasroute)
|
|
162
|
+
- [addQuery](#gear-addquery)
|
|
163
|
+
- [parseQuery](#gear-parsequery)
|
|
164
|
+
- [buildQuery](#gear-buildquery)
|
|
165
|
+
- [removeCloak](#gear-removecloak)
|
|
166
|
+
- [flattenChildren](#gear-flattenchildren)
|
|
167
|
+
- [data](#gear-data)
|
|
168
|
+
- [data](#gear-data)
|
|
169
|
+
- [data](#gear-data)
|
|
170
|
+
- [data](#gear-data)
|
|
171
|
+
- [data](#gear-data)
|
|
172
|
+
- [removeData](#gear-removedata)
|
|
173
|
+
- [removeData](#gear-removedata)
|
|
174
|
+
- [removeData](#gear-removedata)
|
|
175
|
+
- [formRequestSubmit](#gear-formrequestsubmit)
|
|
176
|
+
- [polyfill](#gear-polyfill)
|
|
177
|
+
- [useFieldMultiUploader](#gear-usefieldmultiuploader)
|
|
178
|
+
- [useUnicornPhpAdapter](#gear-useunicornphpadapter)
|
|
179
|
+
- [useLegacyMethods](#gear-uselegacymethods)
|
|
180
|
+
- [createUnicorn](#gear-createunicorn)
|
|
181
|
+
- [createUnicornWithPlugins](#gear-createunicornwithplugins)
|
|
182
|
+
- [useUnicorn](#gear-useunicorn)
|
|
183
|
+
- [useInject](#gear-useinject)
|
|
184
|
+
- [pushUnicornToGlobal](#gear-pushunicorntoglobal)
|
|
185
|
+
- [useMacro](#gear-usemacro)
|
|
186
|
+
- [useMacro](#gear-usemacro)
|
|
187
|
+
- [useMacro](#gear-usemacro)
|
|
188
|
+
- [useLegacy](#gear-uselegacy)
|
|
189
|
+
|
|
190
|
+
### :gear: isPlainObject
|
|
191
|
+
|
|
192
|
+
| Function | Type |
|
|
193
|
+
| ---------- | ---------- |
|
|
194
|
+
| `isPlainObject` | `(val: any) => val is Record<string, any>` |
|
|
195
|
+
|
|
196
|
+
### :gear: mergeDeep
|
|
197
|
+
|
|
198
|
+
| Function | Type |
|
|
199
|
+
| ---------- | ---------- |
|
|
200
|
+
| `mergeDeep` | `<T = Record<string, any>>(target: Partial<T>, ...sources: any[]) => T` |
|
|
201
|
+
|
|
202
|
+
### :gear: getData
|
|
203
|
+
|
|
204
|
+
| Function | Type |
|
|
205
|
+
| ---------- | ---------- |
|
|
206
|
+
| `getData` | `(element: Element, name?: string or undefined) => any` |
|
|
207
|
+
|
|
208
|
+
### :gear: setData
|
|
209
|
+
|
|
210
|
+
| Function | Type |
|
|
211
|
+
| ---------- | ---------- |
|
|
212
|
+
| `setData` | `(element: Element, name: string, value: any) => void` |
|
|
213
|
+
|
|
214
|
+
### :gear: defData
|
|
215
|
+
|
|
216
|
+
| Function | Type |
|
|
217
|
+
| ---------- | ---------- |
|
|
218
|
+
| `defData` | `(element: Element, name: string, defCallback: Function) => any` |
|
|
219
|
+
|
|
220
|
+
### :gear: removeData
|
|
221
|
+
|
|
222
|
+
| Function | Type |
|
|
223
|
+
| ---------- | ---------- |
|
|
224
|
+
| `removeData` | `(element: Element, name: string) => any` |
|
|
225
|
+
|
|
226
|
+
### :gear: prepareData
|
|
227
|
+
|
|
228
|
+
| Function | Type |
|
|
229
|
+
| ---------- | ---------- |
|
|
230
|
+
| `prepareData` | `<T extends Node>(element: T) => T` |
|
|
231
|
+
|
|
232
|
+
### :gear: domready
|
|
233
|
+
|
|
234
|
+
| Function | Type |
|
|
235
|
+
| ---------- | ---------- |
|
|
236
|
+
| `domready` | `(callback?: ((value: any) => any) or undefined) => Promise<void>` |
|
|
237
|
+
|
|
238
|
+
References:
|
|
239
|
+
|
|
240
|
+
* [https://stackoverflow.com/a/9899701](https://stackoverflow.com/a/9899701)
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
### :gear: selectOne
|
|
244
|
+
|
|
245
|
+
| Function | Type |
|
|
246
|
+
| ---------- | ---------- |
|
|
247
|
+
| `selectOne` | `{ <K extends keyof HTMLElementTagNameMap>(ele: K): HTMLElementTagNameMap[K] or null; <E extends Element = Element>(ele: string): E or null; <E extends Element = Element>(ele: E): E; <E extends Element = Element>(ele: string or E): E or null; }` |
|
|
248
|
+
|
|
249
|
+
### :gear: selectOne
|
|
250
|
+
|
|
251
|
+
| Function | Type |
|
|
252
|
+
| ---------- | ---------- |
|
|
253
|
+
| `selectOne` | `{ <K extends keyof HTMLElementTagNameMap>(ele: K): HTMLElementTagNameMap[K] or null; <E extends Element = Element>(ele: string): E or null; <E extends Element = Element>(ele: E): E; <E extends Element = Element>(ele: string or E): E or null; }` |
|
|
254
|
+
|
|
255
|
+
### :gear: selectOne
|
|
256
|
+
|
|
257
|
+
| Function | Type |
|
|
258
|
+
| ---------- | ---------- |
|
|
259
|
+
| `selectOne` | `{ <K extends keyof HTMLElementTagNameMap>(ele: K): HTMLElementTagNameMap[K] or null; <E extends Element = Element>(ele: string): E or null; <E extends Element = Element>(ele: E): E; <E extends Element = Element>(ele: string or E): E or null; }` |
|
|
260
|
+
|
|
261
|
+
### :gear: selectOne
|
|
262
|
+
|
|
263
|
+
| Function | Type |
|
|
264
|
+
| ---------- | ---------- |
|
|
265
|
+
| `selectOne` | `{ <K extends keyof HTMLElementTagNameMap>(ele: K): HTMLElementTagNameMap[K] or null; <E extends Element = Element>(ele: string): E or null; <E extends Element = Element>(ele: E): E; <E extends Element = Element>(ele: string or E): E or null; }` |
|
|
266
|
+
|
|
267
|
+
### :gear: selectOne
|
|
268
|
+
|
|
269
|
+
| Function | Type |
|
|
270
|
+
| ---------- | ---------- |
|
|
271
|
+
| `selectOne` | `{ <K extends keyof HTMLElementTagNameMap>(ele: K): HTMLElementTagNameMap[K] or null; <E extends Element = Element>(ele: string): E or null; <E extends Element = Element>(ele: E): E; <E extends Element = Element>(ele: string or E): E or null; }` |
|
|
272
|
+
|
|
273
|
+
### :gear: selectAll
|
|
274
|
+
|
|
275
|
+
| Function | Type |
|
|
276
|
+
| ---------- | ---------- |
|
|
277
|
+
| `selectAll` | `{ <E extends Element = Element>(ele: string, callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: NodeListOf<E> or E[], callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: string or ... 1 more ... or E[], callback?: ((ele: E) => any) or undefined): E[]; <E ext...` |
|
|
278
|
+
|
|
279
|
+
### :gear: selectAll
|
|
280
|
+
|
|
281
|
+
| Function | Type |
|
|
282
|
+
| ---------- | ---------- |
|
|
283
|
+
| `selectAll` | `{ <E extends Element = Element>(ele: string, callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: NodeListOf<E> or E[], callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: string or ... 1 more ... or E[], callback?: ((ele: E) => any) or undefined): E[]; <E ext...` |
|
|
284
|
+
|
|
285
|
+
### :gear: selectAll
|
|
286
|
+
|
|
287
|
+
| Function | Type |
|
|
288
|
+
| ---------- | ---------- |
|
|
289
|
+
| `selectAll` | `{ <E extends Element = Element>(ele: string, callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: NodeListOf<E> or E[], callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: string or ... 1 more ... or E[], callback?: ((ele: E) => any) or undefined): E[]; <E ext...` |
|
|
290
|
+
|
|
291
|
+
### :gear: selectAll
|
|
292
|
+
|
|
293
|
+
| Function | Type |
|
|
294
|
+
| ---------- | ---------- |
|
|
295
|
+
| `selectAll` | `{ <E extends Element = Element>(ele: string, callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: NodeListOf<E> or E[], callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: string or ... 1 more ... or E[], callback?: ((ele: E) => any) or undefined): E[]; <E ext...` |
|
|
296
|
+
|
|
297
|
+
### :gear: selectAll
|
|
298
|
+
|
|
299
|
+
| Function | Type |
|
|
300
|
+
| ---------- | ---------- |
|
|
301
|
+
| `selectAll` | `{ <E extends Element = Element>(ele: string, callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: NodeListOf<E> or E[], callback?: ((ele: E) => any) or undefined): E[]; <E extends Element = Element>(ele: string or ... 1 more ... or E[], callback?: ((ele: E) => any) or undefined): E[]; <E ext...` |
|
|
302
|
+
|
|
303
|
+
### :gear: getBoundedInstance
|
|
304
|
+
|
|
305
|
+
| Function | Type |
|
|
306
|
+
| ---------- | ---------- |
|
|
307
|
+
| `getBoundedInstance` | `{ <T = any, E = Element>(selector: E, name: string, callback?: ((el: E) => any) or undefined): T; <T = any, E extends Element = Element>(selector: string or E, name: string, callback?: ((el: E) => any) or undefined): T or null; }` |
|
|
308
|
+
|
|
309
|
+
### :gear: getBoundedInstance
|
|
310
|
+
|
|
311
|
+
| Function | Type |
|
|
312
|
+
| ---------- | ---------- |
|
|
313
|
+
| `getBoundedInstance` | `{ <T = any, E = Element>(selector: E, name: string, callback?: ((el: E) => any) or undefined): T; <T = any, E extends Element = Element>(selector: string or E, name: string, callback?: ((el: E) => any) or undefined): T or null; }` |
|
|
314
|
+
|
|
315
|
+
### :gear: getBoundedInstance
|
|
316
|
+
|
|
317
|
+
| Function | Type |
|
|
318
|
+
| ---------- | ---------- |
|
|
319
|
+
| `getBoundedInstance` | `{ <T = any, E = Element>(selector: E, name: string, callback?: ((el: E) => any) or undefined): T; <T = any, E extends Element = Element>(selector: string or E, name: string, callback?: ((el: E) => any) or undefined): T or null; }` |
|
|
320
|
+
|
|
321
|
+
### :gear: getBoundedInstanceList
|
|
322
|
+
|
|
323
|
+
| Function | Type |
|
|
324
|
+
| ---------- | ---------- |
|
|
325
|
+
| `getBoundedInstanceList` | `<T = any, E extends Element = Element>(selector: string or NodeListOf<E>, name: string, callback?: (el: E) => any) => (T or null)[]` |
|
|
326
|
+
|
|
327
|
+
### :gear: module
|
|
328
|
+
|
|
329
|
+
| Function | Type |
|
|
330
|
+
| ---------- | ---------- |
|
|
331
|
+
| `module` | `{ <T = any, E extends Element = Element>(ele: string, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: NodeListOf<E>, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: E, name: string, cal...` |
|
|
332
|
+
|
|
333
|
+
### :gear: module
|
|
334
|
+
|
|
335
|
+
| Function | Type |
|
|
336
|
+
| ---------- | ---------- |
|
|
337
|
+
| `module` | `{ <T = any, E extends Element = Element>(ele: string, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: NodeListOf<E>, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: E, name: string, cal...` |
|
|
338
|
+
|
|
339
|
+
### :gear: module
|
|
340
|
+
|
|
341
|
+
| Function | Type |
|
|
342
|
+
| ---------- | ---------- |
|
|
343
|
+
| `module` | `{ <T = any, E extends Element = Element>(ele: string, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: NodeListOf<E>, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: E, name: string, cal...` |
|
|
344
|
+
|
|
345
|
+
### :gear: module
|
|
346
|
+
|
|
347
|
+
| Function | Type |
|
|
348
|
+
| ---------- | ---------- |
|
|
349
|
+
| `module` | `{ <T = any, E extends Element = Element>(ele: string, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: NodeListOf<E>, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: E, name: string, cal...` |
|
|
350
|
+
|
|
351
|
+
### :gear: module
|
|
352
|
+
|
|
353
|
+
| Function | Type |
|
|
354
|
+
| ---------- | ---------- |
|
|
355
|
+
| `module` | `{ <T = any, E extends Element = Element>(ele: string, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: NodeListOf<E>, name: string, callback?: ((el: E) => any) or undefined): (T or null)[]; <T = any, E extends Element = Element>(ele: E, name: string, cal...` |
|
|
356
|
+
|
|
357
|
+
### :gear: h
|
|
358
|
+
|
|
359
|
+
| Function | Type |
|
|
360
|
+
| ---------- | ---------- |
|
|
361
|
+
| `h` | `<T extends keyof HTMLElementTagNameMap>(element: T, attrs?: Record<string, any> or undefined, content?: any) => HTMLElementTagNameMap[T]` |
|
|
362
|
+
|
|
363
|
+
### :gear: h
|
|
364
|
+
|
|
365
|
+
| Function | Type |
|
|
366
|
+
| ---------- | ---------- |
|
|
367
|
+
| `h` | `<T extends keyof HTMLElementTagNameMap>(element: T, attrs?: Record<string, any> or undefined, content?: any) => HTMLElementTagNameMap[T]` |
|
|
368
|
+
|
|
369
|
+
### :gear: html
|
|
370
|
+
|
|
371
|
+
| Function | Type |
|
|
372
|
+
| ---------- | ---------- |
|
|
373
|
+
| `html` | `<T extends Element = HTMLElement>(html: string) => T` |
|
|
374
|
+
|
|
375
|
+
### :gear: delegate
|
|
376
|
+
|
|
377
|
+
Pure JS version of jQuery delegate()
|
|
378
|
+
|
|
379
|
+
| Function | Type |
|
|
380
|
+
| ---------- | ---------- |
|
|
381
|
+
| `delegate` | `(wrapper: string or Element, selector: string, eventName: string, callback: (e: Event) => void) => () => void` |
|
|
382
|
+
|
|
383
|
+
References:
|
|
384
|
+
|
|
385
|
+
* [https://gist.github.com/iagobruno/4db2ed62dc40fa841bb9a5c7de92f5f8](https://gist.github.com/iagobruno/4db2ed62dc40fa841bb9a5c7de92f5f8)
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### :gear: injectCssToDocument
|
|
389
|
+
|
|
390
|
+
| Function | Type |
|
|
391
|
+
| ---------- | ---------- |
|
|
392
|
+
| `injectCssToDocument` | `{ (doc: Document, ...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; (...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; }` |
|
|
393
|
+
|
|
394
|
+
### :gear: injectCssToDocument
|
|
395
|
+
|
|
396
|
+
| Function | Type |
|
|
397
|
+
| ---------- | ---------- |
|
|
398
|
+
| `injectCssToDocument` | `{ (doc: Document, ...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; (...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; }` |
|
|
399
|
+
|
|
400
|
+
### :gear: injectCssToDocument
|
|
401
|
+
|
|
402
|
+
| Function | Type |
|
|
403
|
+
| ---------- | ---------- |
|
|
404
|
+
| `injectCssToDocument` | `{ (doc: Document, ...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; (...css: (string or CSSStyleSheet)[]): CSSStyleSheet[]; }` |
|
|
405
|
+
|
|
406
|
+
### :gear: animateTo
|
|
407
|
+
|
|
408
|
+
| Function | Type |
|
|
409
|
+
| ---------- | ---------- |
|
|
410
|
+
| `animateTo` | `(element: HTMLElement, styles: Partial<Record<keyof CSSStyleDeclaration, any>>, options?: number or KeyframeAnimationOptions) => Animation` |
|
|
411
|
+
|
|
412
|
+
### :gear: base64UrlEncode
|
|
413
|
+
|
|
414
|
+
| Function | Type |
|
|
415
|
+
| ---------- | ---------- |
|
|
416
|
+
| `base64UrlEncode` | `(string: string) => string` |
|
|
417
|
+
|
|
418
|
+
### :gear: base64UrlDecode
|
|
419
|
+
|
|
420
|
+
Base64 URL decode
|
|
421
|
+
|
|
422
|
+
| Function | Type |
|
|
423
|
+
| ---------- | ---------- |
|
|
424
|
+
| `base64UrlDecode` | `(string: string) => string` |
|
|
425
|
+
|
|
426
|
+
### :gear: serial
|
|
427
|
+
|
|
428
|
+
| Function | Type |
|
|
429
|
+
| ---------- | ---------- |
|
|
430
|
+
| `serial` | `() => number` |
|
|
431
|
+
|
|
432
|
+
### :gear: watchAttributes
|
|
433
|
+
|
|
434
|
+
| Function | Type |
|
|
435
|
+
| ---------- | ---------- |
|
|
436
|
+
| `watchAttributes` | `<T extends HTMLElement>(el: T, callback?: AttributeMutationCallback<T> or undefined) => AttributeMutationObserver<T>` |
|
|
437
|
+
|
|
438
|
+
### :gear: forceArray
|
|
439
|
+
|
|
440
|
+
| Function | Type |
|
|
441
|
+
| ---------- | ---------- |
|
|
442
|
+
| `forceArray` | `<T>(item: T or T[]) => T[]` |
|
|
443
|
+
|
|
444
|
+
### :gear: debounce
|
|
445
|
+
|
|
446
|
+
| Function | Type |
|
|
447
|
+
| ---------- | ---------- |
|
|
448
|
+
| `debounce` | `<T extends Function = Function>(handler: T, wait?: number) => T` |
|
|
449
|
+
|
|
450
|
+
### :gear: throttle
|
|
451
|
+
|
|
452
|
+
| Function | Type |
|
|
453
|
+
| ---------- | ---------- |
|
|
454
|
+
| `throttle` | `<T extends Function = Function>(handler: T, wait?: number) => T` |
|
|
455
|
+
|
|
456
|
+
### :gear: isDebug
|
|
457
|
+
|
|
458
|
+
| Function | Type |
|
|
459
|
+
| ---------- | ---------- |
|
|
460
|
+
| `isDebug` | `() => boolean` |
|
|
461
|
+
|
|
462
|
+
### :gear: nextTick
|
|
463
|
+
|
|
464
|
+
| Function | Type |
|
|
465
|
+
| ---------- | ---------- |
|
|
466
|
+
| `nextTick` | `(callback?: (() => any) or undefined) => Promise<any>` |
|
|
467
|
+
|
|
468
|
+
### :gear: wait
|
|
469
|
+
|
|
470
|
+
| Function | Type |
|
|
471
|
+
| ---------- | ---------- |
|
|
472
|
+
| `wait` | `<T extends readonly unknown[]>(...promisee: { [K in keyof T]: T[K] or PromiseLike<T[K]>; }) => Promise<Awaited<T>>` |
|
|
473
|
+
|
|
474
|
+
### :gear: useLang
|
|
475
|
+
|
|
476
|
+
| Function | Type |
|
|
477
|
+
| ---------- | ---------- |
|
|
478
|
+
| `useLang` | `() => UnicornLang` |
|
|
479
|
+
|
|
480
|
+
### :gear: trans
|
|
481
|
+
|
|
482
|
+
| Function | Type |
|
|
483
|
+
| ---------- | ---------- |
|
|
484
|
+
| `trans` | `(id: string, ...args: any[]) => string` |
|
|
485
|
+
|
|
486
|
+
### :gear: __
|
|
487
|
+
|
|
488
|
+
| Function | Type |
|
|
489
|
+
| ---------- | ---------- |
|
|
490
|
+
| `__` | `(id: string, ...args: any[]) => string` |
|
|
491
|
+
|
|
492
|
+
### :gear: useScriptImport
|
|
493
|
+
|
|
494
|
+
| Function | Type |
|
|
495
|
+
| ---------- | ---------- |
|
|
496
|
+
| `useScriptImport` | `(src: string, attrs?: Record<string, string>) => Promise<void>` |
|
|
497
|
+
|
|
498
|
+
### :gear: doImport
|
|
499
|
+
|
|
500
|
+
| Function | Type |
|
|
501
|
+
| ---------- | ---------- |
|
|
502
|
+
| `doImport` | `<T = any>(src: string) => Promise<T>` |
|
|
503
|
+
|
|
504
|
+
### :gear: useImport
|
|
505
|
+
|
|
506
|
+
| Function | Type |
|
|
507
|
+
| ---------- | ---------- |
|
|
508
|
+
| `useImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
509
|
+
|
|
510
|
+
### :gear: useImport
|
|
511
|
+
|
|
512
|
+
| Function | Type |
|
|
513
|
+
| ---------- | ---------- |
|
|
514
|
+
| `useImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
515
|
+
|
|
516
|
+
### :gear: useImport
|
|
517
|
+
|
|
518
|
+
| Function | Type |
|
|
519
|
+
| ---------- | ---------- |
|
|
520
|
+
| `useImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
521
|
+
|
|
522
|
+
### :gear: useImport
|
|
523
|
+
|
|
524
|
+
| Function | Type |
|
|
525
|
+
| ---------- | ---------- |
|
|
526
|
+
| `useImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
527
|
+
|
|
528
|
+
### :gear: useImport
|
|
529
|
+
|
|
530
|
+
| Function | Type |
|
|
531
|
+
| ---------- | ---------- |
|
|
532
|
+
| `useImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
533
|
+
|
|
534
|
+
### :gear: useSeriesImport
|
|
535
|
+
|
|
536
|
+
| Function | Type |
|
|
537
|
+
| ---------- | ---------- |
|
|
538
|
+
| `useSeriesImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
539
|
+
|
|
540
|
+
### :gear: useSeriesImport
|
|
541
|
+
|
|
542
|
+
| Function | Type |
|
|
543
|
+
| ---------- | ---------- |
|
|
544
|
+
| `useSeriesImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
545
|
+
|
|
546
|
+
### :gear: useSeriesImport
|
|
547
|
+
|
|
548
|
+
| Function | Type |
|
|
549
|
+
| ---------- | ---------- |
|
|
550
|
+
| `useSeriesImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
551
|
+
|
|
552
|
+
### :gear: useSeriesImport
|
|
553
|
+
|
|
554
|
+
| Function | Type |
|
|
555
|
+
| ---------- | ---------- |
|
|
556
|
+
| `useSeriesImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
557
|
+
|
|
558
|
+
### :gear: useSeriesImport
|
|
559
|
+
|
|
560
|
+
| Function | Type |
|
|
561
|
+
| ---------- | ---------- |
|
|
562
|
+
| `useSeriesImport` | `{ (...src: any[]): Promise<any>; <T extends any[]>(...src: string[]): Promise<T>; <T = any>(src: string): Promise<{ default: T; }>; <D = any, C = any>(src: string): Promise<{ default: D; } and Dictionary<...>>; }` |
|
|
563
|
+
|
|
564
|
+
### :gear: useCssIncludes
|
|
565
|
+
|
|
566
|
+
| Function | Type |
|
|
567
|
+
| ---------- | ---------- |
|
|
568
|
+
| `useCssIncludes` | `(...hrefs: string[]) => Promise<void[]>` |
|
|
569
|
+
|
|
570
|
+
### :gear: useCssImport
|
|
571
|
+
|
|
572
|
+
| Function | Type |
|
|
573
|
+
| ---------- | ---------- |
|
|
574
|
+
| `useCssImport` | `(...hrefs: string[]) => Promise<CSSStyleSheet[]>` |
|
|
575
|
+
|
|
576
|
+
### :gear: useCheckboxesMultiSelect
|
|
577
|
+
|
|
578
|
+
| Function | Type |
|
|
579
|
+
| ---------- | ---------- |
|
|
580
|
+
| `useCheckboxesMultiSelect` | `{ (): Promise<any>; (selector?: Nullable<string or HTMLElement>, options?: Record<string, any> or undefined): Promise<CheckboxesMultiSelect>; }` |
|
|
581
|
+
|
|
582
|
+
### :gear: useCheckboxesMultiSelect
|
|
583
|
+
|
|
584
|
+
| Function | Type |
|
|
585
|
+
| ---------- | ---------- |
|
|
586
|
+
| `useCheckboxesMultiSelect` | `{ (): Promise<any>; (selector?: Nullable<string or HTMLElement>, options?: Record<string, any> or undefined): Promise<CheckboxesMultiSelect>; }` |
|
|
587
|
+
|
|
588
|
+
### :gear: useCheckboxesMultiSelect
|
|
589
|
+
|
|
590
|
+
| Function | Type |
|
|
591
|
+
| ---------- | ---------- |
|
|
592
|
+
| `useCheckboxesMultiSelect` | `{ (): Promise<any>; (selector?: Nullable<string or HTMLElement>, options?: Record<string, any> or undefined): Promise<CheckboxesMultiSelect>; }` |
|
|
593
|
+
|
|
594
|
+
### :gear: useFieldCascadeSelect
|
|
595
|
+
|
|
596
|
+
| Function | Type |
|
|
597
|
+
| ---------- | ---------- |
|
|
598
|
+
| `useFieldCascadeSelect` | `() => Promise<CascadeSelectModule>` |
|
|
599
|
+
|
|
600
|
+
### :gear: useFieldFileDrag
|
|
601
|
+
|
|
602
|
+
| Function | Type |
|
|
603
|
+
| ---------- | ---------- |
|
|
604
|
+
| `useFieldFileDrag` | `() => Promise<FileDragModule>` |
|
|
605
|
+
|
|
606
|
+
### :gear: useFieldFlatpickr
|
|
607
|
+
|
|
608
|
+
| Function | Type |
|
|
609
|
+
| ---------- | ---------- |
|
|
610
|
+
| `useFieldFlatpickr` | `() => Promise<any>` |
|
|
611
|
+
|
|
612
|
+
### :gear: createCallback
|
|
613
|
+
|
|
614
|
+
| Function | Type |
|
|
615
|
+
| ---------- | ---------- |
|
|
616
|
+
| `createCallback` | `(type: "list" or "single", selector: string, modalSelector: string) => ModalSelectCallback` |
|
|
617
|
+
|
|
618
|
+
### :gear: useFieldModalSelect
|
|
619
|
+
|
|
620
|
+
| Function | Type |
|
|
621
|
+
| ---------- | ---------- |
|
|
622
|
+
| `useFieldModalSelect` | `() => Promise<ModalSelectModule>` |
|
|
623
|
+
|
|
624
|
+
### :gear: useFieldModalTree
|
|
625
|
+
|
|
626
|
+
| Function | Type |
|
|
627
|
+
| ---------- | ---------- |
|
|
628
|
+
| `useFieldModalTree` | `() => Promise<any>` |
|
|
629
|
+
|
|
630
|
+
### :gear: useFieldRepeatable
|
|
631
|
+
|
|
632
|
+
| Function | Type |
|
|
633
|
+
| ---------- | ---------- |
|
|
634
|
+
| `useFieldRepeatable` | `() => Promise<RepeatableModule>` |
|
|
635
|
+
|
|
636
|
+
### :gear: createHttpClient
|
|
637
|
+
|
|
638
|
+
| Function | Type |
|
|
639
|
+
| ---------- | ---------- |
|
|
640
|
+
| `createHttpClient` | `(config?: CreateAxiosDefaults<any> or AxiosInstance or undefined) => { axios: AxiosInstance; request: <T = any, D = any>(options: AxiosRequestConfig<any>) => Promise<...>; ... 11 more ...; isAxiosError: <T = any, D = any>(payload: any) => payload is AxiosError<...>; }` |
|
|
641
|
+
|
|
642
|
+
### :gear: useFieldSingleImageDrag
|
|
643
|
+
|
|
644
|
+
| Function | Type |
|
|
645
|
+
| ---------- | ---------- |
|
|
646
|
+
| `useFieldSingleImageDrag` | `() => Promise<SingleImageDragModule>` |
|
|
647
|
+
|
|
648
|
+
### :gear: useFormAsync
|
|
649
|
+
|
|
650
|
+
| Function | Type |
|
|
651
|
+
| ---------- | ---------- |
|
|
652
|
+
| `useFormAsync` | `{ (): Promise<UnicornFormElement>; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): Promise<UnicornFormElement or null>; }` |
|
|
653
|
+
|
|
654
|
+
### :gear: useFormAsync
|
|
655
|
+
|
|
656
|
+
| Function | Type |
|
|
657
|
+
| ---------- | ---------- |
|
|
658
|
+
| `useFormAsync` | `{ (): Promise<UnicornFormElement>; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): Promise<UnicornFormElement or null>; }` |
|
|
659
|
+
|
|
660
|
+
### :gear: useFormAsync
|
|
661
|
+
|
|
662
|
+
| Function | Type |
|
|
663
|
+
| ---------- | ---------- |
|
|
664
|
+
| `useFormAsync` | `{ (): Promise<UnicornFormElement>; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): Promise<UnicornFormElement or null>; }` |
|
|
665
|
+
|
|
666
|
+
### :gear: useForm
|
|
667
|
+
|
|
668
|
+
| Function | Type |
|
|
669
|
+
| ---------- | ---------- |
|
|
670
|
+
| `useForm` | `{ (): UnicornFormElement; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): UnicornFormElement or null; }` |
|
|
671
|
+
|
|
672
|
+
### :gear: useForm
|
|
673
|
+
|
|
674
|
+
| Function | Type |
|
|
675
|
+
| ---------- | ---------- |
|
|
676
|
+
| `useForm` | `{ (): UnicornFormElement; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): UnicornFormElement or null; }` |
|
|
677
|
+
|
|
678
|
+
### :gear: useForm
|
|
679
|
+
|
|
680
|
+
| Function | Type |
|
|
681
|
+
| ---------- | ---------- |
|
|
682
|
+
| `useForm` | `{ (): UnicornFormElement; (ele?: string or Element or undefined, options?: Record<string, any> or undefined): UnicornFormElement or null; }` |
|
|
683
|
+
|
|
684
|
+
### :gear: useFormComponent
|
|
685
|
+
|
|
686
|
+
| Function | Type |
|
|
687
|
+
| ---------- | ---------- |
|
|
688
|
+
| `useFormComponent` | `(ele?: string or Element or undefined, options?: Record<string, any>) => Promise<UnicornFormElement or null>` |
|
|
689
|
+
|
|
690
|
+
### :gear: useGridAsync
|
|
691
|
+
|
|
692
|
+
| Function | Type |
|
|
693
|
+
| ---------- | ---------- |
|
|
694
|
+
| `useGridAsync` | `(ele?: string or HTMLElement or undefined, options?: Record<string, any> or undefined) => Promise<UnicornGridElement or null>` |
|
|
695
|
+
|
|
696
|
+
### :gear: useGrid
|
|
697
|
+
|
|
698
|
+
| Function | Type |
|
|
699
|
+
| ---------- | ---------- |
|
|
700
|
+
| `useGrid` | `(ele: string or HTMLElement, options?: Record<string, any> or undefined) => UnicornGridElement or null` |
|
|
701
|
+
|
|
702
|
+
### :gear: useGridComponent
|
|
703
|
+
|
|
704
|
+
| Function | Type |
|
|
705
|
+
| ---------- | ---------- |
|
|
706
|
+
| `useGridComponent` | `(ele: string or HTMLElement, options?: Record<string, any> or undefined) => Promise<UnicornGridElement or null>` |
|
|
707
|
+
|
|
708
|
+
### :gear: useHttpClient
|
|
709
|
+
|
|
710
|
+
| Function | Type |
|
|
711
|
+
| ---------- | ---------- |
|
|
712
|
+
| `useHttpClient` | `(config?: CreateAxiosDefaults<any> or AxiosInstance or undefined) => Promise<{ axios: AxiosInstance; request: <T = any, D = any>(options: AxiosRequestConfig<any>) => Promise<...>; ... 11 more ...; isAxiosError: <T = any, D = any>(payload: any) => payload is AxiosError<...>; }>` |
|
|
713
|
+
|
|
714
|
+
### :gear: useIframeModal
|
|
715
|
+
|
|
716
|
+
| Function | Type |
|
|
717
|
+
| ---------- | ---------- |
|
|
718
|
+
| `useIframeModal` | `() => Promise<IFrameModalModule>` |
|
|
719
|
+
|
|
720
|
+
### :gear: useListDependent
|
|
721
|
+
|
|
722
|
+
| Function | Type |
|
|
723
|
+
| ---------- | ---------- |
|
|
724
|
+
| `useListDependent` | `{ (): Promise<ListDependentModule>; (element: string or HTMLSelectElement, dependent?: Nullable<string or HTMLSelectElement>, options?: Partial<...> or undefined): Promise<...>; }` |
|
|
725
|
+
|
|
726
|
+
### :gear: useListDependent
|
|
727
|
+
|
|
728
|
+
| Function | Type |
|
|
729
|
+
| ---------- | ---------- |
|
|
730
|
+
| `useListDependent` | `{ (): Promise<ListDependentModule>; (element: string or HTMLSelectElement, dependent?: Nullable<string or HTMLSelectElement>, options?: Partial<...> or undefined): Promise<...>; }` |
|
|
731
|
+
|
|
732
|
+
### :gear: useListDependent
|
|
733
|
+
|
|
734
|
+
| Function | Type |
|
|
735
|
+
| ---------- | ---------- |
|
|
736
|
+
| `useListDependent` | `{ (): Promise<ListDependentModule>; (element: string or HTMLSelectElement, dependent?: Nullable<string or HTMLSelectElement>, options?: Partial<...> or undefined): Promise<...>; }` |
|
|
737
|
+
|
|
738
|
+
### :gear: useQueue
|
|
739
|
+
|
|
740
|
+
| Function | Type |
|
|
741
|
+
| ---------- | ---------- |
|
|
742
|
+
| `useQueue` | `(name?: string, maxRunning?: number) => TaskQueue` |
|
|
743
|
+
|
|
744
|
+
### :gear: createQueue
|
|
745
|
+
|
|
746
|
+
| Function | Type |
|
|
747
|
+
| ---------- | ---------- |
|
|
748
|
+
| `createQueue` | `(maxRunning?: number) => TaskQueue` |
|
|
749
|
+
|
|
750
|
+
### :gear: get
|
|
751
|
+
|
|
752
|
+
| Function | Type |
|
|
753
|
+
| ---------- | ---------- |
|
|
754
|
+
| `get` | `(name: string, options?: Partial<S3UploaderGlobalOptions> or undefined) => S3Uploader` |
|
|
755
|
+
|
|
756
|
+
### :gear: get
|
|
757
|
+
|
|
758
|
+
| Function | Type |
|
|
759
|
+
| ---------- | ---------- |
|
|
760
|
+
| `get` | `(name: string, options?: Partial<S3UploaderGlobalOptions> or undefined) => S3Uploader` |
|
|
761
|
+
|
|
762
|
+
### :gear: create
|
|
763
|
+
|
|
764
|
+
| Function | Type |
|
|
765
|
+
| ---------- | ---------- |
|
|
766
|
+
| `create` | `(name: string, options?: Partial<S3UploaderGlobalOptions>) => S3Uploader` |
|
|
767
|
+
|
|
768
|
+
### :gear: destroy
|
|
769
|
+
|
|
770
|
+
| Function | Type |
|
|
771
|
+
| ---------- | ---------- |
|
|
772
|
+
| `destroy` | `(name: string) => void` |
|
|
773
|
+
|
|
774
|
+
### :gear: useS3Uploader
|
|
775
|
+
|
|
776
|
+
| Function | Type |
|
|
777
|
+
| ---------- | ---------- |
|
|
778
|
+
| `useS3Uploader` | `{ (): Promise<S3UploaderModule>; (name: string, options?: Partial<S3UploaderGlobalOptions> or undefined): Promise<S3Uploader>; }` |
|
|
779
|
+
|
|
780
|
+
### :gear: useS3Uploader
|
|
781
|
+
|
|
782
|
+
| Function | Type |
|
|
783
|
+
| ---------- | ---------- |
|
|
784
|
+
| `useS3Uploader` | `{ (): Promise<S3UploaderModule>; (name: string, options?: Partial<S3UploaderGlobalOptions> or undefined): Promise<S3Uploader>; }` |
|
|
785
|
+
|
|
786
|
+
### :gear: useS3Uploader
|
|
787
|
+
|
|
788
|
+
| Function | Type |
|
|
789
|
+
| ---------- | ---------- |
|
|
790
|
+
| `useS3Uploader` | `{ (): Promise<S3UploaderModule>; (name: string, options?: Partial<S3UploaderGlobalOptions> or undefined): Promise<S3Uploader>; }` |
|
|
791
|
+
|
|
792
|
+
### :gear: useS3MultipartUploader
|
|
793
|
+
|
|
794
|
+
| Function | Type |
|
|
795
|
+
| ---------- | ---------- |
|
|
796
|
+
| `useS3MultipartUploader` | `{ (): Promise<S3MultipartUploaderModule>; (options: Partial<S3MultipartUploaderOptions>): Promise<S3MultipartUploader>; }` |
|
|
797
|
+
|
|
798
|
+
### :gear: useS3MultipartUploader
|
|
799
|
+
|
|
800
|
+
| Function | Type |
|
|
801
|
+
| ---------- | ---------- |
|
|
802
|
+
| `useS3MultipartUploader` | `{ (): Promise<S3MultipartUploaderModule>; (options: Partial<S3MultipartUploaderOptions>): Promise<S3MultipartUploader>; }` |
|
|
803
|
+
|
|
804
|
+
### :gear: useS3MultipartUploader
|
|
805
|
+
|
|
806
|
+
| Function | Type |
|
|
807
|
+
| ---------- | ---------- |
|
|
808
|
+
| `useS3MultipartUploader` | `{ (): Promise<S3MultipartUploaderModule>; (options: Partial<S3MultipartUploaderOptions>): Promise<S3MultipartUploader>; }` |
|
|
809
|
+
|
|
810
|
+
### :gear: useShowOn
|
|
811
|
+
|
|
812
|
+
| Function | Type |
|
|
813
|
+
| ---------- | ---------- |
|
|
814
|
+
| `useShowOn` | `() => Promise<ShowOnModule>` |
|
|
815
|
+
|
|
816
|
+
### :gear: useStack
|
|
817
|
+
|
|
818
|
+
| Function | Type |
|
|
819
|
+
| ---------- | ---------- |
|
|
820
|
+
| `useStack` | `<T = any>(name?: string, store?: any[]) => Stack<T>` |
|
|
821
|
+
|
|
822
|
+
### :gear: createStack
|
|
823
|
+
|
|
824
|
+
| Function | Type |
|
|
825
|
+
| ---------- | ---------- |
|
|
826
|
+
| `createStack` | `<T = any>(store?: any[]) => Stack<T>` |
|
|
827
|
+
|
|
828
|
+
### :gear: useTomSelect
|
|
829
|
+
|
|
830
|
+
| Function | Type |
|
|
831
|
+
| ---------- | ---------- |
|
|
832
|
+
| `useTomSelect` | `(selector?: Nullable<string or HTMLElement or NodeListOf<HTMLElement>>, options?: Record<string, any>, theme?: string) => Promise<...>` |
|
|
833
|
+
|
|
834
|
+
References:
|
|
835
|
+
|
|
836
|
+
* [https://tom-select.js.org/](https://tom-select.js.org/)
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
### :gear: get
|
|
840
|
+
|
|
841
|
+
| Function | Type |
|
|
842
|
+
| ---------- | ---------- |
|
|
843
|
+
| `get` | `(selector: string, options?: Record<string, any>) => Promise<TinymceController>` |
|
|
844
|
+
|
|
845
|
+
### :gear: create
|
|
846
|
+
|
|
847
|
+
| Function | Type |
|
|
848
|
+
| ---------- | ---------- |
|
|
849
|
+
| `create` | `(selector: string or HTMLElement, options?: Record<string, any>) => Promise<TinymceController>` |
|
|
850
|
+
|
|
851
|
+
### :gear: destroy
|
|
852
|
+
|
|
853
|
+
| Function | Type |
|
|
854
|
+
| ---------- | ---------- |
|
|
855
|
+
| `destroy` | `(selector: string) => void` |
|
|
856
|
+
|
|
857
|
+
### :gear: addHook
|
|
858
|
+
|
|
859
|
+
| Function | Type |
|
|
860
|
+
| ---------- | ---------- |
|
|
861
|
+
| `addHook` | `(handler: (tinymce: TinyMCE) => any) => void` |
|
|
862
|
+
|
|
863
|
+
### :gear: clearHooks
|
|
864
|
+
|
|
865
|
+
| Function | Type |
|
|
866
|
+
| ---------- | ---------- |
|
|
867
|
+
| `clearHooks` | `() => void` |
|
|
868
|
+
|
|
869
|
+
### :gear: useTinymce
|
|
870
|
+
|
|
871
|
+
| Function | Type |
|
|
872
|
+
| ---------- | ---------- |
|
|
873
|
+
| `useTinymce` | `{ (): Promise<TinymceModule>; (selector?: string or undefined, options?: Record<string, any> or undefined): Promise<TinymceController>; }` |
|
|
874
|
+
|
|
875
|
+
### :gear: useTinymce
|
|
876
|
+
|
|
877
|
+
| Function | Type |
|
|
878
|
+
| ---------- | ---------- |
|
|
879
|
+
| `useTinymce` | `{ (): Promise<TinymceModule>; (selector?: string or undefined, options?: Record<string, any> or undefined): Promise<TinymceController>; }` |
|
|
880
|
+
|
|
881
|
+
### :gear: useTinymce
|
|
882
|
+
|
|
883
|
+
| Function | Type |
|
|
884
|
+
| ---------- | ---------- |
|
|
885
|
+
| `useTinymce` | `{ (): Promise<TinymceModule>; (selector?: string or undefined, options?: Record<string, any> or undefined): Promise<TinymceController>; }` |
|
|
886
|
+
|
|
887
|
+
### :gear: useTinymceHook
|
|
888
|
+
|
|
889
|
+
| Function | Type |
|
|
890
|
+
| ---------- | ---------- |
|
|
891
|
+
| `useTinymceHook` | `(handler: (tinymce: TinyMCE) => any) => Promise<void>` |
|
|
892
|
+
|
|
893
|
+
### :gear: useUIBootstrap5
|
|
894
|
+
|
|
895
|
+
| Function | Type |
|
|
896
|
+
| ---------- | ---------- |
|
|
897
|
+
| `useUIBootstrap5` | `(install?: boolean, pushToGlobal?: boolean) => Promise<UIBootstrap5>` |
|
|
898
|
+
|
|
899
|
+
### :gear: useBs5Tooltip
|
|
900
|
+
|
|
901
|
+
| Function | Type |
|
|
902
|
+
| ---------- | ---------- |
|
|
903
|
+
| `useBs5Tooltip` | `(selector?: string or Element or NodeListOf<Element>, config?: Partial<Options>) => Promise<Tooltip[]>` |
|
|
904
|
+
|
|
905
|
+
### :gear: useBs5KeepTab
|
|
906
|
+
|
|
907
|
+
| Function | Type |
|
|
908
|
+
| ---------- | ---------- |
|
|
909
|
+
| `useBs5KeepTab` | `{ (): Promise<KeepTabModule>; (selector?: string or HTMLElement or undefined, options?: KeepTabOptions or undefined): Promise<...>; }` |
|
|
910
|
+
|
|
911
|
+
### :gear: useBs5ButtonRadio
|
|
912
|
+
|
|
913
|
+
| Function | Type |
|
|
914
|
+
| ---------- | ---------- |
|
|
915
|
+
| `useBs5ButtonRadio` | `{ (): Promise<ButtonRadioModule>; (selector?: string or HTMLElement or undefined, options?: ButtonRadioOptions or undefined): Promise<...>; }` |
|
|
916
|
+
|
|
917
|
+
### :gear: useWebDirective
|
|
918
|
+
|
|
919
|
+
| Function | Type |
|
|
920
|
+
| ---------- | ---------- |
|
|
921
|
+
| `useWebDirective` | `{ (name: string, options: false): Promise<void>; (name: string, options?: any): Promise<WebDirective>; }` |
|
|
922
|
+
|
|
923
|
+
### :gear: useWebDirective
|
|
924
|
+
|
|
925
|
+
| Function | Type |
|
|
926
|
+
| ---------- | ---------- |
|
|
927
|
+
| `useWebDirective` | `{ (name: string, options: false): Promise<void>; (name: string, options?: any): Promise<WebDirective>; }` |
|
|
928
|
+
|
|
929
|
+
### :gear: useWebDirective
|
|
930
|
+
|
|
931
|
+
| Function | Type |
|
|
932
|
+
| ---------- | ---------- |
|
|
933
|
+
| `useWebDirective` | `{ (name: string, options: false): Promise<void>; (name: string, options?: any): Promise<WebDirective>; }` |
|
|
934
|
+
|
|
935
|
+
### :gear: useUniDirective
|
|
936
|
+
|
|
937
|
+
| Function | Type |
|
|
938
|
+
| ---------- | ---------- |
|
|
939
|
+
| `useUniDirective` | `<T extends Element = HTMLElement, M extends Record<string, boolean> = Record<string, boolean>>(name: string, handler: WebDirectiveHandler<T, M>, wdInstance?: string or WebDirective) => Promise<...>` |
|
|
940
|
+
|
|
941
|
+
### :gear: useFormValidation
|
|
942
|
+
|
|
943
|
+
| Function | Type |
|
|
944
|
+
| ---------- | ---------- |
|
|
945
|
+
| `useFormValidation` | `{ (): Promise<ValidationModule>; (selector: string or Element): Promise<UnicornFormValidation or null>; }` |
|
|
946
|
+
|
|
947
|
+
### :gear: useFormValidation
|
|
948
|
+
|
|
949
|
+
| Function | Type |
|
|
950
|
+
| ---------- | ---------- |
|
|
951
|
+
| `useFormValidation` | `{ (): Promise<ValidationModule>; (selector: string or Element): Promise<UnicornFormValidation or null>; }` |
|
|
952
|
+
|
|
953
|
+
### :gear: useFormValidation
|
|
954
|
+
|
|
955
|
+
| Function | Type |
|
|
956
|
+
| ---------- | ---------- |
|
|
957
|
+
| `useFormValidation` | `{ (): Promise<ValidationModule>; (selector: string or Element): Promise<UnicornFormValidation or null>; }` |
|
|
958
|
+
|
|
959
|
+
### :gear: useFormValidationInstance
|
|
960
|
+
|
|
961
|
+
| Function | Type |
|
|
962
|
+
| ---------- | ---------- |
|
|
963
|
+
| `useFormValidationInstance` | `(selector: string or Element) => UnicornFormValidation or null` |
|
|
964
|
+
|
|
965
|
+
### :gear: useFieldValidationInstance
|
|
966
|
+
|
|
967
|
+
| Function | Type |
|
|
968
|
+
| ---------- | ---------- |
|
|
969
|
+
| `useFieldValidationInstance` | `(selector: string or Element) => UnicornFieldValidation or null` |
|
|
970
|
+
|
|
971
|
+
### :gear: addGlobalValidator
|
|
972
|
+
|
|
973
|
+
| Function | Type |
|
|
974
|
+
| ---------- | ---------- |
|
|
975
|
+
| `addGlobalValidator` | `<T extends unknown, E extends HTMLElement, P = Record<string, any>>(name: string, validator: ValidationHandler<T, E, P>, options?: ValidatorOptions<E, P>) => Promise<...>` |
|
|
976
|
+
|
|
977
|
+
### :gear: useAlertAdapter
|
|
978
|
+
|
|
979
|
+
| Function | Type |
|
|
980
|
+
| ---------- | ---------- |
|
|
981
|
+
| `useAlertAdapter` | `(config?: AlertAdapterConfig or undefined) => any` |
|
|
982
|
+
|
|
983
|
+
### :gear: useUI
|
|
984
|
+
|
|
985
|
+
| Function | Type |
|
|
986
|
+
| ---------- | ---------- |
|
|
987
|
+
| `useUI` | `(instance?: UnicornUI or undefined) => UnicornUI` |
|
|
988
|
+
|
|
989
|
+
### :gear: useUITheme
|
|
990
|
+
|
|
991
|
+
| Function | Type |
|
|
992
|
+
| ---------- | ---------- |
|
|
993
|
+
| `useUITheme` | `<T extends UIThemeInterface>(theme?: T or Constructor<T> or undefined) => UIThemeInterface` |
|
|
994
|
+
|
|
995
|
+
### :gear: loadAlpine
|
|
996
|
+
|
|
997
|
+
| Function | Type |
|
|
998
|
+
| ---------- | ---------- |
|
|
999
|
+
| `loadAlpine` | `(callback?: Nullable<AlpinePrepareCallback>) => Promise<Alpine>` |
|
|
1000
|
+
|
|
1001
|
+
### :gear: initAlpineComponent
|
|
1002
|
+
|
|
1003
|
+
| Function | Type |
|
|
1004
|
+
| ---------- | ---------- |
|
|
1005
|
+
| `initAlpineComponent` | `(directive: string) => Promise<void>` |
|
|
1006
|
+
|
|
1007
|
+
### :gear: prepareAlpine
|
|
1008
|
+
|
|
1009
|
+
Before Alpine init
|
|
1010
|
+
|
|
1011
|
+
| Function | Type |
|
|
1012
|
+
| ---------- | ---------- |
|
|
1013
|
+
| `prepareAlpine` | `(callback: AlpinePrepareCallback) => Promise<void>` |
|
|
1014
|
+
|
|
1015
|
+
### :gear: prepareAlpineDefer
|
|
1016
|
+
|
|
1017
|
+
| Function | Type |
|
|
1018
|
+
| ---------- | ---------- |
|
|
1019
|
+
| `prepareAlpineDefer` | `(callback: AlpinePrepareCallback) => Promise<void>` |
|
|
1020
|
+
|
|
1021
|
+
### :gear: renderMessage
|
|
1022
|
+
|
|
1023
|
+
Render Messages.
|
|
1024
|
+
|
|
1025
|
+
| Function | Type |
|
|
1026
|
+
| ---------- | ---------- |
|
|
1027
|
+
| `renderMessage` | `(messages: string or string[], type?: string) => (() => any) or undefined` |
|
|
1028
|
+
|
|
1029
|
+
### :gear: clearMessages
|
|
1030
|
+
|
|
1031
|
+
Clear messages.
|
|
1032
|
+
|
|
1033
|
+
| Function | Type |
|
|
1034
|
+
| ---------- | ---------- |
|
|
1035
|
+
| `clearMessages` | `() => void` |
|
|
1036
|
+
|
|
1037
|
+
### :gear: mark
|
|
1038
|
+
|
|
1039
|
+
| Function | Type |
|
|
1040
|
+
| ---------- | ---------- |
|
|
1041
|
+
| `mark` | `(selector?: string or HTMLElement or undefined, keyword?: string, options?: Record<string, any>) => Promise<any>` |
|
|
1042
|
+
|
|
1043
|
+
### :gear: slideUp
|
|
1044
|
+
|
|
1045
|
+
| Function | Type |
|
|
1046
|
+
| ---------- | ---------- |
|
|
1047
|
+
| `slideUp` | `(target: string or HTMLElement, duration?: number) => Promise<void or Animation>` |
|
|
1048
|
+
|
|
1049
|
+
### :gear: slideDown
|
|
1050
|
+
|
|
1051
|
+
| Function | Type |
|
|
1052
|
+
| ---------- | ---------- |
|
|
1053
|
+
| `slideDown` | `(target: string or HTMLElement, duration?: number, display?: string) => Promise<void or Animation>` |
|
|
1054
|
+
|
|
1055
|
+
### :gear: slideToggle
|
|
1056
|
+
|
|
1057
|
+
slideToggle
|
|
1058
|
+
|
|
1059
|
+
| Function | Type |
|
|
1060
|
+
| ---------- | ---------- |
|
|
1061
|
+
| `slideToggle` | `(target: string or HTMLElement, duration?: number, display?: string) => Promise<void or Animation>` |
|
|
1062
|
+
|
|
1063
|
+
### :gear: fadeOut
|
|
1064
|
+
|
|
1065
|
+
| Function | Type |
|
|
1066
|
+
| ---------- | ---------- |
|
|
1067
|
+
| `fadeOut` | `(selector: string or HTMLElement, duration?: number) => Promise<void or Animation>` |
|
|
1068
|
+
|
|
1069
|
+
### :gear: fadeIn
|
|
1070
|
+
|
|
1071
|
+
| Function | Type |
|
|
1072
|
+
| ---------- | ---------- |
|
|
1073
|
+
| `fadeIn` | `(selector: string or HTMLElement, duration?: number, display?: string) => Promise<void or Animation>` |
|
|
1074
|
+
|
|
1075
|
+
### :gear: highlight
|
|
1076
|
+
|
|
1077
|
+
| Function | Type |
|
|
1078
|
+
| ---------- | ---------- |
|
|
1079
|
+
| `highlight` | `(selector: string or HTMLElement, color?: string, duration?: number) => Promise<void or Animation>` |
|
|
1080
|
+
|
|
1081
|
+
### :gear: useColorPicker
|
|
1082
|
+
|
|
1083
|
+
Color Picker.
|
|
1084
|
+
|
|
1085
|
+
| Function | Type |
|
|
1086
|
+
| ---------- | ---------- |
|
|
1087
|
+
| `useColorPicker` | `(selector?: Nullable<string or HTMLElement or NodeListOf<HTMLElement>>, options?: Partial<SpectrumOptions>) => Promise<...>` |
|
|
1088
|
+
|
|
1089
|
+
### :gear: useDisableOnSubmit
|
|
1090
|
+
|
|
1091
|
+
| Function | Type |
|
|
1092
|
+
| ---------- | ---------- |
|
|
1093
|
+
| `useDisableOnSubmit` | `(formSelector?: string or HTMLFormElement, buttonSelector?: string, options?: Record<string, any>) => void` |
|
|
1094
|
+
|
|
1095
|
+
### :gear: useDisableIfStackNotEmpty
|
|
1096
|
+
|
|
1097
|
+
| Function | Type |
|
|
1098
|
+
| ---------- | ---------- |
|
|
1099
|
+
| `useDisableIfStackNotEmpty` | `(buttonSelector?: string, stackName?: string) => void` |
|
|
1100
|
+
|
|
1101
|
+
### :gear: useKeepAlive
|
|
1102
|
+
|
|
1103
|
+
Keep alive.
|
|
1104
|
+
|
|
1105
|
+
| Function | Type |
|
|
1106
|
+
| ---------- | ---------- |
|
|
1107
|
+
| `useKeepAlive` | `(url: string, time?: number) => () => void` |
|
|
1108
|
+
|
|
1109
|
+
### :gear: useVueComponentField
|
|
1110
|
+
|
|
1111
|
+
Vue component field.
|
|
1112
|
+
|
|
1113
|
+
| Function | Type |
|
|
1114
|
+
| ---------- | ---------- |
|
|
1115
|
+
| `useVueComponentField` | `(selector?: Nullable<string or HTMLElement>, value?: any, options?: Record<string, any>) => Promise<any>` |
|
|
1116
|
+
|
|
1117
|
+
### :gear: useSystemUri
|
|
1118
|
+
|
|
1119
|
+
| Function | Type |
|
|
1120
|
+
| ---------- | ---------- |
|
|
1121
|
+
| `useSystemUri` | `{ (): UnicornSystemUri; (type: UriTypes): string; }` |
|
|
1122
|
+
|
|
1123
|
+
### :gear: useSystemUri
|
|
1124
|
+
|
|
1125
|
+
| Function | Type |
|
|
1126
|
+
| ---------- | ---------- |
|
|
1127
|
+
| `useSystemUri` | `{ (): UnicornSystemUri; (type: UriTypes): string; }` |
|
|
1128
|
+
|
|
1129
|
+
### :gear: useSystemUri
|
|
1130
|
+
|
|
1131
|
+
| Function | Type |
|
|
1132
|
+
| ---------- | ---------- |
|
|
1133
|
+
| `useSystemUri` | `{ (): UnicornSystemUri; (type: UriTypes): string; }` |
|
|
1134
|
+
|
|
1135
|
+
### :gear: useAssetUri
|
|
1136
|
+
|
|
1137
|
+
| Function | Type |
|
|
1138
|
+
| ---------- | ---------- |
|
|
1139
|
+
| `useAssetUri` | `{ (): UnicornAssetUri; (type?: AssetTypes or undefined, path?: string or undefined): string; }` |
|
|
1140
|
+
|
|
1141
|
+
### :gear: useAssetUri
|
|
1142
|
+
|
|
1143
|
+
| Function | Type |
|
|
1144
|
+
| ---------- | ---------- |
|
|
1145
|
+
| `useAssetUri` | `{ (): UnicornAssetUri; (type?: AssetTypes or undefined, path?: string or undefined): string; }` |
|
|
1146
|
+
|
|
1147
|
+
### :gear: useAssetUri
|
|
1148
|
+
|
|
1149
|
+
| Function | Type |
|
|
1150
|
+
| ---------- | ---------- |
|
|
1151
|
+
| `useAssetUri` | `{ (): UnicornAssetUri; (type?: AssetTypes or undefined, path?: string or undefined): string; }` |
|
|
1152
|
+
|
|
1153
|
+
### :gear: addUriBase
|
|
1154
|
+
|
|
1155
|
+
| Function | Type |
|
|
1156
|
+
| ---------- | ---------- |
|
|
1157
|
+
| `addUriBase` | `(uri: string, type?: string) => string` |
|
|
1158
|
+
|
|
1159
|
+
### :gear: addRoute
|
|
1160
|
+
|
|
1161
|
+
Add a route.
|
|
1162
|
+
|
|
1163
|
+
| Function | Type |
|
|
1164
|
+
| ---------- | ---------- |
|
|
1165
|
+
| `addRoute` | `(route: string, url: string) => void` |
|
|
1166
|
+
|
|
1167
|
+
### :gear: route
|
|
1168
|
+
|
|
1169
|
+
Get route.
|
|
1170
|
+
|
|
1171
|
+
| Function | Type |
|
|
1172
|
+
| ---------- | ---------- |
|
|
1173
|
+
| `route` | `(route: string, query?: Record<string, any> or undefined) => string` |
|
|
1174
|
+
|
|
1175
|
+
### :gear: hasRoute
|
|
1176
|
+
|
|
1177
|
+
| Function | Type |
|
|
1178
|
+
| ---------- | ---------- |
|
|
1179
|
+
| `hasRoute` | `(route: string) => boolean` |
|
|
1180
|
+
|
|
1181
|
+
### :gear: addQuery
|
|
1182
|
+
|
|
1183
|
+
| Function | Type |
|
|
1184
|
+
| ---------- | ---------- |
|
|
1185
|
+
| `addQuery` | `(url: string, query?: Record<string, any> or undefined) => string` |
|
|
1186
|
+
|
|
1187
|
+
### :gear: parseQuery
|
|
1188
|
+
|
|
1189
|
+
| Function | Type |
|
|
1190
|
+
| ---------- | ---------- |
|
|
1191
|
+
| `parseQuery` | `<T = Record<string, any>>(queryString: string) => T` |
|
|
1192
|
+
|
|
1193
|
+
### :gear: buildQuery
|
|
1194
|
+
|
|
1195
|
+
| Function | Type |
|
|
1196
|
+
| ---------- | ---------- |
|
|
1197
|
+
| `buildQuery` | `(query: Record<string, any>) => string` |
|
|
1198
|
+
|
|
1199
|
+
### :gear: removeCloak
|
|
1200
|
+
|
|
1201
|
+
| Function | Type |
|
|
1202
|
+
| ---------- | ---------- |
|
|
1203
|
+
| `removeCloak` | `() => void` |
|
|
1204
|
+
|
|
1205
|
+
### :gear: flattenChildren
|
|
1206
|
+
|
|
1207
|
+
| Function | Type |
|
|
1208
|
+
| ---------- | ---------- |
|
|
1209
|
+
| `flattenChildren` | `(children: TreeNode[]) => TreeNode[]` |
|
|
1210
|
+
|
|
1211
|
+
### :gear: data
|
|
1212
|
+
|
|
1213
|
+
| Function | Type |
|
|
1214
|
+
| ---------- | ---------- |
|
|
1215
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
1216
|
+
|
|
1217
|
+
### :gear: data
|
|
1218
|
+
|
|
1219
|
+
| Function | Type |
|
|
1220
|
+
| ---------- | ---------- |
|
|
1221
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
1222
|
+
|
|
1223
|
+
### :gear: data
|
|
1224
|
+
|
|
1225
|
+
| Function | Type |
|
|
1226
|
+
| ---------- | ---------- |
|
|
1227
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
1228
|
+
|
|
1229
|
+
### :gear: data
|
|
1230
|
+
|
|
1231
|
+
| Function | Type |
|
|
1232
|
+
| ---------- | ---------- |
|
|
1233
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
1234
|
+
|
|
1235
|
+
### :gear: data
|
|
1236
|
+
|
|
1237
|
+
| Function | Type |
|
|
1238
|
+
| ---------- | ---------- |
|
|
1239
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
1240
|
+
|
|
1241
|
+
### :gear: removeData
|
|
1242
|
+
|
|
1243
|
+
| Function | Type |
|
|
1244
|
+
| ---------- | ---------- |
|
|
1245
|
+
| `removeData` | `{ (name: string): any; (ele: Element, name: string): any; }` |
|
|
1246
|
+
|
|
1247
|
+
### :gear: removeData
|
|
1248
|
+
|
|
1249
|
+
| Function | Type |
|
|
1250
|
+
| ---------- | ---------- |
|
|
1251
|
+
| `removeData` | `{ (name: string): any; (ele: Element, name: string): any; }` |
|
|
1252
|
+
|
|
1253
|
+
### :gear: removeData
|
|
1254
|
+
|
|
1255
|
+
| Function | Type |
|
|
1256
|
+
| ---------- | ---------- |
|
|
1257
|
+
| `removeData` | `{ (name: string): any; (ele: Element, name: string): any; }` |
|
|
1258
|
+
|
|
1259
|
+
### :gear: formRequestSubmit
|
|
1260
|
+
|
|
1261
|
+
| Function | Type |
|
|
1262
|
+
| ---------- | ---------- |
|
|
1263
|
+
| `formRequestSubmit` | `(prototype: any) => void` |
|
|
1264
|
+
|
|
1265
|
+
### :gear: polyfill
|
|
1266
|
+
|
|
1267
|
+
| Function | Type |
|
|
1268
|
+
| ---------- | ---------- |
|
|
1269
|
+
| `polyfill` | `() => void` |
|
|
1270
|
+
|
|
1271
|
+
### :gear: useFieldMultiUploader
|
|
1272
|
+
|
|
1273
|
+
| Function | Type |
|
|
1274
|
+
| ---------- | ---------- |
|
|
1275
|
+
| `useFieldMultiUploader` | `() => Promise<MultiUploaderModule>` |
|
|
1276
|
+
|
|
1277
|
+
### :gear: useUnicornPhpAdapter
|
|
1278
|
+
|
|
1279
|
+
| Function | Type |
|
|
1280
|
+
| ---------- | ---------- |
|
|
1281
|
+
| `useUnicornPhpAdapter` | `(app?: UnicornApp or undefined) => { repeatable: () => Promise<RepeatableModule>; flatpickr: () => Promise<any>; fileDrag: () => Promise<FileDragModule>; ... 10 more ...; bootstrap: { ...; }; }` |
|
|
1282
|
+
|
|
1283
|
+
### :gear: useLegacyMethods
|
|
1284
|
+
|
|
1285
|
+
| Function | Type |
|
|
1286
|
+
| ---------- | ---------- |
|
|
1287
|
+
| `useLegacyMethods` | `(app: any) => Promise<void>` |
|
|
1288
|
+
|
|
1289
|
+
### :gear: createUnicorn
|
|
1290
|
+
|
|
1291
|
+
| Function | Type |
|
|
1292
|
+
| ---------- | ---------- |
|
|
1293
|
+
| `createUnicorn` | `() => UnicornApp` |
|
|
1294
|
+
|
|
1295
|
+
### :gear: createUnicornWithPlugins
|
|
1296
|
+
|
|
1297
|
+
| Function | Type |
|
|
1298
|
+
| ---------- | ---------- |
|
|
1299
|
+
| `createUnicornWithPlugins` | `() => UnicornApp` |
|
|
1300
|
+
|
|
1301
|
+
### :gear: useUnicorn
|
|
1302
|
+
|
|
1303
|
+
| Function | Type |
|
|
1304
|
+
| ---------- | ---------- |
|
|
1305
|
+
| `useUnicorn` | `(instance?: UnicornApp or undefined) => UnicornApp` |
|
|
1306
|
+
|
|
1307
|
+
### :gear: useInject
|
|
1308
|
+
|
|
1309
|
+
| Function | Type |
|
|
1310
|
+
| ---------- | ---------- |
|
|
1311
|
+
| `useInject` | `{ <T>(id: InjectionKey<T>): T; <T>(id: InjectionKey<T>, def: T): T; <T>(id: InjectionKey<T>, def?: T or undefined): T; }` |
|
|
1312
|
+
|
|
1313
|
+
### :gear: pushUnicornToGlobal
|
|
1314
|
+
|
|
1315
|
+
| Function | Type |
|
|
1316
|
+
| ---------- | ---------- |
|
|
1317
|
+
| `pushUnicornToGlobal` | `(app?: UnicornApp or undefined) => void` |
|
|
1318
|
+
|
|
1319
|
+
### :gear: useMacro
|
|
1320
|
+
|
|
1321
|
+
| Function | Type |
|
|
1322
|
+
| ---------- | ---------- |
|
|
1323
|
+
| `useMacro` | `{ <T extends Dictionary>(name: T): T; <N extends string, T extends unknown>(name: N, prop: T): { [K in N]: T; }; }` |
|
|
1324
|
+
|
|
1325
|
+
### :gear: useMacro
|
|
1326
|
+
|
|
1327
|
+
| Function | Type |
|
|
1328
|
+
| ---------- | ---------- |
|
|
1329
|
+
| `useMacro` | `{ <T extends Dictionary>(name: T): T; <N extends string, T extends unknown>(name: N, prop: T): { [K in N]: T; }; }` |
|
|
1330
|
+
|
|
1331
|
+
### :gear: useMacro
|
|
1332
|
+
|
|
1333
|
+
| Function | Type |
|
|
1334
|
+
| ---------- | ---------- |
|
|
1335
|
+
| `useMacro` | `{ <T extends Dictionary>(name: T): T; <N extends string, T extends unknown>(name: N, prop: T): { [K in N]: T; }; }` |
|
|
1336
|
+
|
|
1337
|
+
### :gear: useLegacy
|
|
1338
|
+
|
|
1339
|
+
| Function | Type |
|
|
1340
|
+
| ---------- | ---------- |
|
|
1341
|
+
| `useLegacy` | `(app?: UnicornApp or undefined) => Promise<UnicornApp>` |
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
## :wrench: Constants
|
|
1345
|
+
|
|
1346
|
+
- [ready](#gear-ready)
|
|
1347
|
+
- [ready](#gear-ready)
|
|
1348
|
+
- [ready](#gear-ready)
|
|
1349
|
+
- [ready](#gear-ready)
|
|
1350
|
+
- [ready](#gear-ready)
|
|
1351
|
+
- [ready](#gear-ready)
|
|
1352
|
+
- [ready](#gear-ready)
|
|
1353
|
+
- [ready](#gear-ready)
|
|
1354
|
+
- [ready](#gear-ready)
|
|
1355
|
+
- [ready](#gear-ready)
|
|
1356
|
+
- [ready](#gear-ready)
|
|
1357
|
+
- [ready](#gear-ready)
|
|
1358
|
+
- [ready](#gear-ready)
|
|
1359
|
+
- [ready](#gear-ready)
|
|
1360
|
+
|
|
1361
|
+
### :gear: ready
|
|
1362
|
+
|
|
1363
|
+
| Constant | Type |
|
|
1364
|
+
| ---------- | ---------- |
|
|
1365
|
+
| `ready` | `Promise<void>` |
|
|
1366
|
+
|
|
1367
|
+
### :gear: ready
|
|
1368
|
+
|
|
1369
|
+
| Constant | Type |
|
|
1370
|
+
| ---------- | ---------- |
|
|
1371
|
+
| `ready` | `Promise<void>` |
|
|
1372
|
+
|
|
1373
|
+
### :gear: ready
|
|
1374
|
+
|
|
1375
|
+
| Constant | Type |
|
|
1376
|
+
| ---------- | ---------- |
|
|
1377
|
+
| `ready` | `Promise<void>` |
|
|
1378
|
+
|
|
1379
|
+
### :gear: ready
|
|
1380
|
+
|
|
1381
|
+
| Constant | Type |
|
|
1382
|
+
| ---------- | ---------- |
|
|
1383
|
+
| `ready` | `Promise<void>` |
|
|
1384
|
+
|
|
1385
|
+
### :gear: ready
|
|
1386
|
+
|
|
1387
|
+
| Constant | Type |
|
|
1388
|
+
| ---------- | ---------- |
|
|
1389
|
+
| `ready` | `Promise<void>` |
|
|
1390
|
+
|
|
1391
|
+
### :gear: ready
|
|
1392
|
+
|
|
1393
|
+
| Constant | Type |
|
|
1394
|
+
| ---------- | ---------- |
|
|
1395
|
+
| `ready` | `Promise<void>` |
|
|
1396
|
+
|
|
1397
|
+
### :gear: ready
|
|
1398
|
+
|
|
1399
|
+
| Constant | Type |
|
|
1400
|
+
| ---------- | ---------- |
|
|
1401
|
+
| `ready` | `Promise<void>` |
|
|
1402
|
+
|
|
1403
|
+
### :gear: ready
|
|
1404
|
+
|
|
1405
|
+
| Constant | Type |
|
|
1406
|
+
| ---------- | ---------- |
|
|
1407
|
+
| `ready` | `Promise<void>` |
|
|
1408
|
+
|
|
1409
|
+
### :gear: ready
|
|
1410
|
+
|
|
1411
|
+
| Constant | Type |
|
|
1412
|
+
| ---------- | ---------- |
|
|
1413
|
+
| `ready` | `Promise<void>` |
|
|
1414
|
+
|
|
1415
|
+
### :gear: ready
|
|
1416
|
+
|
|
1417
|
+
| Constant | Type |
|
|
1418
|
+
| ---------- | ---------- |
|
|
1419
|
+
| `ready` | `Promise<void>` |
|
|
1420
|
+
|
|
1421
|
+
### :gear: ready
|
|
1422
|
+
|
|
1423
|
+
| Constant | Type |
|
|
1424
|
+
| ---------- | ---------- |
|
|
1425
|
+
| `ready` | `Promise<void>` |
|
|
1426
|
+
|
|
1427
|
+
### :gear: ready
|
|
1428
|
+
|
|
1429
|
+
| Constant | Type |
|
|
1430
|
+
| ---------- | ---------- |
|
|
1431
|
+
| `ready` | `Promise<void>` |
|
|
1432
|
+
|
|
1433
|
+
### :gear: ready
|
|
1434
|
+
|
|
1435
|
+
| Constant | Type |
|
|
1436
|
+
| ---------- | ---------- |
|
|
1437
|
+
| `ready` | `Promise<[void, void]>` |
|
|
1438
|
+
|
|
1439
|
+
### :gear: ready
|
|
1440
|
+
|
|
1441
|
+
| Constant | Type |
|
|
1442
|
+
| ---------- | ---------- |
|
|
1443
|
+
| `ready` | `Promise<void>` |
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
## :factory: AttributeMutationObserver
|
|
1447
|
+
|
|
1448
|
+
### Methods
|
|
1449
|
+
|
|
1450
|
+
- [watch](#gear-watch)
|
|
1451
|
+
- [observe](#gear-observe)
|
|
1452
|
+
- [disconnect](#gear-disconnect)
|
|
1453
|
+
|
|
1454
|
+
#### :gear: watch
|
|
1455
|
+
|
|
1456
|
+
| Method | Type |
|
|
1457
|
+
| ---------- | ---------- |
|
|
1458
|
+
| `watch` | `(name: string, callback: AttributeWatcher<T>) => () => void` |
|
|
1459
|
+
|
|
1460
|
+
#### :gear: observe
|
|
1461
|
+
|
|
1462
|
+
| Method | Type |
|
|
1463
|
+
| ---------- | ---------- |
|
|
1464
|
+
| `observe` | `() => void` |
|
|
1465
|
+
|
|
1466
|
+
#### :gear: disconnect
|
|
1467
|
+
|
|
1468
|
+
| Method | Type |
|
|
1469
|
+
| ---------- | ---------- |
|
|
1470
|
+
| `disconnect` | `() => void` |
|
|
1471
|
+
|
|
1472
|
+
### Properties
|
|
1473
|
+
|
|
1474
|
+
- [observer](#gear-observer)
|
|
1475
|
+
- [watches](#gear-watches)
|
|
1476
|
+
|
|
1477
|
+
#### :gear: observer
|
|
1478
|
+
|
|
1479
|
+
| Property | Type |
|
|
1480
|
+
| ---------- | ---------- |
|
|
1481
|
+
| `observer` | `MutationObserver` |
|
|
1482
|
+
|
|
1483
|
+
#### :gear: watches
|
|
1484
|
+
|
|
1485
|
+
| Property | Type |
|
|
1486
|
+
| ---------- | ---------- |
|
|
1487
|
+
| `watches` | `Record<string, AttributeWatcher<T>[]>` |
|
|
1488
|
+
|
|
1489
|
+
## :factory: default
|
|
1490
|
+
|
|
1491
|
+
### Methods
|
|
1492
|
+
|
|
1493
|
+
- [trans](#gear-trans)
|
|
1494
|
+
- [get](#gear-get)
|
|
1495
|
+
- [has](#gear-has)
|
|
1496
|
+
- [add](#gear-add)
|
|
1497
|
+
- [getStrings](#gear-getstrings)
|
|
1498
|
+
|
|
1499
|
+
#### :gear: trans
|
|
1500
|
+
|
|
1501
|
+
Translate a string.
|
|
1502
|
+
|
|
1503
|
+
| Method | Type |
|
|
1504
|
+
| ---------- | ---------- |
|
|
1505
|
+
| `trans` | `(id: string, ...args: any[]) => string` |
|
|
1506
|
+
|
|
1507
|
+
#### :gear: get
|
|
1508
|
+
|
|
1509
|
+
Find text.
|
|
1510
|
+
|
|
1511
|
+
| Method | Type |
|
|
1512
|
+
| ---------- | ---------- |
|
|
1513
|
+
| `get` | `(id: string) => string or null` |
|
|
1514
|
+
|
|
1515
|
+
#### :gear: has
|
|
1516
|
+
|
|
1517
|
+
Has language key.
|
|
1518
|
+
|
|
1519
|
+
| Method | Type |
|
|
1520
|
+
| ---------- | ---------- |
|
|
1521
|
+
| `has` | `(key: string) => boolean` |
|
|
1522
|
+
|
|
1523
|
+
#### :gear: add
|
|
1524
|
+
|
|
1525
|
+
Add language key.
|
|
1526
|
+
|
|
1527
|
+
| Method | Type |
|
|
1528
|
+
| ---------- | ---------- |
|
|
1529
|
+
| `add` | `(key: string, value: string) => this` |
|
|
1530
|
+
|
|
1531
|
+
#### :gear: getStrings
|
|
1532
|
+
|
|
1533
|
+
| Method | Type |
|
|
1534
|
+
| ---------- | ---------- |
|
|
1535
|
+
| `getStrings` | `() => Record<string, string>` |
|
|
1536
|
+
|
|
1537
|
+
## :factory: CheckboxesMultiSelect
|
|
1538
|
+
|
|
1539
|
+
### Static Methods
|
|
1540
|
+
|
|
1541
|
+
- [handle](#gear-handle)
|
|
1542
|
+
|
|
1543
|
+
#### :gear: handle
|
|
1544
|
+
|
|
1545
|
+
| Method | Type |
|
|
1546
|
+
| ---------- | ---------- |
|
|
1547
|
+
| `handle` | `(selector: any, options?: any) => any[]` |
|
|
1548
|
+
|
|
1549
|
+
### Methods
|
|
1550
|
+
|
|
1551
|
+
- [select](#gear-select)
|
|
1552
|
+
|
|
1553
|
+
#### :gear: select
|
|
1554
|
+
|
|
1555
|
+
| Method | Type |
|
|
1556
|
+
| ---------- | ---------- |
|
|
1557
|
+
| `select` | `(box: HTMLInputElement, event: MouseEvent) => void` |
|
|
1558
|
+
|
|
1559
|
+
### Properties
|
|
1560
|
+
|
|
1561
|
+
- [defaultOptions](#gear-defaultoptions)
|
|
1562
|
+
- [$element](#gear-$element)
|
|
1563
|
+
- [options](#gear-options)
|
|
1564
|
+
- [boxes](#gear-boxes)
|
|
1565
|
+
- [last](#gear-last)
|
|
1566
|
+
|
|
1567
|
+
#### :gear: defaultOptions
|
|
1568
|
+
|
|
1569
|
+
| Property | Type |
|
|
1570
|
+
| ---------- | ---------- |
|
|
1571
|
+
| `defaultOptions` | `{ duration: number; inputSelector: string; }` |
|
|
1572
|
+
|
|
1573
|
+
#### :gear: $element
|
|
1574
|
+
|
|
1575
|
+
| Property | Type |
|
|
1576
|
+
| ---------- | ---------- |
|
|
1577
|
+
| `$element` | `HTMLElement` |
|
|
1578
|
+
|
|
1579
|
+
#### :gear: options
|
|
1580
|
+
|
|
1581
|
+
| Property | Type |
|
|
1582
|
+
| ---------- | ---------- |
|
|
1583
|
+
| `options` | `any` |
|
|
1584
|
+
|
|
1585
|
+
#### :gear: boxes
|
|
1586
|
+
|
|
1587
|
+
| Property | Type |
|
|
1588
|
+
| ---------- | ---------- |
|
|
1589
|
+
| `boxes` | `HTMLInputElement[]` |
|
|
1590
|
+
|
|
1591
|
+
#### :gear: last
|
|
1592
|
+
|
|
1593
|
+
| Property | Type |
|
|
1594
|
+
| ---------- | ---------- |
|
|
1595
|
+
| `last` | `false or HTMLInputElement` |
|
|
1596
|
+
|
|
1597
|
+
## :factory: FileDragElement
|
|
1598
|
+
|
|
1599
|
+
### Methods
|
|
1600
|
+
|
|
1601
|
+
- [connectedCallback](#gear-connectedcallback)
|
|
1602
|
+
- [bindEvent](#gear-bindevent)
|
|
1603
|
+
- [prepareElements](#gear-prepareelements)
|
|
1604
|
+
- [createElementsLayout](#gear-createelementslayout)
|
|
1605
|
+
- [onChange](#gear-onchange)
|
|
1606
|
+
- [checkFileType](#gear-checkfiletype)
|
|
1607
|
+
- [compareMimeType](#gear-comparemimetype)
|
|
1608
|
+
|
|
1609
|
+
#### :gear: connectedCallback
|
|
1610
|
+
|
|
1611
|
+
| Method | Type |
|
|
1612
|
+
| ---------- | ---------- |
|
|
1613
|
+
| `connectedCallback` | `() => void` |
|
|
1614
|
+
|
|
1615
|
+
#### :gear: bindEvent
|
|
1616
|
+
|
|
1617
|
+
| Method | Type |
|
|
1618
|
+
| ---------- | ---------- |
|
|
1619
|
+
| `bindEvent` | `() => void` |
|
|
1620
|
+
|
|
1621
|
+
#### :gear: prepareElements
|
|
1622
|
+
|
|
1623
|
+
| Method | Type |
|
|
1624
|
+
| ---------- | ---------- |
|
|
1625
|
+
| `prepareElements` | `() => void` |
|
|
1626
|
+
|
|
1627
|
+
#### :gear: createElementsLayout
|
|
1628
|
+
|
|
1629
|
+
| Method | Type |
|
|
1630
|
+
| ---------- | ---------- |
|
|
1631
|
+
| `createElementsLayout` | `() => void` |
|
|
1632
|
+
|
|
1633
|
+
#### :gear: onChange
|
|
1634
|
+
|
|
1635
|
+
| Method | Type |
|
|
1636
|
+
| ---------- | ---------- |
|
|
1637
|
+
| `onChange` | `(evt?: Event or undefined) => void` |
|
|
1638
|
+
|
|
1639
|
+
#### :gear: checkFileType
|
|
1640
|
+
|
|
1641
|
+
| Method | Type |
|
|
1642
|
+
| ---------- | ---------- |
|
|
1643
|
+
| `checkFileType` | `(accepted: string[], file: File) => void` |
|
|
1644
|
+
|
|
1645
|
+
#### :gear: compareMimeType
|
|
1646
|
+
|
|
1647
|
+
| Method | Type |
|
|
1648
|
+
| ---------- | ---------- |
|
|
1649
|
+
| `compareMimeType` | `(accepted: string, mime: string) => boolean` |
|
|
1650
|
+
|
|
1651
|
+
### Static Properties
|
|
1652
|
+
|
|
1653
|
+
- [is](#gear-is)
|
|
1654
|
+
|
|
1655
|
+
#### :gear: is
|
|
1656
|
+
|
|
1657
|
+
| Property | Type |
|
|
1658
|
+
| ---------- | ---------- |
|
|
1659
|
+
| `is` | `string` |
|
|
1660
|
+
|
|
1661
|
+
### Properties
|
|
1662
|
+
|
|
1663
|
+
- [element](#gear-element)
|
|
1664
|
+
- [overlayLabel](#gear-overlaylabel)
|
|
1665
|
+
- [button](#gear-button)
|
|
1666
|
+
- [options](#gear-options)
|
|
1667
|
+
|
|
1668
|
+
#### :gear: element
|
|
1669
|
+
|
|
1670
|
+
| Property | Type |
|
|
1671
|
+
| ---------- | ---------- |
|
|
1672
|
+
| `element` | `HTMLInputElement` |
|
|
1673
|
+
|
|
1674
|
+
#### :gear: overlayLabel
|
|
1675
|
+
|
|
1676
|
+
| Property | Type |
|
|
1677
|
+
| ---------- | ---------- |
|
|
1678
|
+
| `overlayLabel` | `HTMLLabelElement` |
|
|
1679
|
+
|
|
1680
|
+
#### :gear: button
|
|
1681
|
+
|
|
1682
|
+
| Property | Type |
|
|
1683
|
+
| ---------- | ---------- |
|
|
1684
|
+
| `button` | `HTMLButtonElement` |
|
|
1685
|
+
|
|
1686
|
+
#### :gear: options
|
|
1687
|
+
|
|
1688
|
+
| Property | Type |
|
|
1689
|
+
| ---------- | ---------- |
|
|
1690
|
+
| `options` | `FileDragOptions` |
|
|
1691
|
+
|
|
1692
|
+
## :factory: FlatpickrElement
|
|
1693
|
+
|
|
1694
|
+
### Methods
|
|
1695
|
+
|
|
1696
|
+
- [getOptions](#gear-getoptions)
|
|
1697
|
+
- [getInstance](#gear-getinstance)
|
|
1698
|
+
|
|
1699
|
+
#### :gear: getOptions
|
|
1700
|
+
|
|
1701
|
+
| Method | Type |
|
|
1702
|
+
| ---------- | ---------- |
|
|
1703
|
+
| `getOptions` | `() => any` |
|
|
1704
|
+
|
|
1705
|
+
#### :gear: getInstance
|
|
1706
|
+
|
|
1707
|
+
| Method | Type |
|
|
1708
|
+
| ---------- | ---------- |
|
|
1709
|
+
| `getInstance` | `() => Instance` |
|
|
1710
|
+
|
|
1711
|
+
### Properties
|
|
1712
|
+
|
|
1713
|
+
- [instance](#gear-instance)
|
|
1714
|
+
|
|
1715
|
+
#### :gear: instance
|
|
1716
|
+
|
|
1717
|
+
| Property | Type |
|
|
1718
|
+
| ---------- | ---------- |
|
|
1719
|
+
| `instance` | `Instance` |
|
|
1720
|
+
|
|
1721
|
+
## :factory: IFrameModalElement
|
|
1722
|
+
|
|
1723
|
+
### Methods
|
|
1724
|
+
|
|
1725
|
+
- [template](#gear-template)
|
|
1726
|
+
- [connectedCallback](#gear-connectedcallback)
|
|
1727
|
+
- [bindEvents](#gear-bindevents)
|
|
1728
|
+
- [resize](#gear-resize)
|
|
1729
|
+
- [getModalId](#gear-getmodalid)
|
|
1730
|
+
|
|
1731
|
+
#### :gear: template
|
|
1732
|
+
|
|
1733
|
+
| Method | Type |
|
|
1734
|
+
| ---------- | ---------- |
|
|
1735
|
+
| `template` | `() => string` |
|
|
1736
|
+
|
|
1737
|
+
#### :gear: connectedCallback
|
|
1738
|
+
|
|
1739
|
+
| Method | Type |
|
|
1740
|
+
| ---------- | ---------- |
|
|
1741
|
+
| `connectedCallback` | `() => void` |
|
|
1742
|
+
|
|
1743
|
+
#### :gear: bindEvents
|
|
1744
|
+
|
|
1745
|
+
| Method | Type |
|
|
1746
|
+
| ---------- | ---------- |
|
|
1747
|
+
| `bindEvents` | `() => void` |
|
|
1748
|
+
|
|
1749
|
+
#### :gear: resize
|
|
1750
|
+
|
|
1751
|
+
| Method | Type |
|
|
1752
|
+
| ---------- | ---------- |
|
|
1753
|
+
| `resize` | `(iframe: HTMLIFrameElement) => void` |
|
|
1754
|
+
|
|
1755
|
+
#### :gear: getModalId
|
|
1756
|
+
|
|
1757
|
+
| Method | Type |
|
|
1758
|
+
| ---------- | ---------- |
|
|
1759
|
+
| `getModalId` | `() => string` |
|
|
1760
|
+
|
|
1761
|
+
### Static Properties
|
|
1762
|
+
|
|
1763
|
+
- [is](#gear-is)
|
|
1764
|
+
|
|
1765
|
+
#### :gear: is
|
|
1766
|
+
|
|
1767
|
+
| Property | Type |
|
|
1768
|
+
| ---------- | ---------- |
|
|
1769
|
+
| `is` | `string` |
|
|
1770
|
+
|
|
1771
|
+
### Properties
|
|
1772
|
+
|
|
1773
|
+
- [options](#gear-options)
|
|
1774
|
+
- [modalElement](#gear-modalelement)
|
|
1775
|
+
- [modal](#gear-modal)
|
|
1776
|
+
- [iframe](#gear-iframe)
|
|
1777
|
+
|
|
1778
|
+
#### :gear: options
|
|
1779
|
+
|
|
1780
|
+
| Property | Type |
|
|
1781
|
+
| ---------- | ---------- |
|
|
1782
|
+
| `options` | `IFrameModalOptions` |
|
|
1783
|
+
|
|
1784
|
+
#### :gear: modalElement
|
|
1785
|
+
|
|
1786
|
+
| Property | Type |
|
|
1787
|
+
| ---------- | ---------- |
|
|
1788
|
+
| `modalElement` | `HTMLDivElement` |
|
|
1789
|
+
|
|
1790
|
+
#### :gear: modal
|
|
1791
|
+
|
|
1792
|
+
| Property | Type |
|
|
1793
|
+
| ---------- | ---------- |
|
|
1794
|
+
| `modal` | `Modal` |
|
|
1795
|
+
|
|
1796
|
+
#### :gear: iframe
|
|
1797
|
+
|
|
1798
|
+
| Property | Type |
|
|
1799
|
+
| ---------- | ---------- |
|
|
1800
|
+
| `iframe` | `HTMLIFrameElement` |
|
|
1801
|
+
|
|
1802
|
+
## :factory: SingleImageDragElement
|
|
1803
|
+
|
|
1804
|
+
### Methods
|
|
1805
|
+
|
|
1806
|
+
- [connectedCallback](#gear-connectedcallback)
|
|
1807
|
+
- [bindEvents](#gear-bindevents)
|
|
1808
|
+
- [getInputAccept](#gear-getinputaccept)
|
|
1809
|
+
- [handleFileSelect](#gear-handlefileselect)
|
|
1810
|
+
- [checkFile](#gear-checkfile)
|
|
1811
|
+
- [compareMimeType](#gear-comparemimetype)
|
|
1812
|
+
- [checkSize](#gear-checksize)
|
|
1813
|
+
- [alert](#gear-alert)
|
|
1814
|
+
- [storeValue](#gear-storevalue)
|
|
1815
|
+
|
|
1816
|
+
#### :gear: connectedCallback
|
|
1817
|
+
|
|
1818
|
+
| Method | Type |
|
|
1819
|
+
| ---------- | ---------- |
|
|
1820
|
+
| `connectedCallback` | `() => void` |
|
|
1821
|
+
|
|
1822
|
+
#### :gear: bindEvents
|
|
1823
|
+
|
|
1824
|
+
| Method | Type |
|
|
1825
|
+
| ---------- | ---------- |
|
|
1826
|
+
| `bindEvents` | `() => void` |
|
|
1827
|
+
|
|
1828
|
+
#### :gear: getInputAccept
|
|
1829
|
+
|
|
1830
|
+
| Method | Type |
|
|
1831
|
+
| ---------- | ---------- |
|
|
1832
|
+
| `getInputAccept` | `() => string` |
|
|
1833
|
+
|
|
1834
|
+
#### :gear: handleFileSelect
|
|
1835
|
+
|
|
1836
|
+
| Method | Type |
|
|
1837
|
+
| ---------- | ---------- |
|
|
1838
|
+
| `handleFileSelect` | `(file: File) => void` |
|
|
1839
|
+
|
|
1840
|
+
#### :gear: checkFile
|
|
1841
|
+
|
|
1842
|
+
| Method | Type |
|
|
1843
|
+
| ---------- | ---------- |
|
|
1844
|
+
| `checkFile` | `(file: File) => boolean` |
|
|
1845
|
+
|
|
1846
|
+
#### :gear: compareMimeType
|
|
1847
|
+
|
|
1848
|
+
| Method | Type |
|
|
1849
|
+
| ---------- | ---------- |
|
|
1850
|
+
| `compareMimeType` | `(accept: string, mime: string) => boolean` |
|
|
1851
|
+
|
|
1852
|
+
#### :gear: checkSize
|
|
1853
|
+
|
|
1854
|
+
| Method | Type |
|
|
1855
|
+
| ---------- | ---------- |
|
|
1856
|
+
| `checkSize` | `(image: HTMLImageElement) => boolean` |
|
|
1857
|
+
|
|
1858
|
+
#### :gear: alert
|
|
1859
|
+
|
|
1860
|
+
| Method | Type |
|
|
1861
|
+
| ---------- | ---------- |
|
|
1862
|
+
| `alert` | `(title: string, text?: string, type?: string) => any` |
|
|
1863
|
+
|
|
1864
|
+
#### :gear: storeValue
|
|
1865
|
+
|
|
1866
|
+
| Method | Type |
|
|
1867
|
+
| ---------- | ---------- |
|
|
1868
|
+
| `storeValue` | `(url: string, preview: string) => void` |
|
|
1869
|
+
|
|
1870
|
+
### Static Properties
|
|
1871
|
+
|
|
1872
|
+
- [is](#gear-is)
|
|
1873
|
+
|
|
1874
|
+
#### :gear: is
|
|
1875
|
+
|
|
1876
|
+
| Property | Type |
|
|
1877
|
+
| ---------- | ---------- |
|
|
1878
|
+
| `is` | `string` |
|
|
1879
|
+
|
|
1880
|
+
### Properties
|
|
1881
|
+
|
|
1882
|
+
- [currentImage](#gear-currentimage)
|
|
1883
|
+
- [currentFile](#gear-currentfile)
|
|
1884
|
+
- [lastZoom](#gear-lastzoom)
|
|
1885
|
+
- [valueBackup](#gear-valuebackup)
|
|
1886
|
+
|
|
1887
|
+
#### :gear: currentImage
|
|
1888
|
+
|
|
1889
|
+
| Property | Type |
|
|
1890
|
+
| ---------- | ---------- |
|
|
1891
|
+
| `currentImage` | `string` |
|
|
1892
|
+
|
|
1893
|
+
#### :gear: currentFile
|
|
1894
|
+
|
|
1895
|
+
| Property | Type |
|
|
1896
|
+
| ---------- | ---------- |
|
|
1897
|
+
| `currentFile` | `File or undefined` |
|
|
1898
|
+
|
|
1899
|
+
#### :gear: lastZoom
|
|
1900
|
+
|
|
1901
|
+
| Property | Type |
|
|
1902
|
+
| ---------- | ---------- |
|
|
1903
|
+
| `lastZoom` | `number` |
|
|
1904
|
+
|
|
1905
|
+
#### :gear: valueBackup
|
|
1906
|
+
|
|
1907
|
+
| Property | Type |
|
|
1908
|
+
| ---------- | ---------- |
|
|
1909
|
+
| `valueBackup` | `string` |
|
|
1910
|
+
|
|
1911
|
+
## :factory: UnicornFormElement
|
|
1912
|
+
|
|
1913
|
+
### Static Methods
|
|
1914
|
+
|
|
1915
|
+
- [flattenObject](#gear-flattenobject)
|
|
1916
|
+
- [buildFieldName](#gear-buildfieldname)
|
|
1917
|
+
|
|
1918
|
+
#### :gear: flattenObject
|
|
1919
|
+
|
|
1920
|
+
| Method | Type |
|
|
1921
|
+
| ---------- | ---------- |
|
|
1922
|
+
| `flattenObject` | `(ob: Record<string, any>) => Record<string, any>` |
|
|
1923
|
+
|
|
1924
|
+
References:
|
|
1925
|
+
|
|
1926
|
+
* [https://stackoverflow.com/a/53739792](https://stackoverflow.com/a/53739792)
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
#### :gear: buildFieldName
|
|
1930
|
+
|
|
1931
|
+
| Method | Type |
|
|
1932
|
+
| ---------- | ---------- |
|
|
1933
|
+
| `buildFieldName` | `(field: string) => string` |
|
|
1934
|
+
|
|
1935
|
+
### Methods
|
|
1936
|
+
|
|
1937
|
+
- [initComponent](#gear-initcomponent)
|
|
1938
|
+
- [useState](#gear-usestate)
|
|
1939
|
+
- [getElement](#gear-getelement)
|
|
1940
|
+
- [submit](#gear-submit)
|
|
1941
|
+
- [injectInput](#gear-injectinput)
|
|
1942
|
+
- [get](#gear-get)
|
|
1943
|
+
- [post](#gear-post)
|
|
1944
|
+
- [put](#gear-put)
|
|
1945
|
+
- [patch](#gear-patch)
|
|
1946
|
+
- [delete](#gear-delete)
|
|
1947
|
+
|
|
1948
|
+
#### :gear: initComponent
|
|
1949
|
+
|
|
1950
|
+
| Method | Type |
|
|
1951
|
+
| ---------- | ---------- |
|
|
1952
|
+
| `initComponent` | `(store?: string, custom?: {}) => Promise<Alpine>` |
|
|
1953
|
+
|
|
1954
|
+
#### :gear: useState
|
|
1955
|
+
|
|
1956
|
+
| Method | Type |
|
|
1957
|
+
| ---------- | ---------- |
|
|
1958
|
+
| `useState` | `(custom?: {}) => Record<string, any>` |
|
|
1959
|
+
|
|
1960
|
+
#### :gear: getElement
|
|
1961
|
+
|
|
1962
|
+
| Method | Type |
|
|
1963
|
+
| ---------- | ---------- |
|
|
1964
|
+
| `getElement` | `() => HTMLFormElement or undefined` |
|
|
1965
|
+
|
|
1966
|
+
#### :gear: submit
|
|
1967
|
+
|
|
1968
|
+
| Method | Type |
|
|
1969
|
+
| ---------- | ---------- |
|
|
1970
|
+
| `submit` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>, method?: Nullable<string>, customMethod?: Nullable<string>) => boolean` |
|
|
1971
|
+
|
|
1972
|
+
#### :gear: injectInput
|
|
1973
|
+
|
|
1974
|
+
| Method | Type |
|
|
1975
|
+
| ---------- | ---------- |
|
|
1976
|
+
| `injectInput` | `(name: string, value: any) => HTMLInputElement` |
|
|
1977
|
+
|
|
1978
|
+
#### :gear: get
|
|
1979
|
+
|
|
1980
|
+
Make a GET request.
|
|
1981
|
+
|
|
1982
|
+
| Method | Type |
|
|
1983
|
+
| ---------- | ---------- |
|
|
1984
|
+
| `get` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>, customMethod?: Nullable<string>) => boolean` |
|
|
1985
|
+
|
|
1986
|
+
#### :gear: post
|
|
1987
|
+
|
|
1988
|
+
Post form.
|
|
1989
|
+
|
|
1990
|
+
| Method | Type |
|
|
1991
|
+
| ---------- | ---------- |
|
|
1992
|
+
| `post` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>, customMethod?: Nullable<string>) => boolean` |
|
|
1993
|
+
|
|
1994
|
+
#### :gear: put
|
|
1995
|
+
|
|
1996
|
+
Make a PUT request.
|
|
1997
|
+
|
|
1998
|
+
| Method | Type |
|
|
1999
|
+
| ---------- | ---------- |
|
|
2000
|
+
| `put` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2001
|
+
|
|
2002
|
+
#### :gear: patch
|
|
2003
|
+
|
|
2004
|
+
Make a PATCH request.
|
|
2005
|
+
|
|
2006
|
+
| Method | Type |
|
|
2007
|
+
| ---------- | ---------- |
|
|
2008
|
+
| `patch` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2009
|
+
|
|
2010
|
+
#### :gear: delete
|
|
2011
|
+
|
|
2012
|
+
Make a DELETE request.
|
|
2013
|
+
|
|
2014
|
+
| Method | Type |
|
|
2015
|
+
| ---------- | ---------- |
|
|
2016
|
+
| `delete` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2017
|
+
|
|
2018
|
+
### Properties
|
|
2019
|
+
|
|
2020
|
+
- [element](#gear-element)
|
|
2021
|
+
- [options](#gear-options)
|
|
2022
|
+
|
|
2023
|
+
#### :gear: element
|
|
2024
|
+
|
|
2025
|
+
| Property | Type |
|
|
2026
|
+
| ---------- | ---------- |
|
|
2027
|
+
| `element` | `HTMLFormElement or undefined` |
|
|
2028
|
+
|
|
2029
|
+
#### :gear: options
|
|
2030
|
+
|
|
2031
|
+
| Property | Type |
|
|
2032
|
+
| ---------- | ---------- |
|
|
2033
|
+
| `options` | `Record<string, any>` |
|
|
2034
|
+
|
|
2035
|
+
## :factory: UnicornGridElement
|
|
2036
|
+
|
|
2037
|
+
### Methods
|
|
2038
|
+
|
|
2039
|
+
- [bindEvents](#gear-bindevents)
|
|
2040
|
+
- [initComponent](#gear-initcomponent)
|
|
2041
|
+
- [useState](#gear-usestate)
|
|
2042
|
+
- [getElement](#gear-getelement)
|
|
2043
|
+
- [sendFilter](#gear-sendfilter)
|
|
2044
|
+
- [clearFilters](#gear-clearfilters)
|
|
2045
|
+
- [sort](#gear-sort)
|
|
2046
|
+
- [sortBy](#gear-sortby)
|
|
2047
|
+
- [isSortActive](#gear-issortactive)
|
|
2048
|
+
- [getDirection](#gear-getdirection)
|
|
2049
|
+
- [orderingEquals](#gear-orderingequals)
|
|
2050
|
+
- [checkRow](#gear-checkrow)
|
|
2051
|
+
- [getCheckboxByRow](#gear-getcheckboxbyrow)
|
|
2052
|
+
- [updateRow](#gear-updaterow)
|
|
2053
|
+
- [updateItem](#gear-updateitem)
|
|
2054
|
+
- [updateItemByTask](#gear-updateitembytask)
|
|
2055
|
+
- [doTask](#gear-dotask)
|
|
2056
|
+
- [updateRowByTask](#gear-updaterowbytask)
|
|
2057
|
+
- [updateListByTask](#gear-updatelistbytask)
|
|
2058
|
+
- [copyItem](#gear-copyitem)
|
|
2059
|
+
- [copyRow](#gear-copyrow)
|
|
2060
|
+
- [deleteList](#gear-deletelist)
|
|
2061
|
+
- [toggleAll](#gear-toggleall)
|
|
2062
|
+
- [disableAllCheckboxes](#gear-disableallcheckboxes)
|
|
2063
|
+
- [countChecked](#gear-countchecked)
|
|
2064
|
+
- [getChecked](#gear-getchecked)
|
|
2065
|
+
- [getCheckedValues](#gear-getcheckedvalues)
|
|
2066
|
+
- [validateChecked](#gear-validatechecked)
|
|
2067
|
+
- [hasChecked](#gear-haschecked)
|
|
2068
|
+
- [reorderAll](#gear-reorderall)
|
|
2069
|
+
- [moveItem](#gear-moveitem)
|
|
2070
|
+
- [moveUp](#gear-moveup)
|
|
2071
|
+
- [moveDown](#gear-movedown)
|
|
2072
|
+
- [getId](#gear-getid)
|
|
2073
|
+
|
|
2074
|
+
#### :gear: bindEvents
|
|
2075
|
+
|
|
2076
|
+
| Method | Type |
|
|
2077
|
+
| ---------- | ---------- |
|
|
2078
|
+
| `bindEvents` | `() => void` |
|
|
2079
|
+
|
|
2080
|
+
#### :gear: initComponent
|
|
2081
|
+
|
|
2082
|
+
| Method | Type |
|
|
2083
|
+
| ---------- | ---------- |
|
|
2084
|
+
| `initComponent` | `(store?: string, custom?: Record<string, string>) => Promise<Alpine>` |
|
|
2085
|
+
|
|
2086
|
+
#### :gear: useState
|
|
2087
|
+
|
|
2088
|
+
| Method | Type |
|
|
2089
|
+
| ---------- | ---------- |
|
|
2090
|
+
| `useState` | `(this: any, custom?: Record<string, any>) => Partial<Record<string, any>> and Record<string, any>` |
|
|
2091
|
+
|
|
2092
|
+
#### :gear: getElement
|
|
2093
|
+
|
|
2094
|
+
| Method | Type |
|
|
2095
|
+
| ---------- | ---------- |
|
|
2096
|
+
| `getElement` | `() => HTMLElement` |
|
|
2097
|
+
|
|
2098
|
+
#### :gear: sendFilter
|
|
2099
|
+
|
|
2100
|
+
| Method | Type |
|
|
2101
|
+
| ---------- | ---------- |
|
|
2102
|
+
| `sendFilter` | `($event?: Event or undefined, method?: string or undefined) => void` |
|
|
2103
|
+
|
|
2104
|
+
#### :gear: clearFilters
|
|
2105
|
+
|
|
2106
|
+
| Method | Type |
|
|
2107
|
+
| ---------- | ---------- |
|
|
2108
|
+
| `clearFilters` | `(element: HTMLElement, method?: Nullable<string>) => void` |
|
|
2109
|
+
|
|
2110
|
+
#### :gear: sort
|
|
2111
|
+
|
|
2112
|
+
| Method | Type |
|
|
2113
|
+
| ---------- | ---------- |
|
|
2114
|
+
| `sort` | `($el: HTMLElement) => boolean` |
|
|
2115
|
+
|
|
2116
|
+
#### :gear: sortBy
|
|
2117
|
+
|
|
2118
|
+
Sort two items.
|
|
2119
|
+
|
|
2120
|
+
| Method | Type |
|
|
2121
|
+
| ---------- | ---------- |
|
|
2122
|
+
| `sortBy` | `(ordering: Nullable<string>) => boolean` |
|
|
2123
|
+
|
|
2124
|
+
#### :gear: isSortActive
|
|
2125
|
+
|
|
2126
|
+
| Method | Type |
|
|
2127
|
+
| ---------- | ---------- |
|
|
2128
|
+
| `isSortActive` | `($el: HTMLElement) => boolean` |
|
|
2129
|
+
|
|
2130
|
+
#### :gear: getDirection
|
|
2131
|
+
|
|
2132
|
+
| Method | Type |
|
|
2133
|
+
| ---------- | ---------- |
|
|
2134
|
+
| `getDirection` | `($el: HTMLElement) => "ASC" or "DESC" or null` |
|
|
2135
|
+
|
|
2136
|
+
#### :gear: orderingEquals
|
|
2137
|
+
|
|
2138
|
+
| Method | Type |
|
|
2139
|
+
| ---------- | ---------- |
|
|
2140
|
+
| `orderingEquals` | `(a: Nullable<string>, b: Nullable<string>) => boolean` |
|
|
2141
|
+
|
|
2142
|
+
#### :gear: checkRow
|
|
2143
|
+
|
|
2144
|
+
Check a row's checkbox.
|
|
2145
|
+
|
|
2146
|
+
| Method | Type |
|
|
2147
|
+
| ---------- | ---------- |
|
|
2148
|
+
| `checkRow` | `(row: number, value?: boolean) => void` |
|
|
2149
|
+
|
|
2150
|
+
#### :gear: getCheckboxByRow
|
|
2151
|
+
|
|
2152
|
+
| Method | Type |
|
|
2153
|
+
| ---------- | ---------- |
|
|
2154
|
+
| `getCheckboxByRow` | `(row: number) => Nullable<HTMLInputElement>` |
|
|
2155
|
+
|
|
2156
|
+
#### :gear: updateRow
|
|
2157
|
+
|
|
2158
|
+
Update a row.
|
|
2159
|
+
|
|
2160
|
+
| Method | Type |
|
|
2161
|
+
| ---------- | ---------- |
|
|
2162
|
+
| `updateRow` | `(row: number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2163
|
+
|
|
2164
|
+
#### :gear: updateItem
|
|
2165
|
+
|
|
2166
|
+
Update an item by id.
|
|
2167
|
+
|
|
2168
|
+
| Method | Type |
|
|
2169
|
+
| ---------- | ---------- |
|
|
2170
|
+
| `updateItem` | `(id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2171
|
+
|
|
2172
|
+
#### :gear: updateItemByTask
|
|
2173
|
+
|
|
2174
|
+
Update a item with batch task.
|
|
2175
|
+
|
|
2176
|
+
| Method | Type |
|
|
2177
|
+
| ---------- | ---------- |
|
|
2178
|
+
| `updateItemByTask` | `(task: string, id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2179
|
+
|
|
2180
|
+
#### :gear: doTask
|
|
2181
|
+
|
|
2182
|
+
| Method | Type |
|
|
2183
|
+
| ---------- | ---------- |
|
|
2184
|
+
| `doTask` | `(task: string, id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2185
|
+
|
|
2186
|
+
#### :gear: updateRowByTask
|
|
2187
|
+
|
|
2188
|
+
Update a row with batch task.
|
|
2189
|
+
|
|
2190
|
+
| Method | Type |
|
|
2191
|
+
| ---------- | ---------- |
|
|
2192
|
+
| `updateRowByTask` | `(task: string, row: number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2193
|
+
|
|
2194
|
+
#### :gear: updateListByTask
|
|
2195
|
+
|
|
2196
|
+
Batch update items.
|
|
2197
|
+
|
|
2198
|
+
| Method | Type |
|
|
2199
|
+
| ---------- | ---------- |
|
|
2200
|
+
| `updateListByTask` | `(task: string, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2201
|
+
|
|
2202
|
+
#### :gear: copyItem
|
|
2203
|
+
|
|
2204
|
+
Copy a row.
|
|
2205
|
+
|
|
2206
|
+
| Method | Type |
|
|
2207
|
+
| ---------- | ---------- |
|
|
2208
|
+
| `copyItem` | `(id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2209
|
+
|
|
2210
|
+
#### :gear: copyRow
|
|
2211
|
+
|
|
2212
|
+
Copy a row.
|
|
2213
|
+
|
|
2214
|
+
| Method | Type |
|
|
2215
|
+
| ---------- | ---------- |
|
|
2216
|
+
| `copyRow` | `(row: number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2217
|
+
|
|
2218
|
+
#### :gear: deleteList
|
|
2219
|
+
|
|
2220
|
+
Delete checked items.
|
|
2221
|
+
|
|
2222
|
+
| Method | Type |
|
|
2223
|
+
| ---------- | ---------- |
|
|
2224
|
+
| `deleteList` | `(message?: false or Nullable<string>, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2225
|
+
|
|
2226
|
+
#### :gear: toggleAll
|
|
2227
|
+
|
|
2228
|
+
Toggle all checkboxes.
|
|
2229
|
+
|
|
2230
|
+
| Method | Type |
|
|
2231
|
+
| ---------- | ---------- |
|
|
2232
|
+
| `toggleAll` | `(value: boolean) => this` |
|
|
2233
|
+
|
|
2234
|
+
#### :gear: disableAllCheckboxes
|
|
2235
|
+
|
|
2236
|
+
| Method | Type |
|
|
2237
|
+
| ---------- | ---------- |
|
|
2238
|
+
| `disableAllCheckboxes` | `() => void` |
|
|
2239
|
+
|
|
2240
|
+
#### :gear: countChecked
|
|
2241
|
+
|
|
2242
|
+
Count checked checkboxes.
|
|
2243
|
+
|
|
2244
|
+
| Method | Type |
|
|
2245
|
+
| ---------- | ---------- |
|
|
2246
|
+
| `countChecked` | `() => number` |
|
|
2247
|
+
|
|
2248
|
+
#### :gear: getChecked
|
|
2249
|
+
|
|
2250
|
+
Get Checked boxes.
|
|
2251
|
+
|
|
2252
|
+
| Method | Type |
|
|
2253
|
+
| ---------- | ---------- |
|
|
2254
|
+
| `getChecked` | `() => HTMLInputElement[]` |
|
|
2255
|
+
|
|
2256
|
+
#### :gear: getCheckedValues
|
|
2257
|
+
|
|
2258
|
+
| Method | Type |
|
|
2259
|
+
| ---------- | ---------- |
|
|
2260
|
+
| `getCheckedValues` | `() => string[]` |
|
|
2261
|
+
|
|
2262
|
+
#### :gear: validateChecked
|
|
2263
|
+
|
|
2264
|
+
Validate there has one or more checked boxes.
|
|
2265
|
+
|
|
2266
|
+
| Method | Type |
|
|
2267
|
+
| ---------- | ---------- |
|
|
2268
|
+
| `validateChecked` | `(event?: Event or undefined, callback?: ((grid: UnicornGridElement) => any) or undefined, msg?: string or undefined) => this` |
|
|
2269
|
+
|
|
2270
|
+
#### :gear: hasChecked
|
|
2271
|
+
|
|
2272
|
+
| Method | Type |
|
|
2273
|
+
| ---------- | ---------- |
|
|
2274
|
+
| `hasChecked` | `() => boolean` |
|
|
2275
|
+
|
|
2276
|
+
#### :gear: reorderAll
|
|
2277
|
+
|
|
2278
|
+
Reorder all.
|
|
2279
|
+
|
|
2280
|
+
| Method | Type |
|
|
2281
|
+
| ---------- | ---------- |
|
|
2282
|
+
| `reorderAll` | `(url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2283
|
+
|
|
2284
|
+
#### :gear: moveItem
|
|
2285
|
+
|
|
2286
|
+
Reorder items.
|
|
2287
|
+
|
|
2288
|
+
| Method | Type |
|
|
2289
|
+
| ---------- | ---------- |
|
|
2290
|
+
| `moveItem` | `(id: string or number, delta: number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2291
|
+
|
|
2292
|
+
#### :gear: moveUp
|
|
2293
|
+
|
|
2294
|
+
| Method | Type |
|
|
2295
|
+
| ---------- | ---------- |
|
|
2296
|
+
| `moveUp` | `(id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2297
|
+
|
|
2298
|
+
#### :gear: moveDown
|
|
2299
|
+
|
|
2300
|
+
| Method | Type |
|
|
2301
|
+
| ---------- | ---------- |
|
|
2302
|
+
| `moveDown` | `(id: string or number, url?: Nullable<string>, data?: Nullable<Record<string, any>>) => boolean` |
|
|
2303
|
+
|
|
2304
|
+
#### :gear: getId
|
|
2305
|
+
|
|
2306
|
+
| Method | Type |
|
|
2307
|
+
| ---------- | ---------- |
|
|
2308
|
+
| `getId` | `(suffix?: string) => string` |
|
|
2309
|
+
|
|
2310
|
+
### Properties
|
|
2311
|
+
|
|
2312
|
+
- [options](#gear-options)
|
|
2313
|
+
- [ordering](#gear-ordering)
|
|
2314
|
+
- [state](#gear-state)
|
|
2315
|
+
|
|
2316
|
+
#### :gear: options
|
|
2317
|
+
|
|
2318
|
+
| Property | Type |
|
|
2319
|
+
| ---------- | ---------- |
|
|
2320
|
+
| `options` | `Record<string, any>` |
|
|
2321
|
+
|
|
2322
|
+
#### :gear: ordering
|
|
2323
|
+
|
|
2324
|
+
| Property | Type |
|
|
2325
|
+
| ---------- | ---------- |
|
|
2326
|
+
| `ordering` | `string` |
|
|
2327
|
+
|
|
2328
|
+
#### :gear: state
|
|
2329
|
+
|
|
2330
|
+
| Property | Type |
|
|
2331
|
+
| ---------- | ---------- |
|
|
2332
|
+
| `state` | `{}` |
|
|
2333
|
+
|
|
2334
|
+
## :factory: ListDependent
|
|
2335
|
+
|
|
2336
|
+
### Static Methods
|
|
2337
|
+
|
|
2338
|
+
- [handle](#gear-handle)
|
|
2339
|
+
|
|
2340
|
+
#### :gear: handle
|
|
2341
|
+
|
|
2342
|
+
| Method | Type |
|
|
2343
|
+
| ---------- | ---------- |
|
|
2344
|
+
| `handle` | `(el: string or HTMLSelectElement, dependent?: string or HTMLSelectElement or undefined, options?: Partial<ListDependentOptions>) => ListDependent` |
|
|
2345
|
+
|
|
2346
|
+
### Methods
|
|
2347
|
+
|
|
2348
|
+
- [bindEvents](#gear-bindevents)
|
|
2349
|
+
- [changeList](#gear-changelist)
|
|
2350
|
+
- [sourceUpdate](#gear-sourceupdate)
|
|
2351
|
+
- [abort](#gear-abort)
|
|
2352
|
+
- [updateListElements](#gear-updatelistelements)
|
|
2353
|
+
- [appendOptionTo](#gear-appendoptionto)
|
|
2354
|
+
- [isSelected](#gear-isselected)
|
|
2355
|
+
- [beforeHook](#gear-beforehook)
|
|
2356
|
+
- [afterHook](#gear-afterhook)
|
|
2357
|
+
- [mergeOptions](#gear-mergeoptions)
|
|
2358
|
+
|
|
2359
|
+
#### :gear: bindEvents
|
|
2360
|
+
|
|
2361
|
+
Bind events.
|
|
2362
|
+
|
|
2363
|
+
| Method | Type |
|
|
2364
|
+
| ---------- | ---------- |
|
|
2365
|
+
| `bindEvents` | `() => void` |
|
|
2366
|
+
|
|
2367
|
+
#### :gear: changeList
|
|
2368
|
+
|
|
2369
|
+
Update the list elements.
|
|
2370
|
+
|
|
2371
|
+
| Method | Type |
|
|
2372
|
+
| ---------- | ---------- |
|
|
2373
|
+
| `changeList` | `(value: string, initial?: boolean) => void` |
|
|
2374
|
+
|
|
2375
|
+
#### :gear: sourceUpdate
|
|
2376
|
+
|
|
2377
|
+
Update list by source.
|
|
2378
|
+
|
|
2379
|
+
| Method | Type |
|
|
2380
|
+
| ---------- | ---------- |
|
|
2381
|
+
| `sourceUpdate` | `(value: string, initial?: boolean) => void` |
|
|
2382
|
+
|
|
2383
|
+
#### :gear: abort
|
|
2384
|
+
|
|
2385
|
+
| Method | Type |
|
|
2386
|
+
| ---------- | ---------- |
|
|
2387
|
+
| `abort` | `() => void` |
|
|
2388
|
+
|
|
2389
|
+
#### :gear: updateListElements
|
|
2390
|
+
|
|
2391
|
+
| Method | Type |
|
|
2392
|
+
| ---------- | ---------- |
|
|
2393
|
+
| `updateListElements` | `(items: MaybeGroupedListItems) => void` |
|
|
2394
|
+
|
|
2395
|
+
#### :gear: appendOptionTo
|
|
2396
|
+
|
|
2397
|
+
| Method | Type |
|
|
2398
|
+
| ---------- | ---------- |
|
|
2399
|
+
| `appendOptionTo` | `(item: any, parent: any) => void` |
|
|
2400
|
+
|
|
2401
|
+
#### :gear: isSelected
|
|
2402
|
+
|
|
2403
|
+
| Method | Type |
|
|
2404
|
+
| ---------- | ---------- |
|
|
2405
|
+
| `isSelected` | `(value: string) => boolean` |
|
|
2406
|
+
|
|
2407
|
+
#### :gear: beforeHook
|
|
2408
|
+
|
|
2409
|
+
Before hook.
|
|
2410
|
+
|
|
2411
|
+
| Method | Type |
|
|
2412
|
+
| ---------- | ---------- |
|
|
2413
|
+
| `beforeHook` | `(value: string, element: HTMLSelectElement, dependent: HTMLSelectElement) => any` |
|
|
2414
|
+
|
|
2415
|
+
#### :gear: afterHook
|
|
2416
|
+
|
|
2417
|
+
After hook.
|
|
2418
|
+
|
|
2419
|
+
| Method | Type |
|
|
2420
|
+
| ---------- | ---------- |
|
|
2421
|
+
| `afterHook` | `(value: string, element: HTMLSelectElement, dependent: HTMLSelectElement) => any` |
|
|
2422
|
+
|
|
2423
|
+
#### :gear: mergeOptions
|
|
2424
|
+
|
|
2425
|
+
| Method | Type |
|
|
2426
|
+
| ---------- | ---------- |
|
|
2427
|
+
| `mergeOptions` | `(options: Partial<ListDependentOptions>) => ListDependentOptions` |
|
|
2428
|
+
|
|
2429
|
+
### Properties
|
|
2430
|
+
|
|
2431
|
+
- [element](#gear-element)
|
|
2432
|
+
- [dependent](#gear-dependent)
|
|
2433
|
+
- [options](#gear-options)
|
|
2434
|
+
- [abortController](#gear-abortcontroller)
|
|
2435
|
+
|
|
2436
|
+
#### :gear: element
|
|
2437
|
+
|
|
2438
|
+
| Property | Type |
|
|
2439
|
+
| ---------- | ---------- |
|
|
2440
|
+
| `element` | `HTMLSelectElement` |
|
|
2441
|
+
|
|
2442
|
+
#### :gear: dependent
|
|
2443
|
+
|
|
2444
|
+
| Property | Type |
|
|
2445
|
+
| ---------- | ---------- |
|
|
2446
|
+
| `dependent` | `HTMLSelectElement` |
|
|
2447
|
+
|
|
2448
|
+
#### :gear: options
|
|
2449
|
+
|
|
2450
|
+
| Property | Type |
|
|
2451
|
+
| ---------- | ---------- |
|
|
2452
|
+
| `options` | `ListDependentOptions` |
|
|
2453
|
+
|
|
2454
|
+
#### :gear: abortController
|
|
2455
|
+
|
|
2456
|
+
| Property | Type |
|
|
2457
|
+
| ---------- | ---------- |
|
|
2458
|
+
| `abortController` | `AbortController or null` |
|
|
2459
|
+
|
|
2460
|
+
## :factory: EventMixin
|
|
2461
|
+
|
|
2462
|
+
### Methods
|
|
2463
|
+
|
|
2464
|
+
- [on](#gear-on)
|
|
2465
|
+
- [on](#gear-on)
|
|
2466
|
+
- [on](#gear-on)
|
|
2467
|
+
- [once](#gear-once)
|
|
2468
|
+
- [once](#gear-once)
|
|
2469
|
+
- [once](#gear-once)
|
|
2470
|
+
- [off](#gear-off)
|
|
2471
|
+
- [trigger](#gear-trigger)
|
|
2472
|
+
- [trigger](#gear-trigger)
|
|
2473
|
+
- [trigger](#gear-trigger)
|
|
2474
|
+
- [listeners](#gear-listeners)
|
|
2475
|
+
|
|
2476
|
+
#### :gear: on
|
|
2477
|
+
|
|
2478
|
+
| Method | Type |
|
|
2479
|
+
| ---------- | ---------- |
|
|
2480
|
+
| `on` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2481
|
+
|
|
2482
|
+
#### :gear: on
|
|
2483
|
+
|
|
2484
|
+
| Method | Type |
|
|
2485
|
+
| ---------- | ---------- |
|
|
2486
|
+
| `on` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2487
|
+
|
|
2488
|
+
#### :gear: on
|
|
2489
|
+
|
|
2490
|
+
| Method | Type |
|
|
2491
|
+
| ---------- | ---------- |
|
|
2492
|
+
| `on` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2493
|
+
|
|
2494
|
+
#### :gear: once
|
|
2495
|
+
|
|
2496
|
+
| Method | Type |
|
|
2497
|
+
| ---------- | ---------- |
|
|
2498
|
+
| `once` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2499
|
+
|
|
2500
|
+
#### :gear: once
|
|
2501
|
+
|
|
2502
|
+
| Method | Type |
|
|
2503
|
+
| ---------- | ---------- |
|
|
2504
|
+
| `once` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2505
|
+
|
|
2506
|
+
#### :gear: once
|
|
2507
|
+
|
|
2508
|
+
| Method | Type |
|
|
2509
|
+
| ---------- | ---------- |
|
|
2510
|
+
| `once` | `{ <T extends any[]>(event: string, handler: EventHandler<T>): this; (event: string or string[], handler: EventHandler<any[]>): this; }` |
|
|
2511
|
+
|
|
2512
|
+
#### :gear: off
|
|
2513
|
+
|
|
2514
|
+
| Method | Type |
|
|
2515
|
+
| ---------- | ---------- |
|
|
2516
|
+
| `off` | `(event: string, handler?: EventHandler<any[]> or undefined) => this` |
|
|
2517
|
+
|
|
2518
|
+
#### :gear: trigger
|
|
2519
|
+
|
|
2520
|
+
| Method | Type |
|
|
2521
|
+
| ---------- | ---------- |
|
|
2522
|
+
| `trigger` | `{ <T extends any[]>(event: string, ...args: T): this; (event: string[], ...args: any[]): this; }` |
|
|
2523
|
+
|
|
2524
|
+
#### :gear: trigger
|
|
2525
|
+
|
|
2526
|
+
| Method | Type |
|
|
2527
|
+
| ---------- | ---------- |
|
|
2528
|
+
| `trigger` | `{ <T extends any[]>(event: string, ...args: T): this; (event: string[], ...args: any[]): this; }` |
|
|
2529
|
+
|
|
2530
|
+
#### :gear: trigger
|
|
2531
|
+
|
|
2532
|
+
| Method | Type |
|
|
2533
|
+
| ---------- | ---------- |
|
|
2534
|
+
| `trigger` | `{ <T extends any[]>(event: string, ...args: T): this; (event: string[], ...args: any[]): this; }` |
|
|
2535
|
+
|
|
2536
|
+
#### :gear: listeners
|
|
2537
|
+
|
|
2538
|
+
| Method | Type |
|
|
2539
|
+
| ---------- | ---------- |
|
|
2540
|
+
| `listeners` | `(event: string) => EventHandler<any[]>[]` |
|
|
2541
|
+
|
|
2542
|
+
### Properties
|
|
2543
|
+
|
|
2544
|
+
- [_listeners](#gear-_listeners)
|
|
2545
|
+
|
|
2546
|
+
#### :gear: _listeners
|
|
2547
|
+
|
|
2548
|
+
| Property | Type |
|
|
2549
|
+
| ---------- | ---------- |
|
|
2550
|
+
| `_listeners` | `Record<string, EventHandler<any[]>[]>` |
|
|
2551
|
+
|
|
2552
|
+
## :factory: S3MultipartUploader
|
|
2553
|
+
|
|
2554
|
+
### Methods
|
|
2555
|
+
|
|
2556
|
+
- [updateProgress](#gear-updateprogress)
|
|
2557
|
+
- [setChunkSize](#gear-setchunksize)
|
|
2558
|
+
- [setChunkSizeInMiB](#gear-setchunksizeinmib)
|
|
2559
|
+
- [replaceExt](#gear-replaceext)
|
|
2560
|
+
- [on](#gear-on)
|
|
2561
|
+
- [on](#gear-on)
|
|
2562
|
+
- [on](#gear-on)
|
|
2563
|
+
- [on](#gear-on)
|
|
2564
|
+
|
|
2565
|
+
#### :gear: updateProgress
|
|
2566
|
+
|
|
2567
|
+
| Method | Type |
|
|
2568
|
+
| ---------- | ---------- |
|
|
2569
|
+
| `updateProgress` | `(loaded: number, total: number, options: S3MultipartUploaderRequestOptions) => void` |
|
|
2570
|
+
|
|
2571
|
+
#### :gear: setChunkSize
|
|
2572
|
+
|
|
2573
|
+
| Method | Type |
|
|
2574
|
+
| ---------- | ---------- |
|
|
2575
|
+
| `setChunkSize` | `(size: number) => this` |
|
|
2576
|
+
|
|
2577
|
+
#### :gear: setChunkSizeInMiB
|
|
2578
|
+
|
|
2579
|
+
| Method | Type |
|
|
2580
|
+
| ---------- | ---------- |
|
|
2581
|
+
| `setChunkSizeInMiB` | `(size: number) => this` |
|
|
2582
|
+
|
|
2583
|
+
#### :gear: replaceExt
|
|
2584
|
+
|
|
2585
|
+
| Method | Type |
|
|
2586
|
+
| ---------- | ---------- |
|
|
2587
|
+
| `replaceExt` | `(path: string, file: File or Blob) => string` |
|
|
2588
|
+
|
|
2589
|
+
#### :gear: on
|
|
2590
|
+
|
|
2591
|
+
| Method | Type |
|
|
2592
|
+
| ---------- | ---------- |
|
|
2593
|
+
| `on` | `{ (event: "start", handler: (file: File, data: { [name: string]: any; path: string; extra: Record<string, any>; }) => void): this; (event: "success", handler: (url: string) => void): this; (event: "progress", handler: (event: ProgressEvent) => void): this; }` |
|
|
2594
|
+
|
|
2595
|
+
#### :gear: on
|
|
2596
|
+
|
|
2597
|
+
| Method | Type |
|
|
2598
|
+
| ---------- | ---------- |
|
|
2599
|
+
| `on` | `{ (event: "start", handler: (file: File, data: { [name: string]: any; path: string; extra: Record<string, any>; }) => void): this; (event: "success", handler: (url: string) => void): this; (event: "progress", handler: (event: ProgressEvent) => void): this; }` |
|
|
2600
|
+
|
|
2601
|
+
#### :gear: on
|
|
2602
|
+
|
|
2603
|
+
| Method | Type |
|
|
2604
|
+
| ---------- | ---------- |
|
|
2605
|
+
| `on` | `{ (event: "start", handler: (file: File, data: { [name: string]: any; path: string; extra: Record<string, any>; }) => void): this; (event: "success", handler: (url: string) => void): this; (event: "progress", handler: (event: ProgressEvent) => void): this; }` |
|
|
2606
|
+
|
|
2607
|
+
#### :gear: on
|
|
2608
|
+
|
|
2609
|
+
| Method | Type |
|
|
2610
|
+
| ---------- | ---------- |
|
|
2611
|
+
| `on` | `{ (event: "start", handler: (file: File, data: { [name: string]: any; path: string; extra: Record<string, any>; }) => void): this; (event: "success", handler: (url: string) => void): this; (event: "progress", handler: (event: ProgressEvent) => void): this; }` |
|
|
2612
|
+
|
|
2613
|
+
### Properties
|
|
2614
|
+
|
|
2615
|
+
- [options](#gear-options)
|
|
2616
|
+
|
|
2617
|
+
#### :gear: options
|
|
2618
|
+
|
|
2619
|
+
| Property | Type |
|
|
2620
|
+
| ---------- | ---------- |
|
|
2621
|
+
| `options` | `S3MultipartUploaderOptions` |
|
|
2622
|
+
|
|
2623
|
+
## :factory: S3Uploader
|
|
2624
|
+
|
|
2625
|
+
### Methods
|
|
2626
|
+
|
|
2627
|
+
- [replaceExt](#gear-replaceext)
|
|
2628
|
+
- [on](#gear-on)
|
|
2629
|
+
- [on](#gear-on)
|
|
2630
|
+
- [on](#gear-on)
|
|
2631
|
+
- [on](#gear-on)
|
|
2632
|
+
- [on](#gear-on)
|
|
2633
|
+
- [on](#gear-on)
|
|
2634
|
+
- [onStart](#gear-onstart)
|
|
2635
|
+
- [onSuccess](#gear-onsuccess)
|
|
2636
|
+
- [onEnd](#gear-onend)
|
|
2637
|
+
- [onProgress](#gear-onprogress)
|
|
2638
|
+
- [onProgressWithTotal](#gear-onprogresswithtotal)
|
|
2639
|
+
|
|
2640
|
+
#### :gear: replaceExt
|
|
2641
|
+
|
|
2642
|
+
| Method | Type |
|
|
2643
|
+
| ---------- | ---------- |
|
|
2644
|
+
| `replaceExt` | `(path: string, file: File or Blob) => string` |
|
|
2645
|
+
|
|
2646
|
+
#### :gear: on
|
|
2647
|
+
|
|
2648
|
+
| Method | Type |
|
|
2649
|
+
| ---------- | ---------- |
|
|
2650
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2651
|
+
|
|
2652
|
+
#### :gear: on
|
|
2653
|
+
|
|
2654
|
+
| Method | Type |
|
|
2655
|
+
| ---------- | ---------- |
|
|
2656
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2657
|
+
|
|
2658
|
+
#### :gear: on
|
|
2659
|
+
|
|
2660
|
+
| Method | Type |
|
|
2661
|
+
| ---------- | ---------- |
|
|
2662
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2663
|
+
|
|
2664
|
+
#### :gear: on
|
|
2665
|
+
|
|
2666
|
+
| Method | Type |
|
|
2667
|
+
| ---------- | ---------- |
|
|
2668
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2669
|
+
|
|
2670
|
+
#### :gear: on
|
|
2671
|
+
|
|
2672
|
+
| Method | Type |
|
|
2673
|
+
| ---------- | ---------- |
|
|
2674
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2675
|
+
|
|
2676
|
+
#### :gear: on
|
|
2677
|
+
|
|
2678
|
+
| Method | Type |
|
|
2679
|
+
| ---------- | ---------- |
|
|
2680
|
+
| `on` | `{ (event: "start", handler: StartEventHandler): this; (event: "success", handler: SuccessEventHandler): this; (event: "end", handler: EndEventHandler): this; (event: "upload-progress", handler: UploadProgressEventHandler): this; (event: "progress", handler: ProgressEventHandler): this; }` |
|
|
2681
|
+
|
|
2682
|
+
#### :gear: onStart
|
|
2683
|
+
|
|
2684
|
+
| Method | Type |
|
|
2685
|
+
| ---------- | ---------- |
|
|
2686
|
+
| `onStart` | `(handler: StartEventHandler) => this` |
|
|
2687
|
+
|
|
2688
|
+
#### :gear: onSuccess
|
|
2689
|
+
|
|
2690
|
+
| Method | Type |
|
|
2691
|
+
| ---------- | ---------- |
|
|
2692
|
+
| `onSuccess` | `(handler: SuccessEventHandler) => this` |
|
|
2693
|
+
|
|
2694
|
+
#### :gear: onEnd
|
|
2695
|
+
|
|
2696
|
+
| Method | Type |
|
|
2697
|
+
| ---------- | ---------- |
|
|
2698
|
+
| `onEnd` | `(handler: EndEventHandler) => this` |
|
|
2699
|
+
|
|
2700
|
+
#### :gear: onProgress
|
|
2701
|
+
|
|
2702
|
+
| Method | Type |
|
|
2703
|
+
| ---------- | ---------- |
|
|
2704
|
+
| `onProgress` | `(handler: UploadProgressEventHandler) => this` |
|
|
2705
|
+
|
|
2706
|
+
#### :gear: onProgressWithTotal
|
|
2707
|
+
|
|
2708
|
+
| Method | Type |
|
|
2709
|
+
| ---------- | ---------- |
|
|
2710
|
+
| `onProgressWithTotal` | `(handler: ProgressEventHandler) => this` |
|
|
2711
|
+
|
|
2712
|
+
### Properties
|
|
2713
|
+
|
|
2714
|
+
- [options](#gear-options)
|
|
2715
|
+
- [http](#gear-http)
|
|
2716
|
+
|
|
2717
|
+
#### :gear: options
|
|
2718
|
+
|
|
2719
|
+
| Property | Type |
|
|
2720
|
+
| ---------- | ---------- |
|
|
2721
|
+
| `options` | `S3UploaderGlobalOptions` |
|
|
2722
|
+
|
|
2723
|
+
#### :gear: http
|
|
2724
|
+
|
|
2725
|
+
| Property | Type |
|
|
2726
|
+
| ---------- | ---------- |
|
|
2727
|
+
| `http` | `{ axios: AxiosInstance; request: <T = any, D = any>(options: AxiosRequestConfig<any>) => Promise<AxiosResponse<T, D, {}>>; ... 11 more ...; isAxiosError: <T = any, D = any>(payload: any) => payload is AxiosError<...>; } or undefined` |
|
|
2728
|
+
|
|
2729
|
+
## :factory: ShowOn
|
|
2730
|
+
|
|
2731
|
+
### Methods
|
|
2732
|
+
|
|
2733
|
+
- [init](#gear-init)
|
|
2734
|
+
- [updateShowState](#gear-updateshowstate)
|
|
2735
|
+
- [isValueMatched](#gear-isvaluematched)
|
|
2736
|
+
- [nodeType](#gear-nodetype)
|
|
2737
|
+
|
|
2738
|
+
#### :gear: init
|
|
2739
|
+
|
|
2740
|
+
| Method | Type |
|
|
2741
|
+
| ---------- | ---------- |
|
|
2742
|
+
| `init` | `() => void` |
|
|
2743
|
+
|
|
2744
|
+
#### :gear: updateShowState
|
|
2745
|
+
|
|
2746
|
+
| Method | Type |
|
|
2747
|
+
| ---------- | ---------- |
|
|
2748
|
+
| `updateShowState` | `(target: HTMLElement, value: any, duration?: number) => void` |
|
|
2749
|
+
|
|
2750
|
+
#### :gear: isValueMatched
|
|
2751
|
+
|
|
2752
|
+
| Method | Type |
|
|
2753
|
+
| ---------- | ---------- |
|
|
2754
|
+
| `isValueMatched` | `(target: HTMLElement, value: any) => boolean` |
|
|
2755
|
+
|
|
2756
|
+
#### :gear: nodeType
|
|
2757
|
+
|
|
2758
|
+
| Method | Type |
|
|
2759
|
+
| ---------- | ---------- |
|
|
2760
|
+
| `nodeType` | `(el: HTMLElement) => "input" or "select" or "textarea" or "checkbox" or "radio"` |
|
|
2761
|
+
|
|
2762
|
+
References:
|
|
2763
|
+
|
|
2764
|
+
* [https://github.com/nickjackson/val/blob/master/index.js#L55](https://github.com/nickjackson/val/blob/master/index.js#L55)
|
|
2765
|
+
|
|
2766
|
+
|
|
2767
|
+
### Properties
|
|
2768
|
+
|
|
2769
|
+
- [el](#gear-el)
|
|
2770
|
+
- [input](#gear-input)
|
|
2771
|
+
- [conditions](#gear-conditions)
|
|
2772
|
+
- [targets](#gear-targets)
|
|
2773
|
+
- [defaultReadonly](#gear-defaultreadonly)
|
|
2774
|
+
- [initialDisplay](#gear-initialdisplay)
|
|
2775
|
+
|
|
2776
|
+
#### :gear: el
|
|
2777
|
+
|
|
2778
|
+
| Property | Type |
|
|
2779
|
+
| ---------- | ---------- |
|
|
2780
|
+
| `el` | `HTMLElement` |
|
|
2781
|
+
|
|
2782
|
+
#### :gear: input
|
|
2783
|
+
|
|
2784
|
+
| Property | Type |
|
|
2785
|
+
| ---------- | ---------- |
|
|
2786
|
+
| `input` | `HTMLInputTypes` |
|
|
2787
|
+
|
|
2788
|
+
#### :gear: conditions
|
|
2789
|
+
|
|
2790
|
+
| Property | Type |
|
|
2791
|
+
| ---------- | ---------- |
|
|
2792
|
+
| `conditions` | `Conditions` |
|
|
2793
|
+
|
|
2794
|
+
#### :gear: targets
|
|
2795
|
+
|
|
2796
|
+
| Property | Type |
|
|
2797
|
+
| ---------- | ---------- |
|
|
2798
|
+
| `targets` | `{}` |
|
|
2799
|
+
|
|
2800
|
+
#### :gear: defaultReadonly
|
|
2801
|
+
|
|
2802
|
+
| Property | Type |
|
|
2803
|
+
| ---------- | ---------- |
|
|
2804
|
+
| `defaultReadonly` | `boolean or null` |
|
|
2805
|
+
|
|
2806
|
+
#### :gear: initialDisplay
|
|
2807
|
+
|
|
2808
|
+
| Property | Type |
|
|
2809
|
+
| ---------- | ---------- |
|
|
2810
|
+
| `initialDisplay` | `string` |
|
|
2811
|
+
|
|
2812
|
+
## :factory: TinymceController
|
|
2813
|
+
|
|
2814
|
+
### Methods
|
|
2815
|
+
|
|
2816
|
+
- [prepareOptions](#gear-prepareoptions)
|
|
2817
|
+
- [insert](#gear-insert)
|
|
2818
|
+
- [getValue](#gear-getvalue)
|
|
2819
|
+
- [setValue](#gear-setvalue)
|
|
2820
|
+
|
|
2821
|
+
#### :gear: prepareOptions
|
|
2822
|
+
|
|
2823
|
+
| Method | Type |
|
|
2824
|
+
| ---------- | ---------- |
|
|
2825
|
+
| `prepareOptions` | `(options: Record<string, any>, version?: string) => Record<string, any>` |
|
|
2826
|
+
|
|
2827
|
+
#### :gear: insert
|
|
2828
|
+
|
|
2829
|
+
| Method | Type |
|
|
2830
|
+
| ---------- | ---------- |
|
|
2831
|
+
| `insert` | `(text: string) => void` |
|
|
2832
|
+
|
|
2833
|
+
#### :gear: getValue
|
|
2834
|
+
|
|
2835
|
+
| Method | Type |
|
|
2836
|
+
| ---------- | ---------- |
|
|
2837
|
+
| `getValue` | `() => string` |
|
|
2838
|
+
|
|
2839
|
+
#### :gear: setValue
|
|
2840
|
+
|
|
2841
|
+
| Method | Type |
|
|
2842
|
+
| ---------- | ---------- |
|
|
2843
|
+
| `setValue` | `(text: string) => void` |
|
|
2844
|
+
|
|
2845
|
+
### Properties
|
|
2846
|
+
|
|
2847
|
+
- [editor](#gear-editor)
|
|
2848
|
+
- [options](#gear-options)
|
|
2849
|
+
|
|
2850
|
+
#### :gear: editor
|
|
2851
|
+
|
|
2852
|
+
| Property | Type |
|
|
2853
|
+
| ---------- | ---------- |
|
|
2854
|
+
| `editor` | `Editor or undefined` |
|
|
2855
|
+
|
|
2856
|
+
#### :gear: options
|
|
2857
|
+
|
|
2858
|
+
| Property | Type |
|
|
2859
|
+
| ---------- | ---------- |
|
|
2860
|
+
| `options` | `Record<string, any>` |
|
|
2861
|
+
|
|
2862
|
+
## :factory: ButtonRadio
|
|
2863
|
+
|
|
2864
|
+
### Static Methods
|
|
2865
|
+
|
|
2866
|
+
- [handle](#gear-handle)
|
|
2867
|
+
|
|
2868
|
+
#### :gear: handle
|
|
2869
|
+
|
|
2870
|
+
| Method | Type |
|
|
2871
|
+
| ---------- | ---------- |
|
|
2872
|
+
| `handle` | `(el: string or HTMLElement, options?: ButtonRadioOptions) => any` |
|
|
2873
|
+
|
|
2874
|
+
### Methods
|
|
2875
|
+
|
|
2876
|
+
- [prepareButton](#gear-preparebutton)
|
|
2877
|
+
- [syncState](#gear-syncstate)
|
|
2878
|
+
- [parseClasses](#gear-parseclasses)
|
|
2879
|
+
|
|
2880
|
+
#### :gear: prepareButton
|
|
2881
|
+
|
|
2882
|
+
| Method | Type |
|
|
2883
|
+
| ---------- | ---------- |
|
|
2884
|
+
| `prepareButton` | `(radio: HTMLInputElement, exists?: boolean) => HTMLButtonElement` |
|
|
2885
|
+
|
|
2886
|
+
#### :gear: syncState
|
|
2887
|
+
|
|
2888
|
+
| Method | Type |
|
|
2889
|
+
| ---------- | ---------- |
|
|
2890
|
+
| `syncState` | `() => void` |
|
|
2891
|
+
|
|
2892
|
+
#### :gear: parseClasses
|
|
2893
|
+
|
|
2894
|
+
| Method | Type |
|
|
2895
|
+
| ---------- | ---------- |
|
|
2896
|
+
| `parseClasses` | `(...className: string[]) => string[]` |
|
|
2897
|
+
|
|
2898
|
+
### Properties
|
|
2899
|
+
|
|
2900
|
+
- [wrapper](#gear-wrapper)
|
|
2901
|
+
- [element](#gear-element)
|
|
2902
|
+
- [radios](#gear-radios)
|
|
2903
|
+
- [inputs](#gear-inputs)
|
|
2904
|
+
- [buttons](#gear-buttons)
|
|
2905
|
+
- [colors](#gear-colors)
|
|
2906
|
+
- [options](#gear-options)
|
|
2907
|
+
|
|
2908
|
+
#### :gear: wrapper
|
|
2909
|
+
|
|
2910
|
+
| Property | Type |
|
|
2911
|
+
| ---------- | ---------- |
|
|
2912
|
+
| `wrapper` | `HTMLElement` |
|
|
2913
|
+
|
|
2914
|
+
#### :gear: element
|
|
2915
|
+
|
|
2916
|
+
| Property | Type |
|
|
2917
|
+
| ---------- | ---------- |
|
|
2918
|
+
| `element` | `HTMLElement` |
|
|
2919
|
+
|
|
2920
|
+
#### :gear: radios
|
|
2921
|
+
|
|
2922
|
+
| Property | Type |
|
|
2923
|
+
| ---------- | ---------- |
|
|
2924
|
+
| `radios` | `HTMLInputElement[]` |
|
|
2925
|
+
|
|
2926
|
+
#### :gear: inputs
|
|
2927
|
+
|
|
2928
|
+
| Property | Type |
|
|
2929
|
+
| ---------- | ---------- |
|
|
2930
|
+
| `inputs` | `HTMLInputElement[]` |
|
|
2931
|
+
|
|
2932
|
+
#### :gear: buttons
|
|
2933
|
+
|
|
2934
|
+
| Property | Type |
|
|
2935
|
+
| ---------- | ---------- |
|
|
2936
|
+
| `buttons` | `HTMLButtonElement[]` |
|
|
2937
|
+
|
|
2938
|
+
#### :gear: colors
|
|
2939
|
+
|
|
2940
|
+
| Property | Type |
|
|
2941
|
+
| ---------- | ---------- |
|
|
2942
|
+
| `colors` | `string[]` |
|
|
2943
|
+
|
|
2944
|
+
#### :gear: options
|
|
2945
|
+
|
|
2946
|
+
| Property | Type |
|
|
2947
|
+
| ---------- | ---------- |
|
|
2948
|
+
| `options` | `Required<ButtonRadioOptions>` |
|
|
2949
|
+
|
|
2950
|
+
## :factory: KeepTab
|
|
2951
|
+
|
|
2952
|
+
### Methods
|
|
2953
|
+
|
|
2954
|
+
- [bindEvents](#gear-bindevents)
|
|
2955
|
+
- [getButtonHref](#gear-getbuttonhref)
|
|
2956
|
+
- [findTabButtonByHref](#gear-findtabbuttonbyhref)
|
|
2957
|
+
- [activateTab](#gear-activatetab)
|
|
2958
|
+
- [hasTab](#gear-hastab)
|
|
2959
|
+
- [switchTab](#gear-switchtab)
|
|
2960
|
+
|
|
2961
|
+
#### :gear: bindEvents
|
|
2962
|
+
|
|
2963
|
+
| Method | Type |
|
|
2964
|
+
| ---------- | ---------- |
|
|
2965
|
+
| `bindEvents` | `() => void` |
|
|
2966
|
+
|
|
2967
|
+
#### :gear: getButtonHref
|
|
2968
|
+
|
|
2969
|
+
| Method | Type |
|
|
2970
|
+
| ---------- | ---------- |
|
|
2971
|
+
| `getButtonHref` | `(button: HTMLAnchorElement) => string` |
|
|
2972
|
+
|
|
2973
|
+
#### :gear: findTabButtonByHref
|
|
2974
|
+
|
|
2975
|
+
| Method | Type |
|
|
2976
|
+
| ---------- | ---------- |
|
|
2977
|
+
| `findTabButtonByHref` | `(href: string) => HTMLAnchorElement or undefined` |
|
|
2978
|
+
|
|
2979
|
+
#### :gear: activateTab
|
|
2980
|
+
|
|
2981
|
+
| Method | Type |
|
|
2982
|
+
| ---------- | ---------- |
|
|
2983
|
+
| `activateTab` | `(href: string) => void` |
|
|
2984
|
+
|
|
2985
|
+
#### :gear: hasTab
|
|
2986
|
+
|
|
2987
|
+
| Method | Type |
|
|
2988
|
+
| ---------- | ---------- |
|
|
2989
|
+
| `hasTab` | `(href: string) => boolean` |
|
|
2990
|
+
|
|
2991
|
+
#### :gear: switchTab
|
|
2992
|
+
|
|
2993
|
+
Switch tab.
|
|
2994
|
+
|
|
2995
|
+
| Method | Type |
|
|
2996
|
+
| ---------- | ---------- |
|
|
2997
|
+
| `switchTab` | `() => true or undefined` |
|
|
2998
|
+
|
|
2999
|
+
### Properties
|
|
3000
|
+
|
|
3001
|
+
- [$element](#gear-$element)
|
|
3002
|
+
- [tabButtons](#gear-tabbuttons)
|
|
3003
|
+
- [storageKey](#gear-storagekey)
|
|
3004
|
+
- [options](#gear-options)
|
|
3005
|
+
|
|
3006
|
+
#### :gear: $element
|
|
3007
|
+
|
|
3008
|
+
| Property | Type |
|
|
3009
|
+
| ---------- | ---------- |
|
|
3010
|
+
| `$element` | `HTMLElement` |
|
|
3011
|
+
|
|
3012
|
+
#### :gear: tabButtons
|
|
3013
|
+
|
|
3014
|
+
| Property | Type |
|
|
3015
|
+
| ---------- | ---------- |
|
|
3016
|
+
| `tabButtons` | `NodeListOf<HTMLElement>` |
|
|
3017
|
+
|
|
3018
|
+
#### :gear: storageKey
|
|
3019
|
+
|
|
3020
|
+
| Property | Type |
|
|
3021
|
+
| ---------- | ---------- |
|
|
3022
|
+
| `storageKey` | `string` |
|
|
3023
|
+
|
|
3024
|
+
#### :gear: options
|
|
3025
|
+
|
|
3026
|
+
| Property | Type |
|
|
3027
|
+
| ---------- | ---------- |
|
|
3028
|
+
| `options` | `any` |
|
|
3029
|
+
|
|
3030
|
+
## :factory: UIBootstrap5
|
|
3031
|
+
|
|
3032
|
+
### Static Methods
|
|
3033
|
+
|
|
3034
|
+
- [get](#gear-get)
|
|
3035
|
+
|
|
3036
|
+
#### :gear: get
|
|
3037
|
+
|
|
3038
|
+
| Method | Type |
|
|
3039
|
+
| ---------- | ---------- |
|
|
3040
|
+
| `get` | `() => UIBootstrap5` |
|
|
3041
|
+
|
|
3042
|
+
### Methods
|
|
3043
|
+
|
|
3044
|
+
- [renderMessage](#gear-rendermessage)
|
|
3045
|
+
- [clearMessages](#gear-clearmessages)
|
|
3046
|
+
- [tooltip](#gear-tooltip)
|
|
3047
|
+
- [getMajorVersion](#gear-getmajorversion)
|
|
3048
|
+
- [pushBootstrapToGlobal](#gear-pushbootstraptoglobal)
|
|
3049
|
+
|
|
3050
|
+
#### :gear: renderMessage
|
|
3051
|
+
|
|
3052
|
+
| Method | Type |
|
|
3053
|
+
| ---------- | ---------- |
|
|
3054
|
+
| `renderMessage` | `(messages: string or string[], type?: string) => () => void` |
|
|
3055
|
+
|
|
3056
|
+
#### :gear: clearMessages
|
|
3057
|
+
|
|
3058
|
+
| Method | Type |
|
|
3059
|
+
| ---------- | ---------- |
|
|
3060
|
+
| `clearMessages` | `() => void` |
|
|
3061
|
+
|
|
3062
|
+
#### :gear: tooltip
|
|
3063
|
+
|
|
3064
|
+
| Method | Type |
|
|
3065
|
+
| ---------- | ---------- |
|
|
3066
|
+
| `tooltip` | `(selector?: string or Element or NodeListOf<Element>, config?: Partial<Options>) => Tooltip[]` |
|
|
3067
|
+
|
|
3068
|
+
#### :gear: getMajorVersion
|
|
3069
|
+
|
|
3070
|
+
| Method | Type |
|
|
3071
|
+
| ---------- | ---------- |
|
|
3072
|
+
| `getMajorVersion` | `(module: any) => number` |
|
|
3073
|
+
|
|
3074
|
+
#### :gear: pushBootstrapToGlobal
|
|
3075
|
+
|
|
3076
|
+
| Method | Type |
|
|
3077
|
+
| ---------- | ---------- |
|
|
3078
|
+
| `pushBootstrapToGlobal` | `() => void` |
|
|
3079
|
+
|
|
3080
|
+
### Static Properties
|
|
3081
|
+
|
|
3082
|
+
- [instance](#gear-instance)
|
|
3083
|
+
|
|
3084
|
+
#### :gear: instance
|
|
3085
|
+
|
|
3086
|
+
| Property | Type |
|
|
3087
|
+
| ---------- | ---------- |
|
|
3088
|
+
| `instance` | `UIBootstrap5 or null` |
|
|
3089
|
+
|
|
3090
|
+
### Properties
|
|
3091
|
+
|
|
3092
|
+
- [bootstrap](#gear-bootstrap)
|
|
3093
|
+
|
|
3094
|
+
#### :gear: bootstrap
|
|
3095
|
+
|
|
3096
|
+
| Property | Type |
|
|
3097
|
+
| ---------- | ---------- |
|
|
3098
|
+
| `bootstrap` | `typeof import("D:/www/earth/node_modules/@types/bootstrap/index")` |
|
|
3099
|
+
|
|
3100
|
+
## :factory: UnicornFormValidation
|
|
3101
|
+
|
|
3102
|
+
### Static Methods
|
|
3103
|
+
|
|
3104
|
+
- [addGlobalValidator](#gear-addglobalvalidator)
|
|
3105
|
+
|
|
3106
|
+
#### :gear: addGlobalValidator
|
|
3107
|
+
|
|
3108
|
+
Add validator handler.
|
|
3109
|
+
|
|
3110
|
+
| Method | Type |
|
|
3111
|
+
| ---------- | ---------- |
|
|
3112
|
+
| `addGlobalValidator` | `<T extends unknown, E extends HTMLElement, P = Record<string, any>>(name: string, handler: ValidationHandler<T, E, P>, options?: ValidatorOptions<E, P>) => typeof UnicornFormValidation` |
|
|
3113
|
+
|
|
3114
|
+
### Methods
|
|
3115
|
+
|
|
3116
|
+
- [mergeOptions](#gear-mergeoptions)
|
|
3117
|
+
- [init](#gear-init)
|
|
3118
|
+
- [findDOMFields](#gear-finddomfields)
|
|
3119
|
+
- [prepareFields](#gear-preparefields)
|
|
3120
|
+
- [prepareFieldWrapper](#gear-preparefieldwrapper)
|
|
3121
|
+
- [findFields](#gear-findfields)
|
|
3122
|
+
- [getFieldComponent](#gear-getfieldcomponent)
|
|
3123
|
+
- [validateAll](#gear-validateall)
|
|
3124
|
+
- [scrollTo](#gear-scrollto)
|
|
3125
|
+
- [markFormAsValidated](#gear-markformasvalidated)
|
|
3126
|
+
- [markFormAsUnvalidated](#gear-markformasunvalidated)
|
|
3127
|
+
- [addField](#gear-addfield)
|
|
3128
|
+
- [registerDefaultValidators](#gear-registerdefaultvalidators)
|
|
3129
|
+
- [addValidator](#gear-addvalidator)
|
|
3130
|
+
|
|
3131
|
+
#### :gear: mergeOptions
|
|
3132
|
+
|
|
3133
|
+
| Method | Type |
|
|
3134
|
+
| ---------- | ---------- |
|
|
3135
|
+
| `mergeOptions` | `(options: Partial<FormValidationOptions>) => FormValidationOptions` |
|
|
3136
|
+
|
|
3137
|
+
#### :gear: init
|
|
3138
|
+
|
|
3139
|
+
| Method | Type |
|
|
3140
|
+
| ---------- | ---------- |
|
|
3141
|
+
| `init` | `() => void` |
|
|
3142
|
+
|
|
3143
|
+
#### :gear: findDOMFields
|
|
3144
|
+
|
|
3145
|
+
| Method | Type |
|
|
3146
|
+
| ---------- | ---------- |
|
|
3147
|
+
| `findDOMFields` | `() => HTMLElement[]` |
|
|
3148
|
+
|
|
3149
|
+
#### :gear: prepareFields
|
|
3150
|
+
|
|
3151
|
+
| Method | Type |
|
|
3152
|
+
| ---------- | ---------- |
|
|
3153
|
+
| `prepareFields` | `(inputs: HTMLElement[]) => Promise<void>` |
|
|
3154
|
+
|
|
3155
|
+
#### :gear: prepareFieldWrapper
|
|
3156
|
+
|
|
3157
|
+
| Method | Type |
|
|
3158
|
+
| ---------- | ---------- |
|
|
3159
|
+
| `prepareFieldWrapper` | `(input: HTMLElement) => HTMLElement or null` |
|
|
3160
|
+
|
|
3161
|
+
#### :gear: findFields
|
|
3162
|
+
|
|
3163
|
+
| Method | Type |
|
|
3164
|
+
| ---------- | ---------- |
|
|
3165
|
+
| `findFields` | `(containsPresets?: boolean) => HTMLElement[]` |
|
|
3166
|
+
|
|
3167
|
+
#### :gear: getFieldComponent
|
|
3168
|
+
|
|
3169
|
+
| Method | Type |
|
|
3170
|
+
| ---------- | ---------- |
|
|
3171
|
+
| `getFieldComponent` | `(input: HTMLElement) => UnicornFieldValidation or null` |
|
|
3172
|
+
|
|
3173
|
+
#### :gear: validateAll
|
|
3174
|
+
|
|
3175
|
+
| Method | Type |
|
|
3176
|
+
| ---------- | ---------- |
|
|
3177
|
+
| `validateAll` | `(fields?: Nullable<HTMLElement[]>) => boolean` |
|
|
3178
|
+
|
|
3179
|
+
#### :gear: scrollTo
|
|
3180
|
+
|
|
3181
|
+
| Method | Type |
|
|
3182
|
+
| ---------- | ---------- |
|
|
3183
|
+
| `scrollTo` | `(element: HTMLElement) => void` |
|
|
3184
|
+
|
|
3185
|
+
#### :gear: markFormAsValidated
|
|
3186
|
+
|
|
3187
|
+
| Method | Type |
|
|
3188
|
+
| ---------- | ---------- |
|
|
3189
|
+
| `markFormAsValidated` | `() => void` |
|
|
3190
|
+
|
|
3191
|
+
#### :gear: markFormAsUnvalidated
|
|
3192
|
+
|
|
3193
|
+
| Method | Type |
|
|
3194
|
+
| ---------- | ---------- |
|
|
3195
|
+
| `markFormAsUnvalidated` | `() => void` |
|
|
3196
|
+
|
|
3197
|
+
#### :gear: addField
|
|
3198
|
+
|
|
3199
|
+
| Method | Type |
|
|
3200
|
+
| ---------- | ---------- |
|
|
3201
|
+
| `addField` | `(field: HTMLElement) => this` |
|
|
3202
|
+
|
|
3203
|
+
#### :gear: registerDefaultValidators
|
|
3204
|
+
|
|
3205
|
+
| Method | Type |
|
|
3206
|
+
| ---------- | ---------- |
|
|
3207
|
+
| `registerDefaultValidators` | `() => void` |
|
|
3208
|
+
|
|
3209
|
+
#### :gear: addValidator
|
|
3210
|
+
|
|
3211
|
+
Add validator handler.
|
|
3212
|
+
|
|
3213
|
+
| Method | Type |
|
|
3214
|
+
| ---------- | ---------- |
|
|
3215
|
+
| `addValidator` | `<T extends unknown, E extends HTMLElement, P = Record<string, any>>(name: string, handler: ValidationHandler<T, E, P>, options?: ValidatorOptions<E, P>) => this` |
|
|
3216
|
+
|
|
3217
|
+
### Static Properties
|
|
3218
|
+
|
|
3219
|
+
- [globalValidators](#gear-globalvalidators)
|
|
3220
|
+
- [is](#gear-is)
|
|
3221
|
+
|
|
3222
|
+
#### :gear: globalValidators
|
|
3223
|
+
|
|
3224
|
+
| Property | Type |
|
|
3225
|
+
| ---------- | ---------- |
|
|
3226
|
+
| `globalValidators` | `Record<string, Validator<any, any, any>>` |
|
|
3227
|
+
|
|
3228
|
+
#### :gear: is
|
|
3229
|
+
|
|
3230
|
+
| Property | Type |
|
|
3231
|
+
| ---------- | ---------- |
|
|
3232
|
+
| `is` | `string` |
|
|
3233
|
+
|
|
3234
|
+
### Properties
|
|
3235
|
+
|
|
3236
|
+
- [presetFields](#gear-presetfields)
|
|
3237
|
+
- [validators](#gear-validators)
|
|
3238
|
+
- [options](#gear-options)
|
|
3239
|
+
- [$form](#gear-$form)
|
|
3240
|
+
|
|
3241
|
+
#### :gear: presetFields
|
|
3242
|
+
|
|
3243
|
+
| Property | Type |
|
|
3244
|
+
| ---------- | ---------- |
|
|
3245
|
+
| `presetFields` | `HTMLElement[]` |
|
|
3246
|
+
|
|
3247
|
+
#### :gear: validators
|
|
3248
|
+
|
|
3249
|
+
| Property | Type |
|
|
3250
|
+
| ---------- | ---------- |
|
|
3251
|
+
| `validators` | `Record<string, Validator<any, any, any>>` |
|
|
3252
|
+
|
|
3253
|
+
#### :gear: options
|
|
3254
|
+
|
|
3255
|
+
| Property | Type |
|
|
3256
|
+
| ---------- | ---------- |
|
|
3257
|
+
| `options` | `FormValidationOptions` |
|
|
3258
|
+
|
|
3259
|
+
#### :gear: $form
|
|
3260
|
+
|
|
3261
|
+
| Property | Type |
|
|
3262
|
+
| ---------- | ---------- |
|
|
3263
|
+
| `$form` | `HTMLElement` |
|
|
3264
|
+
|
|
3265
|
+
## :factory: UnicornFieldValidation
|
|
3266
|
+
|
|
3267
|
+
### Methods
|
|
3268
|
+
|
|
3269
|
+
- [mergeOptions](#gear-mergeoptions)
|
|
3270
|
+
- [selectInput](#gear-selectinput)
|
|
3271
|
+
- [init](#gear-init)
|
|
3272
|
+
- [bindEvents](#gear-bindevents)
|
|
3273
|
+
- [prepareWrapper](#gear-preparewrapper)
|
|
3274
|
+
- [checkValidity](#gear-checkvalidity)
|
|
3275
|
+
- [runCustomValidity](#gear-runcustomvalidity)
|
|
3276
|
+
- [checkCustomDataAttributeValidity](#gear-checkcustomdataattributevalidity)
|
|
3277
|
+
- [checkInputOptionsValidity](#gear-checkinputoptionsvalidity)
|
|
3278
|
+
- [updateValidClass](#gear-updatevalidclass)
|
|
3279
|
+
- [getFormValidation](#gear-getformvalidation)
|
|
3280
|
+
- [getValidator](#gear-getvalidator)
|
|
3281
|
+
- [handleCustomResult](#gear-handlecustomresult)
|
|
3282
|
+
- [handleAsyncCustomResult](#gear-handleasynccustomresult)
|
|
3283
|
+
- [raiseCustomErrorState](#gear-raisecustomerrorstate)
|
|
3284
|
+
- [setAsInvalidAndReport](#gear-setasinvalidandreport)
|
|
3285
|
+
- [setCustomValidity](#gear-setcustomvalidity)
|
|
3286
|
+
- [reportValidity](#gear-reportvalidity)
|
|
3287
|
+
- [showInvalidResponse](#gear-showinvalidresponse)
|
|
3288
|
+
- [getErrorElement](#gear-geterrorelement)
|
|
3289
|
+
- [createHelpElement](#gear-createhelpelement)
|
|
3290
|
+
- [parseSelector](#gear-parseselector)
|
|
3291
|
+
- [setAsValidAndClearResponse](#gear-setasvalidandclearresponse)
|
|
3292
|
+
- [clearInvalidResponse](#gear-clearinvalidresponse)
|
|
3293
|
+
- [getForm](#gear-getform)
|
|
3294
|
+
- [findLabel](#gear-findlabel)
|
|
3295
|
+
|
|
3296
|
+
#### :gear: mergeOptions
|
|
3297
|
+
|
|
3298
|
+
| Method | Type |
|
|
3299
|
+
| ---------- | ---------- |
|
|
3300
|
+
| `mergeOptions` | `(options: Partial<FieldValidationOptions>) => FieldValidationOptions` |
|
|
3301
|
+
|
|
3302
|
+
#### :gear: selectInput
|
|
3303
|
+
|
|
3304
|
+
| Method | Type |
|
|
3305
|
+
| ---------- | ---------- |
|
|
3306
|
+
| `selectInput` | `() => InputElements or undefined` |
|
|
3307
|
+
|
|
3308
|
+
#### :gear: init
|
|
3309
|
+
|
|
3310
|
+
| Method | Type |
|
|
3311
|
+
| ---------- | ---------- |
|
|
3312
|
+
| `init` | `() => void` |
|
|
3313
|
+
|
|
3314
|
+
#### :gear: bindEvents
|
|
3315
|
+
|
|
3316
|
+
| Method | Type |
|
|
3317
|
+
| ---------- | ---------- |
|
|
3318
|
+
| `bindEvents` | `() => void` |
|
|
3319
|
+
|
|
3320
|
+
#### :gear: prepareWrapper
|
|
3321
|
+
|
|
3322
|
+
| Method | Type |
|
|
3323
|
+
| ---------- | ---------- |
|
|
3324
|
+
| `prepareWrapper` | `() => void` |
|
|
3325
|
+
|
|
3326
|
+
#### :gear: checkValidity
|
|
3327
|
+
|
|
3328
|
+
| Method | Type |
|
|
3329
|
+
| ---------- | ---------- |
|
|
3330
|
+
| `checkValidity` | `() => boolean` |
|
|
3331
|
+
|
|
3332
|
+
#### :gear: runCustomValidity
|
|
3333
|
+
|
|
3334
|
+
| Method | Type |
|
|
3335
|
+
| ---------- | ---------- |
|
|
3336
|
+
| `runCustomValidity` | `() => boolean` |
|
|
3337
|
+
|
|
3338
|
+
#### :gear: checkCustomDataAttributeValidity
|
|
3339
|
+
|
|
3340
|
+
| Method | Type |
|
|
3341
|
+
| ---------- | ---------- |
|
|
3342
|
+
| `checkCustomDataAttributeValidity` | `() => boolean` |
|
|
3343
|
+
|
|
3344
|
+
#### :gear: checkInputOptionsValidity
|
|
3345
|
+
|
|
3346
|
+
| Method | Type |
|
|
3347
|
+
| ---------- | ---------- |
|
|
3348
|
+
| `checkInputOptionsValidity` | `() => boolean` |
|
|
3349
|
+
|
|
3350
|
+
#### :gear: updateValidClass
|
|
3351
|
+
|
|
3352
|
+
| Method | Type |
|
|
3353
|
+
| ---------- | ---------- |
|
|
3354
|
+
| `updateValidClass` | `(valid: Boolean) => void` |
|
|
3355
|
+
|
|
3356
|
+
#### :gear: getFormValidation
|
|
3357
|
+
|
|
3358
|
+
| Method | Type |
|
|
3359
|
+
| ---------- | ---------- |
|
|
3360
|
+
| `getFormValidation` | `(element?: Nullable<HTMLFormElement>) => UnicornFormValidation or null` |
|
|
3361
|
+
|
|
3362
|
+
#### :gear: getValidator
|
|
3363
|
+
|
|
3364
|
+
| Method | Type |
|
|
3365
|
+
| ---------- | ---------- |
|
|
3366
|
+
| `getValidator` | `(name: string) => [Validator<any, HTMLElement, Record<string, any>>, Record<string, any>] or null` |
|
|
3367
|
+
|
|
3368
|
+
#### :gear: handleCustomResult
|
|
3369
|
+
|
|
3370
|
+
| Method | Type |
|
|
3371
|
+
| ---------- | ---------- |
|
|
3372
|
+
| `handleCustomResult` | `(result: string or boolean or undefined, validator?: Nullable<Validator<any, HTMLElement, Record<string, any>>>) => boolean` |
|
|
3373
|
+
|
|
3374
|
+
#### :gear: handleAsyncCustomResult
|
|
3375
|
+
|
|
3376
|
+
| Method | Type |
|
|
3377
|
+
| ---------- | ---------- |
|
|
3378
|
+
| `handleAsyncCustomResult` | `(result: boolean, validator?: Nullable<Validator<any, HTMLElement, Record<string, any>>>) => boolean` |
|
|
3379
|
+
|
|
3380
|
+
#### :gear: raiseCustomErrorState
|
|
3381
|
+
|
|
3382
|
+
| Method | Type |
|
|
3383
|
+
| ---------- | ---------- |
|
|
3384
|
+
| `raiseCustomErrorState` | `(validator: Validator<any, HTMLElement, Record<string, any>>) => void` |
|
|
3385
|
+
|
|
3386
|
+
#### :gear: setAsInvalidAndReport
|
|
3387
|
+
|
|
3388
|
+
| Method | Type |
|
|
3389
|
+
| ---------- | ---------- |
|
|
3390
|
+
| `setAsInvalidAndReport` | `(error: string) => void` |
|
|
3391
|
+
|
|
3392
|
+
#### :gear: setCustomValidity
|
|
3393
|
+
|
|
3394
|
+
| Method | Type |
|
|
3395
|
+
| ---------- | ---------- |
|
|
3396
|
+
| `setCustomValidity` | `(error: string) => void` |
|
|
3397
|
+
|
|
3398
|
+
#### :gear: reportValidity
|
|
3399
|
+
|
|
3400
|
+
| Method | Type |
|
|
3401
|
+
| ---------- | ---------- |
|
|
3402
|
+
| `reportValidity` | `() => void` |
|
|
3403
|
+
|
|
3404
|
+
#### :gear: showInvalidResponse
|
|
3405
|
+
|
|
3406
|
+
| Method | Type |
|
|
3407
|
+
| ---------- | ---------- |
|
|
3408
|
+
| `showInvalidResponse` | `() => void` |
|
|
3409
|
+
|
|
3410
|
+
#### :gear: getErrorElement
|
|
3411
|
+
|
|
3412
|
+
| Method | Type |
|
|
3413
|
+
| ---------- | ---------- |
|
|
3414
|
+
| `getErrorElement` | `() => Element or null` |
|
|
3415
|
+
|
|
3416
|
+
#### :gear: createHelpElement
|
|
3417
|
+
|
|
3418
|
+
| Method | Type |
|
|
3419
|
+
| ---------- | ---------- |
|
|
3420
|
+
| `createHelpElement` | `() => HTMLElement` |
|
|
3421
|
+
|
|
3422
|
+
#### :gear: parseSelector
|
|
3423
|
+
|
|
3424
|
+
| Method | Type |
|
|
3425
|
+
| ---------- | ---------- |
|
|
3426
|
+
| `parseSelector` | `(subselector: string) => { tags: string[]; classes: string[]; ids: string[]; attrs: string[][]; }` |
|
|
3427
|
+
|
|
3428
|
+
References:
|
|
3429
|
+
|
|
3430
|
+
* [https://stackoverflow.com/a/17888178](https://stackoverflow.com/a/17888178)
|
|
3431
|
+
|
|
3432
|
+
|
|
3433
|
+
#### :gear: setAsValidAndClearResponse
|
|
3434
|
+
|
|
3435
|
+
| Method | Type |
|
|
3436
|
+
| ---------- | ---------- |
|
|
3437
|
+
| `setAsValidAndClearResponse` | `() => void` |
|
|
3438
|
+
|
|
3439
|
+
#### :gear: clearInvalidResponse
|
|
3440
|
+
|
|
3441
|
+
| Method | Type |
|
|
3442
|
+
| ---------- | ---------- |
|
|
3443
|
+
| `clearInvalidResponse` | `() => void` |
|
|
3444
|
+
|
|
3445
|
+
#### :gear: getForm
|
|
3446
|
+
|
|
3447
|
+
| Method | Type |
|
|
3448
|
+
| ---------- | ---------- |
|
|
3449
|
+
| `getForm` | `() => HTMLFormElement` |
|
|
3450
|
+
|
|
3451
|
+
#### :gear: findLabel
|
|
3452
|
+
|
|
3453
|
+
| Method | Type |
|
|
3454
|
+
| ---------- | ---------- |
|
|
3455
|
+
| `findLabel` | `() => null` |
|
|
3456
|
+
|
|
3457
|
+
### Static Properties
|
|
3458
|
+
|
|
3459
|
+
- [is](#gear-is)
|
|
3460
|
+
|
|
3461
|
+
#### :gear: is
|
|
3462
|
+
|
|
3463
|
+
| Property | Type |
|
|
3464
|
+
| ---------- | ---------- |
|
|
3465
|
+
| `is` | `string` |
|
|
3466
|
+
|
|
3467
|
+
### Properties
|
|
3468
|
+
|
|
3469
|
+
- [$input](#gear-$input)
|
|
3470
|
+
- [options](#gear-options)
|
|
3471
|
+
|
|
3472
|
+
#### :gear: $input
|
|
3473
|
+
|
|
3474
|
+
| Property | Type |
|
|
3475
|
+
| ---------- | ---------- |
|
|
3476
|
+
| `$input` | `InputElements or undefined` |
|
|
3477
|
+
|
|
3478
|
+
#### :gear: options
|
|
3479
|
+
|
|
3480
|
+
| Property | Type |
|
|
3481
|
+
| ---------- | ---------- |
|
|
3482
|
+
| `options` | `FieldValidationOptions` |
|
|
3483
|
+
|
|
3484
|
+
## :factory: UnicornUI
|
|
3485
|
+
|
|
3486
|
+
### Methods
|
|
3487
|
+
|
|
3488
|
+
- [installTheme](#gear-installtheme)
|
|
3489
|
+
|
|
3490
|
+
#### :gear: installTheme
|
|
3491
|
+
|
|
3492
|
+
| Method | Type |
|
|
3493
|
+
| ---------- | ---------- |
|
|
3494
|
+
| `installTheme` | `(theme: any) => void` |
|
|
3495
|
+
|
|
3496
|
+
### Properties
|
|
3497
|
+
|
|
3498
|
+
- [theme](#gear-theme)
|
|
3499
|
+
|
|
3500
|
+
#### :gear: theme
|
|
3501
|
+
|
|
3502
|
+
| Property | Type |
|
|
3503
|
+
| ---------- | ---------- |
|
|
3504
|
+
| `theme` | `UIThemeInterface or undefined` |
|
|
3505
|
+
|
|
3506
|
+
## :factory: UnicornSystemUri
|
|
3507
|
+
|
|
3508
|
+
### Static Methods
|
|
3509
|
+
|
|
3510
|
+
- [get](#gear-get)
|
|
3511
|
+
|
|
3512
|
+
#### :gear: get
|
|
3513
|
+
|
|
3514
|
+
| Method | Type |
|
|
3515
|
+
| ---------- | ---------- |
|
|
3516
|
+
| `get` | `() => UnicornSystemUri` |
|
|
3517
|
+
|
|
3518
|
+
### Methods
|
|
3519
|
+
|
|
3520
|
+
- [path](#gear-path)
|
|
3521
|
+
- [root](#gear-root)
|
|
3522
|
+
- [current](#gear-current)
|
|
3523
|
+
- [full](#gear-full)
|
|
3524
|
+
- [route](#gear-route)
|
|
3525
|
+
- [script](#gear-script)
|
|
3526
|
+
- [routeWithQuery](#gear-routewithquery)
|
|
3527
|
+
- [routeAndQuery](#gear-routeandquery)
|
|
3528
|
+
|
|
3529
|
+
#### :gear: path
|
|
3530
|
+
|
|
3531
|
+
| Method | Type |
|
|
3532
|
+
| ---------- | ---------- |
|
|
3533
|
+
| `path` | `(path?: string) => string` |
|
|
3534
|
+
|
|
3535
|
+
#### :gear: root
|
|
3536
|
+
|
|
3537
|
+
| Method | Type |
|
|
3538
|
+
| ---------- | ---------- |
|
|
3539
|
+
| `root` | `(path?: string) => string` |
|
|
3540
|
+
|
|
3541
|
+
#### :gear: current
|
|
3542
|
+
|
|
3543
|
+
| Method | Type |
|
|
3544
|
+
| ---------- | ---------- |
|
|
3545
|
+
| `current` | `() => string` |
|
|
3546
|
+
|
|
3547
|
+
#### :gear: full
|
|
3548
|
+
|
|
3549
|
+
| Method | Type |
|
|
3550
|
+
| ---------- | ---------- |
|
|
3551
|
+
| `full` | `() => string` |
|
|
3552
|
+
|
|
3553
|
+
#### :gear: route
|
|
3554
|
+
|
|
3555
|
+
| Method | Type |
|
|
3556
|
+
| ---------- | ---------- |
|
|
3557
|
+
| `route` | `() => string` |
|
|
3558
|
+
|
|
3559
|
+
#### :gear: script
|
|
3560
|
+
|
|
3561
|
+
| Method | Type |
|
|
3562
|
+
| ---------- | ---------- |
|
|
3563
|
+
| `script` | `() => string` |
|
|
3564
|
+
|
|
3565
|
+
#### :gear: routeWithQuery
|
|
3566
|
+
|
|
3567
|
+
| Method | Type |
|
|
3568
|
+
| ---------- | ---------- |
|
|
3569
|
+
| `routeWithQuery` | `() => string` |
|
|
3570
|
+
|
|
3571
|
+
#### :gear: routeAndQuery
|
|
3572
|
+
|
|
3573
|
+
| Method | Type |
|
|
3574
|
+
| ---------- | ---------- |
|
|
3575
|
+
| `routeAndQuery` | `() => string[]` |
|
|
3576
|
+
|
|
3577
|
+
### Static Properties
|
|
3578
|
+
|
|
3579
|
+
- [instance](#gear-instance)
|
|
3580
|
+
|
|
3581
|
+
#### :gear: instance
|
|
3582
|
+
|
|
3583
|
+
| Property | Type |
|
|
3584
|
+
| ---------- | ---------- |
|
|
3585
|
+
| `instance` | `UnicornSystemUri` |
|
|
3586
|
+
|
|
3587
|
+
## :factory: UnicornAssetUri
|
|
3588
|
+
|
|
3589
|
+
### Static Methods
|
|
3590
|
+
|
|
3591
|
+
- [get](#gear-get)
|
|
3592
|
+
|
|
3593
|
+
#### :gear: get
|
|
3594
|
+
|
|
3595
|
+
| Method | Type |
|
|
3596
|
+
| ---------- | ---------- |
|
|
3597
|
+
| `get` | `() => UnicornAssetUri` |
|
|
3598
|
+
|
|
3599
|
+
### Methods
|
|
3600
|
+
|
|
3601
|
+
- [path](#gear-path)
|
|
3602
|
+
- [root](#gear-root)
|
|
3603
|
+
|
|
3604
|
+
#### :gear: path
|
|
3605
|
+
|
|
3606
|
+
| Method | Type |
|
|
3607
|
+
| ---------- | ---------- |
|
|
3608
|
+
| `path` | `(path?: string) => string` |
|
|
3609
|
+
|
|
3610
|
+
#### :gear: root
|
|
3611
|
+
|
|
3612
|
+
| Method | Type |
|
|
3613
|
+
| ---------- | ---------- |
|
|
3614
|
+
| `root` | `(path?: string) => string` |
|
|
3615
|
+
|
|
3616
|
+
### Static Properties
|
|
3617
|
+
|
|
3618
|
+
- [instance](#gear-instance)
|
|
3619
|
+
|
|
3620
|
+
#### :gear: instance
|
|
3621
|
+
|
|
3622
|
+
| Property | Type |
|
|
3623
|
+
| ---------- | ---------- |
|
|
3624
|
+
| `instance` | `UnicornAssetUri` |
|
|
3625
|
+
|
|
3626
|
+
## :factory: UnicornApp
|
|
3627
|
+
|
|
3628
|
+
### Methods
|
|
3629
|
+
|
|
3630
|
+
- [use](#gear-use)
|
|
3631
|
+
- [detach](#gear-detach)
|
|
3632
|
+
- [inject](#gear-inject)
|
|
3633
|
+
- [inject](#gear-inject)
|
|
3634
|
+
- [inject](#gear-inject)
|
|
3635
|
+
- [inject](#gear-inject)
|
|
3636
|
+
- [provide](#gear-provide)
|
|
3637
|
+
- [wait](#gear-wait)
|
|
3638
|
+
- [completed](#gear-completed)
|
|
3639
|
+
- [macro](#gear-macro)
|
|
3640
|
+
|
|
3641
|
+
#### :gear: use
|
|
3642
|
+
|
|
3643
|
+
| Method | Type |
|
|
3644
|
+
| ---------- | ---------- |
|
|
3645
|
+
| `use` | `(plugin: UnicornPlugin, options?: Record<string, any>) => this` |
|
|
3646
|
+
|
|
3647
|
+
#### :gear: detach
|
|
3648
|
+
|
|
3649
|
+
| Method | Type |
|
|
3650
|
+
| ---------- | ---------- |
|
|
3651
|
+
| `detach` | `(plugin: any) => this` |
|
|
3652
|
+
|
|
3653
|
+
#### :gear: inject
|
|
3654
|
+
|
|
3655
|
+
| Method | Type |
|
|
3656
|
+
| ---------- | ---------- |
|
|
3657
|
+
| `inject` | `{ <T>(id: InjectionKey<T>): T; <T>(id: InjectionKey<T>, def: T): T; <T>(id: InjectionKey<T>, def?: T or undefined): T; }` |
|
|
3658
|
+
|
|
3659
|
+
#### :gear: inject
|
|
3660
|
+
|
|
3661
|
+
| Method | Type |
|
|
3662
|
+
| ---------- | ---------- |
|
|
3663
|
+
| `inject` | `{ <T>(id: InjectionKey<T>): T; <T>(id: InjectionKey<T>, def: T): T; <T>(id: InjectionKey<T>, def?: T or undefined): T; }` |
|
|
3664
|
+
|
|
3665
|
+
#### :gear: inject
|
|
3666
|
+
|
|
3667
|
+
| Method | Type |
|
|
3668
|
+
| ---------- | ---------- |
|
|
3669
|
+
| `inject` | `{ <T>(id: InjectionKey<T>): T; <T>(id: InjectionKey<T>, def: T): T; <T>(id: InjectionKey<T>, def?: T or undefined): T; }` |
|
|
3670
|
+
|
|
3671
|
+
#### :gear: inject
|
|
3672
|
+
|
|
3673
|
+
| Method | Type |
|
|
3674
|
+
| ---------- | ---------- |
|
|
3675
|
+
| `inject` | `{ <T>(id: InjectionKey<T>): T; <T>(id: InjectionKey<T>, def: T): T; <T>(id: InjectionKey<T>, def?: T or undefined): T; }` |
|
|
3676
|
+
|
|
3677
|
+
#### :gear: provide
|
|
3678
|
+
|
|
3679
|
+
| Method | Type |
|
|
3680
|
+
| ---------- | ---------- |
|
|
3681
|
+
| `provide` | `<T>(id: InjectionKey<T>, value: any) => this` |
|
|
3682
|
+
|
|
3683
|
+
#### :gear: wait
|
|
3684
|
+
|
|
3685
|
+
| Method | Type |
|
|
3686
|
+
| ---------- | ---------- |
|
|
3687
|
+
| `wait` | `(callback: Function) => Promise<any>` |
|
|
3688
|
+
|
|
3689
|
+
#### :gear: completed
|
|
3690
|
+
|
|
3691
|
+
| Method | Type |
|
|
3692
|
+
| ---------- | ---------- |
|
|
3693
|
+
| `completed` | `() => Promise<any[]>` |
|
|
3694
|
+
|
|
3695
|
+
#### :gear: macro
|
|
3696
|
+
|
|
3697
|
+
| Method | Type |
|
|
3698
|
+
| ---------- | ---------- |
|
|
3699
|
+
| `macro` | `(name: string, prop: any) => this` |
|
|
3700
|
+
|
|
3701
|
+
### Properties
|
|
3702
|
+
|
|
3703
|
+
- [registry](#gear-registry)
|
|
3704
|
+
- [plugins](#gear-plugins)
|
|
3705
|
+
- [waits](#gear-waits)
|
|
3706
|
+
- [options](#gear-options)
|
|
3707
|
+
- [defaultOptions](#gear-defaultoptions)
|
|
3708
|
+
- [domready](#gear-domready)
|
|
3709
|
+
- [data](#gear-data)
|
|
3710
|
+
|
|
3711
|
+
#### :gear: registry
|
|
3712
|
+
|
|
3713
|
+
| Property | Type |
|
|
3714
|
+
| ---------- | ---------- |
|
|
3715
|
+
| `registry` | `Map<any, any>` |
|
|
3716
|
+
|
|
3717
|
+
#### :gear: plugins
|
|
3718
|
+
|
|
3719
|
+
| Property | Type |
|
|
3720
|
+
| ---------- | ---------- |
|
|
3721
|
+
| `plugins` | `Map<any, any>` |
|
|
3722
|
+
|
|
3723
|
+
#### :gear: waits
|
|
3724
|
+
|
|
3725
|
+
| Property | Type |
|
|
3726
|
+
| ---------- | ---------- |
|
|
3727
|
+
| `waits` | `Promise<any>[]` |
|
|
3728
|
+
|
|
3729
|
+
#### :gear: options
|
|
3730
|
+
|
|
3731
|
+
| Property | Type |
|
|
3732
|
+
| ---------- | ---------- |
|
|
3733
|
+
| `options` | `Record<string, any>` |
|
|
3734
|
+
|
|
3735
|
+
#### :gear: defaultOptions
|
|
3736
|
+
|
|
3737
|
+
| Property | Type |
|
|
3738
|
+
| ---------- | ---------- |
|
|
3739
|
+
| `defaultOptions` | `Record<string, any>` |
|
|
3740
|
+
|
|
3741
|
+
#### :gear: domready
|
|
3742
|
+
|
|
3743
|
+
| Property | Type |
|
|
3744
|
+
| ---------- | ---------- |
|
|
3745
|
+
| `domready` | `(callback?: ((value: any) => any) or undefined) => Promise<void>` |
|
|
3746
|
+
|
|
3747
|
+
#### :gear: data
|
|
3748
|
+
|
|
3749
|
+
| Property | Type |
|
|
3750
|
+
| ---------- | ---------- |
|
|
3751
|
+
| `data` | `{ (name: string, data?: any): any; <T = void, R = [T] extends [void] ? any : T or undefined>(name: string): R; <T = void, R = [T] extends [void] ? any : T or undefined>(ele: Element, name: string): R; (ele: Element, name: string, value: any): any; }` |
|
|
3752
|
+
|
|
3753
|
+
## :factory: MultiUploaderElement
|
|
3754
|
+
|
|
3755
|
+
### Static Properties
|
|
3756
|
+
|
|
3757
|
+
- [is](#gear-is)
|
|
3758
|
+
|
|
3759
|
+
#### :gear: is
|
|
3760
|
+
|
|
3761
|
+
| Property | Type |
|
|
3762
|
+
| ---------- | ---------- |
|
|
3763
|
+
| `is` | `string` |
|
|
3764
|
+
|
|
3765
|
+
### Properties
|
|
3766
|
+
|
|
3767
|
+
- [modalElement](#gear-modalelement)
|
|
3768
|
+
- [vm](#gear-vm)
|
|
3769
|
+
|
|
3770
|
+
#### :gear: modalElement
|
|
3771
|
+
|
|
3772
|
+
| Property | Type |
|
|
3773
|
+
| ---------- | ---------- |
|
|
3774
|
+
| `modalElement` | `HTMLDivElement` |
|
|
3775
|
+
|
|
3776
|
+
#### :gear: vm
|
|
3777
|
+
|
|
3778
|
+
| Property | Type |
|
|
3779
|
+
| ---------- | ---------- |
|
|
3780
|
+
| `vm` | `ComponentPublicInstance` |
|
|
3781
|
+
|
|
3782
|
+
## :factory: UnicornPhpAdapter
|
|
3783
|
+
|
|
3784
|
+
### Static Methods
|
|
3785
|
+
|
|
3786
|
+
- [install](#gear-install)
|
|
3787
|
+
|
|
3788
|
+
#### :gear: install
|
|
3789
|
+
|
|
3790
|
+
| Method | Type |
|
|
3791
|
+
| ---------- | ---------- |
|
|
3792
|
+
| `install` | `(app: UnicornApp) => void` |
|
|
3793
|
+
|
|
3794
|
+
## :factory: LegacyLoader
|
|
3795
|
+
|
|
3796
|
+
### Static Methods
|
|
3797
|
+
|
|
3798
|
+
- [install](#gear-install)
|
|
3799
|
+
|
|
3800
|
+
#### :gear: install
|
|
3801
|
+
|
|
3802
|
+
| Method | Type |
|
|
3803
|
+
| ---------- | ---------- |
|
|
3804
|
+
| `install` | `(app: any) => void` |
|
|
3805
|
+
|
|
3806
|
+
### Methods
|
|
3807
|
+
|
|
3808
|
+
- [doImport](#gear-doimport)
|
|
3809
|
+
- [import](#gear-import)
|
|
3810
|
+
- [importSync](#gear-importsync)
|
|
3811
|
+
- [minFileName](#gear-minfilename)
|
|
3812
|
+
- [asImported](#gear-asimported)
|
|
3813
|
+
- [afterImported](#gear-afterimported)
|
|
3814
|
+
|
|
3815
|
+
#### :gear: doImport
|
|
3816
|
+
|
|
3817
|
+
| Method | Type |
|
|
3818
|
+
| ---------- | ---------- |
|
|
3819
|
+
| `doImport` | `(src: string) => Promise<any>` |
|
|
3820
|
+
|
|
3821
|
+
#### :gear: import
|
|
3822
|
+
|
|
3823
|
+
Import modules or scripts.
|
|
3824
|
+
|
|
3825
|
+
| Method | Type |
|
|
3826
|
+
| ---------- | ---------- |
|
|
3827
|
+
| `import` | `(...src: any[]) => Promise<any>` |
|
|
3828
|
+
|
|
3829
|
+
#### :gear: importSync
|
|
3830
|
+
|
|
3831
|
+
Import sync.
|
|
3832
|
+
|
|
3833
|
+
| Method | Type |
|
|
3834
|
+
| ---------- | ---------- |
|
|
3835
|
+
| `importSync` | `(...src: any) => Promise<any>` |
|
|
3836
|
+
|
|
3837
|
+
#### :gear: minFileName
|
|
3838
|
+
|
|
3839
|
+
| Method | Type |
|
|
3840
|
+
| ---------- | ---------- |
|
|
3841
|
+
| `minFileName` | `(fileName: string) => string` |
|
|
3842
|
+
|
|
3843
|
+
#### :gear: asImported
|
|
3844
|
+
|
|
3845
|
+
| Method | Type |
|
|
3846
|
+
| ---------- | ---------- |
|
|
3847
|
+
| `asImported` | `(name: string) => void` |
|
|
3848
|
+
|
|
3849
|
+
#### :gear: afterImported
|
|
3850
|
+
|
|
3851
|
+
Add after import hook for some url or id.
|
|
3852
|
+
|
|
3853
|
+
| Method | Type |
|
|
3854
|
+
| ---------- | ---------- |
|
|
3855
|
+
| `afterImported` | `(name: string, callback: (resolve: Function, reject?: Function or undefined) => void) => Promise<any>` |
|