@vaadin/crud 25.1.0-beta1 → 25.1.0-beta3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -47,85 +47,6 @@
47
47
  }
48
48
  ]
49
49
  },
50
- {
51
- "kind": "javascript-module",
52
- "path": "src/vaadin-crud-controllers.js",
53
- "declarations": [
54
- {
55
- "kind": "class",
56
- "description": "A controller for initializing slotted button.",
57
- "name": "ButtonSlotController",
58
- "members": [
59
- {
60
- "kind": "field",
61
- "name": "theme",
62
- "default": "theme"
63
- },
64
- {
65
- "kind": "field",
66
- "name": "type",
67
- "default": "type"
68
- }
69
- ],
70
- "superclass": {
71
- "name": "SlotController",
72
- "package": "@vaadin/component-base/src/slot-controller.js"
73
- }
74
- },
75
- {
76
- "kind": "class",
77
- "description": "A controller for initializing slotted form.",
78
- "name": "FormSlotController",
79
- "members": [],
80
- "superclass": {
81
- "name": "SlotController",
82
- "package": "@vaadin/component-base/src/slot-controller.js"
83
- }
84
- },
85
- {
86
- "kind": "class",
87
- "description": "A controller for initializing slotted grid.",
88
- "name": "GridSlotController",
89
- "members": [],
90
- "superclass": {
91
- "name": "SlotController",
92
- "package": "@vaadin/component-base/src/slot-controller.js"
93
- }
94
- }
95
- ],
96
- "exports": [
97
- {
98
- "kind": "js",
99
- "name": "ButtonSlotController",
100
- "declaration": {
101
- "name": "ButtonSlotController",
102
- "module": "src/vaadin-crud-controllers.js"
103
- }
104
- },
105
- {
106
- "kind": "js",
107
- "name": "FormSlotController",
108
- "declaration": {
109
- "name": "FormSlotController",
110
- "module": "src/vaadin-crud-controllers.js"
111
- }
112
- },
113
- {
114
- "kind": "js",
115
- "name": "GridSlotController",
116
- "declaration": {
117
- "name": "GridSlotController",
118
- "module": "src/vaadin-crud-controllers.js"
119
- }
120
- }
121
- ]
122
- },
123
- {
124
- "kind": "javascript-module",
125
- "path": "src/vaadin-crud-dialog.js",
126
- "declarations": [],
127
- "exports": []
128
- },
129
50
  {
130
51
  "kind": "javascript-module",
131
52
  "path": "src/vaadin-crud-edit-column.js",
@@ -139,6 +60,9 @@
139
60
  "kind": "field",
140
61
  "name": "ariaLabel",
141
62
  "privacy": "public",
63
+ "type": {
64
+ "text": "string"
65
+ },
142
66
  "description": "The arial-label for the edit button",
143
67
  "attribute": "aria-label"
144
68
  },
@@ -344,7 +268,7 @@
344
268
  "name": "textAlign",
345
269
  "privacy": "public",
346
270
  "type": {
347
- "text": "GridColumnTextAlign | null | undefined"
271
+ "text": "string"
348
272
  },
349
273
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
350
274
  "attribute": "text-align",
