-
Notifications
You must be signed in to change notification settings - Fork 12
/
uikit.d.ts
1539 lines (1446 loc) · 36.2 KB
/
uikit.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare namespace UIkit {
interface DropdownElement {
/**
* Show the dropdown
*/
show(): void;
/**
* Hide the dropdown
*/
hide(force?: boolean): void;
}
type DropdownPosition =
| 'bottom-left'
| 'bottom-center'
| 'bottom-right'
| 'top-left'
| 'top-center'
| 'top-right'
| 'left-top'
| 'left-center'
| 'left-bottom'
| 'right-top'
| 'right-center'
| 'right-bottom';
interface DropdownOptions {
/**
* Dropdown position
* @default 'bottom-left'
*/
pos?: DropdownPosition;
/**
* Dropdown trigger behaviour
* @default 'hover'
*/
mode?: 'hover' | 'click';
/**
* Remain time before auto closing dropdown in hover mode
* @default 800
*/
remaintime?: number;
/**
* Stretch dropdown width to a specified element
* @default false
*/
justify?: string | HTMLElement | false;
/**
* Referenced element to keep dropdowns visibilty
* @default window
*/
boundary?: string | HTMLElement | Window;
/**
* Delay time in hover mode before a dropdown is shown in ms
* @default 0
*/
delay?: number;
/**
* Dropdown selector
* @default '.uk-dropdown,.uk-dropdown-blank'
*/
dropdownSelector?: string | HTMLElement;
/**
* Is added to the delay time when hovering from one active dropdown to another dropdown (in ms)
* @default 250
*/
hoverDelayIdle?: number;
/**
* Prevent automatic dropdown flip
* Possible values: 'x', 'y', true, false
* @default false
*/
preventflip?: 'x' | 'y' | boolean;
}
/**
* Create a toggleable dropdown with different styles
* Documentation: {@link http://getuikit.org/docs/dropdown.html}
*
* Events:
* Name Description
* show.uk.dropdown Triggered on dropdown show
* hide.uk.dropdown Triggered on dropdown hide
* stack.uk.dropdown Triggered when a dropdown stacks to fit into screen
*/
type Dropdown = (selector: string | HTMLElement, options?: DropdownOptions) => DropdownElement;
interface ModalElement {
/**
* Show the modal
*/
show(): void;
/**
* Hide the modal
*/
hide(): void;
/**
* Return if the modal is active on the page
* @return True if the modal is current active on the page, false otherwise
*/
isActive(): boolean;
}
interface ModalOptions {
/**
* Close the modal when the Esc key is pressed.
*
* @default true
*/
escClose?: boolean;
/**
* Close the modal when the background is clicked.
*
* @default true
*/
bgClose?: boolean;
/**
* Stack modals, when more than one is open.
* By default, the previous modal will be hidden.
*
* @default false
*/
stack?: boolean;
/**
* Define a target container via a selector to specify where the modal
* should be appended in the DOM.
* Setting it to false will prevent this behavior.
*
* @default true
*/
container?: string | boolean;
/**
* Class to add to <html> when modal is active
*
* @default 'uk-modal-page'
*/
clsPage?: string;
/**
* Class of the element to be considered the panel of the modal
*
* @default 'uk-modal-dialog'
*/
clsPanel?: string;
/**
* CSS selector for all elements that should trigger the closing of the modal
*
* @default '.uk-modal-close, .uk-modal-close-default, .uk-modal-close-outside, .uk-modal-close-full'
*/
selClose?: string;
/**
* classes that the root `div` element should have.
*
* Note that when you specify this, the default 'uk-modal-dialog' is not appended
* automatically. A common use-case for this is to have the 'uk-modal-dialog' element
* also have the 'uk-modal-body' class.
*
* @default 'uk-modal-dialog'
*/
className?: string;
}
/**
* Create modal dialogs with different styles and transitions
* Documentation: {@link http://getuikit.org/docs/modal.html}
*
* <h2>Events</h2>
*
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
*
* <tr>
* <td><code>show.uk.modal</code></td>
* <td>event</td>
* <td>On modal show</td>
* </tr>
* <tr>
* <td><code>hide.uk.modal</code></td>
* <td>event</td>
* <td>On modal hide</td>
* </tr>
* </table>
* @example
* <pre><code>
* $('.modalSelector').on({
* 'show.uk.modal': function(){
* console.log("Modal is visible.");
* },
*
* 'hide.uk.modal': function(){
* console.log("Element is not visible.");
* }
* });
* </code></pre>
*/
interface Modal {
/**
* Create a alert dialog
* @param message The message to display. Can be Html
*/
alert(message: string): void;
/**
* Create a confirm dialog
* @param message The message to display. Can be Html
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options
*/
confirm(message: string, options?: ModalOptions): void;
/**
* Create a confirm dialog and execute onconfirm on confirmation
* @param message The message to display. Can be Html
* @param onconfirm A function to execute on confirmation
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options
*/
confirm(message: string, onconfirm: () => any, options?: ModalOptions): void;
/**
* Create a confirm dialog and execute onconfirm on confirmation and oncancel on cancelation.
* @param message The message to display. Can be Html
* @param onconfirm A function to execute on confirmation
* @param oncancel A function to execute on cancelation
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options
*/
confirm(
message: string,
onconfirm: () => any,
oncancel?: () => any,
options?: ModalOptions,
): void;
/**
* Create a prompt dialog, where the user enter information
* @param message The message to display. Can be Html
* @param value A value to init the input
* @param fn A function to execute on submission. The function receive the new value as a parameter
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options
*/
prompt(
message: string,
value: string,
onsubmit?: (newValue: string) => any,
options?: ModalOptions,
): void;
/**
* Create a modal that blocks the entire page
* @param content A content to display. Can be Html
* @param [options={bgclose: true, keyboard: false, modal: false}] The modal options
*/
blockUI(content: string, options?: ModalOptions): ModalElement;
/**
* Select a modal element on page and return it.
* @example
* <pre><code>
* var modal = UIkit.modal(".modalSelector");
*
* if ( modal.isActive() ) {
* modal.hide();
* } else {
* modal.show();
* }
* </code></pre>
*/
(selector: string | HTMLElement, options?: ModalOptions): ModalElement;
}
/**
* Create a smooth off-canvas sidebar that slides in and out of the page
* Documentation: {@link http://getuikit.org/docs/offcanvas.html}
* <h2>Events:</h2>
* <table class="uk-table uk-table-striped uk-text-nowrap">
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>show.uk.offcanvas</code></td>
* <td>event, panel, bar</td>
* <td>On offcanvas show</td>
* </tr>
* <tr>
* <td><code>hide.uk.offcanvas</code></td>
* <td>event, panel, bar</td>
* <td>On offcanvas hide</td>
* </tr>
* </table>
*/
interface OffCanvas {
/**
* Show an off-canvas matching the passed CSS selector
* @param selector A CSS selector
*/
show(selector: string): void;
/**
* Hide any active offcanvas. Set force to true, if you don't want any
* animation
* @param force When seted to true do not run animations.
* @default false
*/
hide(force?: boolean): void;
}
interface LightBoxOptions {
/**
* Group name to group elements as a gallery to show.
* @default false
*/
group?: string;
/**
* Animation duration between gallery item change
* @default 400
*/
duration?: number;
/**
* Allow keyboard navigation
* @default true
*/
keyboard?: boolean;
}
interface LightBoxItem {
source: string;
type: string;
}
interface LightBoxElement {
/**
* Open the lightbox
*/
show(): void;
}
/**
* Create a fancy lightbox for images and videos utilizing the @see {@link modal|Modal Component}
* Documentation {@link http://getuikit.org/docs/lightbox.html}
* <h2>Events:</h2>
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>showitem.uk.lightbox</code></td>
* <td>event, data</td>
* <td>On lightbox show</td>
* </tr>
* </table>
*/
interface LightBox {
/**
* Create dynamic lightbox
* @param items Group of items on the lightbox
* @return The lightbox element to show
*/
create(items: LightBoxItem[]): LightBoxElement;
/**
* Init element manually
*/
(element: string | HTMLElement, options?: LightBoxOptions): LightBoxElement;
}
type CallbackAutoComplete = () => string;
interface AutoCompleteOptions {
/**
* Data source
* @default []
*/
source?: string | string[] | CallbackAutoComplete;
/**
* Min. input length before triggering autocomplete
* @default 3
*/
minLength?: number;
/**
* Query name when sending ajax request
* @default search
*/
param?: string;
/**
* Delay time after stop typing
* @default 300
*/
delay?: number;
}
/**
* Create inputs that allow users to choose from a list of pre-generated values while typing
* Documentation {@link http://getuikit.org/docs/autocomplete.html}
* <h2>Events</h2>
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>selectitem.uk.autocomplete</code></td>
* <td>event, data, acobject</td>
* <td>On item selected</td>
* </tr>
* <tr>
* <td><code>show.uk.autocomplete</code></td>
* <td>event</td>
* <td>On autocomplete dropdown show</td>
* </tr>
* </table>
*/
type AutoComplete = (element: string | HTMLElement, options?: AutoCompleteOptions) => any;
interface DatePickerOptions {
/**
* Start of the week
* integer (0..6)
* @default 1
*/
weekstart?: number;
/**
* Language string definitions
* @default { months:['January',...], weekdays:['Sun',..,'Sat'] }
*/
i18n?: {};
/**
* Date format string
* @default 'DD.MM.YYYY'
*/
format?: string;
/**
* Offset to the input value
* @default 5
*/
offsettop?: number;
/**
* Min. date
* bool (false to ignore the option)
* string (date as in format)
* integer (offset in days from current date)
* @default false
*/
minDate?: string | boolean | number;
/**
* Max. date
* bool (false to ignore the option)
* string (date as in format)
* integer (offset in days from current date)
* @default false
*/
maxDate?: string | boolean | number;
/**
* Position of the datepicker
* 'auto', 'top', 'bottom'
* @default 'auto'
*/
pos?: string;
}
/**
* Create a toggleable dropdown with an datepicker
* Documentation {@link http://getuikit.org/docs/datepicker.html}
* <h2>Events</h2>
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>show.uk.datepicker</code></td>
* <td>event</td>
* <td>On datepicker dropdown show</td>
* </tr>
* <tr>
* <td><code>hide.uk.datepicker</code></td>
* <td>event</td>
* <td>On datepicker dropdown hide</td>
* </tr>
* <tr>
* <td><code>update.uk.datepicker</code></td>
* <td>event</td>
* <td>On calendar rendering</td>
* </tr>
* </table>
*/
type DatePicker = (element: string | HTMLElement, options?: DatePickerOptions) => any;
interface HtmlEditorOptions {
/**
* View mode
* Possible values 'split','tab'
* @default 'split'
*/
mode?: string;
/**
* Button list to appear in the toolbar
* @default [ "bold", "italic", "strike", "link", "picture", ... ]
*/
toolbar?: string[];
/**
* Min. browser width when to switch to responsive tab mode when in split mode
* @default 1000
*/
maxsplitsize?: number;
/**
* Label string for preview mode
* @default 'Preview'
*/
lblPreview?: string;
/**
* Label string for code mode
* @default 'Markdown'
*/
lblCodeview?: string;
}
/**
* Create a rich HTML or markdown editor with an immediate preview and syntax highlighting
* Documentation {@link http://getuikit.org/docs/htmleditor.html}
*/
type HtmlEditor = (element: string | HTMLElement, options?: HtmlEditorOptions) => any;
interface SliderOptions {
/**
* Center items mode
* @default false
*/
center?: boolean;
/**
* Mouse movement threshold in pixel until trigger element dragging
* @default true
*/
threshold?: boolean;
/**
* Infinite scrolling
* @default true
*/
infinite?: boolean;
/**
* Class added on active item in center mode
* @default uk-active
*/
activecls?: string;
/**
* Defines whether or not the slider items should switch automatically
* @default false
*/
autoplay?: boolean;
/**
* Pause autoplay when hovering a slider
* @default true
*/
pauseOnHover?: boolean;
/**
* Defines the timespan between switching slider items
* @default 7000
*/
autoplayInterval?: number;
}
/**
* Create a list of items to use as a responsive carousel slider
* Documentation {@link http://getuikit.org/docs/slider.html}
* <h2>Events</h2>
* <table class="uk-table uk-table-striped uk-text-nowrap">
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>focusitem.uk.slider</code></td>
* <td>event, index, item</td>
* <td>On item focus</td>
* </tr>
* </table>
*/
type Slider = (element: string | HTMLElement, options?: SliderOptions) => any;
interface SlideSetOptions {
/**
* Default visible items in a set
* @default 1
*/
default?: number;
/**
* Visible items in a set at small breakpoint
* @default null
*/
small?: number;
/**
* Visible items in a set at medium breakpoint
* @default null
*/
medium?: number;
/**
* Visible items in a set at large breakpoint
* @default null
*/
large?: number;
/**
* Visible items in a set at xlarge breakpoint
* @default null
*/
xlarge?: number;
/**
* Animation name
* @default 'fade'
*/
animation?: string;
/**
* Animation duration in ms
* @default 200
*/
duration?: number;
/**
* Animation delay between items in a set
* @default 100
*/
delay?: number;
/**
* Items filter
* @default ""
*/
filter?: string;
/**
* Defines whether or not the slideset items should switch automatically.
* @default false
*/
autoplay?: boolean;
/**
* Pause autoplay when hovering a slideset.
* @default true
*/
pauseOnHover?: boolean;
/**
* Defines the timespan between switching slideset items.
* @default 7000
*/
autoplayInterval?: number;
}
/**
* Create sets and groups of items, allowing to loop through the sets.
* Documentation {@link http://getuikit.org/docs/slideset.html}
* <h2>Events</h2>
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>show.uk.slideset</code></td>
* <td>event, set</td>
* <td>On set show</td>
* </tr>
* </table>
*/
type SlideSet = (element: string | HTMLElement, options?: SlideSetOptions) => any;
interface SlideShowOptions {
/**
* Defines the preferred transition between items.
* @default 'fade
*/
animation?: string;
/**
* Defines the transition duration.
* @default 500
*/
duration?: number;
/**
* Defines the slideshow height.
* @default 'auto'
*/
height?: string;
/**
* Defines the first slideshow item to be displayed.
* @default 0
*/
start?: number;
/**
* Defines whether or not the slideshow items should switch automatically.
* @default false
*/
autoplay?: boolean;
/**
* Pause autoplay when hovering a slideshow.
* @default true
*/
pauseOnHover?: boolean;
/**
* Defines the timespan between switching slideshow items.
* @default 7000
*/
autoplayInterval?: number;
/**
* Defines whether or not a video starts automatically.
* @default true
*/
videoautoplay?: boolean;
/**
* Defines whether or not a video is muted.
* @default false
*/
videomute?: boolean;
/**
* Defines whether or not the Ken Burns effect is active. If kenburns is a numeric value, it will be used as
* the animation duration.
* @default false
*/
kenburns?: boolean;
/**
* Animation series.
* @default 'uk-animation-middle-left, uk-animation-top-right, uk-animation-bottom-left, uk-animation-top-center,uk-animation-bottom-right'
*/
kenburnsanimations?: string;
/**
* Defines the number of slices, if a "Slice" transition is set.
* @default 15
*/
slices?: number;
}
/**
* Create a responsive image or video slideshow with stunning transition effects, fullscreen mode and overlays.
* Documentation {@link http://getuikit.org/docs/slideshow.html}
* <h2>Events</h2>
* <table>
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>show.uk.slideshow</code></td>
* <td>event, next slide</td>
* <td>On showing a new slide (after animation is finished)</td>
* </tr>
* </table>
*/
type SlideShow = (element: string | HTMLElement, options: SlideShowOptions) => any;
interface ParallaxOptions {
/**
* Animation velocity during scrolling
* @default 0.5
*/
velocity?: number;
/**
* Element dimension reference for animation duration.
* @default false
*/
target?: boolean;
/**
* Animation range depending on the viewport.
* <h2>Possible value</h2>
* float (0 to 1)
* @default false
*/
viewport?: number;
/**
* Condition for the active status with a width as integer (e.g. 640) or a css media query
* @default false
* <h2>Possible Value</h2>
* integer / string
*/
media?: number | string;
}
/**
* Animate CSS properties depending on the scroll position of the document.
* Documentation {@link http://getuikit.org/docs/parallax.html}
*/
type Parallax = (element: string | HTMLElement, options: ParallaxOptions) => any;
interface AccordionOptions {
/**
* Show first item on init
* @default true
* <h2>Possible value</h2>
* boolean
*/
showfirst?: boolean;
/**
* Allow multiple open items
* @default true
* <h2>Possible value</h2>
* boolean
*/
collapse?: boolean;
/**
* Animate toggle
* @default true
* <h2>Possible value</h2>
* boolean
*/
animate?: boolean;
/**
* Animation function
* @default swing
* <h2>Possible value</h2>
* string
*/
easing?: string;
/**
* Animation duration
* @default 300
* <h2>Possible value</h2>
* integer
*/
duration?: number;
/**
* Css selector for toggles
* @default .uk-accordion-title
* <h2>Possible value</h2>
* string
*/
toggle?: string;
/**
* Css selector for content containers
* @default .uk-accordion-content
* <h2>Possible value</h2>
* string
*/
containers?: string;
/**
* Class to add when an item is active
* @default uk-active
* <h2>Possible value</h2>
* string
*/
clsactive?: string;
}
/**
* Create a list of items, allowing each item's content to be expanded and collapsed by clicking its header.
* Documentation {@link http://getuikit.org/docs/accordion.html}
* <h2>Events</h2>
* <table class="uk-table uk-table-striped uk-text-nowrap">
* <tr>
* <th>Name</th>
* <th>Parameter</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><code>toggle.uk.accordion</code></td>
* <td>event, active, toggle, content</td>
* <td>On item toggle</td>
* </tr>
* </table>
*/
type Accordion = (element: string | HTMLElement, options: AccordionOptions) => any;
interface NotifyOptions {
/**
* The message to display
*/
message?: string;
/**
* A notification can be styled by adding a status to the message to indicate an info, success, warning or a
* danger status.
* <h2>Possible values</h2>
* info, sucess, warning, danger
* If you want to create one set its style with the CSS class uk-notify-message-yourStatus
* @default 'info'
*/
status?: string;
/**
* Amount of tiem in milliseconds a messa is visible. Set to 0 for sticky message
* @default 5000
*/
timeout?: number;
/**
* Adjust the notification's position to different corners.
* @default 'top-center'
* <h2>Possible values</h2>
* top-center, top-left, top-right, bottom-center, bottom-left, bottom-right
* If you want to create one value set its style with the CSS uk-notify-yourPosition
*/
pos?: string;
}
/**
* Create toggleable notifications that fade out automatically
* Documentation {@link http://getuikit.org/docs/notify.html}
*/
interface Notify {
/**
* Show a notification
* @param message The html message
* @param [status] The status or options
*/
(message: string, status?: string | NotifyOptions): any;
/**
* Show a notification
* @param options Options
*/
(options: NotifyOptions): any;
}
interface SearchOptions {
/**
* Data source url
* @default ''
* <h2>Possible value</h2>
* string
*/
source?: string;
/**
* Min. input length before triggering autocomplete
* @default 3
* <h2>Possible value</h2>
* integer
*/
minLength?: number;
/**
* Query name when sending ajax request
* @default search
* <h2>Possible value</h2>
* string
*/
param?: string;
/**
* Delay time after stop typing
* @default 300
* <h2>Possible value</h2>
* integer
*/
delay?: number;
}
/**
* Easily create a nicely looking search.
* Documentation {@link http://getuikit.org/docs/search.html}
*/
type Search = (element: string | HTMLElement, options: SearchOptions) => any;
interface NestableOptions {
/**
* List group
* @default false
* <h2>Possible value</h2>
* string
*/
group?: string;
/**
* Max nesting level
* @default 10
* <h2>Possible value</h2>
* integer
*/
maxDepth?: number;
/**
* Pixel threshold before starting to drag
* @default 20
* <h2>Possible value</h2>
* integer
*/
threshold?: number;
/**
* List node name
* @default ul
* <h2>Possible value</h2>