@plaidev/karte-action-sdk 1.1.112 → 1.1.113-27923240.51ac14b8
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/dist/hydrate/index.es.d.ts +931 -267
- package/dist/hydrate/index.es.js +678 -292
- package/dist/index.es.d.ts +931 -267
- package/dist/index.es.js +651 -292
- package/dist/templates.js +1 -0
- package/package.json +6 -1
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { Writable as Writable_ } from "svelte/store";
|
|
2
2
|
import { get as get_ } from "svelte/store";
|
|
3
3
|
import { SvelteComponentDev } from "svelte/internal";
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
4
7
|
declare const PropTypes: readonly [
|
|
5
8
|
"BooleanKeyword",
|
|
6
9
|
"NumberKeyword",
|
|
@@ -22,17 +25,38 @@ declare const PropTypes: readonly [
|
|
|
22
25
|
"ModalPlacement",
|
|
23
26
|
"OnClick"
|
|
24
27
|
];
|
|
28
|
+
/**
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
25
31
|
type PropType = (typeof PropTypes)[number];
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
26
35
|
type Code = string;
|
|
36
|
+
/**
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
27
39
|
declare const MediaQueries: {
|
|
28
40
|
[key: string]: string;
|
|
29
41
|
};
|
|
42
|
+
/**
|
|
43
|
+
* @internal
|
|
44
|
+
*/
|
|
30
45
|
type MediaQuery = string;
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
*/
|
|
31
49
|
declare const Directions: readonly [
|
|
32
50
|
"row",
|
|
33
51
|
"column"
|
|
34
52
|
];
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
35
56
|
type Direction = (typeof Directions)[number];
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
36
60
|
declare const AnimationStyles: readonly [
|
|
37
61
|
"none",
|
|
38
62
|
"fade",
|
|
@@ -42,7 +66,13 @@ declare const AnimationStyles: readonly [
|
|
|
42
66
|
"slide-left",
|
|
43
67
|
"slide-right"
|
|
44
68
|
];
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
45
72
|
type AnimationStyle = (typeof AnimationStyles)[number];
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
46
76
|
declare const ModalPositions: readonly [
|
|
47
77
|
"top-left",
|
|
48
78
|
"top-center",
|
|
@@ -55,35 +85,62 @@ declare const ModalPositions: readonly [
|
|
|
55
85
|
"bottom-right",
|
|
56
86
|
"none"
|
|
57
87
|
];
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
58
91
|
type ModalPosition = (typeof ModalPositions)[number];
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
59
95
|
type ModalMargin = {
|
|
60
96
|
left?: string;
|
|
61
97
|
right?: string;
|
|
62
98
|
top?: string;
|
|
63
99
|
bottom?: string;
|
|
64
100
|
};
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
65
104
|
type ModalPlacement<M = ModalMargin> = {
|
|
66
105
|
position?: ModalPosition;
|
|
67
106
|
margin?: M;
|
|
68
107
|
backgroundOverlay?: boolean;
|
|
69
108
|
backgroundClick?: OnClickOperation;
|
|
70
109
|
};
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
71
113
|
declare const DefaultModalPlacement: Required<ModalPlacement<Required<ModalMargin>>>;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
72
117
|
declare const Elasticities: readonly [
|
|
73
118
|
"none",
|
|
74
119
|
"vertical",
|
|
75
120
|
"horizontal"
|
|
76
121
|
];
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
77
125
|
type Elasticity = (typeof Elasticities)[number];
|
|
126
|
+
/**
|
|
127
|
+
* @internal
|
|
128
|
+
*/
|
|
78
129
|
declare const ElasticityStyle: {
|
|
79
130
|
none: string;
|
|
80
131
|
vertical: string;
|
|
81
132
|
horizontal: string;
|
|
82
133
|
};
|
|
134
|
+
/**
|
|
135
|
+
* @internal
|
|
136
|
+
*/
|
|
83
137
|
declare const TextDirections: readonly [
|
|
84
138
|
"horizontal",
|
|
85
139
|
"vertical"
|
|
86
140
|
];
|
|
141
|
+
/**
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
87
144
|
type TextDirection = (typeof TextDirections)[number];
|
|
88
145
|
type OperationArgumentTypes = {
|
|
89
146
|
StringKeyword: string;
|
|
@@ -94,6 +151,9 @@ type OperationArgumentTypes = {
|
|
|
94
151
|
Handler: string;
|
|
95
152
|
Trigger: string;
|
|
96
153
|
};
|
|
154
|
+
/**
|
|
155
|
+
* @internal
|
|
156
|
+
*/
|
|
97
157
|
type OperationArgumentType = keyof OperationArgumentTypes;
|
|
98
158
|
type BaseOperationOptions = ReadonlyArray<{
|
|
99
159
|
operation: string;
|
|
@@ -110,7 +170,13 @@ type ConvertOperationOption<Option extends BaseOperationOptions[number]> = Optio
|
|
|
110
170
|
type ConvertOperationOptionArguments<Arguments extends BaseOperationOptions[number]["args"]> = {
|
|
111
171
|
-readonly [Index in keyof Arguments]: Arguments[Index] extends BaseOperationOptions[number]["args"][number] ? OperationArgumentTypes[Arguments[Index]["type"]] : never;
|
|
112
172
|
};
|
|
173
|
+
/**
|
|
174
|
+
* @internal
|
|
175
|
+
*/
|
|
113
176
|
type Operation = ConvertOperationOptions<ReadonlyArray<any>>;
|
|
177
|
+
/**
|
|
178
|
+
* @internal
|
|
179
|
+
*/
|
|
114
180
|
declare const OnClickOperationOptions: readonly [
|
|
115
181
|
{
|
|
116
182
|
readonly operation: "none";
|
|
@@ -158,10 +224,61 @@ declare const OnClickOperationOptions: readonly [
|
|
|
158
224
|
];
|
|
159
225
|
}
|
|
160
226
|
];
|
|
227
|
+
/**
|
|
228
|
+
* @internal
|
|
229
|
+
*/
|
|
161
230
|
type OnClickOperation = ConvertOperationOptions<typeof OnClickOperationOptions>;
|
|
231
|
+
/**
|
|
232
|
+
* @internal
|
|
233
|
+
*/
|
|
234
|
+
declare const FormOperationOptions: readonly [
|
|
235
|
+
{
|
|
236
|
+
readonly operation: "submit";
|
|
237
|
+
readonly args: readonly [
|
|
238
|
+
{
|
|
239
|
+
readonly type: "TransitState";
|
|
240
|
+
readonly default: "/";
|
|
241
|
+
}
|
|
242
|
+
];
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
readonly operation: "next";
|
|
246
|
+
readonly args: readonly [
|
|
247
|
+
{
|
|
248
|
+
readonly type: "TransitState";
|
|
249
|
+
readonly default: "/";
|
|
250
|
+
}
|
|
251
|
+
];
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
readonly operation: "prev";
|
|
255
|
+
readonly args: readonly [
|
|
256
|
+
{
|
|
257
|
+
readonly type: "TransitState";
|
|
258
|
+
readonly default: "/";
|
|
259
|
+
}
|
|
260
|
+
];
|
|
261
|
+
}
|
|
262
|
+
];
|
|
263
|
+
/**
|
|
264
|
+
* @internal
|
|
265
|
+
*/
|
|
266
|
+
type FormOperation = ConvertOperationOptions<typeof FormOperationOptions>;
|
|
267
|
+
/**
|
|
268
|
+
* @internal
|
|
269
|
+
*/
|
|
162
270
|
type LongText = string;
|
|
271
|
+
/**
|
|
272
|
+
* @internal
|
|
273
|
+
*/
|
|
163
274
|
type Url = string;
|
|
275
|
+
/**
|
|
276
|
+
* @internal
|
|
277
|
+
*/
|
|
164
278
|
type Image = string;
|
|
279
|
+
/**
|
|
280
|
+
* @internal
|
|
281
|
+
*/
|
|
165
282
|
declare const LengthUnits: readonly [
|
|
166
283
|
"px",
|
|
167
284
|
"em",
|
|
@@ -170,66 +287,147 @@ declare const LengthUnits: readonly [
|
|
|
170
287
|
"fr",
|
|
171
288
|
"%"
|
|
172
289
|
];
|
|
290
|
+
/**
|
|
291
|
+
* @internal
|
|
292
|
+
*/
|
|
173
293
|
type LengthUnit = (typeof LengthUnits)[number];
|
|
294
|
+
/**
|
|
295
|
+
* @internal
|
|
296
|
+
*/
|
|
174
297
|
type Length = `${number}${LengthUnit}` | "auto";
|
|
298
|
+
/**
|
|
299
|
+
* @internal
|
|
300
|
+
*/
|
|
175
301
|
type Color = `#${string}` | `rgba(${string})`;
|
|
302
|
+
/**
|
|
303
|
+
* @internal
|
|
304
|
+
*/
|
|
176
305
|
declare const Justifies: readonly [
|
|
177
306
|
"flex-start",
|
|
178
307
|
"center",
|
|
179
308
|
"flex-end"
|
|
180
309
|
];
|
|
310
|
+
/**
|
|
311
|
+
* @internal
|
|
312
|
+
*/
|
|
181
313
|
type Justify = (typeof Justifies)[number];
|
|
314
|
+
/**
|
|
315
|
+
* @internal
|
|
316
|
+
*/
|
|
182
317
|
declare const Alignments: readonly [
|
|
183
318
|
"flex-start",
|
|
184
319
|
"center",
|
|
185
320
|
"flex-end"
|
|
186
321
|
];
|
|
322
|
+
/**
|
|
323
|
+
* @internal
|
|
324
|
+
*/
|
|
187
325
|
type Alignment = (typeof Alignments)[number];
|
|
326
|
+
/**
|
|
327
|
+
* @internal
|
|
328
|
+
*/
|
|
188
329
|
declare const ObjectFits: readonly [
|
|
189
330
|
"fill",
|
|
190
331
|
"contain",
|
|
191
332
|
"cover"
|
|
192
333
|
];
|
|
334
|
+
/**
|
|
335
|
+
* @internal
|
|
336
|
+
*/
|
|
193
337
|
type ObjectFit = (typeof ObjectFits)[number];
|
|
338
|
+
/**
|
|
339
|
+
* @internal
|
|
340
|
+
*/
|
|
194
341
|
declare const ClipPaths: readonly [
|
|
195
342
|
"none",
|
|
196
343
|
"circle(closest-side)"
|
|
197
344
|
];
|
|
345
|
+
/**
|
|
346
|
+
* @internal
|
|
347
|
+
*/
|
|
198
348
|
type ClipPath = (typeof ClipPaths)[number];
|
|
349
|
+
/**
|
|
350
|
+
* @internal
|
|
351
|
+
*/
|
|
199
352
|
declare const Repeats: readonly [
|
|
200
353
|
"repeat",
|
|
201
354
|
"space",
|
|
202
355
|
"round",
|
|
203
356
|
"no-repeat"
|
|
204
357
|
];
|
|
358
|
+
/**
|
|
359
|
+
* @internal
|
|
360
|
+
*/
|
|
205
361
|
type Repeat = (typeof Repeats)[number];
|
|
362
|
+
/**
|
|
363
|
+
* @internal
|
|
364
|
+
*/
|
|
206
365
|
declare const BackgroundSizes: readonly [
|
|
207
366
|
"cover",
|
|
208
367
|
"contain",
|
|
209
368
|
"auto"
|
|
210
369
|
];
|
|
370
|
+
/**
|
|
371
|
+
* @internal
|
|
372
|
+
*/
|
|
211
373
|
type BackgroundSize = (typeof BackgroundSizes)[number];
|
|
374
|
+
/**
|
|
375
|
+
* @internal
|
|
376
|
+
*/
|
|
212
377
|
declare const Cursors: readonly [
|
|
213
378
|
"default",
|
|
214
379
|
"pointer"
|
|
215
380
|
];
|
|
381
|
+
/**
|
|
382
|
+
* @internal
|
|
383
|
+
*/
|
|
216
384
|
type Cursor = (typeof Cursors)[number];
|
|
385
|
+
/**
|
|
386
|
+
* @internal
|
|
387
|
+
*/
|
|
217
388
|
declare const Overflows: readonly [
|
|
218
389
|
"visible",
|
|
219
390
|
"auto",
|
|
220
391
|
"hidden"
|
|
221
392
|
];
|
|
393
|
+
/**
|
|
394
|
+
* @internal
|
|
395
|
+
*/
|
|
222
396
|
type Overflow = (typeof Overflows)[number];
|
|
397
|
+
/**
|
|
398
|
+
* @internal
|
|
399
|
+
*/
|
|
223
400
|
type Border = string;
|
|
401
|
+
/**
|
|
402
|
+
* @internal
|
|
403
|
+
*/
|
|
224
404
|
type BorderStyle = string;
|
|
405
|
+
/**
|
|
406
|
+
* @internal
|
|
407
|
+
*/
|
|
225
408
|
type BorderWidth = `${number}px`;
|
|
409
|
+
/**
|
|
410
|
+
* @internal
|
|
411
|
+
*/
|
|
226
412
|
type Style = string;
|
|
413
|
+
/**
|
|
414
|
+
* @internal
|
|
415
|
+
*/
|
|
227
416
|
type StateName = string;
|
|
417
|
+
/**
|
|
418
|
+
* @internal
|
|
419
|
+
*/
|
|
228
420
|
declare const WritingModes: readonly [
|
|
229
421
|
"horizontal-tb",
|
|
230
422
|
"vertical-lr"
|
|
231
423
|
];
|
|
424
|
+
/**
|
|
425
|
+
* @internal
|
|
426
|
+
*/
|
|
232
427
|
type WritingMode = (typeof WritingModes)[number];
|
|
428
|
+
/**
|
|
429
|
+
* @internal
|
|
430
|
+
*/
|
|
233
431
|
declare const ListSeparatorTypes: readonly [
|
|
234
432
|
"none",
|
|
235
433
|
"border",
|
|
@@ -239,24 +437,51 @@ type ListSeparatorType = (typeof ListSeparatorTypes)[number];
|
|
|
239
437
|
interface BaseListSeparator {
|
|
240
438
|
type: ListSeparatorType;
|
|
241
439
|
}
|
|
440
|
+
/**
|
|
441
|
+
* @internal
|
|
442
|
+
*/
|
|
242
443
|
interface ListSeparatorNone extends BaseListSeparator {
|
|
243
444
|
type: "none";
|
|
244
445
|
}
|
|
446
|
+
/**
|
|
447
|
+
* @internal
|
|
448
|
+
*/
|
|
245
449
|
interface ListSeparatorBorder extends BaseListSeparator {
|
|
246
450
|
type: "border";
|
|
247
451
|
borderStyle: BorderStyle;
|
|
248
452
|
borderWidth?: BorderWidth;
|
|
249
453
|
borderColor?: Color;
|
|
250
454
|
}
|
|
455
|
+
/**
|
|
456
|
+
* @internal
|
|
457
|
+
*/
|
|
251
458
|
interface ListSeparatorGap extends BaseListSeparator {
|
|
252
459
|
type: "gap";
|
|
253
460
|
gap: Length;
|
|
254
461
|
}
|
|
462
|
+
/**
|
|
463
|
+
* @internal
|
|
464
|
+
*/
|
|
255
465
|
type ListSeparator = ListSeparatorNone | ListSeparatorBorder | ListSeparatorGap;
|
|
466
|
+
/**
|
|
467
|
+
* @internal
|
|
468
|
+
*/
|
|
256
469
|
declare const DefaultListSeparatorNone: Required<ListSeparatorNone>;
|
|
470
|
+
/**
|
|
471
|
+
* @internal
|
|
472
|
+
*/
|
|
257
473
|
declare const DefaultListSeparatorBorder: Required<ListSeparatorBorder>;
|
|
474
|
+
/**
|
|
475
|
+
* @internal
|
|
476
|
+
*/
|
|
258
477
|
declare const DefaultListSeparatorGap: Required<ListSeparatorGap>;
|
|
478
|
+
/**
|
|
479
|
+
* @internal
|
|
480
|
+
*/
|
|
259
481
|
declare const DefaultListSeparator: Required<ListSeparatorBorder>;
|
|
482
|
+
/**
|
|
483
|
+
* @internal
|
|
484
|
+
*/
|
|
260
485
|
declare const ListBackgroundTypes: readonly [
|
|
261
486
|
"none",
|
|
262
487
|
"stripe"
|
|
@@ -265,23 +490,50 @@ type ListBackgroundType = (typeof ListBackgroundTypes)[number];
|
|
|
265
490
|
interface BaseListBackground {
|
|
266
491
|
type: ListBackgroundType;
|
|
267
492
|
}
|
|
493
|
+
/**
|
|
494
|
+
* @internal
|
|
495
|
+
*/
|
|
268
496
|
interface ListBackgroundNone extends BaseListBackground {
|
|
269
497
|
type: "none";
|
|
270
498
|
}
|
|
499
|
+
/**
|
|
500
|
+
* @internal
|
|
501
|
+
*/
|
|
271
502
|
interface ListBackgroundStripe extends BaseListBackground {
|
|
272
503
|
type: "stripe";
|
|
273
504
|
background1?: Color;
|
|
274
505
|
background2?: Color;
|
|
275
506
|
}
|
|
507
|
+
/**
|
|
508
|
+
* @internal
|
|
509
|
+
*/
|
|
276
510
|
type ListBackground = ListBackgroundNone | ListBackgroundStripe;
|
|
511
|
+
/**
|
|
512
|
+
* @internal
|
|
513
|
+
*/
|
|
277
514
|
declare const DefaultListBackgroundNone: Required<ListBackgroundNone>;
|
|
515
|
+
/**
|
|
516
|
+
* @internal
|
|
517
|
+
*/
|
|
278
518
|
declare const DefaultListBackgroundStripe: Required<ListBackgroundStripe>;
|
|
519
|
+
/**
|
|
520
|
+
* @internal
|
|
521
|
+
*/
|
|
279
522
|
declare const DefaultListBackground: Required<ListBackgroundNone>;
|
|
523
|
+
/**
|
|
524
|
+
* @internal
|
|
525
|
+
*/
|
|
280
526
|
declare const ListDirections: readonly [
|
|
281
527
|
"vertical",
|
|
282
528
|
"horizontal"
|
|
283
529
|
];
|
|
530
|
+
/**
|
|
531
|
+
* @internal
|
|
532
|
+
*/
|
|
284
533
|
type ListDirection = (typeof ListDirections)[number];
|
|
534
|
+
/**
|
|
535
|
+
* @internal
|
|
536
|
+
*/
|
|
285
537
|
type ListContext = {
|
|
286
538
|
separator: ListSeparator;
|
|
287
539
|
background: ListBackground;
|
|
@@ -297,7 +549,9 @@ type ListContext = {
|
|
|
297
549
|
// Wrap svelte tools
|
|
298
550
|
type Store<T> = Writable_<T>;
|
|
299
551
|
/**
|
|
300
|
-
*
|
|
552
|
+
* get store state value
|
|
553
|
+
*
|
|
554
|
+
* @deprecated 非推奨
|
|
301
555
|
*/
|
|
302
556
|
declare const getStoreState: typeof get_;
|
|
303
557
|
type SystemConfig = {
|
|
@@ -320,13 +574,16 @@ type CustomVariables = {
|
|
|
320
574
|
declare const actionSetting: Store<ActionSetting>;
|
|
321
575
|
/**
|
|
322
576
|
* {@link getActionSetting} function to get action setting.
|
|
323
|
-
*
|
|
577
|
+
*
|
|
578
|
+
* @returns Current action setting
|
|
324
579
|
*/
|
|
325
580
|
declare function getActionSetting(): ActionSetting;
|
|
326
581
|
/**
|
|
327
582
|
* {@link setActionSetting} function to "update" action setting
|
|
328
|
-
*
|
|
329
|
-
* @
|
|
583
|
+
*
|
|
584
|
+
* @param setting - Updated action setting
|
|
585
|
+
*
|
|
586
|
+
* @returns New action setting
|
|
330
587
|
*/
|
|
331
588
|
declare function setActionSetting(setting: ActionSetting): ActionSetting;
|
|
332
589
|
/**
|
|
@@ -339,7 +596,8 @@ declare function resetActionSetting(): void;
|
|
|
339
596
|
declare const system: Store<SystemConfig>;
|
|
340
597
|
/**
|
|
341
598
|
* {@link getSystem} function to get KARTE system config.
|
|
342
|
-
*
|
|
599
|
+
*
|
|
600
|
+
* @returns Current karte system config
|
|
343
601
|
*/
|
|
344
602
|
declare function getSystem(): SystemConfig;
|
|
345
603
|
/**
|
|
@@ -359,7 +617,8 @@ declare const state: Store<string>;
|
|
|
359
617
|
declare function setState(stateId: string, force?: boolean): void;
|
|
360
618
|
/**
|
|
361
619
|
* {@link getState} function to get current state ID.
|
|
362
|
-
*
|
|
620
|
+
*
|
|
621
|
+
* @returns Current state ID
|
|
363
622
|
*/
|
|
364
623
|
declare function getState(): string;
|
|
365
624
|
/**
|
|
@@ -368,12 +627,14 @@ declare function getState(): string;
|
|
|
368
627
|
declare const states: Store<string[]>;
|
|
369
628
|
/**
|
|
370
629
|
* {@link getStates} function to add new state ID to list of state IDs.
|
|
371
|
-
*
|
|
630
|
+
*
|
|
631
|
+
* @param stateId - New state ID
|
|
372
632
|
*/
|
|
373
633
|
declare function addState(stateId: string): void;
|
|
374
634
|
/**
|
|
375
635
|
* {@link getStates} function to get a list of all state IDs.
|
|
376
|
-
*
|
|
636
|
+
*
|
|
637
|
+
* @returns All state IDs
|
|
377
638
|
*/
|
|
378
639
|
declare function getStates(): string[];
|
|
379
640
|
/**
|
|
@@ -382,7 +643,8 @@ declare function getStates(): string[];
|
|
|
382
643
|
declare const opened: Store<boolean>;
|
|
383
644
|
/**
|
|
384
645
|
* {@link isOpened} function to check if action is opened.
|
|
385
|
-
*
|
|
646
|
+
*
|
|
647
|
+
* @returns Flag if action is opend / true: Opend, false: Not opened
|
|
386
648
|
*/
|
|
387
649
|
declare function isOpened(): boolean;
|
|
388
650
|
/**
|
|
@@ -392,19 +654,21 @@ declare function setOpened(on: boolean): void;
|
|
|
392
654
|
/**
|
|
393
655
|
* Store to handle visibility of action
|
|
394
656
|
*
|
|
395
|
-
* @deprecated
|
|
657
|
+
* @deprecated 非推奨
|
|
396
658
|
*/
|
|
397
659
|
declare const closed: Store<boolean>; // deprecated
|
|
398
660
|
/**
|
|
399
661
|
* {@link isClosed} function to check if action is clsoed.
|
|
400
|
-
*
|
|
401
|
-
* @
|
|
662
|
+
*
|
|
663
|
+
* @returns Flag if action is closed / true: Closed, false: Not closed
|
|
664
|
+
*
|
|
665
|
+
* @deprecated 非推奨
|
|
402
666
|
*/
|
|
403
667
|
declare function isClosed(): boolean;
|
|
404
668
|
/**
|
|
405
669
|
* {@link setClosed} function to set if action is closed.
|
|
406
670
|
*
|
|
407
|
-
* @deprecated
|
|
671
|
+
* @deprecated 非推奨
|
|
408
672
|
*/
|
|
409
673
|
declare function setClosed(on: boolean): void;
|
|
410
674
|
/**
|
|
@@ -412,7 +676,7 @@ declare function setClosed(on: boolean): void;
|
|
|
412
676
|
*/
|
|
413
677
|
declare const maximumZindex: Store<number>;
|
|
414
678
|
/**
|
|
415
|
-
*
|
|
679
|
+
* Set maximum z-index.
|
|
416
680
|
*/
|
|
417
681
|
declare const setMaximumZindex: (zindex?: number) => void;
|
|
418
682
|
/**
|
|
@@ -425,7 +689,8 @@ declare const internalHandlers: Store<{
|
|
|
425
689
|
}>;
|
|
426
690
|
/**
|
|
427
691
|
* {@link getInternalHandlers} function to get internal event handlers.
|
|
428
|
-
*
|
|
692
|
+
*
|
|
693
|
+
* @returns Current internal handlers
|
|
429
694
|
*/
|
|
430
695
|
declare function getInternalHandlers(): {
|
|
431
696
|
[key: string]: ActionEventHandler[];
|
|
@@ -438,8 +703,10 @@ declare function setInternalHandlers(handlers: {
|
|
|
438
703
|
}): void;
|
|
439
704
|
/**
|
|
440
705
|
* {@link updateInternalHandlers} function to update internal event handlers.
|
|
441
|
-
*
|
|
442
|
-
* @
|
|
706
|
+
*
|
|
707
|
+
* @param handlers - Updated internal event handlers
|
|
708
|
+
*
|
|
709
|
+
* @returns New internal handlers
|
|
443
710
|
*/
|
|
444
711
|
declare function updateInternalHandlers(handlers: {
|
|
445
712
|
[key: string]: ActionEventHandler[];
|
|
@@ -456,22 +723,26 @@ declare const customHandlers: Store<{
|
|
|
456
723
|
}>;
|
|
457
724
|
/**
|
|
458
725
|
* {@link getCustomHandlers} function to get custom event handlers.
|
|
459
|
-
*
|
|
726
|
+
*
|
|
727
|
+
* @returns Current custom event handlers
|
|
460
728
|
*/
|
|
461
729
|
declare function getCustomHandlers(): {
|
|
462
730
|
[key: string]: ActionEventHandler;
|
|
463
731
|
};
|
|
464
732
|
/**
|
|
465
733
|
* {@link setCustomHandlers} function to set custom event handlers.
|
|
466
|
-
*
|
|
734
|
+
*
|
|
735
|
+
* @param handlers - New custom event handlers
|
|
467
736
|
*/
|
|
468
737
|
declare function setCustomHandlers(handlers: {
|
|
469
738
|
[key: string]: ActionEventHandler;
|
|
470
739
|
}): void;
|
|
471
740
|
/**
|
|
472
741
|
* {@link updateCustomHandlers} function to update custom event handlers.
|
|
473
|
-
*
|
|
474
|
-
* @
|
|
742
|
+
*
|
|
743
|
+
* @param handlers - Updated custom event handlers
|
|
744
|
+
*
|
|
745
|
+
* @returns New custom event handlers
|
|
475
746
|
*/
|
|
476
747
|
declare function updateCustomHandlers(handlers: {
|
|
477
748
|
[key: string]: ActionEventHandler;
|
|
@@ -484,7 +755,8 @@ declare function updateCustomHandlers(handlers: {
|
|
|
484
755
|
declare const destroyed: Store<boolean>;
|
|
485
756
|
/**
|
|
486
757
|
* {@link isDestroyed} function to check if action is destroyed.
|
|
487
|
-
*
|
|
758
|
+
*
|
|
759
|
+
* @returns Flag if action is destoryed / true: Destroyed, false: Not Destroyed
|
|
488
760
|
*/
|
|
489
761
|
declare function isDestroyed(): boolean;
|
|
490
762
|
/**
|
|
@@ -496,7 +768,8 @@ declare function setDestroyed(on: boolean): void;
|
|
|
496
768
|
declare const stopped: Store<boolean>;
|
|
497
769
|
/**
|
|
498
770
|
* {@link isStopped} function to check if action is stopped.
|
|
499
|
-
*
|
|
771
|
+
*
|
|
772
|
+
* @returns Flag if action is stopped / true: Stopped, false: Not stopped
|
|
500
773
|
*/
|
|
501
774
|
declare function isStopped(): boolean;
|
|
502
775
|
/**
|
|
@@ -511,18 +784,22 @@ declare const customVariables: Store<{
|
|
|
511
784
|
}>;
|
|
512
785
|
/**
|
|
513
786
|
* {@link getCustomVariables} function to get custom variables.
|
|
514
|
-
*
|
|
787
|
+
*
|
|
788
|
+
* @returns Current custom variables
|
|
515
789
|
*/
|
|
516
790
|
declare function getCustomVariables(): CustomVariables;
|
|
517
791
|
/**
|
|
518
792
|
* {@link setCustomVariables} function to set custom variables.
|
|
519
|
-
*
|
|
793
|
+
*
|
|
794
|
+
* @param variables - New custom variables
|
|
520
795
|
*/
|
|
521
796
|
declare function setCustomVariables(variables: CustomVariables): void;
|
|
522
797
|
/**
|
|
523
798
|
* {@link updateCustomVariables} function to update custom variables.
|
|
524
|
-
*
|
|
525
|
-
* @
|
|
799
|
+
*
|
|
800
|
+
* @param variables - Updated custom variables
|
|
801
|
+
*
|
|
802
|
+
* @returns New custom variables
|
|
526
803
|
*/
|
|
527
804
|
declare function updateCustomVariables(variables: CustomVariables): CustomVariables;
|
|
528
805
|
interface FormData {
|
|
@@ -574,21 +851,23 @@ interface CustomAnimationOptions {
|
|
|
574
851
|
/**
|
|
575
852
|
* A waiting time in milliseconds before starting animation
|
|
576
853
|
*
|
|
577
|
-
* @
|
|
854
|
+
* @defaultValue 0
|
|
578
855
|
*/
|
|
579
856
|
delay?: number;
|
|
580
857
|
/**
|
|
581
858
|
* A total duration time in milliseconds of the animation
|
|
582
859
|
*
|
|
583
|
-
* @
|
|
860
|
+
* @defaultValue 1000
|
|
584
861
|
*/
|
|
585
862
|
duration?: number;
|
|
586
863
|
}
|
|
587
864
|
/**
|
|
588
865
|
* The function to activate svelte animation.
|
|
866
|
+
*
|
|
867
|
+
* @param node - A target node of animation. This argument is passed by svelte, by default.
|
|
868
|
+
* @param customAnimationOptions - A custom animation option object
|
|
869
|
+
*
|
|
589
870
|
* @see {@link https://svelte.dev/docs#template-syntax-element-directives-transition-fn-custom-transition-functions| Custom transition functions} for detail documentation
|
|
590
|
-
* @param {Element} node A target node of animation. This argument is passed by svelte, by default.
|
|
591
|
-
* @param {CustomAnimationOptions} customAnimationOptions A custom animation option object
|
|
592
871
|
*/
|
|
593
872
|
declare function customAnimation(node: Element, { transform, animationStyle, delay, duration }: CustomAnimationOptions): {
|
|
594
873
|
delay?: undefined;
|
|
@@ -604,39 +883,46 @@ declare function customAnimation(node: Element, { transform, animationStyle, del
|
|
|
604
883
|
/**
|
|
605
884
|
* {@link loadGlobalScript} load JavaScript that does not support ESM.
|
|
606
885
|
*
|
|
607
|
-
* @param
|
|
886
|
+
* @param src - Link of JavaScript file
|
|
608
887
|
*/
|
|
609
888
|
declare function loadGlobalScript(src: string): Promise<any>;
|
|
610
889
|
/**
|
|
611
890
|
* {@link applyGlobalCss} apply global CSS to WEB page.
|
|
612
891
|
*
|
|
613
|
-
* @param
|
|
892
|
+
* @param css - CSS
|
|
614
893
|
*/
|
|
615
894
|
declare function applyGlobalCss(css: string): Promise<any>;
|
|
616
895
|
/**
|
|
617
896
|
* {@link loadGlobalStyle} load global style to WEB page.
|
|
618
897
|
*
|
|
619
|
-
* @param
|
|
898
|
+
* @param href - Link of style file
|
|
620
899
|
*/
|
|
621
900
|
declare function loadGlobalStyle(href: string): Promise<any>;
|
|
622
901
|
/**
|
|
623
902
|
* {@link hashCode} generate hash with FNV-1a hash
|
|
624
903
|
*
|
|
625
|
-
* @param
|
|
626
|
-
*
|
|
904
|
+
* @param s - Inputed string
|
|
905
|
+
*
|
|
906
|
+
* @returns Hashed string
|
|
907
|
+
*
|
|
627
908
|
* @see https://stackoverflow.com/a/22429679
|
|
628
909
|
*/
|
|
629
910
|
declare function hashCode(s: string): string;
|
|
630
911
|
/**
|
|
631
912
|
* {@link setAutoStart} function to set auto start flag.
|
|
632
913
|
*
|
|
633
|
-
*
|
|
914
|
+
* @param on - true: auto start, false: not auto start
|
|
634
915
|
*
|
|
635
|
-
* @deprecated
|
|
636
|
-
* @param {boolean} on
|
|
916
|
+
* @deprecated 非推奨。`setActionConfig({ autoStart: false })` を使ってください。
|
|
637
917
|
*/
|
|
638
918
|
declare const setAutoStart: (on?: boolean) => void;
|
|
639
|
-
|
|
919
|
+
/**
|
|
920
|
+
* @internal
|
|
921
|
+
*/
|
|
922
|
+
declare const NOOP: Function; // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
923
|
+
/**
|
|
924
|
+
* @internal
|
|
925
|
+
*/
|
|
640
926
|
declare const isPreview: () => boolean;
|
|
641
927
|
declare const handleFocus: (node: HTMLElement | null) => (e: any) => void;
|
|
642
928
|
declare const setPreviousFocus: () => void;
|
|
@@ -650,54 +936,57 @@ declare const getTransform: (position: ModalPosition) => [
|
|
|
650
936
|
];
|
|
651
937
|
declare const getMarginStyle: (margin: ModalMargin) => string;
|
|
652
938
|
/**
|
|
653
|
-
*
|
|
939
|
+
* スクロール方向
|
|
654
940
|
*/
|
|
655
941
|
type ScrollDirection = "up" | "down";
|
|
656
942
|
/**
|
|
657
|
-
*
|
|
943
|
+
* {@link onScroll} のスクロールコンテキスト情報
|
|
944
|
+
*
|
|
945
|
+
* @remarks
|
|
946
|
+
* このコンテキスト情報は、{@link OnScrollFunction} が呼び出されたタイミングの情報が格納されています
|
|
658
947
|
*/
|
|
659
948
|
interface OnScrollContext {
|
|
660
949
|
/**
|
|
661
|
-
*
|
|
950
|
+
* {@link onScroll} によって指定されたスクロール率
|
|
662
951
|
*/
|
|
663
952
|
rate: number;
|
|
664
953
|
/**
|
|
665
|
-
*
|
|
954
|
+
* ページのスクロール率
|
|
666
955
|
*/
|
|
667
956
|
scrollRate: number;
|
|
668
957
|
/**
|
|
669
|
-
*
|
|
958
|
+
* 前のスクロール率
|
|
670
959
|
*/
|
|
671
960
|
previousRate: number;
|
|
672
961
|
/**
|
|
673
|
-
*
|
|
962
|
+
* 現在のスクロール率と前のスクロール率との差分値
|
|
674
963
|
*/
|
|
675
964
|
deltaRate: number;
|
|
676
965
|
/**
|
|
677
|
-
*
|
|
966
|
+
* スクロール方向
|
|
678
967
|
*/
|
|
679
968
|
direction: ScrollDirection;
|
|
680
969
|
}
|
|
681
970
|
/**
|
|
682
|
-
*
|
|
971
|
+
* {@link onScroll} によって呼び出されるコールバック関数
|
|
683
972
|
*/
|
|
684
973
|
type OnScrollFunction = (ctx: OnScrollContext) => boolean;
|
|
685
974
|
/**
|
|
686
|
-
*
|
|
975
|
+
* スクロール率が達したときに呼び出すコールバックを登録します
|
|
687
976
|
*
|
|
688
|
-
* @param rate -
|
|
689
|
-
* @param fn -
|
|
977
|
+
* @param rate - スクロール率。この値は viewport でのスクロールのパーセンテージ
|
|
978
|
+
* @param fn - スクロール率が達したときに呼び出されるコールバック関数
|
|
690
979
|
*
|
|
691
|
-
* @returns
|
|
980
|
+
* @returns スクロール率によって呼び出されるコールバックを停止する関数を返します
|
|
692
981
|
*/
|
|
693
982
|
declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
|
|
694
983
|
/**
|
|
695
|
-
*
|
|
984
|
+
* 指定した時間の経過後に呼び出すコールバックを登録します
|
|
696
985
|
*
|
|
697
|
-
* @param time -
|
|
698
|
-
* @param fn -
|
|
986
|
+
* @param time - コールバックを呼び出すまでの時間。単位はミリセカンド(ms)
|
|
987
|
+
* @param fn - 指定した時間が経過後に呼び出されるコールバック関数
|
|
699
988
|
*
|
|
700
|
-
* @returns
|
|
989
|
+
* @returns コールバックを呼び出すためのタイマーを停止する関数を返します
|
|
701
990
|
*/
|
|
702
991
|
declare function onTime(time: number, fn: Function): () => void;
|
|
703
992
|
declare function hasSuffix<Suffix extends "px" | "em" | "rem" | "%" | "fr" | "vw" | "vh" | "">(value: string, suffix: Suffix): value is `${number}${Suffix}`;
|
|
@@ -719,57 +1008,64 @@ interface _Props {
|
|
|
719
1008
|
hide_on_time_count?: number;
|
|
720
1009
|
}
|
|
721
1010
|
/**
|
|
722
|
-
*
|
|
1011
|
+
* スクロールに応じてアクションを非表示にするトリガー関数
|
|
723
1012
|
*
|
|
724
|
-
* @
|
|
725
|
-
*
|
|
726
|
-
*
|
|
1013
|
+
* @remarks
|
|
1014
|
+
* スクロール率が `hide_on_scroll_rate` に達したときに `hide` 関数を呼び出します。
|
|
1015
|
+
* `show_on_scroll_reenter` が `true` で、かつ `hide_on_scroll_rate` またはその値以下の場合、アクションに対して `show` 関数が呼び出されます。
|
|
727
1016
|
*
|
|
728
|
-
* @
|
|
729
|
-
*
|
|
730
|
-
*
|
|
1017
|
+
* @param props - アクションのプロパティ。プロパティには `hide_on_scroll`、`hide_on_scroll_rate` そして `show_on_scroll_reenter` が必要です。
|
|
1018
|
+
* @param hide - アクションを非表示にするロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
1019
|
+
* @param show - アクションを再び表示するロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
731
1020
|
*
|
|
732
|
-
* @returns
|
|
1021
|
+
* @returns
|
|
1022
|
+
* スクロールが開始された場合は、クリーンアップする関数を返します。そうでない場合は `null` を返します。
|
|
733
1023
|
*/
|
|
734
|
-
declare function hideOnScroll<Props extends Pick<_Props, "hide_on_scroll" | "hide_on_scroll_rate" | "show_on_scroll_reenter">>(
|
|
1024
|
+
declare function hideOnScroll<Props extends Pick<_Props, "hide_on_scroll" | "hide_on_scroll_rate" | "show_on_scroll_reenter">>(props: Props, hide?: Function, show?: Function): (() => void) | null;
|
|
735
1025
|
/**
|
|
736
|
-
*
|
|
1026
|
+
* 時間に応じてアクションを非表示にするトリガー関数
|
|
737
1027
|
*
|
|
738
|
-
* @
|
|
739
|
-
*
|
|
1028
|
+
* @remarks
|
|
1029
|
+
* 時間のカウントが `hide_on_time_count` に達したときに `hide` 関数を呼び出します。
|
|
740
1030
|
*
|
|
741
|
-
* @
|
|
742
|
-
*
|
|
1031
|
+
* @param props - アクションのプロパティ。プロパティには `hide_on_time` そして `hide_on_time_count` が必要です。
|
|
1032
|
+
* @param hide - アクションを非表示にするロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
743
1033
|
*
|
|
744
|
-
* @returns
|
|
1034
|
+
* @returns
|
|
1035
|
+
* タイマーが開始された場合、タイマーをクリーンアップする関数を返します。それ以外は `null` を返します。
|
|
745
1036
|
*/
|
|
746
1037
|
declare function hideOnTime<Props extends Pick<_Props, "hide_on_time" | "hide_on_time_count">>(props: Props, hide?: Function): (() => void) | null;
|
|
747
1038
|
/**
|
|
748
|
-
*
|
|
1039
|
+
* スクロールに応じてアクションを表示するトリガー関数
|
|
749
1040
|
*
|
|
750
|
-
* @
|
|
751
|
-
*
|
|
752
|
-
*
|
|
1041
|
+
* @remarks
|
|
1042
|
+
* スクロール率が `show_on_scroll_rate` に達したときに `show` 関数を呼び出します。
|
|
1043
|
+
* `hide_on_scroll_releave` が `true` で、かつ `show_on_scroll_rate` 以下の場合は、アクションに対して `hide` 関数が呼び出されます。
|
|
753
1044
|
*
|
|
754
|
-
* @
|
|
755
|
-
*
|
|
756
|
-
*
|
|
1045
|
+
* @param props - アクションのプロパティ。プロパティには `show_on_scroll`、`show_on_scroll_rate` そして `hide_on_scroll_releave` が必要です。
|
|
1046
|
+
* @param show - アクションを表示するロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
1047
|
+
* @param hide - アクションを非表示にするロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
757
1048
|
*
|
|
758
|
-
* @returns
|
|
1049
|
+
* @returns
|
|
1050
|
+
* スクロールが開始されている場合は、クリーンアップ関数を返します。そうでない場合は `null` を返します
|
|
759
1051
|
*/
|
|
760
|
-
declare function showOnScroll<Props extends Pick<_Props, "show_on_scroll" | "show_on_scroll_rate" | "hide_on_scroll_releave">>(
|
|
1052
|
+
declare function showOnScroll<Props extends Pick<_Props, "show_on_scroll" | "show_on_scroll_rate" | "hide_on_scroll_releave">>(props: Props, show?: Function, hide?: Function): (() => void) | null;
|
|
761
1053
|
/**
|
|
762
|
-
*
|
|
1054
|
+
* 時間に応じてアクションを表示するトリガー関数
|
|
763
1055
|
*
|
|
764
|
-
* @param props -
|
|
765
|
-
* @param show -
|
|
1056
|
+
* @param props - アクションのプロパティ。プロパティには `show_on_time` そして `show_on_time_count` が必要です。
|
|
1057
|
+
* @param show - アクションを表示するロジックが実装された関数。指定ない場合は noop 関数が使用されます。
|
|
766
1058
|
*
|
|
767
|
-
* @
|
|
768
|
-
*
|
|
1059
|
+
* @remarks
|
|
1060
|
+
* 時間のカウントが `show_on_time_count` に達したときに `show` 関数を呼び出します。
|
|
769
1061
|
*
|
|
770
|
-
* @returns
|
|
1062
|
+
* @returns
|
|
1063
|
+
* タイマーが開始された場合、タイマーをクリーンアップする関数を返します。それ以外は `null` を返します。
|
|
771
1064
|
*/
|
|
772
1065
|
declare function showOnTime<Props extends Pick<_Props, "show_on_time" | "show_on_time_count">>(props: Props, show?: Function): (() => void) | null;
|
|
1066
|
+
/**
|
|
1067
|
+
* @internal
|
|
1068
|
+
*/
|
|
773
1069
|
interface ActionProps<Props, Variables> {
|
|
774
1070
|
send: (event_name: string, values?: any) => void;
|
|
775
1071
|
data: Props & Variables & CustomVariables;
|
|
@@ -777,45 +1073,51 @@ interface ActionProps<Props, Variables> {
|
|
|
777
1073
|
onChangeState?: (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
|
|
778
1074
|
}
|
|
779
1075
|
/**
|
|
780
|
-
*
|
|
1076
|
+
* {@link create} 向けのオプション
|
|
1077
|
+
*
|
|
1078
|
+
* @public
|
|
781
1079
|
*/
|
|
782
1080
|
interface ActionOptions<Props, Variables> {
|
|
783
1081
|
/**
|
|
784
|
-
*
|
|
1082
|
+
* KARTE アクションでイベントがトリガーされたときに受信するための関数
|
|
785
1083
|
*
|
|
786
|
-
* @
|
|
1084
|
+
* @defaultValue `() => {}`
|
|
787
1085
|
*/
|
|
788
1086
|
send?: (event_name: string, values?: any) => void;
|
|
789
1087
|
/**
|
|
790
|
-
*
|
|
1088
|
+
* KARTE アクションで使用されるプロパティ
|
|
791
1089
|
*
|
|
792
|
-
* @
|
|
1090
|
+
* @defaultValue `{}`
|
|
793
1091
|
*/
|
|
794
1092
|
props?: Props;
|
|
795
1093
|
/**
|
|
796
|
-
*
|
|
1094
|
+
* KARTE アクションで使用されるアクションテーブルのユーザー環境変数
|
|
797
1095
|
*
|
|
798
|
-
* @
|
|
1096
|
+
* @defaultValue `{}`
|
|
799
1097
|
*/
|
|
800
1098
|
variables?: Variables;
|
|
801
1099
|
/**
|
|
802
|
-
* {@link
|
|
1100
|
+
* KARTE アクションでアクションが作成されているときにフックされる {@link onCreate}
|
|
803
1101
|
*
|
|
804
|
-
* @
|
|
1102
|
+
* @defaultValue `() => {}`
|
|
805
1103
|
*/
|
|
806
1104
|
onCreate?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
|
|
807
1105
|
}
|
|
808
1106
|
/**
|
|
809
|
-
*
|
|
1107
|
+
* KARTE アクションを作成する
|
|
810
1108
|
*
|
|
811
|
-
* @param App -
|
|
812
|
-
* @param options -
|
|
1109
|
+
* @param App - Svelte コンポーネントのエントリポイント
|
|
1110
|
+
* @param options - {@link ActionOptions | オプション}
|
|
813
1111
|
*
|
|
814
|
-
* @
|
|
1112
|
+
* @returns KARTE アクションを破棄する関数
|
|
1113
|
+
*
|
|
1114
|
+
* @public
|
|
815
1115
|
*/
|
|
816
1116
|
declare function create<Props extends _Props, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
|
|
817
1117
|
/**
|
|
818
1118
|
* Dispatch the event to destroy KARTE action
|
|
1119
|
+
*
|
|
1120
|
+
* @internal
|
|
819
1121
|
*/
|
|
820
1122
|
declare function dispatchDestroyEvent(): void;
|
|
821
1123
|
/**
|
|
@@ -835,60 +1137,76 @@ declare const KARTE_ACTION_RID = "karte-action-rid";
|
|
|
835
1137
|
declare const KARTE_ACTION_SHORTEN_ID = "karte-action-id";
|
|
836
1138
|
declare function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
|
|
837
1139
|
/**
|
|
838
|
-
*
|
|
1140
|
+
* KARTE アクションのライフサイクルで呼び出されるフック
|
|
839
1141
|
*
|
|
840
|
-
* @param
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
* @param {ActionProps<Props, Variables & CustomVariables>} props Properties of KARTE action
|
|
844
|
-
* @returns {void|Promise<void>}
|
|
1142
|
+
* @param props - KARTE アクションのプロパティ
|
|
1143
|
+
*
|
|
1144
|
+
* @public
|
|
845
1145
|
*/
|
|
846
|
-
|
|
1146
|
+
type ActionHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
|
|
847
1147
|
/**
|
|
848
|
-
*
|
|
1148
|
+
* アクションが作成 (create) される前にフックする
|
|
849
1149
|
*
|
|
850
|
-
* @param
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
* @param {ActionProps<Props, Variables & CustomVariables>} props Properties of KARTE action
|
|
854
|
-
* @returns {void|Promise<void>}
|
|
1150
|
+
* @param fn - 呼び出されるフック関数
|
|
1151
|
+
*
|
|
1152
|
+
* @public
|
|
855
1153
|
*/
|
|
856
|
-
|
|
1154
|
+
declare function onCreate<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
857
1155
|
/**
|
|
858
|
-
*
|
|
1156
|
+
* アクションが表示 (show) された後にフックする
|
|
859
1157
|
*
|
|
860
|
-
* @param
|
|
861
|
-
*
|
|
1158
|
+
* @param fn - 呼び出されるフック関数
|
|
1159
|
+
*
|
|
1160
|
+
* @public
|
|
862
1161
|
*/
|
|
863
|
-
declare function
|
|
864
|
-
|
|
865
|
-
*
|
|
1162
|
+
declare function onShow<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
1163
|
+
/**
|
|
1164
|
+
* KARTE アクションのライフサイクル close で呼び出されるフック
|
|
1165
|
+
*
|
|
1166
|
+
* @param props - KARTE アクションのプロパティ
|
|
1167
|
+
* @param trigger - Close トリガー
|
|
1168
|
+
*
|
|
1169
|
+
* @public
|
|
866
1170
|
*/
|
|
867
|
-
|
|
1171
|
+
type ActionCloseHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, trigger: CloseTrigger) => void | Promise<void>;
|
|
868
1172
|
/**
|
|
869
|
-
*
|
|
1173
|
+
* アクションがクローズ (close) される前にフックする
|
|
870
1174
|
*
|
|
871
|
-
* @param
|
|
1175
|
+
* @param fn - 呼び出されるフック関数
|
|
1176
|
+
*
|
|
1177
|
+
* @public
|
|
872
1178
|
*/
|
|
873
|
-
declare function
|
|
874
|
-
|
|
875
|
-
*
|
|
1179
|
+
declare function onClose<Props extends _Props, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
|
|
1180
|
+
/**
|
|
1181
|
+
* アクションが破棄 (destroy) される前にフックする
|
|
1182
|
+
*
|
|
1183
|
+
* @param fn - 呼び出されるフック関数
|
|
1184
|
+
*
|
|
1185
|
+
* @public
|
|
876
1186
|
*/
|
|
877
|
-
|
|
1187
|
+
declare function onDestroy<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
878
1188
|
/**
|
|
879
|
-
*
|
|
1189
|
+
* KARTE アクションのライフサイクル changeState で呼び出されるフック関数
|
|
1190
|
+
*
|
|
1191
|
+
* @param props - KARTE アクションのプロパティ
|
|
1192
|
+
* @param newState - KARTE アクションの新しいステート
|
|
880
1193
|
*
|
|
881
|
-
* @
|
|
1194
|
+
* @public
|
|
882
1195
|
*/
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
*
|
|
886
|
-
*
|
|
1196
|
+
type ActionChangeStateHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
|
|
1197
|
+
/**
|
|
1198
|
+
* アクションのステートが変更された (changeState) 後にフックする
|
|
1199
|
+
*
|
|
1200
|
+
* @param fn - 呼び出されるフック関数
|
|
1201
|
+
*
|
|
1202
|
+
* @public
|
|
887
1203
|
*/
|
|
888
|
-
|
|
1204
|
+
declare function onChangeState<Props extends _Props, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
|
|
889
1205
|
declare const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
|
|
890
1206
|
/**
|
|
891
|
-
*
|
|
1207
|
+
* create a fog element
|
|
1208
|
+
*
|
|
1209
|
+
* @deprecated 非推奨
|
|
892
1210
|
*/
|
|
893
1211
|
declare function createFog({ color, opacity, zIndex, onclick }: {
|
|
894
1212
|
color?: string;
|
|
@@ -903,15 +1221,17 @@ type EmbedLogic = "replace" | "append" | "prepend" | "after" | "before";
|
|
|
903
1221
|
declare function embed(target: HTMLElement, replace: HTMLElement, embed_method: EmbedLogic): void;
|
|
904
1222
|
declare function getActionShadowRoot(): ShadowRoot | null;
|
|
905
1223
|
/**
|
|
906
|
-
*
|
|
1224
|
+
* KARTE アクションに CSS を適用する
|
|
907
1225
|
*
|
|
908
|
-
* @param
|
|
1226
|
+
* @param css - 適用する CSS
|
|
1227
|
+
*
|
|
1228
|
+
* @returns 適用された style 要素を返す Promise
|
|
909
1229
|
*/
|
|
910
|
-
declare function applyCss(css: string): Promise<
|
|
1230
|
+
declare function applyCss(css: string): Promise<HTMLStyleElement>;
|
|
911
1231
|
/**
|
|
912
|
-
*
|
|
1232
|
+
* KARTE アクションにグローバルなスタイルをロードする
|
|
913
1233
|
*
|
|
914
|
-
* @param
|
|
1234
|
+
* @param href - style ファイルのリンク先 URL
|
|
915
1235
|
*/
|
|
916
1236
|
declare function loadStyle(href: string): Promise<void>;
|
|
917
1237
|
// -------- The following codes are deprecated --------
|
|
@@ -923,14 +1243,16 @@ declare const show: typeof showAction; // deprecated
|
|
|
923
1243
|
declare const close: typeof closeAction; // deprecated
|
|
924
1244
|
/**
|
|
925
1245
|
* An options for {@link createApp}
|
|
926
|
-
*
|
|
1246
|
+
*
|
|
1247
|
+
* @deprecated 非推奨
|
|
927
1248
|
*/
|
|
928
1249
|
type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
|
|
929
1250
|
/**
|
|
930
1251
|
* App application instance that is with {@link createApp}
|
|
931
|
-
* @deprecated
|
|
932
1252
|
*
|
|
933
|
-
* @
|
|
1253
|
+
* @remarks Currently, svelte component is supported only.
|
|
1254
|
+
*
|
|
1255
|
+
* @deprecated 非推奨
|
|
934
1256
|
*/
|
|
935
1257
|
interface App {
|
|
936
1258
|
/**
|
|
@@ -944,12 +1266,13 @@ interface App {
|
|
|
944
1266
|
}
|
|
945
1267
|
/**
|
|
946
1268
|
* Create an application instance
|
|
947
|
-
* @deprecated
|
|
948
1269
|
*
|
|
949
1270
|
* @param App - An entry point of svelte component.
|
|
950
1271
|
* @param options - An {@link AppOptions | options}
|
|
951
1272
|
*
|
|
952
|
-
* @
|
|
1273
|
+
* @returns A function to close the modal
|
|
1274
|
+
*
|
|
1275
|
+
* @deprecated 非推奨
|
|
953
1276
|
*/
|
|
954
1277
|
declare function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
|
|
955
1278
|
declare const collection: (config: {
|
|
@@ -966,6 +1289,9 @@ declare const collection: (config: {
|
|
|
966
1289
|
set(key: string, value: string, cb: (err: Error | null) => void): void;
|
|
967
1290
|
};
|
|
968
1291
|
declare namespace widget {
|
|
1292
|
+
/**
|
|
1293
|
+
* @internal
|
|
1294
|
+
*/
|
|
969
1295
|
const PropTypes: readonly [
|
|
970
1296
|
"BooleanKeyword",
|
|
971
1297
|
"NumberKeyword",
|
|
@@ -987,17 +1313,38 @@ declare namespace widget {
|
|
|
987
1313
|
"ModalPlacement",
|
|
988
1314
|
"OnClick"
|
|
989
1315
|
];
|
|
1316
|
+
/**
|
|
1317
|
+
* @internal
|
|
1318
|
+
*/
|
|
990
1319
|
type PropType = (typeof PropTypes)[number];
|
|
1320
|
+
/**
|
|
1321
|
+
* @internal
|
|
1322
|
+
*/
|
|
991
1323
|
type Code = string;
|
|
1324
|
+
/**
|
|
1325
|
+
* @internal
|
|
1326
|
+
*/
|
|
992
1327
|
const MediaQueries: {
|
|
993
1328
|
[key: string]: string;
|
|
994
1329
|
};
|
|
1330
|
+
/**
|
|
1331
|
+
* @internal
|
|
1332
|
+
*/
|
|
995
1333
|
type MediaQuery = string;
|
|
1334
|
+
/**
|
|
1335
|
+
* @internal
|
|
1336
|
+
*/
|
|
996
1337
|
const Directions: readonly [
|
|
997
1338
|
"row",
|
|
998
1339
|
"column"
|
|
999
1340
|
];
|
|
1341
|
+
/**
|
|
1342
|
+
* @internal
|
|
1343
|
+
*/
|
|
1000
1344
|
type Direction = (typeof Directions)[number];
|
|
1345
|
+
/**
|
|
1346
|
+
* @internal
|
|
1347
|
+
*/
|
|
1001
1348
|
const AnimationStyles: readonly [
|
|
1002
1349
|
"none",
|
|
1003
1350
|
"fade",
|
|
@@ -1007,7 +1354,13 @@ declare namespace widget {
|
|
|
1007
1354
|
"slide-left",
|
|
1008
1355
|
"slide-right"
|
|
1009
1356
|
];
|
|
1357
|
+
/**
|
|
1358
|
+
* @internal
|
|
1359
|
+
*/
|
|
1010
1360
|
type AnimationStyle = (typeof AnimationStyles)[number];
|
|
1361
|
+
/**
|
|
1362
|
+
* @internal
|
|
1363
|
+
*/
|
|
1011
1364
|
const ModalPositions: readonly [
|
|
1012
1365
|
"top-left",
|
|
1013
1366
|
"top-center",
|
|
@@ -1020,35 +1373,62 @@ declare namespace widget {
|
|
|
1020
1373
|
"bottom-right",
|
|
1021
1374
|
"none"
|
|
1022
1375
|
];
|
|
1376
|
+
/**
|
|
1377
|
+
* @internal
|
|
1378
|
+
*/
|
|
1023
1379
|
type ModalPosition = (typeof ModalPositions)[number];
|
|
1380
|
+
/**
|
|
1381
|
+
* @internal
|
|
1382
|
+
*/
|
|
1024
1383
|
type ModalMargin = {
|
|
1025
1384
|
left?: string;
|
|
1026
1385
|
right?: string;
|
|
1027
1386
|
top?: string;
|
|
1028
1387
|
bottom?: string;
|
|
1029
1388
|
};
|
|
1389
|
+
/**
|
|
1390
|
+
* @internal
|
|
1391
|
+
*/
|
|
1030
1392
|
type ModalPlacement<M = ModalMargin> = {
|
|
1031
1393
|
position?: ModalPosition;
|
|
1032
1394
|
margin?: M;
|
|
1033
1395
|
backgroundOverlay?: boolean;
|
|
1034
1396
|
backgroundClick?: OnClickOperation;
|
|
1035
1397
|
};
|
|
1398
|
+
/**
|
|
1399
|
+
* @internal
|
|
1400
|
+
*/
|
|
1036
1401
|
const DefaultModalPlacement: Required<ModalPlacement<Required<ModalMargin>>>;
|
|
1402
|
+
/**
|
|
1403
|
+
* @internal
|
|
1404
|
+
*/
|
|
1037
1405
|
const Elasticities: readonly [
|
|
1038
1406
|
"none",
|
|
1039
1407
|
"vertical",
|
|
1040
1408
|
"horizontal"
|
|
1041
1409
|
];
|
|
1410
|
+
/**
|
|
1411
|
+
* @internal
|
|
1412
|
+
*/
|
|
1042
1413
|
type Elasticity = (typeof Elasticities)[number];
|
|
1414
|
+
/**
|
|
1415
|
+
* @internal
|
|
1416
|
+
*/
|
|
1043
1417
|
const ElasticityStyle: {
|
|
1044
1418
|
none: string;
|
|
1045
1419
|
vertical: string;
|
|
1046
1420
|
horizontal: string;
|
|
1047
1421
|
};
|
|
1422
|
+
/**
|
|
1423
|
+
* @internal
|
|
1424
|
+
*/
|
|
1048
1425
|
const TextDirections: readonly [
|
|
1049
1426
|
"horizontal",
|
|
1050
1427
|
"vertical"
|
|
1051
1428
|
];
|
|
1429
|
+
/**
|
|
1430
|
+
* @internal
|
|
1431
|
+
*/
|
|
1052
1432
|
type TextDirection = (typeof TextDirections)[number];
|
|
1053
1433
|
type OperationArgumentTypes = {
|
|
1054
1434
|
StringKeyword: string;
|
|
@@ -1059,6 +1439,9 @@ declare namespace widget {
|
|
|
1059
1439
|
Handler: string;
|
|
1060
1440
|
Trigger: string;
|
|
1061
1441
|
};
|
|
1442
|
+
/**
|
|
1443
|
+
* @internal
|
|
1444
|
+
*/
|
|
1062
1445
|
type OperationArgumentType = keyof OperationArgumentTypes;
|
|
1063
1446
|
type BaseOperationOptions = ReadonlyArray<{
|
|
1064
1447
|
operation: string;
|
|
@@ -1075,7 +1458,13 @@ declare namespace widget {
|
|
|
1075
1458
|
type ConvertOperationOptionArguments<Arguments extends BaseOperationOptions[number]["args"]> = {
|
|
1076
1459
|
-readonly [Index in keyof Arguments]: Arguments[Index] extends BaseOperationOptions[number]["args"][number] ? OperationArgumentTypes[Arguments[Index]["type"]] : never;
|
|
1077
1460
|
};
|
|
1461
|
+
/**
|
|
1462
|
+
* @internal
|
|
1463
|
+
*/
|
|
1078
1464
|
type Operation = ConvertOperationOptions<ReadonlyArray<any>>;
|
|
1465
|
+
/**
|
|
1466
|
+
* @internal
|
|
1467
|
+
*/
|
|
1079
1468
|
const OnClickOperationOptions: readonly [
|
|
1080
1469
|
{
|
|
1081
1470
|
readonly operation: "none";
|
|
@@ -1123,10 +1512,61 @@ declare namespace widget {
|
|
|
1123
1512
|
];
|
|
1124
1513
|
}
|
|
1125
1514
|
];
|
|
1515
|
+
/**
|
|
1516
|
+
* @internal
|
|
1517
|
+
*/
|
|
1126
1518
|
type OnClickOperation = ConvertOperationOptions<typeof OnClickOperationOptions>;
|
|
1519
|
+
/**
|
|
1520
|
+
* @internal
|
|
1521
|
+
*/
|
|
1522
|
+
const FormOperationOptions: readonly [
|
|
1523
|
+
{
|
|
1524
|
+
readonly operation: "submit";
|
|
1525
|
+
readonly args: readonly [
|
|
1526
|
+
{
|
|
1527
|
+
readonly type: "TransitState";
|
|
1528
|
+
readonly default: "/";
|
|
1529
|
+
}
|
|
1530
|
+
];
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
readonly operation: "next";
|
|
1534
|
+
readonly args: readonly [
|
|
1535
|
+
{
|
|
1536
|
+
readonly type: "TransitState";
|
|
1537
|
+
readonly default: "/";
|
|
1538
|
+
}
|
|
1539
|
+
];
|
|
1540
|
+
},
|
|
1541
|
+
{
|
|
1542
|
+
readonly operation: "prev";
|
|
1543
|
+
readonly args: readonly [
|
|
1544
|
+
{
|
|
1545
|
+
readonly type: "TransitState";
|
|
1546
|
+
readonly default: "/";
|
|
1547
|
+
}
|
|
1548
|
+
];
|
|
1549
|
+
}
|
|
1550
|
+
];
|
|
1551
|
+
/**
|
|
1552
|
+
* @internal
|
|
1553
|
+
*/
|
|
1554
|
+
type FormOperation = ConvertOperationOptions<typeof FormOperationOptions>;
|
|
1555
|
+
/**
|
|
1556
|
+
* @internal
|
|
1557
|
+
*/
|
|
1127
1558
|
type LongText = string;
|
|
1559
|
+
/**
|
|
1560
|
+
* @internal
|
|
1561
|
+
*/
|
|
1128
1562
|
type Url = string;
|
|
1563
|
+
/**
|
|
1564
|
+
* @internal
|
|
1565
|
+
*/
|
|
1129
1566
|
type Image = string;
|
|
1567
|
+
/**
|
|
1568
|
+
* @internal
|
|
1569
|
+
*/
|
|
1130
1570
|
const LengthUnits: readonly [
|
|
1131
1571
|
"px",
|
|
1132
1572
|
"em",
|
|
@@ -1135,66 +1575,147 @@ declare namespace widget {
|
|
|
1135
1575
|
"fr",
|
|
1136
1576
|
"%"
|
|
1137
1577
|
];
|
|
1578
|
+
/**
|
|
1579
|
+
* @internal
|
|
1580
|
+
*/
|
|
1138
1581
|
type LengthUnit = (typeof LengthUnits)[number];
|
|
1582
|
+
/**
|
|
1583
|
+
* @internal
|
|
1584
|
+
*/
|
|
1139
1585
|
type Length = `${number}${LengthUnit}` | "auto";
|
|
1586
|
+
/**
|
|
1587
|
+
* @internal
|
|
1588
|
+
*/
|
|
1140
1589
|
type Color = `#${string}` | `rgba(${string})`;
|
|
1590
|
+
/**
|
|
1591
|
+
* @internal
|
|
1592
|
+
*/
|
|
1141
1593
|
const Justifies: readonly [
|
|
1142
1594
|
"flex-start",
|
|
1143
1595
|
"center",
|
|
1144
1596
|
"flex-end"
|
|
1145
1597
|
];
|
|
1598
|
+
/**
|
|
1599
|
+
* @internal
|
|
1600
|
+
*/
|
|
1146
1601
|
type Justify = (typeof Justifies)[number];
|
|
1602
|
+
/**
|
|
1603
|
+
* @internal
|
|
1604
|
+
*/
|
|
1147
1605
|
const Alignments: readonly [
|
|
1148
1606
|
"flex-start",
|
|
1149
1607
|
"center",
|
|
1150
1608
|
"flex-end"
|
|
1151
1609
|
];
|
|
1610
|
+
/**
|
|
1611
|
+
* @internal
|
|
1612
|
+
*/
|
|
1152
1613
|
type Alignment = (typeof Alignments)[number];
|
|
1614
|
+
/**
|
|
1615
|
+
* @internal
|
|
1616
|
+
*/
|
|
1153
1617
|
const ObjectFits: readonly [
|
|
1154
1618
|
"fill",
|
|
1155
1619
|
"contain",
|
|
1156
1620
|
"cover"
|
|
1157
1621
|
];
|
|
1622
|
+
/**
|
|
1623
|
+
* @internal
|
|
1624
|
+
*/
|
|
1158
1625
|
type ObjectFit = (typeof ObjectFits)[number];
|
|
1626
|
+
/**
|
|
1627
|
+
* @internal
|
|
1628
|
+
*/
|
|
1159
1629
|
const ClipPaths: readonly [
|
|
1160
1630
|
"none",
|
|
1161
1631
|
"circle(closest-side)"
|
|
1162
1632
|
];
|
|
1633
|
+
/**
|
|
1634
|
+
* @internal
|
|
1635
|
+
*/
|
|
1163
1636
|
type ClipPath = (typeof ClipPaths)[number];
|
|
1637
|
+
/**
|
|
1638
|
+
* @internal
|
|
1639
|
+
*/
|
|
1164
1640
|
const Repeats: readonly [
|
|
1165
1641
|
"repeat",
|
|
1166
1642
|
"space",
|
|
1167
1643
|
"round",
|
|
1168
1644
|
"no-repeat"
|
|
1169
1645
|
];
|
|
1646
|
+
/**
|
|
1647
|
+
* @internal
|
|
1648
|
+
*/
|
|
1170
1649
|
type Repeat = (typeof Repeats)[number];
|
|
1650
|
+
/**
|
|
1651
|
+
* @internal
|
|
1652
|
+
*/
|
|
1171
1653
|
const BackgroundSizes: readonly [
|
|
1172
1654
|
"cover",
|
|
1173
1655
|
"contain",
|
|
1174
1656
|
"auto"
|
|
1175
1657
|
];
|
|
1658
|
+
/**
|
|
1659
|
+
* @internal
|
|
1660
|
+
*/
|
|
1176
1661
|
type BackgroundSize = (typeof BackgroundSizes)[number];
|
|
1662
|
+
/**
|
|
1663
|
+
* @internal
|
|
1664
|
+
*/
|
|
1177
1665
|
const Cursors: readonly [
|
|
1178
1666
|
"default",
|
|
1179
1667
|
"pointer"
|
|
1180
1668
|
];
|
|
1669
|
+
/**
|
|
1670
|
+
* @internal
|
|
1671
|
+
*/
|
|
1181
1672
|
type Cursor = (typeof Cursors)[number];
|
|
1673
|
+
/**
|
|
1674
|
+
* @internal
|
|
1675
|
+
*/
|
|
1182
1676
|
const Overflows: readonly [
|
|
1183
1677
|
"visible",
|
|
1184
1678
|
"auto",
|
|
1185
1679
|
"hidden"
|
|
1186
1680
|
];
|
|
1681
|
+
/**
|
|
1682
|
+
* @internal
|
|
1683
|
+
*/
|
|
1187
1684
|
type Overflow = (typeof Overflows)[number];
|
|
1685
|
+
/**
|
|
1686
|
+
* @internal
|
|
1687
|
+
*/
|
|
1188
1688
|
type Border = string;
|
|
1689
|
+
/**
|
|
1690
|
+
* @internal
|
|
1691
|
+
*/
|
|
1189
1692
|
type BorderStyle = string;
|
|
1693
|
+
/**
|
|
1694
|
+
* @internal
|
|
1695
|
+
*/
|
|
1190
1696
|
type BorderWidth = `${number}px`;
|
|
1697
|
+
/**
|
|
1698
|
+
* @internal
|
|
1699
|
+
*/
|
|
1191
1700
|
type Style = string;
|
|
1701
|
+
/**
|
|
1702
|
+
* @internal
|
|
1703
|
+
*/
|
|
1192
1704
|
type StateName = string;
|
|
1705
|
+
/**
|
|
1706
|
+
* @internal
|
|
1707
|
+
*/
|
|
1193
1708
|
const WritingModes: readonly [
|
|
1194
1709
|
"horizontal-tb",
|
|
1195
1710
|
"vertical-lr"
|
|
1196
1711
|
];
|
|
1712
|
+
/**
|
|
1713
|
+
* @internal
|
|
1714
|
+
*/
|
|
1197
1715
|
type WritingMode = (typeof WritingModes)[number];
|
|
1716
|
+
/**
|
|
1717
|
+
* @internal
|
|
1718
|
+
*/
|
|
1198
1719
|
const ListSeparatorTypes: readonly [
|
|
1199
1720
|
"none",
|
|
1200
1721
|
"border",
|
|
@@ -1204,24 +1725,51 @@ declare namespace widget {
|
|
|
1204
1725
|
interface BaseListSeparator {
|
|
1205
1726
|
type: ListSeparatorType;
|
|
1206
1727
|
}
|
|
1728
|
+
/**
|
|
1729
|
+
* @internal
|
|
1730
|
+
*/
|
|
1207
1731
|
interface ListSeparatorNone extends BaseListSeparator {
|
|
1208
1732
|
type: "none";
|
|
1209
1733
|
}
|
|
1734
|
+
/**
|
|
1735
|
+
* @internal
|
|
1736
|
+
*/
|
|
1210
1737
|
interface ListSeparatorBorder extends BaseListSeparator {
|
|
1211
1738
|
type: "border";
|
|
1212
1739
|
borderStyle: BorderStyle;
|
|
1213
1740
|
borderWidth?: BorderWidth;
|
|
1214
1741
|
borderColor?: Color;
|
|
1215
1742
|
}
|
|
1743
|
+
/**
|
|
1744
|
+
* @internal
|
|
1745
|
+
*/
|
|
1216
1746
|
interface ListSeparatorGap extends BaseListSeparator {
|
|
1217
1747
|
type: "gap";
|
|
1218
1748
|
gap: Length;
|
|
1219
1749
|
}
|
|
1750
|
+
/**
|
|
1751
|
+
* @internal
|
|
1752
|
+
*/
|
|
1220
1753
|
type ListSeparator = ListSeparatorNone | ListSeparatorBorder | ListSeparatorGap;
|
|
1754
|
+
/**
|
|
1755
|
+
* @internal
|
|
1756
|
+
*/
|
|
1221
1757
|
const DefaultListSeparatorNone: Required<ListSeparatorNone>;
|
|
1758
|
+
/**
|
|
1759
|
+
* @internal
|
|
1760
|
+
*/
|
|
1222
1761
|
const DefaultListSeparatorBorder: Required<ListSeparatorBorder>;
|
|
1762
|
+
/**
|
|
1763
|
+
* @internal
|
|
1764
|
+
*/
|
|
1223
1765
|
const DefaultListSeparatorGap: Required<ListSeparatorGap>;
|
|
1766
|
+
/**
|
|
1767
|
+
* @internal
|
|
1768
|
+
*/
|
|
1224
1769
|
const DefaultListSeparator: Required<ListSeparatorBorder>;
|
|
1770
|
+
/**
|
|
1771
|
+
* @internal
|
|
1772
|
+
*/
|
|
1225
1773
|
const ListBackgroundTypes: readonly [
|
|
1226
1774
|
"none",
|
|
1227
1775
|
"stripe"
|
|
@@ -1230,23 +1778,50 @@ declare namespace widget {
|
|
|
1230
1778
|
interface BaseListBackground {
|
|
1231
1779
|
type: ListBackgroundType;
|
|
1232
1780
|
}
|
|
1781
|
+
/**
|
|
1782
|
+
* @internal
|
|
1783
|
+
*/
|
|
1233
1784
|
interface ListBackgroundNone extends BaseListBackground {
|
|
1234
1785
|
type: "none";
|
|
1235
1786
|
}
|
|
1787
|
+
/**
|
|
1788
|
+
* @internal
|
|
1789
|
+
*/
|
|
1236
1790
|
interface ListBackgroundStripe extends BaseListBackground {
|
|
1237
1791
|
type: "stripe";
|
|
1238
1792
|
background1?: Color;
|
|
1239
1793
|
background2?: Color;
|
|
1240
1794
|
}
|
|
1795
|
+
/**
|
|
1796
|
+
* @internal
|
|
1797
|
+
*/
|
|
1241
1798
|
type ListBackground = ListBackgroundNone | ListBackgroundStripe;
|
|
1799
|
+
/**
|
|
1800
|
+
* @internal
|
|
1801
|
+
*/
|
|
1242
1802
|
const DefaultListBackgroundNone: Required<ListBackgroundNone>;
|
|
1803
|
+
/**
|
|
1804
|
+
* @internal
|
|
1805
|
+
*/
|
|
1243
1806
|
const DefaultListBackgroundStripe: Required<ListBackgroundStripe>;
|
|
1807
|
+
/**
|
|
1808
|
+
* @internal
|
|
1809
|
+
*/
|
|
1244
1810
|
const DefaultListBackground: Required<ListBackgroundNone>;
|
|
1811
|
+
/**
|
|
1812
|
+
* @internal
|
|
1813
|
+
*/
|
|
1245
1814
|
const ListDirections: readonly [
|
|
1246
1815
|
"vertical",
|
|
1247
1816
|
"horizontal"
|
|
1248
1817
|
];
|
|
1818
|
+
/**
|
|
1819
|
+
* @internal
|
|
1820
|
+
*/
|
|
1249
1821
|
type ListDirection = (typeof ListDirections)[number];
|
|
1822
|
+
/**
|
|
1823
|
+
* @internal
|
|
1824
|
+
*/
|
|
1250
1825
|
type ListContext = {
|
|
1251
1826
|
separator: ListSeparator;
|
|
1252
1827
|
background: ListBackground;
|
|
@@ -1262,7 +1837,9 @@ declare namespace widget {
|
|
|
1262
1837
|
// Wrap svelte tools
|
|
1263
1838
|
type Store<T> = Writable_<T>;
|
|
1264
1839
|
/**
|
|
1265
|
-
*
|
|
1840
|
+
* get store state value
|
|
1841
|
+
*
|
|
1842
|
+
* @deprecated 非推奨
|
|
1266
1843
|
*/
|
|
1267
1844
|
const getStoreState: typeof get_;
|
|
1268
1845
|
type SystemConfig = {
|
|
@@ -1285,13 +1862,16 @@ declare namespace widget {
|
|
|
1285
1862
|
const actionSetting: Store<ActionSetting>;
|
|
1286
1863
|
/**
|
|
1287
1864
|
* {@link getActionSetting} function to get action setting.
|
|
1288
|
-
*
|
|
1865
|
+
*
|
|
1866
|
+
* @returns Current action setting
|
|
1289
1867
|
*/
|
|
1290
1868
|
function getActionSetting(): ActionSetting;
|
|
1291
1869
|
/**
|
|
1292
1870
|
* {@link setActionSetting} function to "update" action setting
|
|
1293
|
-
*
|
|
1294
|
-
* @
|
|
1871
|
+
*
|
|
1872
|
+
* @param setting - Updated action setting
|
|
1873
|
+
*
|
|
1874
|
+
* @returns New action setting
|
|
1295
1875
|
*/
|
|
1296
1876
|
function setActionSetting(setting: ActionSetting): ActionSetting;
|
|
1297
1877
|
/**
|
|
@@ -1304,7 +1884,8 @@ declare namespace widget {
|
|
|
1304
1884
|
const system: Store<SystemConfig>;
|
|
1305
1885
|
/**
|
|
1306
1886
|
* {@link getSystem} function to get KARTE system config.
|
|
1307
|
-
*
|
|
1887
|
+
*
|
|
1888
|
+
* @returns Current karte system config
|
|
1308
1889
|
*/
|
|
1309
1890
|
function getSystem(): SystemConfig;
|
|
1310
1891
|
/**
|
|
@@ -1324,7 +1905,8 @@ declare namespace widget {
|
|
|
1324
1905
|
function setState(stateId: string, force?: boolean): void;
|
|
1325
1906
|
/**
|
|
1326
1907
|
* {@link getState} function to get current state ID.
|
|
1327
|
-
*
|
|
1908
|
+
*
|
|
1909
|
+
* @returns Current state ID
|
|
1328
1910
|
*/
|
|
1329
1911
|
function getState(): string;
|
|
1330
1912
|
/**
|
|
@@ -1333,12 +1915,14 @@ declare namespace widget {
|
|
|
1333
1915
|
const states: Store<string[]>;
|
|
1334
1916
|
/**
|
|
1335
1917
|
* {@link getStates} function to add new state ID to list of state IDs.
|
|
1336
|
-
*
|
|
1918
|
+
*
|
|
1919
|
+
* @param stateId - New state ID
|
|
1337
1920
|
*/
|
|
1338
1921
|
function addState(stateId: string): void;
|
|
1339
1922
|
/**
|
|
1340
1923
|
* {@link getStates} function to get a list of all state IDs.
|
|
1341
|
-
*
|
|
1924
|
+
*
|
|
1925
|
+
* @returns All state IDs
|
|
1342
1926
|
*/
|
|
1343
1927
|
function getStates(): string[];
|
|
1344
1928
|
/**
|
|
@@ -1347,7 +1931,8 @@ declare namespace widget {
|
|
|
1347
1931
|
const opened: Store<boolean>;
|
|
1348
1932
|
/**
|
|
1349
1933
|
* {@link isOpened} function to check if action is opened.
|
|
1350
|
-
*
|
|
1934
|
+
*
|
|
1935
|
+
* @returns Flag if action is opend / true: Opend, false: Not opened
|
|
1351
1936
|
*/
|
|
1352
1937
|
function isOpened(): boolean;
|
|
1353
1938
|
/**
|
|
@@ -1357,19 +1942,21 @@ declare namespace widget {
|
|
|
1357
1942
|
/**
|
|
1358
1943
|
* Store to handle visibility of action
|
|
1359
1944
|
*
|
|
1360
|
-
* @deprecated
|
|
1945
|
+
* @deprecated 非推奨
|
|
1361
1946
|
*/
|
|
1362
1947
|
const closed: Store<boolean>; // deprecated
|
|
1363
1948
|
/**
|
|
1364
1949
|
* {@link isClosed} function to check if action is clsoed.
|
|
1365
|
-
*
|
|
1366
|
-
* @
|
|
1950
|
+
*
|
|
1951
|
+
* @returns Flag if action is closed / true: Closed, false: Not closed
|
|
1952
|
+
*
|
|
1953
|
+
* @deprecated 非推奨
|
|
1367
1954
|
*/
|
|
1368
1955
|
function isClosed(): boolean;
|
|
1369
1956
|
/**
|
|
1370
1957
|
* {@link setClosed} function to set if action is closed.
|
|
1371
1958
|
*
|
|
1372
|
-
* @deprecated
|
|
1959
|
+
* @deprecated 非推奨
|
|
1373
1960
|
*/
|
|
1374
1961
|
function setClosed(on: boolean): void;
|
|
1375
1962
|
/**
|
|
@@ -1377,7 +1964,7 @@ declare namespace widget {
|
|
|
1377
1964
|
*/
|
|
1378
1965
|
const maximumZindex: Store<number>;
|
|
1379
1966
|
/**
|
|
1380
|
-
*
|
|
1967
|
+
* Set maximum z-index.
|
|
1381
1968
|
*/
|
|
1382
1969
|
const setMaximumZindex: (zindex?: number) => void;
|
|
1383
1970
|
/**
|
|
@@ -1390,7 +1977,8 @@ declare namespace widget {
|
|
|
1390
1977
|
}>;
|
|
1391
1978
|
/**
|
|
1392
1979
|
* {@link getInternalHandlers} function to get internal event handlers.
|
|
1393
|
-
*
|
|
1980
|
+
*
|
|
1981
|
+
* @returns Current internal handlers
|
|
1394
1982
|
*/
|
|
1395
1983
|
function getInternalHandlers(): {
|
|
1396
1984
|
[key: string]: ActionEventHandler[];
|
|
@@ -1403,8 +1991,10 @@ declare namespace widget {
|
|
|
1403
1991
|
}): void;
|
|
1404
1992
|
/**
|
|
1405
1993
|
* {@link updateInternalHandlers} function to update internal event handlers.
|
|
1406
|
-
*
|
|
1407
|
-
* @
|
|
1994
|
+
*
|
|
1995
|
+
* @param handlers - Updated internal event handlers
|
|
1996
|
+
*
|
|
1997
|
+
* @returns New internal handlers
|
|
1408
1998
|
*/
|
|
1409
1999
|
function updateInternalHandlers(handlers: {
|
|
1410
2000
|
[key: string]: ActionEventHandler[];
|
|
@@ -1421,22 +2011,26 @@ declare namespace widget {
|
|
|
1421
2011
|
}>;
|
|
1422
2012
|
/**
|
|
1423
2013
|
* {@link getCustomHandlers} function to get custom event handlers.
|
|
1424
|
-
*
|
|
2014
|
+
*
|
|
2015
|
+
* @returns Current custom event handlers
|
|
1425
2016
|
*/
|
|
1426
2017
|
function getCustomHandlers(): {
|
|
1427
2018
|
[key: string]: ActionEventHandler;
|
|
1428
2019
|
};
|
|
1429
2020
|
/**
|
|
1430
2021
|
* {@link setCustomHandlers} function to set custom event handlers.
|
|
1431
|
-
*
|
|
2022
|
+
*
|
|
2023
|
+
* @param handlers - New custom event handlers
|
|
1432
2024
|
*/
|
|
1433
2025
|
function setCustomHandlers(handlers: {
|
|
1434
2026
|
[key: string]: ActionEventHandler;
|
|
1435
2027
|
}): void;
|
|
1436
2028
|
/**
|
|
1437
2029
|
* {@link updateCustomHandlers} function to update custom event handlers.
|
|
1438
|
-
*
|
|
1439
|
-
* @
|
|
2030
|
+
*
|
|
2031
|
+
* @param handlers - Updated custom event handlers
|
|
2032
|
+
*
|
|
2033
|
+
* @returns New custom event handlers
|
|
1440
2034
|
*/
|
|
1441
2035
|
function updateCustomHandlers(handlers: {
|
|
1442
2036
|
[key: string]: ActionEventHandler;
|
|
@@ -1449,7 +2043,8 @@ declare namespace widget {
|
|
|
1449
2043
|
const destroyed: Store<boolean>;
|
|
1450
2044
|
/**
|
|
1451
2045
|
* {@link isDestroyed} function to check if action is destroyed.
|
|
1452
|
-
*
|
|
2046
|
+
*
|
|
2047
|
+
* @returns Flag if action is destoryed / true: Destroyed, false: Not Destroyed
|
|
1453
2048
|
*/
|
|
1454
2049
|
function isDestroyed(): boolean;
|
|
1455
2050
|
/**
|
|
@@ -1461,7 +2056,8 @@ declare namespace widget {
|
|
|
1461
2056
|
const stopped: Store<boolean>;
|
|
1462
2057
|
/**
|
|
1463
2058
|
* {@link isStopped} function to check if action is stopped.
|
|
1464
|
-
*
|
|
2059
|
+
*
|
|
2060
|
+
* @returns Flag if action is stopped / true: Stopped, false: Not stopped
|
|
1465
2061
|
*/
|
|
1466
2062
|
function isStopped(): boolean;
|
|
1467
2063
|
/**
|
|
@@ -1476,18 +2072,22 @@ declare namespace widget {
|
|
|
1476
2072
|
}>;
|
|
1477
2073
|
/**
|
|
1478
2074
|
* {@link getCustomVariables} function to get custom variables.
|
|
1479
|
-
*
|
|
2075
|
+
*
|
|
2076
|
+
* @returns Current custom variables
|
|
1480
2077
|
*/
|
|
1481
2078
|
function getCustomVariables(): CustomVariables;
|
|
1482
2079
|
/**
|
|
1483
2080
|
* {@link setCustomVariables} function to set custom variables.
|
|
1484
|
-
*
|
|
2081
|
+
*
|
|
2082
|
+
* @param variables - New custom variables
|
|
1485
2083
|
*/
|
|
1486
2084
|
function setCustomVariables(variables: CustomVariables): void;
|
|
1487
2085
|
/**
|
|
1488
2086
|
* {@link updateCustomVariables} function to update custom variables.
|
|
1489
|
-
*
|
|
1490
|
-
* @
|
|
2087
|
+
*
|
|
2088
|
+
* @param variables - Updated custom variables
|
|
2089
|
+
*
|
|
2090
|
+
* @returns New custom variables
|
|
1491
2091
|
*/
|
|
1492
2092
|
function updateCustomVariables(variables: CustomVariables): CustomVariables;
|
|
1493
2093
|
interface FormData {
|
|
@@ -1539,21 +2139,23 @@ declare namespace widget {
|
|
|
1539
2139
|
/**
|
|
1540
2140
|
* A waiting time in milliseconds before starting animation
|
|
1541
2141
|
*
|
|
1542
|
-
* @
|
|
2142
|
+
* @defaultValue 0
|
|
1543
2143
|
*/
|
|
1544
2144
|
delay?: number;
|
|
1545
2145
|
/**
|
|
1546
2146
|
* A total duration time in milliseconds of the animation
|
|
1547
2147
|
*
|
|
1548
|
-
* @
|
|
2148
|
+
* @defaultValue 1000
|
|
1549
2149
|
*/
|
|
1550
2150
|
duration?: number;
|
|
1551
2151
|
}
|
|
1552
2152
|
/**
|
|
1553
2153
|
* The function to activate svelte animation.
|
|
2154
|
+
*
|
|
2155
|
+
* @param node - A target node of animation. This argument is passed by svelte, by default.
|
|
2156
|
+
* @param customAnimationOptions - A custom animation option object
|
|
2157
|
+
*
|
|
1554
2158
|
* @see {@link https://svelte.dev/docs#template-syntax-element-directives-transition-fn-custom-transition-functions| Custom transition functions} for detail documentation
|
|
1555
|
-
* @param {Element} node A target node of animation. This argument is passed by svelte, by default.
|
|
1556
|
-
* @param {CustomAnimationOptions} customAnimationOptions A custom animation option object
|
|
1557
2159
|
*/
|
|
1558
2160
|
function customAnimation(node: Element, { transform, animationStyle, delay, duration }: CustomAnimationOptions): {
|
|
1559
2161
|
delay?: undefined;
|
|
@@ -1569,36 +2171,37 @@ declare namespace widget {
|
|
|
1569
2171
|
/**
|
|
1570
2172
|
* {@link loadGlobalScript} load JavaScript that does not support ESM.
|
|
1571
2173
|
*
|
|
1572
|
-
* @param
|
|
2174
|
+
* @param src - Link of JavaScript file
|
|
1573
2175
|
*/
|
|
1574
2176
|
function loadGlobalScript(src: string): Promise<any>;
|
|
1575
2177
|
/**
|
|
1576
2178
|
* {@link applyGlobalCss} apply global CSS to WEB page.
|
|
1577
2179
|
*
|
|
1578
|
-
* @param
|
|
2180
|
+
* @param css - CSS
|
|
1579
2181
|
*/
|
|
1580
2182
|
function applyGlobalCss(css: string): Promise<any>;
|
|
1581
2183
|
/**
|
|
1582
2184
|
* {@link loadGlobalStyle} load global style to WEB page.
|
|
1583
2185
|
*
|
|
1584
|
-
* @param
|
|
2186
|
+
* @param href - Link of style file
|
|
1585
2187
|
*/
|
|
1586
2188
|
function loadGlobalStyle(href: string): Promise<any>;
|
|
1587
2189
|
/**
|
|
1588
2190
|
* {@link hashCode} generate hash with FNV-1a hash
|
|
1589
2191
|
*
|
|
1590
|
-
* @param
|
|
1591
|
-
*
|
|
2192
|
+
* @param s - Inputed string
|
|
2193
|
+
*
|
|
2194
|
+
* @returns Hashed string
|
|
2195
|
+
*
|
|
1592
2196
|
* @see https://stackoverflow.com/a/22429679
|
|
1593
2197
|
*/
|
|
1594
2198
|
function hashCode(s: string): string;
|
|
1595
2199
|
/**
|
|
1596
2200
|
* {@link setAutoStart} function to set auto start flag.
|
|
1597
2201
|
*
|
|
1598
|
-
*
|
|
2202
|
+
* @param on - true: auto start, false: not auto start
|
|
1599
2203
|
*
|
|
1600
|
-
* @deprecated
|
|
1601
|
-
* @param {boolean} on
|
|
2204
|
+
* @deprecated 非推奨。`setActionConfig({ autoStart: false })` を使ってください。
|
|
1602
2205
|
*/
|
|
1603
2206
|
const setAutoStart: (on?: boolean) => void;
|
|
1604
2207
|
// types of props to reference for internaly
|
|
@@ -1616,6 +2219,9 @@ declare namespace widget {
|
|
|
1616
2219
|
hide_on_time?: boolean;
|
|
1617
2220
|
hide_on_time_count?: number;
|
|
1618
2221
|
}
|
|
2222
|
+
/**
|
|
2223
|
+
* @internal
|
|
2224
|
+
*/
|
|
1619
2225
|
interface ActionProps<Props, Variables> {
|
|
1620
2226
|
send: (event_name: string, values?: any) => void;
|
|
1621
2227
|
data: Props & Variables & CustomVariables;
|
|
@@ -1623,45 +2229,51 @@ declare namespace widget {
|
|
|
1623
2229
|
onChangeState?: (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
|
|
1624
2230
|
}
|
|
1625
2231
|
/**
|
|
1626
|
-
*
|
|
2232
|
+
* {@link create} 向けのオプション
|
|
2233
|
+
*
|
|
2234
|
+
* @public
|
|
1627
2235
|
*/
|
|
1628
2236
|
interface ActionOptions<Props, Variables> {
|
|
1629
2237
|
/**
|
|
1630
|
-
*
|
|
2238
|
+
* KARTE アクションでイベントがトリガーされたときに受信するための関数
|
|
1631
2239
|
*
|
|
1632
|
-
* @
|
|
2240
|
+
* @defaultValue `() => {}`
|
|
1633
2241
|
*/
|
|
1634
2242
|
send?: (event_name: string, values?: any) => void;
|
|
1635
2243
|
/**
|
|
1636
|
-
*
|
|
2244
|
+
* KARTE アクションで使用されるプロパティ
|
|
1637
2245
|
*
|
|
1638
|
-
* @
|
|
2246
|
+
* @defaultValue `{}`
|
|
1639
2247
|
*/
|
|
1640
2248
|
props?: Props;
|
|
1641
2249
|
/**
|
|
1642
|
-
*
|
|
2250
|
+
* KARTE アクションで使用されるアクションテーブルのユーザー環境変数
|
|
1643
2251
|
*
|
|
1644
|
-
* @
|
|
2252
|
+
* @defaultValue `{}`
|
|
1645
2253
|
*/
|
|
1646
2254
|
variables?: Variables;
|
|
1647
2255
|
/**
|
|
1648
|
-
* {@link
|
|
2256
|
+
* KARTE アクションでアクションが作成されているときにフックされる {@link onCreate}
|
|
1649
2257
|
*
|
|
1650
|
-
* @
|
|
2258
|
+
* @defaultValue `() => {}`
|
|
1651
2259
|
*/
|
|
1652
2260
|
onCreate?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
|
|
1653
2261
|
}
|
|
1654
2262
|
/**
|
|
1655
|
-
*
|
|
2263
|
+
* KARTE アクションを作成する
|
|
1656
2264
|
*
|
|
1657
|
-
* @param App -
|
|
1658
|
-
* @param options -
|
|
2265
|
+
* @param App - Svelte コンポーネントのエントリポイント
|
|
2266
|
+
* @param options - {@link ActionOptions | オプション}
|
|
2267
|
+
*
|
|
2268
|
+
* @returns KARTE アクションを破棄する関数
|
|
1659
2269
|
*
|
|
1660
|
-
* @
|
|
2270
|
+
* @public
|
|
1661
2271
|
*/
|
|
1662
2272
|
function create<Props extends _Props, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
|
|
1663
2273
|
/**
|
|
1664
2274
|
* Dispatch the event to destroy KARTE action
|
|
2275
|
+
*
|
|
2276
|
+
* @internal
|
|
1665
2277
|
*/
|
|
1666
2278
|
function dispatchDestroyEvent(): void;
|
|
1667
2279
|
/**
|
|
@@ -1681,60 +2293,76 @@ declare namespace widget {
|
|
|
1681
2293
|
const KARTE_ACTION_SHORTEN_ID = "karte-action-id";
|
|
1682
2294
|
function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
|
|
1683
2295
|
/**
|
|
1684
|
-
*
|
|
2296
|
+
* KARTE アクションのライフサイクルで呼び出されるフック
|
|
1685
2297
|
*
|
|
1686
|
-
* @param
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
* @param {ActionProps<Props, Variables & CustomVariables>} props Properties of KARTE action
|
|
1690
|
-
* @returns {void|Promise<void>}
|
|
2298
|
+
* @param props - KARTE アクションのプロパティ
|
|
2299
|
+
*
|
|
2300
|
+
* @public
|
|
1691
2301
|
*/
|
|
1692
|
-
|
|
2302
|
+
type ActionHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
|
|
1693
2303
|
/**
|
|
1694
|
-
*
|
|
2304
|
+
* アクションが作成 (create) される前にフックする
|
|
1695
2305
|
*
|
|
1696
|
-
* @param
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
* @param {ActionProps<Props, Variables & CustomVariables>} props Properties of KARTE action
|
|
1700
|
-
* @returns {void|Promise<void>}
|
|
2306
|
+
* @param fn - 呼び出されるフック関数
|
|
2307
|
+
*
|
|
2308
|
+
* @public
|
|
1701
2309
|
*/
|
|
1702
|
-
|
|
2310
|
+
function onCreate<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
1703
2311
|
/**
|
|
1704
|
-
*
|
|
2312
|
+
* アクションが表示 (show) された後にフックする
|
|
2313
|
+
*
|
|
2314
|
+
* @param fn - 呼び出されるフック関数
|
|
1705
2315
|
*
|
|
1706
|
-
* @
|
|
1707
|
-
* @param {ClosePlace} fn Callback
|
|
2316
|
+
* @public
|
|
1708
2317
|
*/
|
|
1709
|
-
function
|
|
1710
|
-
|
|
1711
|
-
*
|
|
2318
|
+
function onShow<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
2319
|
+
/**
|
|
2320
|
+
* KARTE アクションのライフサイクル close で呼び出されるフック
|
|
2321
|
+
*
|
|
2322
|
+
* @param props - KARTE アクションのプロパティ
|
|
2323
|
+
* @param trigger - Close トリガー
|
|
2324
|
+
*
|
|
2325
|
+
* @public
|
|
1712
2326
|
*/
|
|
1713
|
-
|
|
2327
|
+
type ActionCloseHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, trigger: CloseTrigger) => void | Promise<void>;
|
|
1714
2328
|
/**
|
|
1715
|
-
*
|
|
2329
|
+
* アクションがクローズ (close) される前にフックする
|
|
1716
2330
|
*
|
|
1717
|
-
* @param
|
|
2331
|
+
* @param fn - 呼び出されるフック関数
|
|
2332
|
+
*
|
|
2333
|
+
* @public
|
|
1718
2334
|
*/
|
|
1719
|
-
function
|
|
1720
|
-
|
|
1721
|
-
*
|
|
2335
|
+
function onClose<Props extends _Props, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
|
|
2336
|
+
/**
|
|
2337
|
+
* アクションが破棄 (destroy) される前にフックする
|
|
2338
|
+
*
|
|
2339
|
+
* @param fn - 呼び出されるフック関数
|
|
2340
|
+
*
|
|
2341
|
+
* @public
|
|
1722
2342
|
*/
|
|
1723
|
-
|
|
2343
|
+
function onDestroy<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
|
|
1724
2344
|
/**
|
|
1725
|
-
*
|
|
2345
|
+
* KARTE アクションのライフサイクル changeState で呼び出されるフック関数
|
|
1726
2346
|
*
|
|
1727
|
-
* @param
|
|
2347
|
+
* @param props - KARTE アクションのプロパティ
|
|
2348
|
+
* @param newState - KARTE アクションの新しいステート
|
|
2349
|
+
*
|
|
2350
|
+
* @public
|
|
1728
2351
|
*/
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
*
|
|
1732
|
-
*
|
|
2352
|
+
type ActionChangeStateHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
|
|
2353
|
+
/**
|
|
2354
|
+
* アクションのステートが変更された (changeState) 後にフックする
|
|
2355
|
+
*
|
|
2356
|
+
* @param fn - 呼び出されるフック関数
|
|
2357
|
+
*
|
|
2358
|
+
* @public
|
|
1733
2359
|
*/
|
|
1734
|
-
|
|
2360
|
+
function onChangeState<Props extends _Props, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
|
|
1735
2361
|
const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
|
|
1736
2362
|
/**
|
|
1737
|
-
*
|
|
2363
|
+
* create a fog element
|
|
2364
|
+
*
|
|
2365
|
+
* @deprecated 非推奨
|
|
1738
2366
|
*/
|
|
1739
2367
|
function createFog({ color, opacity, zIndex, onclick }: {
|
|
1740
2368
|
color?: string;
|
|
@@ -1749,15 +2377,17 @@ declare namespace widget {
|
|
|
1749
2377
|
function embed(target: HTMLElement, replace: HTMLElement, embed_method: EmbedLogic): void;
|
|
1750
2378
|
function getActionShadowRoot(): ShadowRoot | null;
|
|
1751
2379
|
/**
|
|
1752
|
-
*
|
|
2380
|
+
* KARTE アクションに CSS を適用する
|
|
2381
|
+
*
|
|
2382
|
+
* @param css - 適用する CSS
|
|
1753
2383
|
*
|
|
1754
|
-
* @
|
|
2384
|
+
* @returns 適用された style 要素を返す Promise
|
|
1755
2385
|
*/
|
|
1756
|
-
function applyCss(css: string): Promise<
|
|
2386
|
+
function applyCss(css: string): Promise<HTMLStyleElement>;
|
|
1757
2387
|
/**
|
|
1758
|
-
*
|
|
2388
|
+
* KARTE アクションにグローバルなスタイルをロードする
|
|
1759
2389
|
*
|
|
1760
|
-
* @param
|
|
2390
|
+
* @param href - style ファイルのリンク先 URL
|
|
1761
2391
|
*/
|
|
1762
2392
|
function loadStyle(href: string): Promise<void>;
|
|
1763
2393
|
// -------- The following codes are deprecated --------
|
|
@@ -1769,14 +2399,16 @@ declare namespace widget {
|
|
|
1769
2399
|
const close: typeof closeAction; // deprecated
|
|
1770
2400
|
/**
|
|
1771
2401
|
* An options for {@link createApp}
|
|
1772
|
-
*
|
|
2402
|
+
*
|
|
2403
|
+
* @deprecated 非推奨
|
|
1773
2404
|
*/
|
|
1774
2405
|
type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
|
|
1775
2406
|
/**
|
|
1776
2407
|
* App application instance that is with {@link createApp}
|
|
1777
|
-
* @deprecated
|
|
1778
2408
|
*
|
|
1779
|
-
* @
|
|
2409
|
+
* @remarks Currently, svelte component is supported only.
|
|
2410
|
+
*
|
|
2411
|
+
* @deprecated 非推奨
|
|
1780
2412
|
*/
|
|
1781
2413
|
interface App {
|
|
1782
2414
|
/**
|
|
@@ -1790,12 +2422,13 @@ declare namespace widget {
|
|
|
1790
2422
|
}
|
|
1791
2423
|
/**
|
|
1792
2424
|
* Create an application instance
|
|
1793
|
-
* @deprecated
|
|
1794
2425
|
*
|
|
1795
2426
|
* @param App - An entry point of svelte component.
|
|
1796
2427
|
* @param options - An {@link AppOptions | options}
|
|
1797
2428
|
*
|
|
1798
|
-
* @
|
|
2429
|
+
* @returns A function to close the modal
|
|
2430
|
+
*
|
|
2431
|
+
* @deprecated 非推奨
|
|
1799
2432
|
*/
|
|
1800
2433
|
function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
|
|
1801
2434
|
// @ts-ignore
|
|
@@ -1809,70 +2442,91 @@ declare namespace widget {
|
|
|
1809
2442
|
/**
|
|
1810
2443
|
* 変数を設定する
|
|
1811
2444
|
*
|
|
1812
|
-
* @param
|
|
1813
|
-
* @param
|
|
2445
|
+
* @param name - 変数名
|
|
2446
|
+
* @param value - 変数値
|
|
2447
|
+
*
|
|
2448
|
+
* @public
|
|
1814
2449
|
*/
|
|
1815
2450
|
function setVal(name: string, value: any): void;
|
|
1816
2451
|
/**
|
|
1817
2452
|
* 変数を取得する
|
|
1818
2453
|
*
|
|
1819
|
-
* @param
|
|
2454
|
+
* @param name - 変数名
|
|
2455
|
+
*
|
|
2456
|
+
* @returns 変数値
|
|
1820
2457
|
*
|
|
1821
|
-
* @
|
|
2458
|
+
* @public
|
|
1822
2459
|
*/
|
|
1823
2460
|
function getVal(name: string): any;
|
|
1824
2461
|
/**
|
|
1825
|
-
*
|
|
2462
|
+
* 変数が変更されたときに実行されるコールバック関数を設定する
|
|
1826
2463
|
*
|
|
1827
|
-
* @param
|
|
1828
|
-
* @param
|
|
2464
|
+
* @param name - 変数名
|
|
2465
|
+
* @param callback - コールバック関数
|
|
2466
|
+
*
|
|
2467
|
+
* @public
|
|
1829
2468
|
*/
|
|
1830
2469
|
function onChangeVal(name: string, callback: ChangeValCallback): void;
|
|
1831
2470
|
/**
|
|
1832
|
-
* WEB
|
|
2471
|
+
* WEBのイベントが発生したときに実行されるコールバック関数を設定する
|
|
2472
|
+
*
|
|
2473
|
+
* @param name - WEBのイベント名
|
|
2474
|
+
* @param callback - コールバック関数
|
|
1833
2475
|
*
|
|
1834
|
-
* @
|
|
1835
|
-
* @param {EventCallback} callback コールバック
|
|
2476
|
+
* @public
|
|
1836
2477
|
*/
|
|
1837
2478
|
function method(name: string, callback: EventCallback): void;
|
|
1838
2479
|
/**
|
|
1839
|
-
* Widget
|
|
2480
|
+
* Widgetのイベントが発生したときに実行されるコールバック関数を設定する
|
|
1840
2481
|
*
|
|
1841
|
-
* @param
|
|
1842
|
-
* @param
|
|
2482
|
+
* @param name - Widgetのイベント名
|
|
2483
|
+
* @param callback - コールバック関数
|
|
2484
|
+
*
|
|
2485
|
+
* @public
|
|
1843
2486
|
*/
|
|
1844
2487
|
function on(name: WidgetEventName, callback: EventCallback): void;
|
|
1845
2488
|
/**
|
|
1846
2489
|
* 現在のステートを設定する
|
|
1847
2490
|
*
|
|
1848
|
-
* @param
|
|
2491
|
+
* @param stateId - ステートID
|
|
2492
|
+
*
|
|
2493
|
+
* @public
|
|
1849
2494
|
*/
|
|
1850
2495
|
function setState$0(stateId: string): void;
|
|
1851
2496
|
/**
|
|
1852
2497
|
* 現在のステートを取得する
|
|
1853
2498
|
*
|
|
1854
|
-
* @
|
|
2499
|
+
* @returns ステートID
|
|
2500
|
+
*
|
|
2501
|
+
* @public
|
|
1855
2502
|
*/
|
|
1856
2503
|
function getState$0(): string;
|
|
1857
2504
|
/**
|
|
1858
2505
|
* ページ内の変数を設定する
|
|
1859
2506
|
*
|
|
1860
|
-
* @param
|
|
1861
|
-
* @param
|
|
2507
|
+
* @param key - 変数のキー
|
|
2508
|
+
* @param value - 変数値
|
|
2509
|
+
*
|
|
2510
|
+
* @public
|
|
1862
2511
|
*/
|
|
1863
2512
|
function setMemoryStore(key: string, value: any): void;
|
|
1864
2513
|
/**
|
|
1865
2514
|
* ページ内の変数を取定する
|
|
1866
2515
|
*
|
|
1867
|
-
* @param
|
|
1868
|
-
*
|
|
2516
|
+
* @param key - 変数のキー
|
|
2517
|
+
*
|
|
2518
|
+
* @returns 変数
|
|
2519
|
+
*
|
|
2520
|
+
* @public
|
|
1869
2521
|
*/
|
|
1870
2522
|
function getMemoryStore(key: string): any;
|
|
1871
2523
|
/**
|
|
1872
2524
|
* ページをまたぐ変数を設定する
|
|
1873
2525
|
*
|
|
1874
|
-
* @param
|
|
1875
|
-
* @param
|
|
2526
|
+
* @param key - 変数のキー
|
|
2527
|
+
* @param value - 変数値
|
|
2528
|
+
*
|
|
2529
|
+
* @public
|
|
1876
2530
|
*/
|
|
1877
2531
|
function setLocalStore(key: string, value: any, options?: {
|
|
1878
2532
|
expire: number | boolean;
|
|
@@ -1880,8 +2534,11 @@ declare namespace widget {
|
|
|
1880
2534
|
/**
|
|
1881
2535
|
* ページをまたぐ変数を取得設定する
|
|
1882
2536
|
*
|
|
1883
|
-
* @param
|
|
1884
|
-
*
|
|
2537
|
+
* @param key - 変数のキー
|
|
2538
|
+
*
|
|
2539
|
+
* @returns 変数
|
|
2540
|
+
*
|
|
2541
|
+
* @public
|
|
1885
2542
|
*/
|
|
1886
2543
|
function getLocalStore(key: string): any | undefined;
|
|
1887
2544
|
const storage: {
|
|
@@ -1897,8 +2554,9 @@ declare namespace widget {
|
|
|
1897
2554
|
/**
|
|
1898
2555
|
* アクションテーブルを操作するオブジェクト
|
|
1899
2556
|
*
|
|
1900
|
-
* @param
|
|
1901
|
-
*
|
|
2557
|
+
* @param table - アクションテーブル名
|
|
2558
|
+
*
|
|
2559
|
+
* @public
|
|
1902
2560
|
*/
|
|
1903
2561
|
function collection(table: string): {
|
|
1904
2562
|
get(key: string | string[], cb: (err: Error, items?: any) => void): void;
|
|
@@ -1911,10 +2569,15 @@ declare namespace widget {
|
|
|
1911
2569
|
};
|
|
1912
2570
|
/**
|
|
1913
2571
|
* アクションを表示する
|
|
2572
|
+
*
|
|
2573
|
+
* @remarks
|
|
2574
|
+
* この関数は {@link showAction} のエイリアスです
|
|
2575
|
+
*
|
|
2576
|
+
* @public
|
|
1914
2577
|
*/
|
|
1915
2578
|
export { showAction as show, closeAction as hide };
|
|
1916
2579
|
}
|
|
1917
|
-
export { CloseTrigger, ALL_ACTION_ID, ALL_ACTION_SHORTEN_ID, actionId, ACTION_SHOW_EVENT, ACTION_CLOSE_EVENT, ACTION_DESTROY_EVENT, ACTION_CHANGE_STATE_EVENT, handleState, initialize, finalize, send_event, none, moveTo, linkTo, closeApp, runScript, execOnClickOperation, haveFunction, customAnimation, loadGlobalScript, applyGlobalCss, loadGlobalStyle, hashCode, setAutoStart, Store, getStoreState, SystemConfig, ActionEventHandler, ActionSetting, CustomVariables, actionSetting, getActionSetting, setActionSetting, resetActionSetting, system, getSystem, setSystem, state, setState, getState, states, addState, getStates, opened, isOpened, setOpened, closed, isClosed, setClosed, maximumZindex, setMaximumZindex, internalHandlers, getInternalHandlers, setInternalHandlers, updateInternalHandlers, customHandlers, getCustomHandlers, setCustomHandlers, updateCustomHandlers, destroyed, isDestroyed, setDestroyed, stopped, isStopped, setStopped, customVariables, getCustomVariables, setCustomVariables, updateCustomVariables, FormData, formData, NOOP, isPreview, handleFocus, setPreviousFocus, handleKeydown, getPositionStyle, getTransform, getMarginStyle, ScrollDirection, OnScrollContext, OnScrollFunction, onScroll, onTime, hasSuffix, toBr, randStr, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, hideOnScroll, hideOnTime, showOnScroll, showOnTime, ActionProps, ActionOptions, create, dispatchDestroyEvent, destroy, showAction, closeAction, KARTE_ACTION_ROOT, KARTE_ACTION_RID, KARTE_ACTION_SHORTEN_ID, ensureActionRoot, onCreate, onShow, onClose, onDestroy, onChangeState, h, createFog, EmbedLogic, embed, getActionShadowRoot, applyCss, loadStyle, showModal, ModalOptions, KARTE_MODAL_ROOT, ensureModalRoot, show, close, AppOptions, App, createApp, collection, widget };
|
|
2580
|
+
export { CloseTrigger, ALL_ACTION_ID, ALL_ACTION_SHORTEN_ID, actionId, ACTION_SHOW_EVENT, ACTION_CLOSE_EVENT, ACTION_DESTROY_EVENT, ACTION_CHANGE_STATE_EVENT, handleState, initialize, finalize, send_event, none, moveTo, linkTo, closeApp, runScript, execOnClickOperation, haveFunction, customAnimation, loadGlobalScript, applyGlobalCss, loadGlobalStyle, hashCode, setAutoStart, Store, getStoreState, SystemConfig, ActionEventHandler, ActionSetting, CustomVariables, actionSetting, getActionSetting, setActionSetting, resetActionSetting, system, getSystem, setSystem, state, setState, getState, states, addState, getStates, opened, isOpened, setOpened, closed, isClosed, setClosed, maximumZindex, setMaximumZindex, internalHandlers, getInternalHandlers, setInternalHandlers, updateInternalHandlers, customHandlers, getCustomHandlers, setCustomHandlers, updateCustomHandlers, destroyed, isDestroyed, setDestroyed, stopped, isStopped, setStopped, customVariables, getCustomVariables, setCustomVariables, updateCustomVariables, FormData, formData, NOOP, isPreview, handleFocus, setPreviousFocus, handleKeydown, getPositionStyle, getTransform, getMarginStyle, ScrollDirection, OnScrollContext, OnScrollFunction, onScroll, onTime, hasSuffix, toBr, randStr, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, FormOperationOptions, FormOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, hideOnScroll, hideOnTime, showOnScroll, showOnTime, ActionProps, ActionOptions, create, dispatchDestroyEvent, destroy, showAction, closeAction, KARTE_ACTION_ROOT, KARTE_ACTION_RID, KARTE_ACTION_SHORTEN_ID, ensureActionRoot, ActionHook, onCreate, onShow, ActionCloseHook, onClose, onDestroy, ActionChangeStateHook, onChangeState, h, createFog, EmbedLogic, embed, getActionShadowRoot, applyCss, loadStyle, showModal, ModalOptions, KARTE_MODAL_ROOT, ensureModalRoot, show, close, AppOptions, App, createApp, collection, widget };
|
|
1918
2581
|
export { default as State } from './components/State.svelte';
|
|
1919
2582
|
export { default as StateItem } from './components/StateItem.svelte';
|
|
1920
2583
|
export { default as Modal } from './components/Modal.svelte';
|
|
@@ -1935,6 +2598,7 @@ export { default as FormTextarea } from './components/FormTextarea.svelte';
|
|
|
1935
2598
|
export { default as FormButton } from './components/FormButton.svelte';
|
|
1936
2599
|
export { default as FormRadioButtons } from './components/FormRadioButtons.svelte';
|
|
1937
2600
|
export { default as FormSelect } from './components/FormSelect.svelte';
|
|
2601
|
+
export { default as FormCheckBoxes } from './components/FormCheckBoxes.svelte';
|
|
1938
2602
|
export { default as Slider } from './components/Slider.svelte';
|
|
1939
2603
|
export { default as SliderItem } from './components/SliderItem.svelte';
|
|
1940
2604
|
export { default as TextBlock } from './components/TextBlock.svelte';
|