-
Notifications
You must be signed in to change notification settings - Fork 2
/
vuetify.py
11006 lines (9767 loc) · 410 KB
/
vuetify.py
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
##########################################################
# DO NOT EDIT: GENERATED FILE
# => instead run: $ROOT/vue-components/generate_python.py
##########################################################
from trame_client.widgets.core import AbstractElement, Template # noqa
from trame_vuetify.module import vue2
class HtmlElement(AbstractElement):
def __init__(self, _elem_name, children=None, **kwargs):
super().__init__(_elem_name, children, **kwargs)
if self.server:
self.server.enable_module(vue2)
try:
import numpy as np
from numbers import Number
except Exception:
# dataframe_to_grid won't work
pass
type_mapper = {
"b": ["textColumn"],
"i": [], # ["numericColumn", "numberColumnFilter"],
"u": [], # ["numericColumn", "numberColumnFilter"],
"f": [], # ["numericColumn", "numberColumnFilter"],
"c": [],
"m": [], # ['timedeltaFormat'],
"M": [], # ["dateColumnFilter", "shortDateTimeFormat"],
"O": [],
"S": [],
"U": [],
"V": [],
}
def cast_to_serializable(value):
isoformat = getattr(value, "isoformat", None)
if (isoformat) and callable(isoformat):
return isoformat()
elif isinstance(value, Number):
if np.isnan(value) or np.isinf(value):
return value.__str__()
return value
return value.__str__()
def dataframe_to_grid(dataframe, options={}):
"""
Transform a dataframe for use with a VDataTable
:param dataframe: A pandas dataframe
:param options: Control which columns are sortable, filterable, grouped, aligned, etc. A dictionary where keys are the columns from the dataframe and values are Vuetify DataTableHeader objects. See more info |header_doc_link|.
.. |header_doc_link| raw:: html
<a href="https://vuetifyjs.com/en/api/v-data-table/#props-headers" target="_blank">here</a>
>>> headers, rows = vuetify.dataframe_to_grid(dataframe)
>>> VDataTable(
... headers=("table_headers", headers),
... items=("table_rows", rows))
"""
headers = {}
for col_name in dataframe.columns:
headers[col_name] = {"text": col_name, "value": col_name}
if options.get(col_name):
headers[col_name].update(options.get(col_name))
return list(headers.values()), dataframe.applymap(cast_to_serializable).to_dict(
orient="records"
)
slot_names = [
"action",
"actions",
"activator",
"append",
"append-item",
"append-outer",
"appendIcon",
"badge",
"body",
"body.append",
"body.prepend",
"category",
"close",
"counter",
"day",
"day-body",
"day-header",
"day-label",
"day-label-header",
"day-month",
"default",
"divider",
"event",
"expanded-item",
"extension",
"foot",
"footer",
"footer.page-text",
"footer.prepend",
"group",
"group.header",
"group.summary",
"header",
"header.<name>",
"header.data-table-select",
"icon",
"img",
"input",
"interval",
"item",
"item.<name>",
"item.data-table-expand",
"item.data-table-select",
"label",
"loader",
"loading",
"message",
"next",
"no-data",
"no-results",
"opposite",
"page-text",
"placeholder",
"prepend",
"prepend-inner",
"prepend-item",
"prependIcon",
"prev",
"progress",
"selection",
"thumb-label",
"top",
]
Template.slot_names.update(slot_names)
__all__ = [
"Template",
"VAlert",
"VApp",
"VAppBar",
"VAppBarNavIcon",
"VAppBarTitle",
"VAutocomplete",
"VAvatar",
"VBadge",
"VBanner",
"VBottomNavigation",
"VBottomSheet",
"VBreadcrumbs",
"VBreadcrumbsDivider",
"VBreadcrumbsItem",
"VBtn",
"VBtnToggle",
"VCalendar",
"VCalendarDaily",
"VCalendarMonthly",
"VCalendarWeekly",
"VCard",
"VCardActions",
"VCardSubtitle",
"VCardText",
"VCardTitle",
"VCarousel",
"VCarouselItem",
"VCarouselReverseTransition",
"VCarouselTransition",
"VCheckbox",
"VChip",
"VChipGroup",
"VCol",
"VColorPicker",
"VCombobox",
"VContainer",
"VContent",
"VDataFooter",
"VDataIterator",
"VDataTable",
"VDataTableHeader",
"VDatePicker",
"VDialog",
"VDialogBottomTransition",
"VDialogTopTransition",
"VDialogTransition",
"VDivider",
"VEditDialog",
"VExpandTransition",
"VExpandXTransition",
"VExpansionPanel",
"VExpansionPanelContent",
"VExpansionPanelHeader",
"VExpansionPanels",
"VFabTransition",
"VFadeTransition",
"VFileInput",
"VFlex",
"VFooter",
"VForm",
"VHover",
"VIcon",
"VImg",
"VInput",
"VItem",
"VItemGroup",
"VLayout",
"VLazy",
"VList",
"VListGroup",
"VListItem",
"VListItemAction",
"VListItemActionText",
"VListItemAvatar",
"VListItemContent",
"VListItemGroup",
"VListItemIcon",
"VListItemSubtitle",
"VListItemTitle",
"VMain",
"VMenu",
"VMenuTransition",
"VNavigationDrawer",
"VOtpInput",
"VOverflowBtn",
"VOverlay",
"VPagination",
"VParallax",
"VProgressCircular",
"VProgressLinear",
"VRadio",
"VRadioGroup",
"VRangeSlider",
"VRating",
"VResponsive",
"VRow",
"VScaleTransition",
"VScrollXReverseTransition",
"VScrollXTransition",
"VScrollYReverseTransition",
"VScrollYTransition",
"VSelect",
"VSheet",
"VSimpleCheckbox",
"VSimpleTable",
"VSkeletonLoader",
"VSlideGroup",
"VSlideItem",
"VSlideXReverseTransition",
"VSlideXTransition",
"VSlideYReverseTransition",
"VSlideYTransition",
"VSlider",
"VSnackbar",
"VSpacer",
"VSparkline",
"VSpeedDial",
"VStepper",
"VStepperContent",
"VStepperHeader",
"VStepperItems",
"VStepperStep",
"VSubheader",
"VSwitch",
"VSystemBar",
"VTab",
"VTabItem",
"VTabReverseTransition",
"VTabTransition",
"VTabs",
"VTabsItems",
"VTabsSlider",
"VTextField",
"VTextarea",
"VThemeProvider",
"VTimePicker",
"VTimeline",
"VTimelineItem",
"VToolbar",
"VToolbarItems",
"VToolbarTitle",
"VTooltip",
"VTreeview",
"VVirtualScroll",
"VWindow",
"VWindowItem",
"dataframe_to_grid",
]
class VApp(HtmlElement):
"""
Vuetify's VApp component. See more info and examples |VApp_vuetify_link|.
.. |VApp_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-app" target="_blank">here</a>
:param id: Sets the DOM id on the component
:type string:
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-app", children, **kwargs)
self._attr_names += [
"id",
]
self._event_names += []
class VAppBar(HtmlElement):
"""
Vuetify's VAppBar component. See more info and examples |VAppBar_vuetify_link|.
.. |VAppBar_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-app-bar" target="_blank">here</a>
:param absolute: Applies position: absolute to the component.
:type boolean:
:param app: See description |VAppBar_vuetify_link|.
:type boolean:
:param bottom: Aligns the component towards the bottom.
:type boolean:
:param clipped_left: Designates that the application's `v-navigation-drawer` that is positioned on the left is below the app-bar.
:type boolean:
:param clipped_right: Designates that the application's `v-navigation-drawer` that is positioned on the right is below the app-bar.
:type boolean:
:param collapse: Puts the toolbar into a collapsed state reducing its maximum width.
:type boolean:
:param collapse_on_scroll: Puts the app-bar into a collapsed state when scrolling.
:type boolean:
:param color: See description |VAppBar_vuetify_link|.
:type string:
:param dark: See description |VAppBar_vuetify_link|.
:type boolean:
:param dense: Reduces the height of the toolbar content to 48px (96px when using the **prominent** prop).
:type boolean:
:param elevate_on_scroll: Elevates the app-bar when scrolling.
:type boolean:
:param elevation: See description |VAppBar_vuetify_link|.
:type ['number', 'string']:
:param extended: Use this prop to increase the height of the toolbar _without_ using the `extension` slot for adding content. May be used in conjunction with the **extension-height** prop, and any of the other props that affect the height of the toolbar, e.g. **prominent**, **dense**, etc., **WITH THE EXCEPTION** of **height**.
:type boolean:
:param extension_height: Specify an explicit height for the `extension` slot.
:type ['number', 'string']:
:param fade_img_on_scroll: When using the **src** prop or `img` slot, will fade the image when scrolling.
:type boolean:
:param fixed: Applies **position: fixed** to the component.
:type boolean:
:param flat: Removes the toolbar's box-shadow.
:type boolean:
:param floating: Applies **display: inline-flex** to the component.
:type boolean:
:param height: Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc.
:type ['number', 'string']:
:param hide_on_scroll: Hides the app-bar when scrolling. Will still show the `extension` slot.
:type boolean:
:param inverted_scroll: Hides the app-bar when scrolling down and displays it when scrolling up.
:type boolean:
:param light: Applies the light theme variant to the component.
:type boolean:
:param max_height: Sets the maximum height for the component.
:type ['number', 'string']:
:param max_width: Sets the maximum width for the component.
:type ['number', 'string']:
:param min_height: Sets the minimum height for the component.
:type ['number', 'string']:
:param min_width: Sets the minimum width for the component.
:type ['number', 'string']:
:param outlined: Removes elevation (box-shadow) and adds a *thin* border.
:type boolean:
:param prominent: Increases the height of the toolbar content to 128px.
:type boolean:
:param rounded: See description |VAppBar_vuetify_link|.
:type ['boolean', 'string']:
:param scroll_off_screen: Hides the app-bar when scrolling. Will **NOT** show the `extension` slot.
:type boolean:
:param scroll_target: Designates the element to target for scrolling events. Uses `window` by default.
:type string:
:param scroll_threshold: The amount of scroll distance down before **hide-on-scroll** activates.
:type ['string', 'number']:
:param shaped: Applies a large border radius on the top left and bottom right of the card.
:type boolean:
:param short: Reduce the height of the toolbar content to 56px (112px when using the **prominent** prop).
:type boolean:
:param shrink_on_scroll: Shrinks a **prominent** toolbar to a **dense** or **short** (default) one when scrolling.
:type boolean:
:param src: Image source. See `v-img` for details
:type ['string', 'object']:
:param tag: Specify a custom tag used on the root element.
:type string:
:param tile: Removes the component's **border-radius**.
:type boolean:
:param value: Controls whether the component is visible or hidden.
:type boolean:
:param width: Sets the width for the component.
:type ['number', 'string']:
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-app-bar", children, **kwargs)
self._attr_names += [
"absolute",
"app",
"bottom",
"clipped_left",
"clipped_right",
"collapse",
"collapse_on_scroll",
"color",
"dark",
"dense",
"elevate_on_scroll",
"elevation",
"extended",
"extension_height",
"fade_img_on_scroll",
"fixed",
"flat",
"floating",
"height",
"hide_on_scroll",
"inverted_scroll",
"light",
"max_height",
"max_width",
"min_height",
"min_width",
"outlined",
"prominent",
"rounded",
"scroll_off_screen",
"scroll_target",
"scroll_threshold",
"shaped",
"short",
"shrink_on_scroll",
"src",
"tag",
"tile",
"value",
"width",
]
self._event_names += []
class VAppBarNavIcon(HtmlElement):
"""
Vuetify's VAppBarNavIcon component. See more info and examples |VAppBarNavIcon_vuetify_link|.
.. |VAppBarNavIcon_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-app-bar-nav-icon" target="_blank">here</a>
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-app-bar-nav-icon", children, **kwargs)
self._attr_names += []
self._event_names += []
class VAppBarTitle(HtmlElement):
"""
Vuetify's VAppBarTitle component. See more info and examples |VAppBarTitle_vuetify_link|.
.. |VAppBarTitle_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-app-bar-title" target="_blank">here</a>
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-app-bar-title", children, **kwargs)
self._attr_names += []
self._event_names += []
class VAlert(HtmlElement):
"""
Vuetify's VAlert component. See more info and examples |VAlert_vuetify_link|.
.. |VAlert_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-alert" target="_blank">here</a>
:param border: Puts a border on the alert. Accepts **top** \| **right** \| **bottom** \| **left**.
:type string:
:param close_icon: Change the default icon used for **dismissible** alerts.
:type string:
:param close_label: See description |VAlert_vuetify_link|.
:type string:
:param color: See description |VAlert_vuetify_link|.
:type string:
:param colored_border: Applies the defined **color** to the alert's border.
:type boolean:
:param dark: See description |VAlert_vuetify_link|.
:type boolean:
:param dense: Decreases component's height.
:type boolean:
:param dismissible: Adds a close icon that can hide the alert.
:type boolean:
:param elevation: See description |VAlert_vuetify_link|.
:type ['number', 'string']:
:param height: Sets the height for the component.
:type ['number', 'string']:
:param icon: Designates a specific icon.
:type ['boolean', 'string']:
:param light: Applies the light theme variant to the component.
:type boolean:
:param max_height: Sets the maximum height for the component.
:type ['number', 'string']:
:param max_width: Sets the maximum width for the component.
:type ['number', 'string']:
:param min_height: Sets the minimum height for the component.
:type ['number', 'string']:
:param min_width: Sets the minimum width for the component.
:type ['number', 'string']:
:param mode: See description |VAlert_vuetify_link|.
:type string:
:param origin: See description |VAlert_vuetify_link|.
:type string:
:param outlined: Makes the background transparent and applies a thin border.
:type boolean:
:param prominent: Displays a larger vertically centered icon to draw more attention.
:type boolean:
:param rounded: See description |VAlert_vuetify_link|.
:type ['boolean', 'string']:
:param shaped: Applies a large border radius on the top left and bottom right of the card.
:type boolean:
:param tag: Specify a custom tag used on the root element.
:type string:
:param text: Applies the defined **color** to text and a low opacity background of the same.
:type boolean:
:param tile: Removes the component's border-radius.
:type boolean:
:param transition: See description |VAlert_vuetify_link|.
:type string:
:param type: Specify a **success**, **info**, **warning** or **error** alert. Uses the contextual color and has a pre-defined icon.
:type string:
:param value: Controls whether the component is visible or hidden.
:type boolean:
:param width: Sets the width for the component.
:type ['number', 'string']:
Events
:param input: The updated bound model
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-alert", children, **kwargs)
self._attr_names += [
"border",
"close_icon",
"close_label",
"color",
"colored_border",
"dark",
"dense",
"dismissible",
"elevation",
"height",
"icon",
"light",
"max_height",
"max_width",
"min_height",
"min_width",
"mode",
"origin",
"outlined",
"prominent",
"rounded",
"shaped",
"tag",
"text",
"tile",
"transition",
"type",
"value",
"width",
]
self._event_names += [
"input",
]
class VAutocomplete(HtmlElement):
"""
Vuetify's VAutocomplete component. See more info and examples |VAutocomplete_vuetify_link|.
.. |VAutocomplete_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-autocomplete" target="_blank">here</a>
:param append_icon: Appends an icon to the component, uses the same syntax as `v-icon`
:type string:
:param append_outer_icon: Appends an icon to the outside the component's input, uses same syntax as `v-icon`
:type string:
:param attach: Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default.
:type any:
:param auto_select_first: When searching, will always highlight the first option
:type boolean:
:param autofocus: Enables autofocus
:type boolean:
:param background_color: Changes the background-color of the input
:type string:
:param cache_items: Keeps a local _unique_ copy of all items that have been passed through the **items** prop.
:type boolean:
:param chips: Changes display of selections to chips
:type boolean:
:param clear_icon: Applied when using **clearable** and the input is dirty
:type string:
:param clearable: Add input clear functionality, default icon is Material Design Icons **mdi-clear**
:type boolean:
:param color: See description |VAutocomplete_vuetify_link|.
:type string:
:param counter: Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.
:type ['boolean', 'number', 'string']:
:param counter_value:
:type function:
:param dark: See description |VAutocomplete_vuetify_link|.
:type boolean:
:param deletable_chips: Adds a remove icon to selected chips
:type boolean:
:param dense: Reduces the input height
:type boolean:
:param disable_lookup: Disables keyboard lookup
:type boolean:
:param disabled: Disables the input
:type boolean:
:param eager: Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO.
:type boolean:
:param error: Puts the input in a manual error state
:type boolean:
:param error_count: The total number of errors that should display at once
:type ['number', 'string']:
:param error_messages: Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation
:type ['string', 'array']:
:param filled: Applies the alternate filled input style
:type boolean:
:param filter: See description |VAutocomplete_vuetify_link|.
:type function:
:param flat: Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props
:type boolean:
:param full_width: Designates input type as full-width
:type boolean:
:param height: Sets the height of the input
:type ['number', 'string']:
:param hide_details: Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display
:type ['boolean', 'string']:
:param hide_no_data: Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open.
:type boolean:
:param hide_selected: Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple
:type boolean:
:param hint: Hint text
:type string:
:param id: Sets the DOM id on the component
:type string:
:param item_color: Sets color of selected items
:type string:
:param item_disabled: Set property of **items**'s disabled value
:type ['string', 'array', 'function']:
:param item_text: Set property of **items**'s text value
:type ['string', 'array', 'function']:
:param item_value: See description |VAutocomplete_vuetify_link|.
:type ['string', 'array', 'function']:
:param items: Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **item-value** and **item-disabled** props. Objects that have a **header** or **divider** property are considered special cases and generate a list header or divider; these items are not selectable.
:type array:
:param label: Sets input label
:type string:
:param light: Applies the light theme variant to the component.
:type boolean:
:param loader_height: Specifies the height of the loader
:type ['number', 'string']:
:param loading: Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color
:type ['boolean', 'string']:
:param menu_props: Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props="auto, overflowY"`, or an object `:menu-props="{ auto: true, overflowY: true }"`
:type ['string', 'array', 'object']:
:param messages: Displays a list of messages or message if using a string
:type ['string', 'array']:
:param multiple: Changes select to multiple. Accepts array for value
:type boolean:
:param no_data_text: Display text when there is no data
:type string:
:param no_filter: Do not apply filtering when searching. Useful when data is being filtered server side
:type boolean:
:param open_on_clear: When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state
:type boolean:
:param outlined: Applies the outlined style to the input
:type boolean:
:param persistent_hint: Forces hint to always be visible
:type boolean:
:param persistent_placeholder: Forces placeholder to always be visible
:type boolean:
:param placeholder: Sets the input's placeholder text
:type string:
:param prefix: Displays prefix text
:type string:
:param prepend_icon: Prepends an icon to the component, uses the same syntax as `v-icon`
:type string:
:param prepend_inner_icon: Prepends an icon inside the component's input, uses the same syntax as `v-icon`
:type string:
:param readonly: Puts input in readonly state
:type boolean:
:param return_object: Changes the selection behavior to return the object directly rather than the value specified with **item-value**
:type boolean:
:param reverse: Reverses the input orientation
:type boolean:
:param rounded: Adds a border radius to the input
:type boolean:
:param rules: Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`
:type array:
:param search_input: Search value. Can be used with `.sync` modifier.
:type string:
:param shaped: Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled`
:type boolean:
:param single_line: Label does not move on focus/dirty
:type boolean:
:param small_chips: Changes display of selections to chips with the **small** property
:type boolean:
:param solo: Changes the style of the input
:type boolean:
:param solo_inverted: Reduces element opacity until focused
:type boolean:
:param success: Puts the input in a manual success state
:type boolean:
:param success_messages: Puts the input in a success state and passes through custom success messages.
:type ['string', 'array']:
:param suffix: Displays suffix text
:type string:
:param validate_on_blur: Delays validation until blur event
:type boolean:
:param value: The input's value
:type any:
:param value_comparator: See description |VAutocomplete_vuetify_link|.
:type function:
Events
:param blur: Emitted when the input is blurred
:param change: Emitted when the input is changed by user interaction
:param click_append: Emitted when appended icon is clicked
:param click_append_outer: Emitted when appended outer icon is clicked
:param click_clear: Emitted when clearable icon clicked
:param click_prepend: Emitted when prepended icon is clicked
:param click_prepend_inner: Emitted when prepended inner icon is clicked
:param focus: Emitted when component is focused
:param input: The updated bound model
:param keydown: Emitted when **any** key is pressed
:param update_error: The `error.sync` event
:param update_list_index: Emitted when menu item is selected using keyboard arrows
:param update_search_input: The `search-input.sync` event
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-autocomplete", children, **kwargs)
self._attr_names += [
"append_icon",
"append_outer_icon",
"attach",
"auto_select_first",
"autofocus",
"background_color",
"cache_items",
"chips",
"clear_icon",
"clearable",
"color",
"counter",
"counter_value", # JS functions unimplemented
"dark",
"deletable_chips",
"dense",
"disable_lookup",
"disabled",
"eager",
"error",
"error_count",
"error_messages",
"filled",
"filter", # JS functions unimplemented
"flat",
"full_width",
"height",
"hide_details",
"hide_no_data",
"hide_selected",
"hint",
"id",
"item_color",
"item_disabled", # JS functions unimplemented
"item_text", # JS functions unimplemented
"item_value", # JS functions unimplemented
"items",
"label",
"light",
"loader_height",
"loading",
"menu_props",
"messages",
"multiple",
"no_data_text",
"no_filter",
"open_on_clear",
"outlined",
"persistent_hint",
"persistent_placeholder",
"placeholder",
"prefix",
"prepend_icon",
"prepend_inner_icon",
"readonly",
"return_object",
"reverse",
"rounded",
"rules",
"search_input",
"shaped",
"single_line",
"small_chips",
"solo",
"solo_inverted",
"success",
"success_messages",
"suffix",
"validate_on_blur",
"value",
"value_comparator", # JS functions unimplemented
]
self._event_names += [
"blur",
"change",
"click",
("click_append", "click:append"),
("click_append_outer", "click:append-outer"),
("click_clear", "click:clear"),
("click_prepend", "click:prepend"),
("click_prepend_inner", "click:prepend-inner"),
"focus",
"input",
"keydown",
"mousedown",
"mouseup",
("update_error", "update:error"),
("update_list_index", "update:list-index"),
("update_search_input", "update:search-input"),
]
class VAvatar(HtmlElement):
"""
Vuetify's VAvatar component. See more info and examples |VAvatar_vuetify_link|.
.. |VAvatar_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-avatar" target="_blank">here</a>
:param color: See description |VAvatar_vuetify_link|.
:type string:
:param height: Sets the height for the component.
:type ['number', 'string']:
:param left: See description |VAvatar_vuetify_link|.
:type boolean:
:param max_height: Sets the maximum height for the component.
:type ['number', 'string']:
:param max_width: Sets the maximum width for the component.
:type ['number', 'string']:
:param min_height: Sets the minimum height for the component.
:type ['number', 'string']:
:param min_width: Sets the minimum width for the component.
:type ['number', 'string']:
:param right: See description |VAvatar_vuetify_link|.
:type boolean:
:param rounded: See description |VAvatar_vuetify_link|.
:type ['boolean', 'string']:
:param size: Sets the height and width of the component.
:type ['number', 'string']:
:param tile: Removes the component's **border-radius**.
:type boolean:
:param width: Sets the width for the component.
:type ['number', 'string']:
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-avatar", children, **kwargs)
self._attr_names += [
"color",
"height",
"left",
"max_height",
"max_width",
"min_height",
"min_width",
"right",
"rounded",
"size",
"tile",
"width",
]
self._event_names += []
class VBadge(HtmlElement):
"""
Vuetify's VBadge component. See more info and examples |VBadge_vuetify_link|.
.. |VBadge_vuetify_link| raw:: html
<a href="https://vuetifyjs.com/api/v-badge" target="_blank">here</a>
:param avatar: Removes badge padding for the use of the `v-avatar` in the **badge** slot.
:type boolean:
:param bordered: Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property.
:type boolean:
:param bottom: Aligns the component towards the bottom.
:type boolean:
:param color: See description |VBadge_vuetify_link|.
:type string:
:param content: Any content you want injected as text into the badge.
:type any:
:param dark: See description |VBadge_vuetify_link|.
:type boolean:
:param dot: Reduce the size of the badge and hide its contents
:type boolean:
:param icon: Designates a specific icon used in the badge.
:type string:
:param inline: Moves the badge to be inline with the wrapping element. Supports the usage of the **left** prop.
:type boolean:
:param label: The **aria-label** used for the badge
:type string:
:param left: Aligns the component towards the left.
:type boolean:
:param light: Applies the light theme variant to the component.
:type boolean:
:param mode: See description |VBadge_vuetify_link|.
:type string:
:param offset_x: Offset the badge on the x-axis.
:type ['number', 'string']:
:param offset_y: Offset the badge on the y-axis.
:type ['number', 'string']:
:param origin: See description |VBadge_vuetify_link|.
:type string:
:param overlap: Overlaps the slotted content on top of the component.
:type boolean:
:param tile: Removes the component's border-radius.
:type boolean:
:param transition: See description |VBadge_vuetify_link|.
:type string:
:param value: Controls whether the component is visible or hidden.
:type any:
"""
def __init__(self, children=None, **kwargs):
super().__init__("v-badge", children, **kwargs)
self._attr_names += [
"avatar",
"bordered",
"bottom",
"color",
"content",
"dark",
"dot",
"icon",
"inline",
"label",
"left",
"light",
"mode",
"offset_x",
"offset_y",
"origin",
"overlap",
"tile",
"transition",
"value",
]
self._event_names += []