@@ -371,6 +295,9 @@
371
295
  "attributes": [
372
296
  {
373
297
  "name": "aria-label",
298
+ "type": {
299
+ "text": "string"
300
+ },
374
301
  "description": "The arial-label for the edit button",
375
302
  "fieldName": "ariaLabel"
376
303
  },
@@ -546,7 +473,7 @@
546
473
  {
547
474
  "name": "text-align",
548
475
  "type": {
549
- "text": "GridColumnTextAlign | null | undefined"
476
+ "text": "string"
550
477
  },
551
478
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
552
479
  "fieldName": "textAlign",
@@ -604,1683 +531,181 @@
604
531
  "type": {
605
532
  "text": "boolean"
606
533
  },
607
- "description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
608
- "attribute": "disabled",
609
- "inheritedFrom": {
610
- "name": "Button",
611
- "package": "@vaadin/button/src/vaadin-button.js"
612
- }
613
- }
614
- ],
615
- "superclass": {
616
- "name": "Button",
617
- "package": "@vaadin/button/src/vaadin-button.js"
618
- },
619
- "tagName": "vaadin-crud-edit",
620
- "customElement": true,
621
- "attributes": [
622
- {
623
- "name": "disabled",
624
- "type": {
625
- "text": "boolean"
626
- },
627
- "description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
628
- "fieldName": "disabled",
629
- "inheritedFrom": {
630
- "name": "Button",
631
- "package": "@vaadin/button/src/vaadin-button.js"
632
- }
633
- },
634
- {
635
- "name": "tabindex",
636
- "type": {
637
- "text": "number"
638
- },
639
- "description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
640
- "fieldName": "tabindex",
641
- "inheritedFrom": {
642
- "name": "Button",
643
- "package": "@vaadin/button/src/vaadin-button.js"
644
- }
645
- }
646
- ],
647
- "events": []
648
- }
649
- ],
650
- "exports": [
651
- {
652
- "kind": "js",
653
- "name": "CrudEdit",
654
- "declaration": {
655
- "name": "CrudEdit",
656
- "module": "src/vaadin-crud-edit.js"
657
- }
658
- }
659
- ]
660
- },
661
- {
662
- "kind": "javascript-module",
663
- "path": "src/vaadin-crud-form.js",
664
- "declarations": [
665
- {
666
- "kind": "class",
667
- "description": "An element used internally by `<vaadin-crud>`. Not intended to be used separately.",
668
- "name": "CrudForm",
669
- "members": [
670
- {
671
- "kind": "field",
672
- "name": "autoResponsive",
673
- "privacy": "public",
674
- "type": {
675
- "text": "boolean"
676
- },
677
- "description": "When set to `true`, the component automatically creates and adjusts columns based on\nthe container's width. Columns have a fixed width defined by `columnWidth` and their\nnumber increases up to the limit set by `maxColumns`. The component dynamically adjusts\nthe number of columns as the container size changes. When this mode is enabled,\n`responsiveSteps` are ignored.\n\nBy default, each field is placed on a new row. To organize fields into rows, there are\ntwo options:\n\n1. Use `<vaadin-form-row>` to explicitly group fields into rows.\n\n2. Enable the `autoRows` property to automatically arrange fields in available columns,\n wrapping to a new row when necessary. `<br>` elements can be used to force a new row.\n\nThe auto-responsive mode is disabled by default. To enable it for an individual instance,\nuse this property. Alternatively, if you want it to be enabled for all instances by default,\nenable the `defaultAutoResponsiveFormLayout` feature flag before `<vaadin-form-layout>`\nelements are added to the DOM:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true;\n```",
678
- "attribute": "auto-responsive",
679
- "inheritedFrom": {
680
- "name": "FormLayoutMixin",
681
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
682
- }
683
- },
684
- {
685
- "kind": "field",
686
- "name": "autoRows",
687
- "privacy": "public",
688
- "type": {
689
- "text": "boolean"
690
- },
691
- "description": "When enabled with `autoResponsive`, distributes fields across columns\nby placing each field in the next available column and wrapping to\nthe next row when the current row is full. `<br>` elements can be\nused to force a new row.\n\nThe default value is `false`.",
692
- "attribute": "auto-rows",
693
- "inheritedFrom": {
694
- "name": "FormLayoutMixin",
695
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
696
- }
697
- },
698
- {
699
- "kind": "field",
700
- "name": "columnWidth",
701
- "privacy": "public",
702
- "type": {
703
- "text": "string"
704
- },
705
- "description": "When `autoResponsive` is enabled, defines the width of each column.\nThe value must be defined in CSS length units, e.g. `100px`.\n\nIf the column width isn't explicitly set, it defaults to `12em`\nor `--vaadin-field-default-width` if that CSS property is defined.",
706
- "attribute": "column-width",
707
- "inheritedFrom": {
708
- "name": "FormLayoutMixin",
709
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
710
- }
711
- },
712
- {
713
- "kind": "field",
714
- "name": "exclude",
715
- "privacy": "public",
716
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
717
- "type": {
718
- "text": "string | RegExp"
719
- },
720
- "attribute": "exclude",
721
- "inheritedFrom": {
722
- "name": "IncludedMixin",
723
- "module": "src/vaadin-crud-include-mixin.js"
724
- }
725
- },
726
- {
727
- "kind": "field",
728
- "name": "expandColumns",
729
- "privacy": "public",
730
- "type": {
731
- "text": "boolean"
732
- },
733
- "description": "When `autoResponsive` is enabled, specifies whether the columns should expand\nin width to evenly fill any remaining space after all columns have been created.\n\nThe default value is `false`.",
734
- "attribute": "expand-columns",
735
- "inheritedFrom": {
736
- "name": "FormLayoutMixin",
737
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
738
- }
739
- },
740
- {
741
- "kind": "field",
742
- "name": "expandFields",
743
- "privacy": "public",
744
- "type": {
745
- "text": "boolean"
746
- },
747
- "description": "When `autoResponsive` is enabled, specifies whether fields should stretch\nto take up all available space within columns. This setting also applies\nto fields inside `<vaadin-form-item>` elements.\n\nThe default value is `false`.",
748
- "attribute": "expand-fields",
749
- "inheritedFrom": {
750
- "name": "FormLayoutMixin",
751
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
752
- }
753
- },
754
- {
755
- "kind": "field",
756
- "name": "include",
757
- "privacy": "public",
758
- "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
759
- "type": {
760
- "text": "string | !Array<string> | undefined"
761
- },
762
- "attribute": "include",
763
- "inheritedFrom": {
764
- "name": "IncludedMixin",
765
- "module": "src/vaadin-crud-include-mixin.js"
766
- }
767
- },
768
- {
769
- "kind": "field",
770
- "name": "item",
771
- "privacy": "public",
772
- "type": {
773
- "text": "unknown"
774
- },
775
- "description": "The item being edited.",
776
- "attribute": "item"
777
- },
778
- {
779
- "kind": "field",
780
- "name": "labelsAside",
781
- "privacy": "public",
782
- "type": {
783
- "text": "boolean"
784
- },
785
- "description": "When enabled with `autoResponsive`, `<vaadin-form-item>` prefers positioning\nlabels beside the fields. If the layout is too narrow to fit a single column\nwith a side label, the component will automatically switch labels to their\ndefault position above the fields.\n\nThe default value is `false`.\n\nTo customize the label width and the gap between the label and the field,\nuse the following CSS properties:\n\n- `--vaadin-form-layout-label-width`\n- `--vaadin-form-layout-label-spacing`",
786
- "attribute": "labels-aside",
787
- "inheritedFrom": {
788
- "name": "FormLayoutMixin",
789
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
790
- }
791
- },
792
- {
793
- "kind": "field",
794
- "name": "maxColumns",
795
- "privacy": "public",
796
- "type": {
797
- "text": "number"
798
- },
799
- "description": "When `autoResponsive` is enabled, defines the maximum number of columns\nthat the layout can create. The layout will create columns up to this\nlimit based on the available container width.\n\nThe default value is `10`.",
800
- "attribute": "max-columns",
801
- "inheritedFrom": {
802
- "name": "FormLayoutMixin",
803
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
804
- }
805
- },
806
- {
807
- "kind": "field",
808
- "name": "minColumns",
809
- "privacy": "public",
810
- "type": {
811
- "text": "number"
812
- },
813
- "description": "When `autoResponsive` is enabled, defines the minimum number of columns\nthat the layout can create. The layout will create columns at least up\nto this limit.\n\nThe default value is `1`.",
814
- "attribute": "min-columns",
815
- "inheritedFrom": {
816
- "name": "FormLayoutMixin",
817
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
818
- }
819
- },
820
- {
821
- "kind": "field",
822
- "name": "responsiveSteps",
823
- "privacy": "public",
824
- "type": {
825
- "text": "!Array<!FormLayoutResponsiveStep>"
826
- },
827
- "description": "Allows specifying a responsive behavior with the number of columns\nand the label position depending on the layout width.\n\nFormat: array of objects, each object defines one responsive step\nwith `minWidth` CSS length, `columns` number, and optional\n`labelsPosition` string of `\"aside\"` or `\"top\"`. At least one item is required.\n\nNOTE: Responsive steps are ignored in auto-responsive mode, which may be\nenabled explicitly via the `autoResponsive` property or implicitly\nif the following feature flag is set:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true\n```\n\n#### Examples\n\n```javascript\nformLayout.responsiveSteps = [{columns: 1}];\n// The layout is always a single column, labels aside.\n```\n\n```javascript\nformLayout.responsiveSteps = [\n {minWidth: 0, columns: 1},\n {minWidth: '40em', columns: 2}\n];\n// Sets two responsive steps:\n// 1. When the layout width is < 40em, one column, labels aside.\n// 2. Width >= 40em, two columns, labels aside.\n```\n\n```javascript\nformLayout.responsiveSteps = [\n {minWidth: 0, columns: 1, labelsPosition: 'top'},\n {minWidth: '20em', columns: 1},\n {minWidth: '40em', columns: 2}\n];\n// Default value. Three responsive steps:\n// 1. Width < 20em, one column, labels on top.\n// 2. 20em <= width < 40em, one column, labels aside.\n// 3. Width >= 40em, two columns, labels aside.\n```",
828
- "attribute": "responsive-steps",
829
- "inheritedFrom": {
830
- "name": "FormLayoutMixin",
831
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
832
- }
833
- }
834
- ],
835
- "attributes": [
836
- {
837
- "name": "auto-responsive",
838
- "type": {
839
- "text": "boolean"
840
- },
841
- "description": "When set to `true`, the component automatically creates and adjusts columns based on\nthe container's width. Columns have a fixed width defined by `columnWidth` and their\nnumber increases up to the limit set by `maxColumns`. The component dynamically adjusts\nthe number of columns as the container size changes. When this mode is enabled,\n`responsiveSteps` are ignored.\n\nBy default, each field is placed on a new row. To organize fields into rows, there are\ntwo options:\n\n1. Use `<vaadin-form-row>` to explicitly group fields into rows.\n\n2. Enable the `autoRows` property to automatically arrange fields in available columns,\n wrapping to a new row when necessary. `<br>` elements can be used to force a new row.\n\nThe auto-responsive mode is disabled by default. To enable it for an individual instance,\nuse this property. Alternatively, if you want it to be enabled for all instances by default,\nenable the `defaultAutoResponsiveFormLayout` feature flag before `<vaadin-form-layout>`\nelements are added to the DOM:\n\n```js\nwindow.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true;\n```",
842
- "fieldName": "autoResponsive",
843
- "inheritedFrom": {
844
- "name": "FormLayoutMixin",
845
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
846
- }
847
- },
848
- {
849
- "name": "auto-rows",
850
- "type": {
851
- "text": "boolean"
852
- },
853
- "description": "When enabled with `autoResponsive`, distributes fields across columns\nby placing each field in the next available column and wrapping to\nthe next row when the current row is full. `<br>` elements can be\nused to force a new row.\n\nThe default value is `false`.",
854
- "fieldName": "autoRows",
855
- "inheritedFrom": {
856
- "name": "FormLayoutMixin",
857
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
858
- }
859
- },
860
- {
861
- "name": "column-width",
862
- "type": {
863
- "text": "string"
864
- },
865
- "description": "When `autoResponsive` is enabled, defines the width of each column.\nThe value must be defined in CSS length units, e.g. `100px`.\n\nIf the column width isn't explicitly set, it defaults to `12em`\nor `--vaadin-field-default-width` if that CSS property is defined.",
866
- "fieldName": "columnWidth",
867
- "inheritedFrom": {
868
- "name": "FormLayoutMixin",
869
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
870
- }
871
- },
872
- {
873
- "name": "exclude",
874
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
875
- "type": {
876
- "text": "string | RegExp"
877
- },
878
- "fieldName": "exclude",
879
- "inheritedFrom": {
880
- "name": "IncludedMixin",
881
- "module": "src/vaadin-crud-include-mixin.js"
882
- }
883
- },
884
- {
885
- "name": "expand-columns",
886
- "type": {
887
- "text": "boolean"
888
- },
889
- "description": "When `autoResponsive` is enabled, specifies whether the columns should expand\nin width to evenly fill any remaining space after all columns have been created.\n\nThe default value is `false`.",
890
- "fieldName": "expandColumns",
891
- "inheritedFrom": {
892
- "name": "FormLayoutMixin",
893
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
894
- }
895
- },
896
- {
897
- "name": "expand-fields",
898
- "type": {
899
- "text": "boolean"
900
- },
901
- "description": "When `autoResponsive` is enabled, specifies whether fields should stretch\nto take up all available space within columns. This setting also applies\nto fields inside `<vaadin-form-item>` elements.\n\nThe default value is `false`.",
902
- "fieldName": "expandFields",
903
- "inheritedFrom": {
904
- "name": "FormLayoutMixin",
905
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
906
- }
907
- },
908
- {
909
- "name": "labels-aside",
910
- "type": {
911
- "text": "boolean"
912
- },
913
- "description": "When enabled with `autoResponsive`, `<vaadin-form-item>` prefers positioning\nlabels beside the fields. If the layout is too narrow to fit a single column\nwith a side label, the component will automatically switch labels to their\ndefault position above the fields.\n\nThe default value is `false`.\n\nTo customize the label width and the gap between the label and the field,\nuse the following CSS properties:\n\n- `--vaadin-form-layout-label-width`\n- `--vaadin-form-layout-label-spacing`",
914
- "fieldName": "labelsAside",
915
- "inheritedFrom": {
916
- "name": "FormLayoutMixin",
917
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
918
- }
919
- },
920
- {
921
- "name": "max-columns",
922
- "type": {
923
- "text": "number"
924
- },
925
- "description": "When `autoResponsive` is enabled, defines the maximum number of columns\nthat the layout can create. The layout will create columns up to this\nlimit based on the available container width.\n\nThe default value is `10`.",
926
- "fieldName": "maxColumns",
927
- "inheritedFrom": {
928
- "name": "FormLayoutMixin",
929
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
930
- }
931
- },
932
- {
933
- "name": "min-columns",
934
- "type": {
935
- "text": "number"
936
- },
937
- "description": "When `autoResponsive` is enabled, defines the minimum number of columns\nthat the layout can create. The layout will create columns at least up\nto this limit.\n\nThe default value is `1`.",
938
- "fieldName": "minColumns",
939
- "inheritedFrom": {
940
- "name": "FormLayoutMixin",
941
- "package": "@vaadin/form-layout/src/vaadin-form-layout-mixin.js"
942
- }
943
- }
944
- ],
945
- "mixins": [
946
- {
947
- "name": "IncludedMixin",
948
- "module": "src/vaadin-crud-include-mixin.js"
949
- }
950
- ],
951
- "superclass": {
952
- "name": "FormLayout",
953
- "package": "@vaadin/form-layout/src/vaadin-form-layout.js"
954
- },
955
- "tagName": "vaadin-crud-form",
956
- "customElement": true,
957
- "events": []
958
- }
959
- ],
960
- "exports": [
961
- {
962
- "kind": "js",
963
- "name": "CrudForm",
964
- "declaration": {
965
- "name": "CrudForm",
966
- "module": "src/vaadin-crud-form.js"
967
- }
968
- }
969
- ]
970
- },
971
- {
972
- "kind": "javascript-module",
973
- "path": "src/vaadin-crud-grid-mixin.js",
974
- "declarations": [
975
- {
976
- "kind": "mixin",
977
- "description": "A mixin providing common crud-grid functionality.",
978
- "name": "CrudGridMixin",
979
- "members": [
980
- {
981
- "kind": "field",
982
- "name": "exclude",
983
- "privacy": "public",
984
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
985
- "type": {
986
- "text": "string | RegExp"
987
- },
988
- "attribute": "exclude",
989
- "inheritedFrom": {
990
- "name": "IncludedMixin",
991
- "module": "src/vaadin-crud-include-mixin.js"
992
- }
993
- },
994
- {
995
- "kind": "field",
996
- "name": "hideEditColumn",
997
- "privacy": "public",
998
- "type": {
999
- "text": "boolean"
1000
- },
1001
- "description": "Determines whether the edit column should be hidden.",
1002
- "attribute": "hide-edit-column"
1003
- },
1004
- {
1005
- "kind": "field",
1006
- "name": "include",
1007
- "privacy": "public",
1008
- "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
1009
- "type": {
1010
- "text": "string | !Array<string> | undefined"
1011
- },
1012
- "attribute": "include",
1013
- "inheritedFrom": {
1014
- "name": "IncludedMixin",
1015
- "module": "src/vaadin-crud-include-mixin.js"
1016
- }
1017
- },
1018
- {
1019
- "kind": "field",
1020
- "name": "noFilter",
1021
- "privacy": "public",
1022
- "description": "Disable filtering in the generated columns.",
1023
- "attribute": "no-filter"
1024
- },
1025
- {
1026
- "kind": "field",
1027
- "name": "noHead",
1028
- "privacy": "public",
1029
- "description": "Do not add headers to columns.",
1030
- "attribute": "no-head"
1031
- },
1032
- {
1033
- "kind": "field",
1034
- "name": "noSort",
1035
- "privacy": "public",
1036
- "description": "Disable sorting in the generated columns.",
1037
- "attribute": "no-sort"
1038
- }
1039
- ],
1040
- "attributes": [
1041
- {
1042
- "name": "exclude",
1043
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
1044
- "type": {
1045
- "text": "string | RegExp"
1046
- },
1047
- "fieldName": "exclude",
1048
- "inheritedFrom": {
1049
- "name": "IncludedMixin",
1050
- "module": "src/vaadin-crud-include-mixin.js"
1051
- }
1052
- },
1053
- {
1054
- "name": "hide-edit-column",
1055
- "type": {
1056
- "text": "boolean"
1057
- },
1058
- "description": "Determines whether the edit column should be hidden.",
1059
- "fieldName": "hideEditColumn"
1060
- },
1061
- {
1062
- "name": "no-filter",
1063
- "description": "Disable filtering in the generated columns.",
1064
- "fieldName": "noFilter"
1065
- },
1066
- {
1067
- "name": "no-head",
1068
- "description": "Do not add headers to columns.",
1069
- "fieldName": "noHead"
1070
- },
1071
- {
1072
- "name": "no-sort",
1073
- "description": "Disable sorting in the generated columns.",
1074
- "fieldName": "noSort"
1075
- }
1076
- ],
1077
- "mixins": [
1078
- {
1079
- "name": "IncludedMixin",
1080
- "module": "src/vaadin-crud-include-mixin.js"
1081
- }
1082
- ],
1083
- "parameters": [
1084
- {
1085
- "name": "superClass"
1086
- }
1087
- ]
1088
- }
1089
- ],
1090
- "exports": [
1091
- {
1092
- "kind": "js",
1093
- "name": "CrudGridMixin",
1094
- "declaration": {
1095
- "name": "CrudGridMixin",
1096
- "module": "src/vaadin-crud-grid-mixin.js"
1097
- }
1098
- }
1099
- ]
1100
- },
1101
- {
1102
- "kind": "javascript-module",
1103
- "path": "src/vaadin-crud-grid.js",
1104
- "declarations": [
1105
- {
1106
- "kind": "class",
1107
- "description": "An element used internally by `<vaadin-crud>`. Not intended to be used separately.",
1108
- "name": "CrudGrid",
1109
- "members": [
1110
- {
1111
- "kind": "field",
1112
- "name": "accessibleName",
1113
- "privacy": "public",
1114
- "type": {
1115
- "text": "string"
1116
- },
1117
- "description": "String used to label the grid to screen reader users.",
1118
- "attribute": "accessible-name",
1119
- "inheritedFrom": {
1120
- "name": "A11yMixin",
1121
- "package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
1122
- }
1123
- },
1124
- {
1125
- "kind": "field",
1126
- "name": "activeItem",
1127
- "privacy": "public",
1128
- "type": {
1129
- "text": "GridItem"
1130
- },
1131
- "description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
1132
- "attribute": "active-item",
1133
- "inheritedFrom": {
1134
- "name": "ActiveItemMixin",
1135
- "package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
1136
- }
1137
- },
1138
- {
1139
- "kind": "field",
1140
- "name": "allRowsVisible",
1141
- "privacy": "public",
1142
- "type": {
1143
- "text": "boolean"
1144
- },
1145
- "description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
1146
- "attribute": "all-rows-visible",
1147
- "inheritedFrom": {
1148
- "name": "GridMixin",
1149
- "package": "@vaadin/grid/src/vaadin-grid-mixin.js"
1150
- }
1151
- },
1152
- {
1153
- "kind": "field",
1154
- "name": "cellPartNameGenerator",
1155
- "privacy": "public",
1156
- "type": {
1157
- "text": "GridCellPartNameGenerator | null | undefined"
1158
- },
1159
- "description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1160
- "attribute": "cell-part-name-generator",
1161
- "inheritedFrom": {
1162
- "name": "StylingMixin",
1163
- "package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
1164
- }
1165
- },
1166
- {
1167
- "kind": "method",
1168
- "name": "clearCache",
1169
- "description": "Clears the cached pages and reloads data from dataprovider when needed.",
1170
- "inheritedFrom": {
1171
- "name": "DataProviderMixin",
1172
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1173
- }
1174
- },
1175
- {
1176
- "kind": "method",
1177
- "name": "closeItemDetails",
1178
- "parameters": [
1179
- {
1180
- "name": "item",
1181
- "type": {
1182
- "text": "!GridItem"
1183
- }
1184
- }
1185
- ],
1186
- "description": "Close the details row of a given item.",
1187
- "inheritedFrom": {
1188
- "name": "RowDetailsMixin",
1189
- "package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
1190
- }
1191
- },
1192
- {
1193
- "kind": "method",
1194
- "name": "collapseItem",
1195
- "parameters": [
1196
- {
1197
- "name": "item",
1198
- "type": {
1199
- "text": "!GridItem"
1200
- }
1201
- }
1202
- ],
1203
- "description": "Collapses the given item tree.",
1204
- "inheritedFrom": {
1205
- "name": "DataProviderMixin",
1206
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1207
- }
1208
- },
1209
- {
1210
- "kind": "field",
1211
- "name": "columnRendering",
1212
- "privacy": "public",
1213
- "type": {
1214
- "text": "!ColumnRendering"
1215
- },
1216
- "description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
1217
- "attribute": "column-rendering",
1218
- "inheritedFrom": {
1219
- "name": "ScrollMixin",
1220
- "package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
1221
- }
1222
- },
1223
- {
1224
- "kind": "field",
1225
- "name": "columnReorderingAllowed",
1226
- "privacy": "public",
1227
- "type": {
1228
- "text": "boolean"
1229
- },
1230
- "description": "Set to true to allow column reordering.",
1231
- "attribute": "column-reordering-allowed",
1232
- "inheritedFrom": {
1233
- "name": "ColumnReorderingMixin",
1234
- "package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
1235
- }
1236
- },
1237
- {
1238
- "kind": "field",
1239
- "name": "dataProvider",
1240
- "privacy": "public",
1241
- "type": {
1242
- "text": "GridDataProvider | null | undefined"
1243
- },
1244
- "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
1245
- "attribute": "data-provider",
1246
- "inheritedFrom": {
1247
- "name": "DataProviderMixin",
1248
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1249
- }
1250
- },
1251
- {
1252
- "kind": "method",
1253
- "name": "deselectItem",
1254
- "parameters": [
1255
- {
1256
- "name": "item",
1257
- "description": "The item object",
1258
- "type": {
1259
- "text": "!GridItem"
1260
- }
1261
- }
1262
- ],
1263
- "description": "Deselects the given item if it is already selected.",
1264
- "inheritedFrom": {
1265
- "name": "SelectionMixin",
1266
- "package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
1267
- }
1268
- },
1269
- {
1270
- "kind": "field",
1271
- "name": "detailsOpenedItems",
1272
- "privacy": "public",
1273
- "type": {
1274
- "text": "!Array<!GridItem>"
1275
- },
1276
- "description": "An array containing references to items with open row details.",
1277
- "attribute": "details-opened-items",
1278
- "inheritedFrom": {
1279
- "name": "RowDetailsMixin",
1280
- "package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
1281
- }
1282
- },
1283
- {
1284
- "kind": "field",
1285
- "name": "dragFilter",
1286
- "privacy": "public",
1287
- "type": {
1288
- "text": "GridDragAndDropFilter | null | undefined"
1289
- },
1290
- "description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1291
- "attribute": "drag-filter",
1292
- "inheritedFrom": {
1293
- "name": "DragAndDropMixin",
1294
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1295
- }
1296
- },
1297
- {
1298
- "kind": "field",
1299
- "name": "dropFilter",
1300
- "privacy": "public",
1301
- "type": {
1302
- "text": "GridDragAndDropFilter | null | undefined"
1303
- },
1304
- "description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1305
- "attribute": "drop-filter",
1306
- "inheritedFrom": {
1307
- "name": "DragAndDropMixin",
1308
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1309
- }
1310
- },
1311
- {
1312
- "kind": "field",
1313
- "name": "dropMode",
1314
- "privacy": "public",
1315
- "type": {
1316
- "text": "GridDropMode | null | undefined"
1317
- },
1318
- "description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
1319
- "attribute": "drop-mode",
1320
- "inheritedFrom": {
1321
- "name": "DragAndDropMixin",
1322
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1323
- }
1324
- },
1325
- {
1326
- "kind": "field",
1327
- "name": "exclude",
1328
- "privacy": "public",
1329
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
1330
- "type": {
1331
- "text": "string | RegExp"
1332
- },
1333
- "attribute": "exclude",
1334
- "inheritedFrom": {
1335
- "name": "IncludedMixin",
1336
- "module": "src/vaadin-crud-include-mixin.js"
1337
- }
1338
- },
1339
- {
1340
- "kind": "field",
1341
- "name": "expandedItems",
1342
- "privacy": "public",
1343
- "type": {
1344
- "text": "!Array<!GridItem>"
1345
- },
1346
- "description": "An array that contains the expanded items.",
1347
- "attribute": "expanded-items",
1348
- "inheritedFrom": {
1349
- "name": "DataProviderMixin",
1350
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1351
- }
1352
- },
1353
- {
1354
- "kind": "method",
1355
- "name": "expandItem",
1356
- "parameters": [
1357
- {
1358
- "name": "item",
1359
- "type": {
1360
- "text": "!GridItem"
1361
- }
1362
- }
1363
- ],
1364
- "description": "Expands the given item tree.",
1365
- "inheritedFrom": {
1366
- "name": "DataProviderMixin",
1367
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1368
- }
1369
- },
1370
- {
1371
- "kind": "method",
1372
- "name": "filterDragAndDrop",
1373
- "description": "Runs the `dragFilter` and `dropFilter` hooks for the visible cells.\nIf the filter depends on varying conditions, you may need to\ncall this function manually in order to update the draggability when\nthe conditions change.",
1374
- "inheritedFrom": {
1375
- "name": "DragAndDropMixin",
1376
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1377
- }
1378
- },
1379
- {
1380
- "kind": "method",
1381
- "name": "generateCellPartNames",
1382
- "description": "Runs the `cellPartNameGenerator` for the visible cells.\nIf the generator depends on varying conditions, you need to\ncall this function manually in order to update the styles when\nthe conditions change.",
1383
- "inheritedFrom": {
1384
- "name": "StylingMixin",
1385
- "package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
1386
- }
1387
- },
1388
- {
1389
- "kind": "method",
1390
- "name": "getEventContext",
1391
- "parameters": [
1392
- {
1393
- "name": "event",
1394
- "type": {
1395
- "text": "!Event"
1396
- }
1397
- }
1398
- ],
1399
- "description": "Returns an object with context information about the event target:\n- `item`: the data object corresponding to the targeted row (not specified when targeting header or footer)\n- `column`: the column element corresponding to the targeted cell (not specified when targeting row details)\n- `section`: whether the event targeted the body, header, footer or details of the grid\n\nThese additional properties are included when `item` is specified:\n- `index`: the index of the item\n- `selected`: the selected state of the item\n- `detailsOpened`: whether the row details are open for the item\n- `expanded`: the expanded state of the tree toggle\n- `level`: the tree hierarchy level\n- `hasChildren`: whether the item has children\n\nThe returned object is populated only when a grid cell, header, footer or row details is found in `event.composedPath()`.\nThis means mostly mouse and keyboard events. If such a grid part is not found in the path, an empty object is returned.\nThis may be the case eg. if the event is fired on the `<vaadin-grid>` element and not any deeper in the DOM, or if\nthe event targets the empty part of the grid body.",
1400
- "return": {
1401
- "type": {
1402
- "text": "GridEventContext"
1403
- }
1404
- },
1405
- "inheritedFrom": {
1406
- "name": "EventContextMixin",
1407
- "package": "@vaadin/grid/src/vaadin-grid-event-context-mixin.js"
1408
- }
1409
- },
1410
- {
1411
- "kind": "method",
1412
- "name": "getItemId",
1413
- "parameters": [
1414
- {
1415
- "name": "item",
1416
- "type": {
1417
- "text": "!GridItem"
1418
- }
1419
- }
1420
- ],
1421
- "description": "Returns a value that identifies the item. Uses `itemIdPath` if available.\nCan be customized by overriding.",
1422
- "return": {
1423
- "type": {
1424
- "text": "!GridItem | !unknown"
1425
- }
1426
- },
1427
- "inheritedFrom": {
1428
- "name": "DataProviderMixin",
1429
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1430
- }
1431
- },
1432
- {
1433
- "kind": "field",
1434
- "name": "hideEditColumn",
1435
- "privacy": "public",
1436
- "type": {
1437
- "text": "boolean"
1438
- },
1439
- "description": "Determines whether the edit column should be hidden.",
1440
- "attribute": "hide-edit-column",
1441
- "inheritedFrom": {
1442
- "name": "CrudGridMixin",
1443
- "module": "src/vaadin-crud-grid-mixin.js"
1444
- }
1445
- },
1446
- {
1447
- "kind": "field",
1448
- "name": "include",
1449
- "privacy": "public",
1450
- "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
1451
- "type": {
1452
- "text": "string | !Array<string> | undefined"
1453
- },
1454
- "attribute": "include",
1455
- "inheritedFrom": {
1456
- "name": "IncludedMixin",
1457
- "module": "src/vaadin-crud-include-mixin.js"
1458
- }
1459
- },
1460
- {
1461
- "kind": "field",
1462
- "name": "isItemSelectable",
1463
- "privacy": "public",
1464
- "type": {
1465
- "text": "(item: !GridItem) => boolean"
1466
- },
1467
- "description": "A function to check whether a specific item in the grid may be\nselected or deselected by the user. Used by the selection column to\nconditionally enable to disable checkboxes for individual items. This\nfunction does not prevent programmatic selection/deselection of\nitems. Changing the function does not modify the currently selected\nitems.\n\nConfiguring this function hides the select all checkbox of the grid\nselection column, which means users can not select or deselect all\nitems anymore, nor do they get feedback on whether all items are\nselected or not.\n\nReceives an item instance and should return a boolean indicating\nwhether users may change the selection state of that item.",
1468
- "attribute": "is-item-selectable",
1469
- "inheritedFrom": {
1470
- "name": "SelectionMixin",
1471
- "package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
1472
- }
1473
- },
1474
- {
1475
- "kind": "field",
1476
- "name": "itemHasChildrenPath",
1477
- "privacy": "public",
1478
- "type": {
1479
- "text": "string"
1480
- },
1481
- "description": "Path to an item sub-property that indicates whether the item has child items.",
1482
- "attribute": "item-has-children-path",
1483
- "inheritedFrom": {
1484
- "name": "DataProviderMixin",
1485
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1486
- }
1487
- },
1488
- {
1489
- "kind": "field",
1490
- "name": "itemIdPath",
1491
- "privacy": "public",
1492
- "type": {
1493
- "text": "string"
1494
- },
1495
- "description": "Path to an item sub-property that identifies the item.",
1496
- "attribute": "item-id-path",
1497
- "inheritedFrom": {
1498
- "name": "DataProviderMixin",
1499
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1500
- }
1501
- },
1502
- {
1503
- "kind": "field",
1504
- "name": "items",
1505
- "privacy": "public",
1506
- "type": {
1507
- "text": "Array<!GridItem> | undefined"
1508
- },
1509
- "description": "An array containing the items which will be passed to renderer functions.",
1510
- "attribute": "items",
1511
- "inheritedFrom": {
1512
- "name": "ArrayDataProviderMixin",
1513
- "package": "@vaadin/grid/src/vaadin-grid-array-data-provider-mixin.js"
1514
- }
1515
- },
1516
- {
1517
- "kind": "field",
1518
- "name": "loading",
1519
- "privacy": "public",
1520
- "type": {
1521
- "text": "boolean"
1522
- },
1523
- "description": "`true` while data is being requested from the data provider.",
1524
- "attribute": "loading",
1525
- "inheritedFrom": {
1526
- "name": "DataProviderMixin",
1527
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1528
- }
1529
- },
1530
- {
1531
- "kind": "field",
1532
- "name": "multiSort",
1533
- "privacy": "public",
1534
- "type": {
1535
- "text": "boolean"
1536
- },
1537
- "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
1538
- "attribute": "multi-sort",
1539
- "inheritedFrom": {
1540
- "name": "SortMixin",
1541
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
1542
- }
1543
- },
1544
- {
1545
- "kind": "field",
1546
- "name": "multiSortOnShiftClick",
1547
- "privacy": "public",
1548
- "type": {
1549
- "text": "boolean"
1550
- },
1551
- "description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
1552
- "attribute": "multi-sort-on-shift-click",
1553
- "inheritedFrom": {
1554
- "name": "SortMixin",
1555
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
1556
- }
1557
- },
1558
- {
1559
- "kind": "field",
1560
- "name": "multiSortPriority",
1561
- "privacy": "public",
1562
- "type": {
1563
- "text": "string"
1564
- },
1565
- "description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
1566
- "attribute": "multi-sort-priority",
1567
- "inheritedFrom": {
1568
- "name": "SortMixin",
1569
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
1570
- }
1571
- },
1572
- {
1573
- "kind": "field",
1574
- "name": "noFilter",
1575
- "privacy": "public",
1576
- "description": "Disable filtering in the generated columns.",
1577
- "attribute": "no-filter",
1578
- "inheritedFrom": {
1579
- "name": "CrudGridMixin",
1580
- "module": "src/vaadin-crud-grid-mixin.js"
1581
- }
1582
- },
1583
- {
1584
- "kind": "field",
1585
- "name": "noHead",
1586
- "privacy": "public",
1587
- "description": "Do not add headers to columns.",
1588
- "attribute": "no-head",
1589
- "inheritedFrom": {
1590
- "name": "CrudGridMixin",
1591
- "module": "src/vaadin-crud-grid-mixin.js"
1592
- }
1593
- },
1594
- {
1595
- "kind": "field",
1596
- "name": "noSort",
1597
- "privacy": "public",
1598
- "description": "Disable sorting in the generated columns.",
1599
- "attribute": "no-sort",
1600
- "inheritedFrom": {
1601
- "name": "CrudGridMixin",
1602
- "module": "src/vaadin-crud-grid-mixin.js"
1603
- }
1604
- },
1605
- {
1606
- "kind": "method",
1607
- "name": "openItemDetails",
1608
- "parameters": [
1609
- {
1610
- "name": "item",
1611
- "type": {
1612
- "text": "!GridItem"
1613
- }
1614
- }
1615
- ],
1616
- "description": "Open the details row of a given item.",
1617
- "inheritedFrom": {
1618
- "name": "RowDetailsMixin",
1619
- "package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
1620
- }
1621
- },
1622
- {
1623
- "kind": "field",
1624
- "name": "pageSize",
1625
- "privacy": "public",
1626
- "type": {
1627
- "text": "number"
1628
- },
1629
- "description": "Number of items fetched at a time from the dataprovider.",
1630
- "attribute": "page-size",
1631
- "inheritedFrom": {
1632
- "name": "DataProviderMixin",
1633
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1634
- }
1635
- },
1636
- {
1637
- "kind": "method",
1638
- "name": "recalculateColumnWidths",
1639
- "description": "Updates the `width` of all columns which have `autoWidth` set to `true`.",
1640
- "inheritedFrom": {
1641
- "name": "ColumnAutoWidthMixin",
1642
- "package": "@vaadin/grid/src/vaadin-grid-column-auto-width-mixin.js"
1643
- }
1644
- },
1645
- {
1646
- "kind": "method",
1647
- "name": "requestContentUpdate",
1648
- "description": "Requests an update for the content of cells.\n\nWhile performing the update, the following renderers are invoked:\n- `Grid.rowDetailsRenderer`\n- `GridColumn.renderer`\n- `GridColumn.headerRenderer`\n- `GridColumn.footerRenderer`\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
1649
- "inheritedFrom": {
1650
- "name": "GridMixin",
1651
- "package": "@vaadin/grid/src/vaadin-grid-mixin.js"
1652
- }
1653
- },
1654
- {
1655
- "kind": "field",
1656
- "name": "rowDetailsRenderer",
1657
- "privacy": "public",
1658
- "type": {
1659
- "text": "GridRowDetailsRenderer | null | undefined"
1660
- },
1661
- "description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
1662
- "attribute": "row-details-renderer",
1663
- "inheritedFrom": {
1664
- "name": "RowDetailsMixin",
1665
- "package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
1666
- }
1667
- },
1668
- {
1669
- "kind": "field",
1670
- "name": "rowsDraggable",
1671
- "privacy": "public",
1672
- "type": {
1673
- "text": "boolean"
1674
- },
1675
- "description": "Marks the grid's rows to be available for dragging.",
1676
- "attribute": "rows-draggable",
1677
- "inheritedFrom": {
1678
- "name": "DragAndDropMixin",
1679
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1680
- }
1681
- },
1682
- {
1683
- "kind": "method",
1684
- "name": "scrollToColumn",
1685
- "parameters": [
1686
- {
1687
- "name": "indexOrColumn",
1688
- "description": "Column element or column index",
1689
- "type": {
1690
- "text": "GridColumn | number"
1691
- }
1692
- }
1693
- ],
1694
- "description": "Scrolls horizontally so that the column becomes visible in the viewport.\n\nThe column can be specified either by its index (among visible columns\nin visual order) or by the column element itself.",
1695
- "inheritedFrom": {
1696
- "name": "ScrollMixin",
1697
- "package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
1698
- }
1699
- },
1700
- {
1701
- "kind": "method",
1702
- "name": "scrollToIndex",
1703
- "parameters": [
1704
- {
1705
- "name": "indexes",
1706
- "description": "Row indexes to scroll to",
1707
- "type": {
1708
- "text": "...number"
1709
- }
1710
- }
1711
- ],
1712
- "description": "Scroll to a specific row index in the virtual list. Note that the row index is\nnot always the same for any particular item. For example, sorting or filtering\nitems can affect the row index related to an item.\n\nThe `indexes` parameter can be either a single number or multiple numbers.\nThe grid will first try to scroll to the item at the first index on the top level.\nIn case the item at the first index is expanded, the grid will then try scroll to the\nitem at the second index within the children of the expanded first item, and so on.\nEach given index points to a child of the item at the previous index.\n\nUsing `Infinity` as an index will point to the last item on the level.",
1713
- "inheritedFrom": {
1714
- "name": "DataProviderMixin",
1715
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1716
- }
1717
- },
1718
- {
1719
- "kind": "field",
1720
- "name": "selectedItems",
1721
- "privacy": "public",
1722
- "type": {
1723
- "text": "!Array<!GridItem>"
1724
- },
1725
- "description": "An array that contains the selected items.",
1726
- "attribute": "selected-items",
1727
- "inheritedFrom": {
1728
- "name": "SelectionMixin",
1729
- "package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
1730
- }
1731
- },
1732
- {
1733
- "kind": "method",
1734
- "name": "selectItem",
1735
- "parameters": [
1736
- {
1737
- "name": "item",
1738
- "description": "The item object",
1739
- "type": {
1740
- "text": "!GridItem"
1741
- }
1742
- }
1743
- ],
1744
- "description": "Selects the given item.",
1745
- "inheritedFrom": {
1746
- "name": "SelectionMixin",
1747
- "package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
1748
- }
1749
- },
1750
- {
1751
- "kind": "method",
1752
- "name": "setDefaultMultiSortPriority",
1753
- "static": true,
1754
- "parameters": [
1755
- {
1756
- "name": "priority",
1757
- "type": {
1758
- "text": "string"
1759
- }
1760
- }
1761
- ],
1762
- "description": "Sets the default multi-sort priority to use for all grid instances.\nThis method should be called before creating any grid instances.\nChanging this setting does not affect the default for existing grids.",
1763
- "inheritedFrom": {
1764
- "name": "SortMixin",
1765
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
1766
- }
1767
- },
1768
- {
1769
- "kind": "field",
1770
- "name": "size",
1771
- "privacy": "public",
1772
- "type": {
1773
- "text": "number"
1774
- },
1775
- "description": "The number of root-level items in the grid.",
1776
- "attribute": "size",
1777
- "inheritedFrom": {
1778
- "name": "DataProviderMixin",
1779
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1780
- }
1781
- }
1782
- ],
1783
- "mixins": [
1784
- {
1785
- "name": "CrudGridMixin",
1786
- "module": "src/vaadin-crud-grid-mixin.js"
1787
- }
1788
- ],
1789
- "superclass": {
1790
- "name": "Grid",
1791
- "package": "@vaadin/grid/src/vaadin-grid.js"
1792
- },
1793
- "attributes": [
1794
- {
1795
- "name": "accessible-name",
1796
- "type": {
1797
- "text": "string"
1798
- },
1799
- "description": "String used to label the grid to screen reader users.",
1800
- "fieldName": "accessibleName",
1801
- "inheritedFrom": {
1802
- "name": "A11yMixin",
1803
- "package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
1804
- }
1805
- },
1806
- {
1807
- "name": "active-item",
1808
- "type": {
1809
- "text": "GridItem"
1810
- },
1811
- "description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
1812
- "fieldName": "activeItem",
1813
- "inheritedFrom": {
1814
- "name": "ActiveItemMixin",
1815
- "package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
1816
- }
1817
- },
1818
- {
1819
- "name": "all-rows-visible",
1820
- "type": {
1821
- "text": "boolean"
1822
- },
1823
- "description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
1824
- "fieldName": "allRowsVisible",
1825
- "inheritedFrom": {
1826
- "name": "GridMixin",
1827
- "package": "@vaadin/grid/src/vaadin-grid-mixin.js"
1828
- }
1829
- },
1830
- {
1831
- "name": "cell-part-name-generator",
1832
- "type": {
1833
- "text": "GridCellPartNameGenerator | null | undefined"
1834
- },
1835
- "description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1836
- "fieldName": "cellPartNameGenerator",
1837
- "inheritedFrom": {
1838
- "name": "StylingMixin",
1839
- "package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
1840
- }
1841
- },
1842
- {
1843
- "name": "column-rendering",
1844
- "type": {
1845
- "text": "!ColumnRendering"
1846
- },
1847
- "description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
1848
- "fieldName": "columnRendering",
1849
- "inheritedFrom": {
1850
- "name": "ScrollMixin",
1851
- "package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
1852
- }
1853
- },
1854
- {
1855
- "name": "column-reordering-allowed",
1856
- "type": {
1857
- "text": "boolean"
1858
- },
1859
- "description": "Set to true to allow column reordering.",
1860
- "fieldName": "columnReorderingAllowed",
1861
- "inheritedFrom": {
1862
- "name": "ColumnReorderingMixin",
1863
- "package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
1864
- }
1865
- },
1866
- {
1867
- "name": "data-provider",
1868
- "type": {
1869
- "text": "GridDataProvider | null | undefined"
1870
- },
1871
- "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
1872
- "fieldName": "dataProvider",
1873
- "inheritedFrom": {
1874
- "name": "DataProviderMixin",
1875
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1876
- }
1877
- },
1878
- {
1879
- "name": "drag-filter",
1880
- "type": {
1881
- "text": "GridDragAndDropFilter | null | undefined"
1882
- },
1883
- "description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1884
- "fieldName": "dragFilter",
1885
- "inheritedFrom": {
1886
- "name": "DragAndDropMixin",
1887
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1888
- }
1889
- },
1890
- {
1891
- "name": "drop-filter",
1892
- "type": {
1893
- "text": "GridDragAndDropFilter | null | undefined"
1894
- },
1895
- "description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
1896
- "fieldName": "dropFilter",
1897
- "inheritedFrom": {
1898
- "name": "DragAndDropMixin",
1899
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1900
- }
1901
- },
1902
- {
1903
- "name": "drop-mode",
1904
- "type": {
1905
- "text": "GridDropMode | null | undefined"
1906
- },
1907
- "description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
1908
- "fieldName": "dropMode",
1909
- "inheritedFrom": {
1910
- "name": "DragAndDropMixin",
1911
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
1912
- }
1913
- },
1914
- {
1915
- "name": "exclude",
1916
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
1917
- "type": {
1918
- "text": "string | RegExp"
1919
- },
1920
- "fieldName": "exclude",
1921
- "inheritedFrom": {
1922
- "name": "IncludedMixin",
1923
- "module": "src/vaadin-crud-include-mixin.js"
1924
- }
1925
- },
1926
- {
1927
- "name": "hide-edit-column",
1928
- "type": {
1929
- "text": "boolean"
1930
- },
1931
- "description": "Determines whether the edit column should be hidden.",
1932
- "fieldName": "hideEditColumn",
1933
- "inheritedFrom": {
1934
- "name": "CrudGridMixin",
1935
- "module": "src/vaadin-crud-grid-mixin.js"
1936
- }
1937
- },
1938
- {
1939
- "name": "interacting",
1940
- "type": {
1941
- "text": "boolean"
1942
- },
1943
- "description": "Indicates whether the grid is currently in interaction mode.\nIn interaction mode the user is currently interacting with a control,\nsuch as an input or a select, within a cell.\nIn interaction mode keyboard navigation between cells is disabled.\nInteraction mode also prevents the focus target cell of that section of\nthe grid from receiving focus, allowing the user to switch focus to\ncontrols in adjacent cells, rather than focussing the outer cell\nitself.",
1944
- "fieldName": "interacting",
1945
- "inheritedFrom": {
1946
- "name": "KeyboardNavigationMixin",
1947
- "package": "@vaadin/grid/src/vaadin-grid-keyboard-navigation-mixin.js"
1948
- }
1949
- },
1950
- {
1951
- "name": "is-attached",
1952
- "fieldName": "isAttached",
1953
- "inheritedFrom": {
1954
- "name": "GridMixin",
1955
- "package": "@vaadin/grid/src/vaadin-grid-mixin.js"
1956
- }
1957
- },
1958
- {
1959
- "name": "is-item-selectable",
1960
- "type": {
1961
- "text": "(item: !GridItem) => boolean"
1962
- },
1963
- "description": "A function to check whether a specific item in the grid may be\nselected or deselected by the user. Used by the selection column to\nconditionally enable to disable checkboxes for individual items. This\nfunction does not prevent programmatic selection/deselection of\nitems. Changing the function does not modify the currently selected\nitems.\n\nConfiguring this function hides the select all checkbox of the grid\nselection column, which means users can not select or deselect all\nitems anymore, nor do they get feedback on whether all items are\nselected or not.\n\nReceives an item instance and should return a boolean indicating\nwhether users may change the selection state of that item.",
1964
- "fieldName": "isItemSelectable",
1965
- "inheritedFrom": {
1966
- "name": "SelectionMixin",
1967
- "package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
1968
- }
1969
- },
1970
- {
1971
- "name": "item-has-children-path",
1972
- "type": {
1973
- "text": "string"
1974
- },
1975
- "description": "Path to an item sub-property that indicates whether the item has child items.",
1976
- "fieldName": "itemHasChildrenPath",
1977
- "inheritedFrom": {
1978
- "name": "DataProviderMixin",
1979
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1980
- }
1981
- },
1982
- {
1983
- "name": "item-id-path",
1984
- "type": {
1985
- "text": "string"
1986
- },
1987
- "description": "Path to an item sub-property that identifies the item.",
1988
- "fieldName": "itemIdPath",
1989
- "inheritedFrom": {
1990
- "name": "DataProviderMixin",
1991
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
1992
- }
1993
- },
1994
- {
1995
- "name": "loading",
1996
- "type": {
1997
- "text": "boolean"
1998
- },
1999
- "description": "`true` while data is being requested from the data provider.",
2000
- "fieldName": "loading",
2001
- "inheritedFrom": {
2002
- "name": "DataProviderMixin",
2003
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
2004
- }
2005
- },
2006
- {
2007
- "name": "multi-sort",
2008
- "type": {
2009
- "text": "boolean"
2010
- },
2011
- "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
2012
- "fieldName": "multiSort",
2013
- "inheritedFrom": {
2014
- "name": "SortMixin",
2015
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
2016
- }
2017
- },
2018
- {
2019
- "name": "multi-sort-on-shift-click",
2020
- "type": {
2021
- "text": "boolean"
2022
- },
2023
- "description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
2024
- "fieldName": "multiSortOnShiftClick",
2025
- "inheritedFrom": {
2026
- "name": "SortMixin",
2027
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
2028
- }
2029
- },
2030
- {
2031
- "name": "multi-sort-priority",
2032
- "type": {
2033
- "text": "string"
2034
- },
2035
- "description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
2036
- "fieldName": "multiSortPriority",
2037
- "inheritedFrom": {
2038
- "name": "SortMixin",
2039
- "package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
2040
- }
2041
- },
2042
- {
2043
- "name": "no-filter",
2044
- "description": "Disable filtering in the generated columns.",
2045
- "fieldName": "noFilter",
2046
- "inheritedFrom": {
2047
- "name": "CrudGridMixin",
2048
- "module": "src/vaadin-crud-grid-mixin.js"
2049
- }
2050
- },
2051
- {
2052
- "name": "no-head",
2053
- "description": "Do not add headers to columns.",
2054
- "fieldName": "noHead",
2055
- "inheritedFrom": {
2056
- "name": "CrudGridMixin",
2057
- "module": "src/vaadin-crud-grid-mixin.js"
2058
- }
2059
- },
2060
- {
2061
- "name": "no-sort",
2062
- "description": "Disable sorting in the generated columns.",
2063
- "fieldName": "noSort",
2064
- "inheritedFrom": {
2065
- "name": "CrudGridMixin",
2066
- "module": "src/vaadin-crud-grid-mixin.js"
2067
- }
2068
- },
2069
- {
2070
- "name": "page-size",
2071
- "type": {
2072
- "text": "number"
2073
- },
2074
- "description": "Number of items fetched at a time from the dataprovider.",
2075
- "fieldName": "pageSize",
2076
- "inheritedFrom": {
2077
- "name": "DataProviderMixin",
2078
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
2079
- }
2080
- },
2081
- {
2082
- "name": "row-details-renderer",
2083
- "type": {
2084
- "text": "GridRowDetailsRenderer | null | undefined"
2085
- },
2086
- "description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
2087
- "fieldName": "rowDetailsRenderer",
2088
- "inheritedFrom": {
2089
- "name": "RowDetailsMixin",
2090
- "package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
2091
- }
2092
- },
2093
- {
2094
- "name": "rows-draggable",
2095
- "type": {
2096
- "text": "boolean"
2097
- },
2098
- "description": "Marks the grid's rows to be available for dragging.",
2099
- "fieldName": "rowsDraggable",
2100
- "inheritedFrom": {
2101
- "name": "DragAndDropMixin",
2102
- "package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
2103
- }
2104
- },
2105
- {
2106
- "name": "size",
2107
- "type": {
2108
- "text": "number"
2109
- },
2110
- "description": "The number of root-level items in the grid.",
2111
- "fieldName": "size",
2112
- "inheritedFrom": {
2113
- "name": "DataProviderMixin",
2114
- "package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
2115
- }
2116
- },
2117
- {
2118
- "name": "tabindex",
2119
- "type": {
2120
- "text": "number"
2121
- },
2122
- "description": "Indicates whether the element can be focused and where it participates in sequential keyboard navigation.",
2123
- "fieldName": "tabindex",
2124
- "inheritedFrom": {
2125
- "name": "TabindexMixin",
2126
- "package": "@vaadin/a11y-base/src/tabindex-mixin.js"
2127
- }
2128
- }
2129
- ],
2130
- "events": [
2131
- {
2132
- "type": {
2133
- "text": "CustomEvent"
2134
- },
2135
- "description": "Fired when the `activeItem` property changes.",
2136
- "name": "active-item-changed",
2137
- "inheritedFrom": {
2138
- "name": "Grid",
2139
- "package": "@vaadin/grid/src/vaadin-grid.js"
2140
- }
2141
- },
2142
- {
2143
- "type": {
2144
- "text": "CustomEvent"
2145
- },
2146
- "description": "Fired when the cell is activated with click or keyboard.",
2147
- "name": "cell-activate",
534
+ "description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
535
+ "attribute": "disabled",
2148
536
  "inheritedFrom": {
2149
- "name": "Grid",
2150
- "package": "@vaadin/grid/src/vaadin-grid.js"
537
+ "name": "Button",
538
+ "package": "@vaadin/button/src/vaadin-button.js"
2151
539
  }
2152
- },
540
+ }
541
+ ],
542
+ "superclass": {
543
+ "name": "Button",
544
+ "package": "@vaadin/button/src/vaadin-button.js"
545
+ },
546
+ "tagName": "vaadin-crud-edit",
547
+ "customElement": true,
548
+ "attributes": [
2153
549
  {
550
+ "name": "disabled",
2154
551
  "type": {
2155
- "text": "CustomEvent"
552
+ "text": "boolean"
2156
553
  },
2157
- "description": "Fired when a cell is focused with click or keyboard navigation.",
2158
- "name": "cell-focus",
554
+ "description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```",
555
+ "fieldName": "disabled",
2159
556
  "inheritedFrom": {
2160
- "name": "Grid",
2161
- "package": "@vaadin/grid/src/vaadin-grid.js"
557
+ "name": "Button",
558
+ "package": "@vaadin/button/src/vaadin-button.js"
2162
559
  }
2163
- },
560
+ }
561
+ ],
562
+ "events": []
563
+ }
564
+ ],
565
+ "exports": [
566
+ {
567
+ "kind": "js",
568
+ "name": "CrudEdit",
569
+ "declaration": {
570
+ "name": "CrudEdit",
571
+ "module": "src/vaadin-crud-edit.js"
572
+ }
573
+ }
574
+ ]
575
+ },
576
+ {
577
+ "kind": "javascript-module",
578
+ "path": "src/vaadin-crud-grid-mixin.js",
579
+ "declarations": [
580
+ {
581
+ "kind": "mixin",
582
+ "description": "A mixin providing common crud-grid functionality.",
583
+ "name": "CrudGridMixin",
584
+ "members": [
2164
585
  {
586
+ "kind": "field",
587
+ "name": "exclude",
588
+ "privacy": "public",
2165
589
  "type": {
2166
- "text": "CustomEvent"
590
+ "text": "string | RegExp"
2167
591
  },
2168
- "description": "Fired when the columns in the grid are reordered.",
2169
- "name": "column-reorder",
592
+ "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
593
+ "attribute": "exclude",
2170
594
  "inheritedFrom": {
2171
- "name": "Grid",
2172
- "package": "@vaadin/grid/src/vaadin-grid.js"
595
+ "name": "IncludedMixin",
596
+ "module": "src/vaadin-crud-include-mixin.js"
2173
597
  }
2174
598
  },
2175
599
  {
600
+ "kind": "field",
601
+ "name": "hideEditColumn",
602
+ "privacy": "public",
2176
603
  "type": {
2177
- "text": "CustomEvent"
604
+ "text": "boolean"
2178
605
  },
2179
- "description": "Fired when the grid column resize is finished.",
2180
- "name": "column-resize",
2181
- "inheritedFrom": {
2182
- "name": "Grid",
2183
- "package": "@vaadin/grid/src/vaadin-grid.js"
2184
- }
606
+ "description": "Determines whether the edit column should be hidden.",
607
+ "attribute": "hide-edit-column"
2185
608
  },
2186
609
  {
610
+ "kind": "field",
611
+ "name": "include",
612
+ "privacy": "public",
2187
613
  "type": {
2188
- "text": "CustomEvent"
614
+ "text": "string | !Array<string> | undefined"
2189
615
  },
2190
- "description": "Fired when the `dataProvider` property changes.",
2191
- "name": "data-provider-changed",
616
+ "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
617
+ "attribute": "include",
2192
618
  "inheritedFrom": {
2193
- "name": "Grid",
2194
- "package": "@vaadin/grid/src/vaadin-grid.js"
619
+ "name": "IncludedMixin",
620
+ "module": "src/vaadin-crud-include-mixin.js"
2195
621
  }
2196
622
  },
2197
623
  {
624
+ "kind": "field",
625
+ "name": "noFilter",
626
+ "privacy": "public",
2198
627
  "type": {
2199
- "text": "CustomEvent"
628
+ "text": "boolean"
2200
629
  },
2201
- "description": "Fired when the `expandedItems` property changes.",
2202
- "name": "expanded-items-changed",
2203
- "inheritedFrom": {
2204
- "name": "Grid",
2205
- "package": "@vaadin/grid/src/vaadin-grid.js"
2206
- }
630
+ "description": "Disable filtering in the generated columns.",
631
+ "attribute": "no-filter"
2207
632
  },
2208
633
  {
634
+ "kind": "field",
635
+ "name": "noHead",
636
+ "privacy": "public",
2209
637
  "type": {
2210
- "text": "CustomEvent"
638
+ "text": "boolean"
2211
639
  },
2212
- "description": "Fired when the dragging of the rows ends.",
2213
- "name": "grid-dragend",
2214
- "inheritedFrom": {
2215
- "name": "Grid",
2216
- "package": "@vaadin/grid/src/vaadin-grid.js"
2217
- }
640
+ "description": "Do not add headers to columns.",
641
+ "attribute": "no-head"
2218
642
  },
2219
643
  {
644
+ "kind": "field",
645
+ "name": "noSort",
646
+ "privacy": "public",
2220
647
  "type": {
2221
- "text": "CustomEvent"
648
+ "text": "boolean"
2222
649
  },
2223
- "description": "Fired when starting to drag grid rows.",
2224
- "name": "grid-dragstart",
2225
- "inheritedFrom": {
2226
- "name": "Grid",
2227
- "package": "@vaadin/grid/src/vaadin-grid.js"
2228
- }
2229
- },
650
+ "description": "Disable sorting in the generated columns.",
651
+ "attribute": "no-sort"
652
+ }
653
+ ],
654
+ "attributes": [
2230
655
  {
656
+ "name": "exclude",
2231
657
  "type": {
2232
- "text": "CustomEvent"
658
+ "text": "string | RegExp"
2233
659
  },
2234
- "description": "Fired when a drop occurs on top of the grid.",
2235
- "name": "grid-drop",
660
+ "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
661
+ "fieldName": "exclude",
2236
662
  "inheritedFrom": {
2237
- "name": "Grid",
2238
- "package": "@vaadin/grid/src/vaadin-grid.js"
663
+ "name": "IncludedMixin",
664
+ "module": "src/vaadin-crud-include-mixin.js"
2239
665
  }
2240
666
  },
2241
667
  {
668
+ "name": "hide-edit-column",
2242
669
  "type": {
2243
- "text": "CustomEvent"
670
+ "text": "boolean"
2244
671
  },
2245
- "description": "Fired when the user selects or deselects an item through the selection column.",
2246
- "name": "item-toggle",
2247
- "inheritedFrom": {
2248
- "name": "Grid",
2249
- "package": "@vaadin/grid/src/vaadin-grid.js"
2250
- }
672
+ "description": "Determines whether the edit column should be hidden.",
673
+ "fieldName": "hideEditColumn"
2251
674
  },
2252
675
  {
676
+ "name": "no-filter",
2253
677
  "type": {
2254
- "text": "CustomEvent"
678
+ "text": "boolean"
2255
679
  },
2256
- "description": "Fired when the `loading` property changes.",
2257
- "name": "loading-changed",
2258
- "inheritedFrom": {
2259
- "name": "Grid",
2260
- "package": "@vaadin/grid/src/vaadin-grid.js"
2261
- }
680
+ "description": "Disable filtering in the generated columns.",
681
+ "fieldName": "noFilter"
2262
682
  },
2263
683
  {
684
+ "name": "no-head",
2264
685
  "type": {
2265
- "text": "CustomEvent"
686
+ "text": "boolean"
2266
687
  },
2267
- "description": "Fired when the `selectedItems` property changes.",
2268
- "name": "selected-items-changed",
2269
- "inheritedFrom": {
2270
- "name": "Grid",
2271
- "package": "@vaadin/grid/src/vaadin-grid.js"
2272
- }
688
+ "description": "Do not add headers to columns.",
689
+ "fieldName": "noHead"
2273
690
  },
2274
691
  {
692
+ "name": "no-sort",
2275
693
  "type": {
2276
- "text": "CustomEvent"
694
+ "text": "boolean"
2277
695
  },
2278
- "description": "Fired when the `size` property changes.",
2279
- "name": "size-changed",
2280
- "inheritedFrom": {
2281
- "name": "Grid",
2282
- "package": "@vaadin/grid/src/vaadin-grid.js"
2283
- }
696
+ "description": "Disable sorting in the generated columns.",
697
+ "fieldName": "noSort"
698
+ }
699
+ ],
700
+ "mixins": [
701
+ {
702
+ "name": "IncludedMixin",
703
+ "module": "src/vaadin-crud-include-mixin.js"
704
+ }
705
+ ],
706
+ "parameters": [
707
+ {
708
+ "name": "superClass"
2284
709
  }
2285
710
  ]
2286
711
  }
@@ -2288,10 +713,10 @@
2288
713
  "exports": [
2289
714
  {
2290
715
  "kind": "js",
2291
- "name": "CrudGrid",
716
+ "name": "CrudGridMixin",
2292
717
  "declaration": {
2293
- "name": "CrudGrid",
2294
- "module": "src/vaadin-crud-grid.js"
718
+ "name": "CrudGridMixin",
719
+ "module": "src/vaadin-crud-grid-mixin.js"
2295
720
  }
2296
721
  }
2297
722
  ]
@@ -2494,30 +919,30 @@
2494
919
  "kind": "field",
2495
920
  "name": "exclude",
2496
921
  "privacy": "public",
2497
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
2498
922
  "type": {
2499
923
  "text": "string | RegExp"
2500
924
  },
925
+ "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
2501
926
  "attribute": "exclude"
2502
927
  },
