-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathcomponents.d.ts
More file actions
2636 lines (2633 loc) · 128 KB
/
components.d.ts
File metadata and controls
2636 lines (2633 loc) · 128 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
import { DnnAutocompleteSuggestion, NeedMoreItemsEventArgs } from "./components/dnn-autocomplete/types";
import { CheckedState } from "./components/dnn-checkbox/types";
import { DnnColorInfo } from "./components/dnn-color-input/dnn-color-info";
import { ColorInfo } from "./utilities/colorInfo";
import { DropzoneResx } from "./components/dnn-dropzone/types";
import { ImageCropperResx } from "./components/dnn-image-cropper/types";
import { IPermissions } from "./components/dnn-permissions-grid/permissions-interface";
import { IRoleGroup } from "./components/dnn-permissions-grid/role-group-interface";
import { IRole } from "./components/dnn-permissions-grid/role-interface";
import { ILocalization } from "./components/dnn-permissions-grid/localization-interface";
import { ISearchedUser } from "./components/dnn-permissions-grid/searched-user-interface";
import { Config } from "jodit/types/config";
import { Jodit } from "jodit";
import { DnnToggleChangeEventDetail } from "./components/dnn-toggle/toggle-interface";
export { DnnAutocompleteSuggestion, NeedMoreItemsEventArgs } from "./components/dnn-autocomplete/types";
export { CheckedState } from "./components/dnn-checkbox/types";
export { DnnColorInfo } from "./components/dnn-color-input/dnn-color-info";
export { ColorInfo } from "./utilities/colorInfo";
export { DropzoneResx } from "./components/dnn-dropzone/types";
export { ImageCropperResx } from "./components/dnn-image-cropper/types";
export { IPermissions } from "./components/dnn-permissions-grid/permissions-interface";
export { IRoleGroup } from "./components/dnn-permissions-grid/role-group-interface";
export { IRole } from "./components/dnn-permissions-grid/role-interface";
export { ILocalization } from "./components/dnn-permissions-grid/localization-interface";
export { ISearchedUser } from "./components/dnn-permissions-grid/searched-user-interface";
export { Config } from "jodit/types/config";
export { Jodit } from "jodit";
export { DnnToggleChangeEventDetail } from "./components/dnn-toggle/toggle-interface";
export namespace Components {
interface DnnAutocomplete {
/**
* Defines the type of automatic completion the browser could use. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
* @default "off"
*/
"autocomplete": string;
/**
* Reports the input validity details. See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState
*/
"checkValidity": () => Promise<ValidityState>;
/**
* Defines whether the field is disabled.
*/
"disabled"?: boolean;
/**
* Defines the help label displayed under the field.
*/
"helpText"?: string;
/**
* The label for this autocomplete.
*/
"label"?: string;
/**
* The name for this autocomplete when used in forms.
*/
"name"?: string;
/**
* How many suggestions to preload in pixels of their height. This is used to calculate the virtual scroll height and request more items before they get into view.
* @default 1000
*/
"preloadThresholdPixels": number;
/**
* Callback to render suggestions, if not provided, only the label will be rendered.
*/
"renderSuggestion"?: (suggestion: DnnAutocompleteSuggestion) => HTMLElement;
/**
* Defines whether the field requires having a value.
*/
"required"?: boolean;
/**
* Can be used to set a custom validity message.
*/
"setCustomValidity": (message: string) => Promise<void>;
/**
* Sets the list of suggestions.
* @default []
*/
"suggestions": DnnAutocompleteSuggestion[];
/**
* The total amount of suggestions for the given search query. This can be used to show virtual scroll and pagination progressive feeding. The needMoreItems event should be used to request more items.
*/
"totalSuggestions"?: number;
/**
* Defines the value for this autocomplete
* @default ""
*/
"value": string;
}
interface DnnButton {
/**
* Defines the look of the button.
* @default 'primary'
*/
"appearance": 'primary' | 'danger' | 'secondary' | 'tertiary';
/**
* Optionally add a confirmation dialog before firing the action.
* @default false
*/
"confirm"?: boolean;
/**
* The text of the confirmation message;
* @default "Are you sure ?"
*/
"confirmMessage"?: string;
/**
* The text of the no button for confirmation.
* @default "No"
*/
"confirmNoText"?: string;
/**
* The text of the yes button for confirmation.
* @default "Yes"
*/
"confirmYesText"?: string;
/**
* Disables the button
* @default false
*/
"disabled": boolean;
/**
* @deprecated Use type instead. Optional button type, can be either submit, reset or button and defaults to button if not specified. Warning: DNN wraps the whole page in a form, only use this if you are handling form submission manually. Warning: This will be deprecated in the next version and replaced with a new 'type' property.
* @default 'button'
*/
"formButtonType": 'submit' | 'reset' | 'button';
/**
* Optionally reverses the button style.
* @default false
*/
"reversed": boolean;
/**
* Optionally sets the button size, small normal or large, defaults to normal
* @default 'normal'
*/
"size"?: 'small' | 'normal' | 'large';
/**
* Optional button type, can be either submit, reset or button and defaults to button if not specified. Warning: DNN wraps the whole page in a form, only use this if you are handling form submission manually.
* @default 'button'
*/
"type": 'submit' | 'reset' | 'button';
}
interface DnnCheckbox {
/**
* Reports the input validity details. See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState
*/
"checkValidity": () => Promise<ValidityState>;
/**
* Defines if the checkbox is checked (true) or unchecked (false) or in an intermediate state (undefined)
* @default "unchecked"
*/
"checked": CheckedState;
/**
* The name to show in the formData (if using forms).
* @default ""
*/
"name": string;
/**
* A function that will be called when the checkbox needs to change state and returns the next state. Can be used to customize the order of the states when the component is clicked. Only called if you also use the tri-state feature (useIntermediate).
* @default (currentState) => this.defaultNextStateHandler(currentState)
*/
"nextStateHandler": (currentState: CheckedState) => CheckedState;
/**
* If true, the checkbox needs to be checked for the form validation to succeed.
* @default false
*/
"required": boolean;
/**
* Can be used to customize the validation message when the field is required but not checked.
* @default "The checkbox must be checked"
*/
"requiredMessage": string;
/**
* Defines if clicking the checkbox will go through the intermediate state between checked and unchecked (tri-state)
* @default false
*/
"useIntermediate": boolean;
/**
* The value for this checkbox (not to be confused with its checked state).
* @default "on"
*/
"value": string;
}
interface DnnChevron {
/**
* Collapse text for screen readers
* @default "collapse"
*/
"collapseText"?: string;
/**
* Expand text for screen readers
* @default "expand"
*/
"expandText"?: string;
/**
* Is the chevron expanded
* @default false
*/
"expanded"?: boolean;
}
interface DnnCollapsible {
/**
* Defines if the panel is expanded or not.
* @default false
*/
"expanded": boolean;
/**
* Defines the transition time in ms, defaults to 150ms
* @default 150
*/
"transitionDuration"?: number;
/**
* Updates the component height, use to update after a slot content changes.
*/
"updateSize": () => Promise<void>;
}
/**
* A custom input component that allows previewing and changing a color value.
*/
interface DnnColorInput {
/**
* Sets the initial color, must be a valid 8 character hexadecimal string without the # sign.
* @default "000088"
*/
"color": string;
/**
* Sets the initial contrast color, must be a valid 8 character hexadecimal string without the # sign.
* @default "FFFFFF"
*/
"contrastColor": string;
/**
* Sets the initial dark color, must be a valid 8 character hexadecimal string without the # sign.
* @default "0000044"
*/
"darkColor": string;
/**
* Defines the help label displayed under the field.
*/
"helpText"?: string;
/**
* The label for this input.
*/
"label"?: string;
/**
* Sets the initial light color, must be a valid 8 character hexadecimal string without the # sign.
* @default "00000FF"
*/
"lightColor": string;
/**
* Can be used to customize the text language.
* @default { contrast: "Contrast", preview: "Preview", cancel: "Cancel", confirm: "Confirm", normal: "Normal", light: "Light", dark: "Dark", }
*/
"localization": {
contrast: string,
preview: string,
cancel: string,
confirm: string,
normal: string,
light: string,
dark: string,
};
/**
* The name for this input if forms are used.
*/
"name"?: string;
/**
* Disables interacting with the component.
*/
"readonly"?: boolean;
/**
* If true, the picker will allow selecting a contast color too.
*/
"useContrastColor"?: boolean;
/**
* If true, the picker will allow selecting a dark color too.
*/
"useDarkColor"?: boolean;
/**
* If true, the picker will allow selecting a light color too.
*/
"useLightColor"?: boolean;
}
/**
* Color Picker for Dnn
*/
interface DnnColorPicker {
/**
* Sets the initial color, must be a valid 8 character hexadecimal string without the # sign.
* @default "FFFFFF"
*/
"color": string;
/**
* Sets the width-height ratio of the color picker saturation-lightness box.
* @example 100% renders a perfect square
* @default "50%"
*/
"colorBoxHeight": string;
}
interface DnnContextMenu {
/**
* Closes the menu.
*/
"close": () => Promise<void>;
/**
* If true, the menu will close when an item is clicked.
* @default false
*/
"closeOnClick": boolean;
/**
* Opens the menu using a pointer event.
*/
"open": (event: PointerEvent) => Promise<void>;
}
interface DnnDropzone {
/**
* If true, will allow the user to take a snapshot using the device camera. (only works over https).
* @default false
*/
"allowCameraMode": boolean;
/**
* A list of allowed file extensions. If not specified, any file is allowed. Ex: ["jpg", "jpeg", "gif", "png"]
*/
"allowedExtensions"?: string[];
/**
* Specifies the jpeg quality for when the device camera is used to generate a picture. Needs to be a number between 0 and 1 and defaults to 0.8
* @default 0.8
*/
"captureQuality": number;
/**
* Max file size in bytes.
*/
"maxFileSize"?: number;
/**
* If true, allows multiple file selection.
* @default false
*/
"multiple": boolean;
/**
* The name of the field when used in a form.
*/
"name"?: string;
/**
* Localization strings
*/
"resx"?: DropzoneResx;
}
/**
* Do not use this component in production, it is meant for testing purposes only and is not distributed in the production package.
*/
interface DnnExampleForm {
}
/**
* A custom input component that wraps the html input element is a mobile friendly component that supports a label, some help text and other features.
*/
interface DnnFieldset {
/**
* Sets the fieldset to a disabled state.
*/
"disable": () => Promise<void>;
/**
* If true, the fieldset will display as disabled.
*/
"disabled"?: boolean;
/**
* Sets the fieldset to an enabled state.
*/
"enable": () => Promise<void>;
/**
* If true, the label will float in the container, set false to show it on top.
*/
"floatLabel"?: boolean;
/**
* If true the fieldset will display as focused.
*/
"focused"?: boolean;
/**
* Can be used to show some help text about this field.
*/
"helpText"?: string;
/**
* If true, the fieldset will display as invalid.
*/
"invalid"?: boolean;
/**
* Sets the text of the fieldset label (caption).
*/
"label"?: string;
/**
* Places the label on the top of the container.
*/
"pinLabel": () => Promise<void>;
/**
* Can be set to specify if the fieldset can be resized by the user.
* @default "none"
*/
"resizable": "none" | "both" | "horizontal" | "vertical" | "block" | "inline";
/**
* Unsets the fieldset focused state.
*/
"setBlurred": () => Promise<void>;
/**
* Sets the fieldset to the focused state.
*/
"setFocused": () => Promise<void>;
/**
* Sets the validity of the field.
*/
"setValidity": (valid: boolean, message?: string) => Promise<void>;
/**
* Places the label in the vertical middle of the container.
*/
"unpinLabel": () => Promise<void>;
}
/**
* Allows cropping an image in-browser with the option to enforce a specific final size.
* All computation happens in the browser and the final image is emmited
* in an event that has a data-url of the image.
*/
interface DnnImageCropper {
/**
* Clears the current image and crop (resets the component).
*/
"clear": () => Promise<void>;
/**
* Sets the desired final image height.
*/
"height"?: number;
/**
* The name of the control when used in a form.
*/
"name"?: string;
/**
* When set to true, prevents cropping an image smaller than the required size, which would blow pixel and make the final picture look blurry.
* @default false
*/
"preventUndersized": boolean;
/**
* Sets the output quality of the cropped image (number between 0 and 1).
* @default 0.8
*/
"quality": number;
/**
* Can be used to customize controls text. Some values support tokens, see default values for examples.
*/
"resx"?: ImageCropperResx;
/**
* Sets the desired final image width.
*/
"width"?: number;
}
/**
* A custom input component that wraps the html input element is a mobile friendly component that supports a label, some help text and other features.
*/
interface DnnInput {
/**
* If true, enables users to switch between a password and a text field (to view their password).
*/
"allowShowPassword"?: boolean;
/**
* Defines the type of auto-completion to use for this field, see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete.
* @default "off"
*/
"autocomplete": string;
/**
* Reports the input validity details. See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState
*/
"checkValidity": () => Promise<ValidityState>;
/**
* @deprecated This control has it's own validation reporting, will be removed in v0.25.0
*/
"disableValidityReporting"?: boolean;
/**
* Defines whether the field is disabled.
*/
"disabled"?: boolean;
/**
* Defines the help label displayed under the field.
*/
"helpText"?: string;
/**
* Hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard.
*/
"inputmode"?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search";
/**
* The label for this input.
*/
"label"?: string;
/**
* Defines the maximum allowed value.
*/
"max"?: number | string;
/**
* Defines the maximum amount of charaters.
*/
"maxlength"?: number;
/**
* Defines the minimum allowed value.
*/
"min"?: number | string;
/**
* Defines the minimum amount of charaters.
*/
"minlength"?: number;
/**
* If true, allows multiple emails to be entered separated by commas.
*/
"multiple"?: boolean;
/**
* The name for this input when used in forms.
*/
"name"?: string;
/**
* Valid for text, search, url, tel, email, and password, the pattern attribute defines a regular expression that the input's value must match in order for the value to pass constraint validation.
*/
"pattern"?: string;
/**
* Defines wheter the defined value is readonly.
*/
"readonly"?: boolean;
/**
* Defines whether the field requires having a value.
*/
"required"?: boolean;
/**
* Can be used to set a custom validity message.
*/
"setCustomValidity": (message: string) => Promise<void>;
/**
* Defines the possible steps for numbers and dates/times. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date#step
*/
"step"?: string | number;
/**
* The input type, supports most of html standard input type, see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types.
* @default "text"
*/
"type": "date" | "datetime-local" | "email" | "number" | "password" | "tel" | "text" | "time" | "url" | "search";
/**
* The value of the input.
* @default ""
*/
"value": number | string | string[];
}
interface DnnModal {
/**
* @deprecated boolean props should always default to being false per html specs, use preventBackdropDismiss instead, will be removed in v0.28.0. Pass false to remove the backdrop click auto-dismiss feature.
*/
"backdropDismiss"?: boolean;
/**
* Optionally pass the aria-label text for the close button. Defaults to "Close modal" if not provided.
* @default "Close modal"
*/
"closeText"?: string;
/**
* Hides the modal
*/
"hide": () => Promise<void>;
/**
* Optionally you can pass true to not show the close button. If you decide to do so, you should either not also prevent dismissal by clicking the backdrop or provide your own dismissal logic in the modal content.
* @default false
*/
"hideCloseButton": boolean;
/**
* Pass true to remove the backdrop click auto-dismiss feature. Defaults to false.
* @default false
*/
"preventBackdropDismiss"?: boolean;
/**
* If set to true, the modal becomes resizable.
* @default false
*/
"resizable"?: boolean;
/**
* Shows the modal
*/
"show": () => Promise<void>;
/**
* @deprecated boolean props should always default to being false per html specs, use hideCloseButton instead, will be removed in v0.28.0. Optionally you can pass false to not show the close button. If you decide to do so, you should either not also prevent dismissal by clicking the backdrop or provide your own dismissal logic in the modal content.
*/
"showCloseButton"?: boolean;
/**
* Reflects the visible state of the modal.
* @default false
*/
"visible": boolean;
}
interface DnnMonacoEditor {
/**
* Defines the language for the editor.
* @default "html"
*/
"language": "plaintext" | "bat" | "coffeescript" | "c" | "cpp" | "csharp" | "dockerfile" | "fsharp" | "go" | "handlebars" | "html" | "ini" | "pug" | "java" | "lua" | "markdown" | "msdax" | "objective-c" | "postiats" | "php" | "powershell" | "python" | "r" | "razor" | "ruby" | "swift" | "sql" | "vb" | "xml" | "less" | "scss" | "css" | "yaml" | "sol" | "sb" | "json" | "typescript" | "javascript";
/**
* The name of the control to use for forms.
*/
"name"?: string;
/**
* Sets the code contained in the editor
* @default ""
*/
"value": string;
}
interface DnnPermissionsGrid {
/**
* The list of users to show under the search users field when a search is performed.
* @default []
*/
"foundUsers": ISearchedUser[];
/**
* The list of permissions.
*/
"permissions": IPermissions;
/**
* Optionally allows localizing the component strings.
*/
"resx"?: ILocalization;
/**
* The list of role groups.
*/
"roleGroups": IRoleGroup[];
/**
* The list of possible roles.
*/
"roles": IRole[];
}
interface DnnProgressBar {
/**
* Sets the max value for the progress bar.
* @default 100
*/
"max": number;
/**
* Determines if gradient colors will be used for progress bar.
* @default false
*/
"useGradient": boolean;
/**
* Sets to current value for the progress bar.
* @default 0
*/
"value": number;
}
interface DnnRichtext {
/**
* Customize the options before initializing the editor, will have all the default options merged with 'options' if passed. This is called last after merging default options with your custom 'options' and just before initializing the editor.
*/
"customizeOptions"?: (options: Config) => Config;
/**
* Name of the field when used in a form.
*/
"name"?: string;
/**
* Optional configuration for Jodit, see https://xdsoft.net/jodit/docs/classes/config.Config.html This will be merged with the default options and passed to the editor. If you prefer to not have to pass a full config object, you can use 'customizeOptions' to modify the options before initializing the editor instead of providing all options here.
*/
"options"?: Config;
/**
* Allows registering your own plugins. The callback will be called with the editor instance as the only argument durig initialization. All other behavior needs to be implemented in the plugin itself using editor.on("eventname"). See https://xdsoft.net/jodit/examples/plugin/custom_plugin.html for an example. Creating a plugin does NOT automatically add it to the toolbar, you need to do that yourself in 'options' or 'customizeOptions', See https://xdsoft.net/jodit/examples/toolbar/custom_button.html for an example.
* @default []
*/
"plugins": {name: string, callback: (editor: Jodit) => void}[];
/**
* Sets the value of the content of the editor.
* @default ""
*/
"value": string;
}
interface DnnSearchbox {
/**
* How many milliseconds to wait before firing the queryChanged event.
* @default 500
*/
"debounceTime": number;
/**
* Sets the field placeholder text.
* @default ""
*/
"placeholder"?: string;
/**
* Sets the query
* @default ""
*/
"query": string;
}
interface DnnSelect {
/**
* Defines the type of automatic completion the browser can use. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
* @default "off"
*/
"autocomplete": string;
/**
* Reports the input validity details. See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState
*/
"checkValidity": () => Promise<ValidityState>;
/**
* Defines whether the field is disabled.
*/
"disabled"?: boolean;
/**
* Defines the help label displayed under the field.
*/
"helpText"?: string;
/**
* The label for this input.
*/
"label"?: string;
/**
* The name for this input, if used in forms.
*/
"name"?: string;
/**
* Defines whether the field requires having a value.
*/
"required"?: boolean;
/**
* The value of the input.
* @default ""
*/
"value": string;
}
interface DnnSortIcon {
/**
* Defines the current sort direction
* @default "none"
*/
"sortDirection": "asc" | "desc" | "none";
}
/**
* Represents a single tab and must be used inside a dnn-tabs element.
*/
interface DnnTab {
/**
* Hides the modal
*/
"hide": () => Promise<void>;
/**
* Shows the tab.
*/
"show": () => Promise<void>;
/**
* Defines the tab title.
*/
"tabTitle": string;
}
interface DnnTabs {
}
/**
* A custom textarea component.
*/
interface DnnTextarea {
/**
* Defines the type of auto-completion to use for this field, see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete.
* @default "off"
*/
"autocomplete": string;
/**
* Reports the input validity details. See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState
*/
"checkValidity": () => Promise<ValidityState>;
/**
* Defines whether the field is disabled.
*/
"disabled"?: boolean;
/**
* Defines the help label displayed under the field.
*/
"helpText"?: string;
/**
* The label for this input.
*/
"label"?: string;
/**
* Defines the maximum amount of charaters.
*/
"maxlength"?: number;
/**
* Defines the minimum amount of charaters.
*/
"minlength"?: number;
/**
* The name for this input when used in forms.
*/
"name"?: string;
/**
* Defines wheter the defined value is readonly.
*/
"readonly"?: boolean;
/**
* Defines whether the field requires having a value.
*/
"required"?: boolean;
/**
* Can be set to change how the user can resize the field.
* @default "block"
*/
"resizable": "none" | "both" | "horizontal" | "vertical" | "block" | "inline";
/**
* Defines how many rows (lines of text) to initially show.
* @default 3
*/
"rows": number;
/**
* Can be used to set a custom validity message.
*/
"setCustomValidity": (message: string) => Promise<void>;
/**
* Sets the value of the textarea.
* @default ""
*/
"value": string;
}
interface DnnToggle {
/**
* If 'true' the toggle is checked (on).
* @default false
*/
"checked": boolean;
/**
* If 'true' the toggle is not be interacted with.
* @default false
*/
"disabled": boolean;
/**
* The field name to use in forms.
*/
"name"?: string;
/**
* The value to post when used in forms.
* @default "on"
*/
"value": string;
}
interface DnnTreeviewItem {
/**
* Defines if the current node is expanded.
* @default false
*/
"expanded": boolean;
}
/**
* A component that shows a vertical list of items as they fit. When they don't all fit, it puts the ones that don't fit into a dropdown menu.
*/
interface DnnVerticalOverflowMenu {
}
interface DnnVerticalSplitview {
/**
* Gets the current divider position percentage.
*/
"getSplitWidthPercentage": () => Promise<number>;
/**
* Sets the width percentage of the divider
*/
"setSplitWidthPercentage": (newWidth: number) => Promise<void>;
/**
* The percentage position of the splitter in the container.
* @default 30
*/
"splitWidthPercentage": number;
/**
* The width of the splitter area.
* @default 16
*/
"splitterWidth": number;
}
}
export interface DnnAutocompleteCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnAutocompleteElement;
}
export interface DnnButtonCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnButtonElement;
}
export interface DnnCheckboxCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnCheckboxElement;
}
export interface DnnChevronCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnChevronElement;
}
export interface DnnCollapsibleCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnCollapsibleElement;
}
export interface DnnColorInputCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnColorInputElement;
}
export interface DnnColorPickerCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnColorPickerElement;
}
export interface DnnDropzoneCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnDropzoneElement;
}
export interface DnnImageCropperCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnImageCropperElement;
}
export interface DnnInputCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnInputElement;
}
export interface DnnModalCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnModalElement;
}
export interface DnnMonacoEditorCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnMonacoEditorElement;
}
export interface DnnPermissionsGridCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnPermissionsGridElement;
}
export interface DnnRichtextCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnRichtextElement;
}
export interface DnnSearchboxCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnSearchboxElement;
}
export interface DnnSelectCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnSelectElement;
}
export interface DnnSortIconCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnSortIconElement;
}
export interface DnnTextareaCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnTextareaElement;
}
export interface DnnToggleCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnToggleElement;
}
export interface DnnTreeviewItemCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnTreeviewItemElement;
}
export interface DnnVerticalSplitviewCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLDnnVerticalSplitviewElement;
}
declare global {
interface HTMLDnnAutocompleteElementEventMap {
"valueChange": number | string | string[];
"valueInput": number | string | string[];
"needMoreItems": NeedMoreItemsEventArgs;
"searchQueryChanged": string;
"itemSelected": string;
}
interface HTMLDnnAutocompleteElement extends Components.DnnAutocomplete, HTMLStencilElement {
addEventListener<K extends keyof HTMLDnnAutocompleteElementEventMap>(type: K, listener: (this: HTMLDnnAutocompleteElement, ev: DnnAutocompleteCustomEvent<HTMLDnnAutocompleteElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
removeEventListener<K extends keyof HTMLDnnAutocompleteElementEventMap>(type: K, listener: (this: HTMLDnnAutocompleteElement, ev: DnnAutocompleteCustomEvent<HTMLDnnAutocompleteElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
}
var HTMLDnnAutocompleteElement: {
prototype: HTMLDnnAutocompleteElement;
new (): HTMLDnnAutocompleteElement;
};
interface HTMLDnnButtonElementEventMap {
"confirmed": any;
"canceled": any;
}
interface HTMLDnnButtonElement extends Components.DnnButton, HTMLStencilElement {
addEventListener<K extends keyof HTMLDnnButtonElementEventMap>(type: K, listener: (this: HTMLDnnButtonElement, ev: DnnButtonCustomEvent<HTMLDnnButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
removeEventListener<K extends keyof HTMLDnnButtonElementEventMap>(type: K, listener: (this: HTMLDnnButtonElement, ev: DnnButtonCustomEvent<HTMLDnnButtonElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
}
var HTMLDnnButtonElement: {
prototype: HTMLDnnButtonElement;
new (): HTMLDnnButtonElement;
};
interface HTMLDnnCheckboxElementEventMap {
"checkedchange": "checked" | "unchecked" | "intermediate";
}
interface HTMLDnnCheckboxElement extends Components.DnnCheckbox, HTMLStencilElement {
addEventListener<K extends keyof HTMLDnnCheckboxElementEventMap>(type: K, listener: (this: HTMLDnnCheckboxElement, ev: DnnCheckboxCustomEvent<HTMLDnnCheckboxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
removeEventListener<K extends keyof HTMLDnnCheckboxElementEventMap>(type: K, listener: (this: HTMLDnnCheckboxElement, ev: DnnCheckboxCustomEvent<HTMLDnnCheckboxElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;