2503
928
  {
2504
929
  "kind": "field",
2505
930
  "name": "include",
2506
931
  "privacy": "public",
2507
- "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
2508
932
  "type": {
2509
933
  "text": "string | !Array<string> | undefined"
2510
934
  },
935
+ "description": "A list of item properties that should be mapped to form fields.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud-form#property-exclude) is ignored.",
2511
936
  "attribute": "include"
2512
937
  }
2513
938
  ],
2514
939
  "attributes": [
2515
940
  {
2516
941
  "name": "exclude",
2517
- "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
2518
942
  "type": {
2519
943
  "text": "string | RegExp"
2520
944
  },
945
+ "description": "A list of item fields that should not be mapped to form fields.\n\nWhen [`include`](#/elements/vaadin-crud-form#property-include) is defined, this property is ignored.\n\nDefault is to exclude any private property.",
2521
946
  "fieldName": "exclude"
2522
947
  }
2523
948
  ],
@@ -2563,7 +988,7 @@
2563
988
  "name": "editedItem",
2564
989
  "privacy": "public",
2565
990
  "type": {
2566
- "text": "unknown"
991
+ "text": "object"
2567
992
  },
2568
993
  "description": "The item being edited in the dialog.",
2569
994
  "attribute": "edited-item"
@@ -2593,7 +1018,7 @@
2593
1018
  "name": "editorPosition",
2594
1019
  "privacy": "public",
2595
1020
  "type": {
2596
- "text": "!CrudEditorPosition"
1021
+ "text": "string"
2597
1022
  },
2598
1023
  "description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
2599
1024
  "attribute": "editor-position"
@@ -2602,26 +1027,21 @@
2602
1027
  "kind": "field",
2603
1028
  "name": "exclude",
2604
1029
  "privacy": "public",
1030
+ "type": {
1031
+ "text": "string"
1032
+ },
2605
1033
  "description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
2606
1034
  "attribute": "exclude"
2607
1035
  },
2608
1036
  {
2609
1037
  "kind": "field",
2610
1038
  "name": "i18n",
1039
+ "privacy": "public",
1040
+ "type": {
1041
+ "text": "Object"
1042
+ },
2611
1043
  "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n newItem: 'New item',\n editItem: 'Edit item',\n saveItem: 'Save',\n cancel: 'Cancel',\n deleteItem: 'Delete...',\n editLabel: 'Edit',\n confirm: {\n delete: {\n title: 'Confirm delete',\n content: 'Are you sure you want to delete the selected item? This action cannot be undone.',\n button: {\n confirm: 'Delete',\n dismiss: 'Cancel'\n }\n },\n cancel: {\n title: 'Unsaved changes',\n content: 'There are unsaved modifications to the item.',\n button: {\n confirm: 'Discard',\n dismiss: 'Continue editing'\n }\n }\n }\n}\n```",
2612
- "return": {
2613
- "type": {
2614
- "text": "!CrudI18n"
2615
- }
2616
- },
2617
- "parameters": [
2618
- {
2619
- "name": "value",
2620
- "type": {
2621
- "text": "Object"
2622
- }
2623
- }
2624
- ],
1044
+ "attribute": "i18n",
2625
1045
  "inheritedFrom": {
2626
1046
  "name": "I18nMixin",
2627
1047
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -2631,6 +1051,9 @@
2631
1051
  "kind": "field",
2632
1052
  "name": "include",
2633
1053
  "privacy": "public",
1054
+ "type": {
1055
+ "text": "string"
1056
+ },
2634
1057
  "description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
2635
1058
  "attribute": "include"
2636
1059
  },
@@ -2639,7 +1062,7 @@
2639
1062
  "name": "items",
2640
1063
  "privacy": "public",
2641
1064
  "type": {
2642
- "text": "Array<unknown> | undefined"
1065
+ "text": "array"
2643
1066
  },
2644
1067
  "description": "An array containing the items which will be stamped to the column template instances.",
2645
1068
  "attribute": "items"
@@ -2648,6 +1071,9 @@
2648
1071
  "kind": "field",
2649
1072
  "name": "noFilter",
2650
1073
  "privacy": "public",
1074
+ "type": {
1075
+ "text": "boolean"
1076
+ },
2651
1077
  "description": "Disable filtering when grid is autoconfigured.",
2652
1078
  "attribute": "no-filter"
2653
1079
  },
@@ -2655,6 +1081,9 @@
2655
1081
  "kind": "field",
2656
1082
  "name": "noHead",
2657
1083
  "privacy": "public",
1084
+ "type": {
1085
+ "text": "boolean"
1086
+ },
2658
1087
  "description": "Remove grid headers when it is autoconfigured.",
2659
1088
  "attribute": "no-head"
2660
1089
  },
@@ -2662,6 +1091,9 @@
2662
1091
  "kind": "field",
2663
1092
  "name": "noSort",
2664
1093
  "privacy": "public",
1094
+ "type": {
1095
+ "text": "boolean"
1096
+ },
2665
1097
  "description": "Disable sorting when grid is autoconfigured.",
2666
1098
  "attribute": "no-sort"
2667
1099
  },
@@ -2683,7 +1115,8 @@
2683
1115
  "text": "number"
2684
1116
  },
2685
1117
  "description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
2686
- "attribute": "size"
1118
+ "attribute": "size",
1119
+ "readonly": true
2687
1120
  }
2688
1121
  ],
2689
1122
  "attributes": [
@@ -2714,18 +1147,26 @@
2714
1147
  {
2715
1148
  "name": "editor-position",
2716
1149
  "type": {
2717
- "text": "!CrudEditorPosition"
1150
+ "text": "string"
2718
1151
  },
2719
1152
  "description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
2720
1153
  "fieldName": "editorPosition"
2721
1154
  },
2722
1155
  {
2723
1156
  "name": "exclude",
1157
+ "type": {
1158
+ "text": "string"
1159
+ },
2724
1160
  "description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
2725
1161
  "fieldName": "exclude"
2726
1162
  },
2727
1163
  {
2728
1164
  "name": "i18n",
1165
+ "type": {
1166
+ "text": "Object"
1167
+ },
1168
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
1169
+ "fieldName": "i18n",
2729
1170
  "inheritedFrom": {
2730
1171
  "name": "I18nMixin",
2731
1172
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -2733,21 +1174,41 @@
2733
1174
  },
2734
1175
  {
2735
1176
  "name": "include",
1177
+ "type": {
1178
+ "text": "string"
1179
+ },
2736
1180
  "description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
2737
1181
  "fieldName": "include"
2738
1182
  },
1183
+ {
1184
+ "name": "items",
1185
+ "type": {
1186
+ "text": "array"
1187
+ },
1188
+ "description": "An array containing the items which will be stamped to the column template instances.",
1189
+ "fieldName": "items"
1190
+ },
2739
1191
  {
2740
1192
  "name": "no-filter",
1193
+ "type": {
1194
+ "text": "boolean"
1195
+ },
2741
1196
  "description": "Disable filtering when grid is autoconfigured.",
2742
1197
  "fieldName": "noFilter"
2743
1198
  },
2744
1199
  {
2745
1200
  "name": "no-head",
1201
+ "type": {
1202
+ "text": "boolean"
1203
+ },
2746
1204
  "description": "Remove grid headers when it is autoconfigured.",
2747
1205
  "fieldName": "noHead"
2748
1206
  },
2749
1207
  {
2750
1208
  "name": "no-sort",
1209
+ "type": {
1210
+ "text": "boolean"
1211
+ },
2751
1212
  "description": "Disable sorting when grid is autoconfigured.",
2752
1213
  "fieldName": "noSort"
2753
1214
  },
@@ -2820,7 +1281,7 @@
2820
1281
  "name": "editedItem",
2821
1282
  "privacy": "public",
2822
1283
  "type": {
2823
- "text": "unknown"
1284
+ "text": "object"
2824
1285
  },
2825
1286
  "description": "The item being edited in the dialog.",
2826
1287
  "attribute": "edited-item",
@@ -2862,7 +1323,7 @@
2862
1323
  "name": "editorPosition",
2863
1324
  "privacy": "public",
2864
1325
  "type": {
2865
- "text": "!CrudEditorPosition"
1326
+ "text": "string"
2866
1327
  },
2867
1328
  "description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
2868
1329
  "attribute": "editor-position",
@@ -2875,6 +1336,9 @@
2875
1336
  "kind": "field",
2876
1337
  "name": "exclude",
2877
1338
  "privacy": "public",
1339
+ "type": {
1340
+ "text": "string"
1341
+ },
2878
1342
  "description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
2879
1343
  "attribute": "exclude",
2880
1344
  "inheritedFrom": {
@@ -2885,20 +1349,12 @@
2885
1349
  {
2886
1350
  "kind": "field",
2887
1351
  "name": "i18n",
1352
+ "privacy": "public",
1353
+ "type": {
1354
+ "text": "Object"
1355
+ },
2888
1356
  "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n newItem: 'New item',\n editItem: 'Edit item',\n saveItem: 'Save',\n cancel: 'Cancel',\n deleteItem: 'Delete...',\n editLabel: 'Edit',\n confirm: {\n delete: {\n title: 'Confirm delete',\n content: 'Are you sure you want to delete the selected item? This action cannot be undone.',\n button: {\n confirm: 'Delete',\n dismiss: 'Cancel'\n }\n },\n cancel: {\n title: 'Unsaved changes',\n content: 'There are unsaved modifications to the item.',\n button: {\n confirm: 'Discard',\n dismiss: 'Continue editing'\n }\n }\n }\n}\n```",
2889
- "return": {
2890
- "type": {
2891
- "text": "!CrudI18n"
2892
- }
2893
- },
2894
- "parameters": [
2895
- {
2896
- "name": "value",
2897
- "type": {
2898
- "text": "Object"
2899
- }
2900
- }
2901
- ],
1357
+ "attribute": "i18n",
2902
1358
  "inheritedFrom": {
2903
1359
  "name": "I18nMixin",
2904
1360
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -2908,6 +1364,9 @@
2908
1364
  "kind": "field",
2909
1365
  "name": "include",
2910
1366
  "privacy": "public",
1367
+ "type": {
1368
+ "text": "string"
1369
+ },
2911
1370
  "description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
2912
1371
  "attribute": "include",
2913
1372
  "inheritedFrom": {
@@ -2920,7 +1379,7 @@
2920
1379
  "name": "items",
2921
1380
  "privacy": "public",
2922
1381
  "type": {
2923
- "text": "Array<unknown> | undefined"
1382
+ "text": "array"
2924
1383
  },
2925
1384
  "description": "An array containing the items which will be stamped to the column template instances.",
2926
1385
  "attribute": "items",
@@ -2933,6 +1392,9 @@
2933
1392
  "kind": "field",
2934
1393
  "name": "noFilter",
2935
1394
  "privacy": "public",
1395
+ "type": {
1396
+ "text": "boolean"
1397
+ },
2936
1398
  "description": "Disable filtering when grid is autoconfigured.",
2937
1399
  "attribute": "no-filter",
2938
1400
  "inheritedFrom": {
@@ -2944,6 +1406,9 @@
2944
1406
  "kind": "field",
2945
1407
  "name": "noHead",
2946
1408
  "privacy": "public",
1409
+ "type": {
1410
+ "text": "boolean"
1411
+ },
2947
1412
  "description": "Remove grid headers when it is autoconfigured.",
2948
1413
  "attribute": "no-head",
2949
1414
  "inheritedFrom": {
@@ -2955,6 +1420,9 @@
2955
1420
  "kind": "field",
2956
1421
  "name": "noSort",
2957
1422
  "privacy": "public",
1423
+ "type": {
1424
+ "text": "boolean"
1425
+ },
2958
1426
  "description": "Disable sorting when grid is autoconfigured.",
2959
1427
  "attribute": "no-sort",
2960
1428
  "inheritedFrom": {
@@ -2985,6 +1453,7 @@
2985
1453
  },
2986
1454
  "description": "Number of items in the data set which is reported by the grid.\nTypically it reflects the number of filtered items displayed in the grid.\n\nNote: As with `<vaadin-grid>`, this property updates automatically only\nif `items` is used for data.",
2987
1455
  "attribute": "size",
1456
+ "readonly": true,
2988
1457
  "inheritedFrom": {
2989
1458
  "name": "CrudMixin",
2990
1459
  "module": "src/vaadin-crud-mixin.js"
@@ -3124,7 +1593,7 @@
3124
1593
  {
3125
1594
  "name": "editor-position",
3126
1595
  "type": {
3127
- "text": "!CrudEditorPosition"
1596
+ "text": "string"
3128
1597
  },
3129
1598
  "description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)",
3130
1599
  "fieldName": "editorPosition",
@@ -3135,6 +1604,9 @@
3135
1604
  },
3136
1605
  {
3137
1606
  "name": "exclude",
1607
+ "type": {
1608
+ "text": "string"
1609
+ },
3138
1610
  "description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)",
3139
1611
  "fieldName": "exclude",
3140
1612
  "inheritedFrom": {
@@ -3144,6 +1616,11 @@
3144
1616
  },
3145
1617
  {
3146
1618
  "name": "i18n",
1619
+ "type": {
1620
+ "text": "Object"
1621
+ },
1622
+ "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
1623
+ "fieldName": "i18n",
3147
1624
  "inheritedFrom": {
3148
1625
  "name": "I18nMixin",
3149
1626
  "package": "@vaadin/component-base/src/i18n-mixin.js"
@@ -3151,6 +1628,9 @@
3151
1628
  },
3152
1629
  {
3153
1630
  "name": "include",
1631
+ "type": {
1632
+ "text": "string"
1633
+ },
3154
1634
  "description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.",
3155
1635
  "fieldName": "include",
3156
1636
  "inheritedFrom": {
@@ -3158,8 +1638,23 @@
3158
1638
  "module": "src/vaadin-crud-mixin.js"
3159
1639
  }
3160
1640
  },
1641
+ {
1642
+ "name": "items",
1643
+ "type": {
1644
+ "text": "array"
1645
+ },
1646
+ "description": "An array containing the items which will be stamped to the column template instances.",
1647
+ "fieldName": "items",
1648
+ "inheritedFrom": {
1649
+ "name": "CrudMixin",
1650
+ "module": "src/vaadin-crud-mixin.js"
1651
+ }
1652
+ },
3161
1653
  {
3162
1654
  "name": "no-filter",
1655
+ "type": {
1656
+ "text": "boolean"
1657
+ },
3163
1658
  "description": "Disable filtering when grid is autoconfigured.",
3164
1659
  "fieldName": "noFilter",
3165
1660
  "inheritedFrom": {
@@ -3169,6 +1664,9 @@
3169
1664
  },
3170
1665
  {
3171
1666
  "name": "no-head",
1667
+ "type": {
1668
+ "text": "boolean"
1669
+ },
3172
1670
  "description": "Remove grid headers when it is autoconfigured.",
3173
1671
  "fieldName": "noHead",
3174
1672
  "inheritedFrom": {
@@ -3178,6 +1676,9 @@
3178
1676
  },
3179
1677
  {
3180
1678
  "name": "no-sort",
1679
+ "type": {
1680
+ "text": "boolean"
1681
+ },
3181
1682
  "description": "Disable sorting when grid is autoconfigured.",
3182
1683
  "fieldName": "noSort",
3183
1684
  "inheritedFrom": {