@vaadin/date-picker 25.4.0-alpha2 → 25.4.0-alpha4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +368 -259
- package/package.json +13 -13
- package/src/vaadin-date-picker-mixin.d.ts +15 -1
- package/src/vaadin-date-picker-mixin.js +2 -4
- package/src/vaadin-date-picker.d.ts +1 -2
- package/src/vaadin-date-picker.js +1 -4
- package/web-types.json +6 -6
- package/web-types.lit.json +5 -5
package/custom-elements.json
CHANGED
|
@@ -857,6 +857,62 @@
|
|
|
857
857
|
"description": "",
|
|
858
858
|
"name": "DatePickerMixin",
|
|
859
859
|
"members": [
|
|
860
|
+
{
|
|
861
|
+
"kind": "field",
|
|
862
|
+
"name": "accessibleDescriptionRef",
|
|
863
|
+
"privacy": "public",
|
|
864
|
+
"type": {
|
|
865
|
+
"text": "string"
|
|
866
|
+
},
|
|
867
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
868
|
+
"attribute": "accessible-description-ref",
|
|
869
|
+
"inheritedFrom": {
|
|
870
|
+
"name": "FieldMixin",
|
|
871
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
872
|
+
}
|
|
873
|
+
},
|
|
874
|
+
{
|
|
875
|
+
"kind": "field",
|
|
876
|
+
"name": "accessibleName",
|
|
877
|
+
"privacy": "public",
|
|
878
|
+
"type": {
|
|
879
|
+
"text": "string"
|
|
880
|
+
},
|
|
881
|
+
"description": "String used to label the component for screen reader users.",
|
|
882
|
+
"attribute": "accessible-name",
|
|
883
|
+
"inheritedFrom": {
|
|
884
|
+
"name": "FieldMixin",
|
|
885
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
886
|
+
}
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"kind": "field",
|
|
890
|
+
"name": "accessibleNameRef",
|
|
891
|
+
"privacy": "public",
|
|
892
|
+
"type": {
|
|
893
|
+
"text": "string"
|
|
894
|
+
},
|
|
895
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
896
|
+
"attribute": "accessible-name-ref",
|
|
897
|
+
"inheritedFrom": {
|
|
898
|
+
"name": "FieldMixin",
|
|
899
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
900
|
+
}
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"kind": "field",
|
|
904
|
+
"name": "allowedCharPattern",
|
|
905
|
+
"privacy": "public",
|
|
906
|
+
"type": {
|
|
907
|
+
"text": "string"
|
|
908
|
+
},
|
|
909
|
+
"description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
|
|
910
|
+
"attribute": "allowed-char-pattern",
|
|
911
|
+
"inheritedFrom": {
|
|
912
|
+
"name": "InputControlMixin",
|
|
913
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
914
|
+
}
|
|
915
|
+
},
|
|
860
916
|
{
|
|
861
917
|
"kind": "field",
|
|
862
918
|
"name": "autofocus",
|
|
@@ -881,6 +937,20 @@
|
|
|
881
937
|
"description": "Set true to prevent the overlay from opening automatically.",
|
|
882
938
|
"attribute": "auto-open-disabled"
|
|
883
939
|
},
|
|
940
|
+
{
|
|
941
|
+
"kind": "field",
|
|
942
|
+
"name": "autoselect",
|
|
943
|
+
"privacy": "public",
|
|
944
|
+
"type": {
|
|
945
|
+
"text": "boolean"
|
|
946
|
+
},
|
|
947
|
+
"description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
|
|
948
|
+
"attribute": "autoselect",
|
|
949
|
+
"inheritedFrom": {
|
|
950
|
+
"name": "InputControlMixin",
|
|
951
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
952
|
+
}
|
|
953
|
+
},
|
|
884
954
|
{
|
|
885
955
|
"kind": "method",
|
|
886
956
|
"name": "checkValidity",
|
|
@@ -889,10 +959,6 @@
|
|
|
889
959
|
"type": {
|
|
890
960
|
"text": "boolean"
|
|
891
961
|
}
|
|
892
|
-
},
|
|
893
|
-
"inheritedFrom": {
|
|
894
|
-
"name": "ValidateMixin",
|
|
895
|
-
"package": "@vaadin/field-base/src/validate-mixin.js"
|
|
896
962
|
}
|
|
897
963
|
},
|
|
898
964
|
{
|
|
@@ -904,6 +970,20 @@
|
|
|
904
970
|
"package": "@vaadin/field-base/src/input-mixin.js"
|
|
905
971
|
}
|
|
906
972
|
},
|
|
973
|
+
{
|
|
974
|
+
"kind": "field",
|
|
975
|
+
"name": "clearButtonVisible",
|
|
976
|
+
"privacy": "public",
|
|
977
|
+
"type": {
|
|
978
|
+
"text": "boolean"
|
|
979
|
+
},
|
|
980
|
+
"description": "Set to true to display the clear icon which clears the input.\nThis also enables clearing the input when pressing Esc key.",
|
|
981
|
+
"attribute": "clear-button-visible",
|
|
982
|
+
"inheritedFrom": {
|
|
983
|
+
"name": "ClearButtonMixin",
|
|
984
|
+
"package": "@vaadin/field-base/src/clear-button-mixin.js"
|
|
985
|
+
}
|
|
986
|
+
},
|
|
907
987
|
{
|
|
908
988
|
"kind": "method",
|
|
909
989
|
"name": "clearCache",
|
|
@@ -921,8 +1001,7 @@
|
|
|
921
1001
|
"type": {
|
|
922
1002
|
"text": "DatePickerDateMetadataProvider | null | undefined"
|
|
923
1003
|
},
|
|
924
|
-
"description": "A function that provides metadata for the dates the calendar is about to render: whether they\nare disabled, and CSS `part` names for styling from outside using the `::part()` selector.\nUnlike `isDateDisabled`, which is called once per date, the metadata provider is called for\na range of dates at a time, and again as the calendar renders further dates.\n\nIt receives a `DatePickerDateRange` and returns an array of `DatePickerDateMetadata` objects\nfor the dates in that range that have metadata. It can return a `Promise` to load the metadata\nasynchronously, and `null` or `undefined` when no date in the range has metadata.\n\nThe returned array has the following structure:\n\n```js\n[\n // The date is an ISO 8601 string.\n { date: '2026-01-01', disabled: true },\n\n // Adds a custom part name to the date.\n { date: '2026-01-02', part: 'busy' },\n]\n```\n\nA date is disabled if its metadata marks it disabled, or `isDateDisabled` returns `true`, or\nit is outside `min` and `max`. Disabled dates are not selectable, and typing a disabled date in\nthe field makes it invalid. The provider does not affect which date is focused when opening the\noverlay. Use `initialPosition` property to provide a selectable date.\n\nWhile a returned `Promise` is pending, the dates it covers are not disabled yet and render with\nthe `loading` part. If the function throws or rejects, corresponding dates are requested again\nthe next time the user navigates.\n\nThe provider is used for validation also when the overlay is closed. Date is considered valid\nwhile the provider is pending, and is re-validated again after the metadata is loaded.\n\nKeep a stable reference to the function: assigning a new one clears the cache and re-fetches\nvisible range. Call `clearCache()` to re-fetch when the data behind the same function changed."
|
|
925
|
-
"attribute": "date-metadata-provider"
|
|
1004
|
+
"description": "A function that provides metadata for the dates the calendar is about to render: whether they\nare disabled, and CSS `part` names for styling from outside using the `::part()` selector.\nUnlike `isDateDisabled`, which is called once per date, the metadata provider is called for\na range of dates at a time, and again as the calendar renders further dates.\n\nIt receives a `DatePickerDateRange` and returns an array of `DatePickerDateMetadata` objects\nfor the dates in that range that have metadata. It can return a `Promise` to load the metadata\nasynchronously, and `null` or `undefined` when no date in the range has metadata.\n\nThe returned array has the following structure:\n\n```js\n[\n // The date is an ISO 8601 string.\n { date: '2026-01-01', disabled: true },\n\n // Adds a custom part name to the date.\n { date: '2026-01-02', part: 'busy' },\n]\n```\n\nA date is disabled if its metadata marks it disabled, or `isDateDisabled` returns `true`, or\nit is outside `min` and `max`. Disabled dates are not selectable, and typing a disabled date in\nthe field makes it invalid. The provider does not affect which date is focused when opening the\noverlay. Use `initialPosition` property to provide a selectable date.\n\nWhile a returned `Promise` is pending, the dates it covers are not disabled yet and render with\nthe `loading` part. If the function throws or rejects, corresponding dates are requested again\nthe next time the user navigates.\n\nThe provider is used for validation also when the overlay is closed. Date is considered valid\nwhile the provider is pending, and is re-validated again after the metadata is loaded.\n\nKeep a stable reference to the function: assigning a new one clears the cache and re-fetches\nvisible range. Call `clearCache()` to re-fetch when the data behind the same function changed."
|
|
926
1005
|
},
|
|
927
1006
|
{
|
|
928
1007
|
"kind": "field",
|
|
@@ -934,24 +1013,47 @@
|
|
|
934
1013
|
"description": "If true, the user cannot interact with this element.",
|
|
935
1014
|
"attribute": "disabled",
|
|
936
1015
|
"inheritedFrom": {
|
|
937
|
-
"name": "
|
|
938
|
-
"package": "@vaadin/a11y-base/src/
|
|
1016
|
+
"name": "DisabledMixin",
|
|
1017
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
939
1018
|
}
|
|
940
1019
|
},
|
|
941
1020
|
{
|
|
942
1021
|
"kind": "field",
|
|
943
|
-
"name": "
|
|
1022
|
+
"name": "errorMessage",
|
|
944
1023
|
"privacy": "public",
|
|
945
1024
|
"type": {
|
|
946
|
-
"text": "
|
|
1025
|
+
"text": "string"
|
|
947
1026
|
},
|
|
948
|
-
"description": "
|
|
949
|
-
"attribute": "
|
|
1027
|
+
"description": "Error to show when the field is invalid.",
|
|
1028
|
+
"attribute": "error-message",
|
|
1029
|
+
"inheritedFrom": {
|
|
1030
|
+
"name": "FieldMixin",
|
|
1031
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1032
|
+
}
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"kind": "field",
|
|
1036
|
+
"name": "helperText",
|
|
1037
|
+
"privacy": "public",
|
|
1038
|
+
"type": {
|
|
1039
|
+
"text": "string"
|
|
1040
|
+
},
|
|
1041
|
+
"description": "String used for the helper text.",
|
|
1042
|
+
"attribute": "helper-text",
|
|
950
1043
|
"inheritedFrom": {
|
|
951
|
-
"name": "
|
|
952
|
-
"package": "@vaadin/
|
|
1044
|
+
"name": "FieldMixin",
|
|
1045
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
953
1046
|
}
|
|
954
1047
|
},
|
|
1048
|
+
{
|
|
1049
|
+
"kind": "field",
|
|
1050
|
+
"name": "i18n",
|
|
1051
|
+
"description": "The object used to localize this component. To change the default\nlocalization, set this to an object that provides all properties, or\njust the individual properties you want to change.\n\nWhen not set, defaults to `undefined`.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n // An array with the full names of months starting\n // with January.\n monthNames: [\n 'January', 'February', 'March', 'April', 'May',\n 'June', 'July', 'August', 'September',\n 'October', 'November', 'December'\n ],\n\n // An array of weekday names starting with Sunday. Used\n // in screen reader announcements.\n weekdays: [\n 'Sunday', 'Monday', 'Tuesday', 'Wednesday',\n 'Thursday', 'Friday', 'Saturday'\n ],\n\n // An array of short weekday names starting with Sunday.\n // Displayed in the calendar.\n weekdaysShort: [\n 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'\n ],\n\n // An integer indicating the first day of the week\n // (0 = Sunday, 1 = Monday, etc.).\n firstDayOfWeek: 0,\n\n // Translation of the Today shortcut button text.\n today: 'Today',\n\n // Translation of the Cancel button text.\n cancel: 'Cancel',\n\n // Accessible name of the overlay content, announced by screen readers\n // when the overlay opens.\n dialogAccessibleName: 'Calendar',\n\n // Used for adjusting the year value when parsing dates with short years.\n // The year values between 0 and 99 are evaluated and adjusted.\n // Example: for a referenceDate of 1970-10-30;\n // dateToBeParsed: 40-10-30, result: 1940-10-30\n // dateToBeParsed: 80-10-30, result: 1980-10-30\n // dateToBeParsed: 10-10-30, result: 2010-10-30\n // Supported date format: ISO 8601 `\"YYYY-MM-DD\"` (default)\n // The default value is the current date.\n referenceDate: '',\n\n // A function to format given `Object` as\n // date string. Object is in the format `{ day: ..., month: ..., year: ... }`\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n formatDate: d => {\n // returns a string representation of the given\n // object in 'MM/DD/YYYY' -format\n },\n\n // A function to parse the given text to an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n // Must properly parse (at least) text formatted by `formatDate`.\n // Setting the property to null will disable keyboard input feature.\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n parseDate: text => {\n // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to\n // an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n }\n\n // A function to format given `monthName` and\n // `fullYear` integer as calendar title string.\n formatTitle: (monthName, fullYear) => {\n return monthName + ' ' + fullYear;\n }\n}\n```",
|
|
1052
|
+
"type": {
|
|
1053
|
+
"text": "DatePickerI18n | undefined"
|
|
1054
|
+
},
|
|
1055
|
+
"privacy": "public"
|
|
1056
|
+
},
|
|
955
1057
|
{
|
|
956
1058
|
"kind": "field",
|
|
957
1059
|
"name": "initialPosition",
|
|
@@ -983,8 +1085,21 @@
|
|
|
983
1085
|
"type": {
|
|
984
1086
|
"text": "function(DatePickerDate): boolean | undefined"
|
|
985
1087
|
},
|
|
986
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.\n\nThe function is called once per date and has to answer synchronously. Use\n`dateMetadataProvider` when the answer has to be loaded first, or when dates also need\ncustom part names. A date is disabled when either of the two disables it."
|
|
987
|
-
|
|
1088
|
+
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.\n\nThe function is called once per date and has to answer synchronously. Use\n`dateMetadataProvider` when the answer has to be loaded first, or when dates also need\ncustom part names. A date is disabled when either of the two disables it."
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"kind": "field",
|
|
1092
|
+
"name": "label",
|
|
1093
|
+
"privacy": "public",
|
|
1094
|
+
"type": {
|
|
1095
|
+
"text": "string"
|
|
1096
|
+
},
|
|
1097
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
1098
|
+
"attribute": "label",
|
|
1099
|
+
"inheritedFrom": {
|
|
1100
|
+
"name": "LabelMixin",
|
|
1101
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
1102
|
+
}
|
|
988
1103
|
},
|
|
989
1104
|
{
|
|
990
1105
|
"kind": "field",
|
|
@@ -1020,6 +1135,20 @@
|
|
|
1020
1135
|
"description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
|
|
1021
1136
|
"attribute": "min"
|
|
1022
1137
|
},
|
|
1138
|
+
{
|
|
1139
|
+
"kind": "field",
|
|
1140
|
+
"name": "name",
|
|
1141
|
+
"privacy": "public",
|
|
1142
|
+
"type": {
|
|
1143
|
+
"text": "string"
|
|
1144
|
+
},
|
|
1145
|
+
"description": "The name of this field.",
|
|
1146
|
+
"attribute": "name",
|
|
1147
|
+
"inheritedFrom": {
|
|
1148
|
+
"name": "InputControlMixin",
|
|
1149
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1023
1152
|
{
|
|
1024
1153
|
"kind": "method",
|
|
1025
1154
|
"name": "open",
|
|
@@ -1035,6 +1164,34 @@
|
|
|
1035
1164
|
"description": "Set true to open the date selector overlay.",
|
|
1036
1165
|
"attribute": "opened"
|
|
1037
1166
|
},
|
|
1167
|
+
{
|
|
1168
|
+
"kind": "field",
|
|
1169
|
+
"name": "placeholder",
|
|
1170
|
+
"privacy": "public",
|
|
1171
|
+
"type": {
|
|
1172
|
+
"text": "string"
|
|
1173
|
+
},
|
|
1174
|
+
"description": "A hint to the user of what can be entered in the field.",
|
|
1175
|
+
"attribute": "placeholder",
|
|
1176
|
+
"inheritedFrom": {
|
|
1177
|
+
"name": "InputControlMixin",
|
|
1178
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1179
|
+
}
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"kind": "field",
|
|
1183
|
+
"name": "readonly",
|
|
1184
|
+
"privacy": "public",
|
|
1185
|
+
"type": {
|
|
1186
|
+
"text": "boolean"
|
|
1187
|
+
},
|
|
1188
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
1189
|
+
"attribute": "readonly",
|
|
1190
|
+
"inheritedFrom": {
|
|
1191
|
+
"name": "InputControlMixin",
|
|
1192
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1038
1195
|
{
|
|
1039
1196
|
"kind": "field",
|
|
1040
1197
|
"name": "required",
|
|
@@ -1059,6 +1216,20 @@
|
|
|
1059
1216
|
"description": "Set true to display ISO-8601 week numbers in the calendar. Notice that\ndisplaying week numbers is only supported when `i18n.firstDayOfWeek`\nis 1 (Monday).",
|
|
1060
1217
|
"attribute": "show-week-numbers"
|
|
1061
1218
|
},
|
|
1219
|
+
{
|
|
1220
|
+
"kind": "field",
|
|
1221
|
+
"name": "title",
|
|
1222
|
+
"privacy": "public",
|
|
1223
|
+
"type": {
|
|
1224
|
+
"text": "string"
|
|
1225
|
+
},
|
|
1226
|
+
"description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
|
|
1227
|
+
"attribute": "title",
|
|
1228
|
+
"inheritedFrom": {
|
|
1229
|
+
"name": "InputControlMixin",
|
|
1230
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1231
|
+
}
|
|
1232
|
+
},
|
|
1062
1233
|
{
|
|
1063
1234
|
"kind": "method",
|
|
1064
1235
|
"name": "validate",
|
|
@@ -1081,11 +1252,7 @@
|
|
|
1081
1252
|
"text": "string"
|
|
1082
1253
|
},
|
|
1083
1254
|
"description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
|
|
1084
|
-
"attribute": "value"
|
|
1085
|
-
"inheritedFrom": {
|
|
1086
|
-
"name": "InputMixin",
|
|
1087
|
-
"package": "@vaadin/field-base/src/input-mixin.js"
|
|
1088
|
-
}
|
|
1255
|
+
"attribute": "value"
|
|
1089
1256
|
}
|
|
1090
1257
|
],
|
|
1091
1258
|
"events": [
|
|
@@ -1093,10 +1260,6 @@
|
|
|
1093
1260
|
"name": "change",
|
|
1094
1261
|
"type": {
|
|
1095
1262
|
"text": "CustomEvent"
|
|
1096
|
-
},
|
|
1097
|
-
"inheritedFrom": {
|
|
1098
|
-
"name": "InputConstraintsMixin",
|
|
1099
|
-
"package": "@vaadin/field-base/src/input-constraints-mixin.js"
|
|
1100
1263
|
}
|
|
1101
1264
|
},
|
|
1102
1265
|
{
|
|
@@ -1117,6 +1280,54 @@
|
|
|
1117
1280
|
}
|
|
1118
1281
|
],
|
|
1119
1282
|
"attributes": [
|
|
1283
|
+
{
|
|
1284
|
+
"name": "accessible-description-ref",
|
|
1285
|
+
"type": {
|
|
1286
|
+
"text": "string"
|
|
1287
|
+
},
|
|
1288
|
+
"description": "A space-separated list of IDs referencing the elements that\ndescribe the component for screen reader users. The referenced\nelements are announced in addition to the helper text and\nthe error message.",
|
|
1289
|
+
"fieldName": "accessibleDescriptionRef",
|
|
1290
|
+
"inheritedFrom": {
|
|
1291
|
+
"name": "FieldMixin",
|
|
1292
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1293
|
+
}
|
|
1294
|
+
},
|
|
1295
|
+
{
|
|
1296
|
+
"name": "accessible-name",
|
|
1297
|
+
"type": {
|
|
1298
|
+
"text": "string"
|
|
1299
|
+
},
|
|
1300
|
+
"description": "String used to label the component for screen reader users.",
|
|
1301
|
+
"fieldName": "accessibleName",
|
|
1302
|
+
"inheritedFrom": {
|
|
1303
|
+
"name": "FieldMixin",
|
|
1304
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1305
|
+
}
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
"name": "accessible-name-ref",
|
|
1309
|
+
"type": {
|
|
1310
|
+
"text": "string"
|
|
1311
|
+
},
|
|
1312
|
+
"description": "A space-separated list of IDs referencing the elements that\nlabel the component for screen reader users.",
|
|
1313
|
+
"fieldName": "accessibleNameRef",
|
|
1314
|
+
"inheritedFrom": {
|
|
1315
|
+
"name": "FieldMixin",
|
|
1316
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1317
|
+
}
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
"name": "allowed-char-pattern",
|
|
1321
|
+
"type": {
|
|
1322
|
+
"text": "string"
|
|
1323
|
+
},
|
|
1324
|
+
"description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`",
|
|
1325
|
+
"fieldName": "allowedCharPattern",
|
|
1326
|
+
"inheritedFrom": {
|
|
1327
|
+
"name": "InputControlMixin",
|
|
1328
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1329
|
+
}
|
|
1330
|
+
},
|
|
1120
1331
|
{
|
|
1121
1332
|
"name": "auto-open-disabled",
|
|
1122
1333
|
"type": {
|
|
@@ -1138,12 +1349,28 @@
|
|
|
1138
1349
|
}
|
|
1139
1350
|
},
|
|
1140
1351
|
{
|
|
1141
|
-
"name": "
|
|
1352
|
+
"name": "autoselect",
|
|
1353
|
+
"type": {
|
|
1354
|
+
"text": "boolean"
|
|
1355
|
+
},
|
|
1356
|
+
"description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.",
|
|
1357
|
+
"fieldName": "autoselect",
|
|
1358
|
+
"inheritedFrom": {
|
|
1359
|
+
"name": "InputControlMixin",
|
|
1360
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1361
|
+
}
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"name": "clear-button-visible",
|
|
1142
1365
|
"type": {
|
|
1143
|
-
"text": "
|
|
1366
|
+
"text": "boolean"
|
|
1144
1367
|
},
|
|
1145
|
-
"description": "
|
|
1146
|
-
"fieldName": "
|
|
1368
|
+
"description": "Set to true to display the clear icon which clears the input.\nThis also enables clearing the input when pressing Esc key.",
|
|
1369
|
+
"fieldName": "clearButtonVisible",
|
|
1370
|
+
"inheritedFrom": {
|
|
1371
|
+
"name": "ClearButtonMixin",
|
|
1372
|
+
"package": "@vaadin/field-base/src/clear-button-mixin.js"
|
|
1373
|
+
}
|
|
1147
1374
|
},
|
|
1148
1375
|
{
|
|
1149
1376
|
"name": "disabled",
|
|
@@ -1153,20 +1380,32 @@
|
|
|
1153
1380
|
"description": "If true, the user cannot interact with this element.",
|
|
1154
1381
|
"fieldName": "disabled",
|
|
1155
1382
|
"inheritedFrom": {
|
|
1156
|
-
"name": "
|
|
1157
|
-
"package": "@vaadin/a11y-base/src/
|
|
1383
|
+
"name": "DisabledMixin",
|
|
1384
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
1158
1385
|
}
|
|
1159
1386
|
},
|
|
1160
1387
|
{
|
|
1161
|
-
"name": "
|
|
1388
|
+
"name": "error-message",
|
|
1389
|
+
"type": {
|
|
1390
|
+
"text": "string"
|
|
1391
|
+
},
|
|
1392
|
+
"description": "Error to show when the field is invalid.",
|
|
1393
|
+
"fieldName": "errorMessage",
|
|
1394
|
+
"inheritedFrom": {
|
|
1395
|
+
"name": "FieldMixin",
|
|
1396
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1397
|
+
}
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
"name": "helper-text",
|
|
1162
1401
|
"type": {
|
|
1163
|
-
"text": "
|
|
1402
|
+
"text": "string"
|
|
1164
1403
|
},
|
|
1165
|
-
"description": "
|
|
1166
|
-
"fieldName": "
|
|
1404
|
+
"description": "String used for the helper text.",
|
|
1405
|
+
"fieldName": "helperText",
|
|
1167
1406
|
"inheritedFrom": {
|
|
1168
|
-
"name": "
|
|
1169
|
-
"package": "@vaadin/
|
|
1407
|
+
"name": "FieldMixin",
|
|
1408
|
+
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
1170
1409
|
}
|
|
1171
1410
|
},
|
|
1172
1411
|
{
|
|
@@ -1190,12 +1429,16 @@
|
|
|
1190
1429
|
}
|
|
1191
1430
|
},
|
|
1192
1431
|
{
|
|
1193
|
-
"name": "
|
|
1432
|
+
"name": "label",
|
|
1194
1433
|
"type": {
|
|
1195
|
-
"text": "
|
|
1434
|
+
"text": "string"
|
|
1196
1435
|
},
|
|
1197
|
-
"description": "
|
|
1198
|
-
"fieldName": "
|
|
1436
|
+
"description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",
|
|
1437
|
+
"fieldName": "label",
|
|
1438
|
+
"inheritedFrom": {
|
|
1439
|
+
"name": "LabelMixin",
|
|
1440
|
+
"package": "@vaadin/field-base/src/label-mixin.js"
|
|
1441
|
+
}
|
|
1199
1442
|
},
|
|
1200
1443
|
{
|
|
1201
1444
|
"name": "manual-validation",
|
|
@@ -1225,6 +1468,18 @@
|
|
|
1225
1468
|
"description": "The earliest date that can be selected. All earlier dates will be disabled.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
|
|
1226
1469
|
"fieldName": "min"
|
|
1227
1470
|
},
|
|
1471
|
+
{
|
|
1472
|
+
"name": "name",
|
|
1473
|
+
"type": {
|
|
1474
|
+
"text": "string"
|
|
1475
|
+
},
|
|
1476
|
+
"description": "The name of this field.",
|
|
1477
|
+
"fieldName": "name",
|
|
1478
|
+
"inheritedFrom": {
|
|
1479
|
+
"name": "InputControlMixin",
|
|
1480
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1481
|
+
}
|
|
1482
|
+
},
|
|
1228
1483
|
{
|
|
1229
1484
|
"name": "opened",
|
|
1230
1485
|
"type": {
|
|
@@ -1233,6 +1488,30 @@
|
|
|
1233
1488
|
"description": "Set true to open the date selector overlay.",
|
|
1234
1489
|
"fieldName": "opened"
|
|
1235
1490
|
},
|
|
1491
|
+
{
|
|
1492
|
+
"name": "placeholder",
|
|
1493
|
+
"type": {
|
|
1494
|
+
"text": "string"
|
|
1495
|
+
},
|
|
1496
|
+
"description": "A hint to the user of what can be entered in the field.",
|
|
1497
|
+
"fieldName": "placeholder",
|
|
1498
|
+
"inheritedFrom": {
|
|
1499
|
+
"name": "InputControlMixin",
|
|
1500
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1501
|
+
}
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"name": "readonly",
|
|
1505
|
+
"type": {
|
|
1506
|
+
"text": "boolean"
|
|
1507
|
+
},
|
|
1508
|
+
"description": "When present, it specifies that the field is read-only.",
|
|
1509
|
+
"fieldName": "readonly",
|
|
1510
|
+
"inheritedFrom": {
|
|
1511
|
+
"name": "InputControlMixin",
|
|
1512
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1236
1515
|
{
|
|
1237
1516
|
"name": "required",
|
|
1238
1517
|
"type": {
|
|
@@ -1254,16 +1533,24 @@
|
|
|
1254
1533
|
"fieldName": "showWeekNumbers"
|
|
1255
1534
|
},
|
|
1256
1535
|
{
|
|
1257
|
-
"name": "
|
|
1536
|
+
"name": "title",
|
|
1258
1537
|
"type": {
|
|
1259
1538
|
"text": "string"
|
|
1260
1539
|
},
|
|
1261
|
-
"description": "
|
|
1262
|
-
"fieldName": "
|
|
1540
|
+
"description": "The text usually displayed in a tooltip popup when the mouse is over the field.",
|
|
1541
|
+
"fieldName": "title",
|
|
1263
1542
|
"inheritedFrom": {
|
|
1264
|
-
"name": "
|
|
1265
|
-
"package": "@vaadin/field-base/src/input-mixin.js"
|
|
1543
|
+
"name": "InputControlMixin",
|
|
1544
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1266
1545
|
}
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"name": "value",
|
|
1549
|
+
"type": {
|
|
1550
|
+
"text": "string"
|
|
1551
|
+
},
|
|
1552
|
+
"description": "Selected date.\n\nSupported date formats:\n- ISO 8601 `\"YYYY-MM-DD\"` (default)\n- 6-digit extended ISO 8601 `\"+YYYYYY-MM-DD\"`, `\"-YYYYYY-MM-DD\"`",
|
|
1553
|
+
"fieldName": "value"
|
|
1267
1554
|
}
|
|
1268
1555
|
],
|
|
1269
1556
|
"mixins": [
|
|
@@ -1272,16 +1559,8 @@
|
|
|
1272
1559
|
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
1273
1560
|
},
|
|
1274
1561
|
{
|
|
1275
|
-
"name": "
|
|
1276
|
-
"package": "@vaadin/
|
|
1277
|
-
},
|
|
1278
|
-
{
|
|
1279
|
-
"name": "InputConstraintsMixin",
|
|
1280
|
-
"package": "@vaadin/field-base/src/input-constraints-mixin.js"
|
|
1281
|
-
},
|
|
1282
|
-
{
|
|
1283
|
-
"name": "KeyboardMixin",
|
|
1284
|
-
"package": "@vaadin/a11y-base/src/keyboard-mixin.js"
|
|
1562
|
+
"name": "InputControlMixin",
|
|
1563
|
+
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
1285
1564
|
}
|
|
1286
1565
|
],
|
|
1287
1566
|
"parameters": [
|
|
@@ -1325,8 +1604,7 @@
|
|
|
1325
1604
|
"privacy": "public",
|
|
1326
1605
|
"type": {
|
|
1327
1606
|
"text": "array"
|
|
1328
|
-
}
|
|
1329
|
-
"attribute": "calendars"
|
|
1607
|
+
}
|
|
1330
1608
|
},
|
|
1331
1609
|
{
|
|
1332
1610
|
"kind": "method",
|
|
@@ -1339,8 +1617,7 @@
|
|
|
1339
1617
|
"privacy": "public",
|
|
1340
1618
|
"type": {
|
|
1341
1619
|
"text": "date"
|
|
1342
|
-
}
|
|
1343
|
-
"attribute": "entered-date"
|
|
1620
|
+
}
|
|
1344
1621
|
},
|
|
1345
1622
|
{
|
|
1346
1623
|
"kind": "field",
|
|
@@ -1381,8 +1658,7 @@
|
|
|
1381
1658
|
"type": {
|
|
1382
1659
|
"text": "object"
|
|
1383
1660
|
},
|
|
1384
|
-
"description": "Date value which is focused using keyboard."
|
|
1385
|
-
"attribute": "focused-date"
|
|
1661
|
+
"description": "Date value which is focused using keyboard."
|
|
1386
1662
|
},
|
|
1387
1663
|
{
|
|
1388
1664
|
"kind": "field",
|
|
@@ -1390,8 +1666,7 @@
|
|
|
1390
1666
|
"privacy": "public",
|
|
1391
1667
|
"type": {
|
|
1392
1668
|
"text": "object"
|
|
1393
|
-
}
|
|
1394
|
-
"attribute": "i18n"
|
|
1669
|
+
}
|
|
1395
1670
|
},
|
|
1396
1671
|
{
|
|
1397
1672
|
"kind": "field",
|
|
@@ -1400,8 +1675,7 @@
|
|
|
1400
1675
|
"type": {
|
|
1401
1676
|
"text": "object"
|
|
1402
1677
|
},
|
|
1403
|
-
"description": "Date which should be visible when there is no value selected."
|
|
1404
|
-
"attribute": "initial-position"
|
|
1678
|
+
"description": "Date which should be visible when there is no value selected."
|
|
1405
1679
|
},
|
|
1406
1680
|
{
|
|
1407
1681
|
"kind": "field",
|
|
@@ -1410,8 +1684,7 @@
|
|
|
1410
1684
|
"type": {
|
|
1411
1685
|
"text": "function(DatePickerDate): boolean | undefined"
|
|
1412
1686
|
},
|
|
1413
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean."
|
|
1414
|
-
"attribute": "is-date-disabled"
|
|
1687
|
+
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean."
|
|
1415
1688
|
},
|
|
1416
1689
|
{
|
|
1417
1690
|
"kind": "field",
|
|
@@ -1432,8 +1705,7 @@
|
|
|
1432
1705
|
"type": {
|
|
1433
1706
|
"text": "object"
|
|
1434
1707
|
},
|
|
1435
|
-
"description": "The latest date that can be selected. All later dates will be disabled."
|
|
1436
|
-
"attribute": "max-date"
|
|
1708
|
+
"description": "The latest date that can be selected. All later dates will be disabled."
|
|
1437
1709
|
},
|
|
1438
1710
|
{
|
|
1439
1711
|
"kind": "field",
|
|
@@ -1442,8 +1714,7 @@
|
|
|
1442
1714
|
"type": {
|
|
1443
1715
|
"text": "object"
|
|
1444
1716
|
},
|
|
1445
|
-
"description": "The earliest date that can be selected. All earlier dates will be disabled."
|
|
1446
|
-
"attribute": "min-date"
|
|
1717
|
+
"description": "The earliest date that can be selected. All earlier dates will be disabled."
|
|
1447
1718
|
},
|
|
1448
1719
|
{
|
|
1449
1720
|
"kind": "method",
|
|
@@ -1492,8 +1763,7 @@
|
|
|
1492
1763
|
"type": {
|
|
1493
1764
|
"text": "object"
|
|
1494
1765
|
},
|
|
1495
|
-
"description": "The value for this element."
|
|
1496
|
-
"attribute": "selected-date"
|
|
1766
|
+
"description": "The value for this element."
|
|
1497
1767
|
},
|
|
1498
1768
|
{
|
|
1499
1769
|
"kind": "field",
|
|
@@ -1515,8 +1785,7 @@
|
|
|
1515
1785
|
"privacy": "public",
|
|
1516
1786
|
"type": {
|
|
1517
1787
|
"text": "array"
|
|
1518
|
-
}
|
|
1519
|
-
"attribute": "years"
|
|
1788
|
+
}
|
|
1520
1789
|
}
|
|
1521
1790
|
],
|
|
1522
1791
|
"events": [
|
|
@@ -1546,28 +1815,6 @@
|
|
|
1546
1815
|
}
|
|
1547
1816
|
],
|
|
1548
1817
|
"attributes": [
|
|
1549
|
-
{
|
|
1550
|
-
"name": "calendars",
|
|
1551
|
-
"type": {
|
|
1552
|
-
"text": "array"
|
|
1553
|
-
},
|
|
1554
|
-
"fieldName": "calendars"
|
|
1555
|
-
},
|
|
1556
|
-
{
|
|
1557
|
-
"name": "entered-date",
|
|
1558
|
-
"type": {
|
|
1559
|
-
"text": "date"
|
|
1560
|
-
},
|
|
1561
|
-
"fieldName": "enteredDate"
|
|
1562
|
-
},
|
|
1563
|
-
{
|
|
1564
|
-
"name": "is-date-disabled",
|
|
1565
|
-
"type": {
|
|
1566
|
-
"text": "function(DatePickerDate): boolean | undefined"
|
|
1567
|
-
},
|
|
1568
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.",
|
|
1569
|
-
"fieldName": "isDateDisabled"
|
|
1570
|
-
},
|
|
1571
1818
|
{
|
|
1572
1819
|
"name": "label",
|
|
1573
1820
|
"description": "Input label",
|
|
@@ -1586,13 +1833,6 @@
|
|
|
1586
1833
|
"text": "boolean"
|
|
1587
1834
|
},
|
|
1588
1835
|
"fieldName": "showWeekNumbers"
|
|
1589
|
-
},
|
|
1590
|
-
{
|
|
1591
|
-
"name": "years",
|
|
1592
|
-
"type": {
|
|
1593
|
-
"text": "array"
|
|
1594
|
-
},
|
|
1595
|
-
"fieldName": "years"
|
|
1596
1836
|
}
|
|
1597
1837
|
],
|
|
1598
1838
|
"parameters": [
|
|
@@ -1711,7 +1951,6 @@
|
|
|
1711
1951
|
"text": "object"
|
|
1712
1952
|
},
|
|
1713
1953
|
"description": "Object with properties that is passed to `renderer` function",
|
|
1714
|
-
"attribute": "model",
|
|
1715
1954
|
"inheritedFrom": {
|
|
1716
1955
|
"name": "OverlayMixin",
|
|
1717
1956
|
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
@@ -1781,7 +2020,6 @@
|
|
|
1781
2020
|
"text": "HTMLElement"
|
|
1782
2021
|
},
|
|
1783
2022
|
"description": "Owner element passed with renderer function",
|
|
1784
|
-
"attribute": "owner",
|
|
1785
2023
|
"inheritedFrom": {
|
|
1786
2024
|
"name": "OverlayMixin",
|
|
1787
2025
|
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
@@ -1795,7 +2033,6 @@
|
|
|
1795
2033
|
"text": "object"
|
|
1796
2034
|
},
|
|
1797
2035
|
"description": "The element next to which this overlay should be aligned.\nThe position of the overlay relative to the positionTarget can be adjusted\nwith properties `horizontalAlign`, `verticalAlign`, `noHorizontalOverlap`\nand `noVerticalOverlap`.",
|
|
1798
|
-
"attribute": "position-target",
|
|
1799
2036
|
"inheritedFrom": {
|
|
1800
2037
|
"name": "PositionMixin",
|
|
1801
2038
|
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
@@ -1809,7 +2046,6 @@
|
|
|
1809
2046
|
"text": "OverlayRenderer | null | undefined"
|
|
1810
2047
|
},
|
|
1811
2048
|
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
1812
|
-
"attribute": "renderer",
|
|
1813
2049
|
"inheritedFrom": {
|
|
1814
2050
|
"name": "OverlayMixin",
|
|
1815
2051
|
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
@@ -1846,7 +2082,6 @@
|
|
|
1846
2082
|
"text": "HTMLElement"
|
|
1847
2083
|
},
|
|
1848
2084
|
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
1849
|
-
"attribute": "restore-focus-node",
|
|
1850
2085
|
"inheritedFrom": {
|
|
1851
2086
|
"name": "OverlayFocusMixin",
|
|
1852
2087
|
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
@@ -2031,30 +2266,6 @@
|
|
|
2031
2266
|
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
2032
2267
|
}
|
|
2033
2268
|
},
|
|
2034
|
-
{
|
|
2035
|
-
"name": "owner",
|
|
2036
|
-
"type": {
|
|
2037
|
-
"text": "HTMLElement"
|
|
2038
|
-
},
|
|
2039
|
-
"description": "Owner element passed with renderer function",
|
|
2040
|
-
"fieldName": "owner",
|
|
2041
|
-
"inheritedFrom": {
|
|
2042
|
-
"name": "OverlayMixin",
|
|
2043
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
2044
|
-
}
|
|
2045
|
-
},
|
|
2046
|
-
{
|
|
2047
|
-
"name": "renderer",
|
|
2048
|
-
"type": {
|
|
2049
|
-
"text": "OverlayRenderer | null | undefined"
|
|
2050
|
-
},
|
|
2051
|
-
"description": "Custom function for rendering the content of the overlay.\nReceives three arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `owner` The host element of the renderer function.\n- `model` The object with the properties related with rendering.",
|
|
2052
|
-
"fieldName": "renderer",
|
|
2053
|
-
"inheritedFrom": {
|
|
2054
|
-
"name": "OverlayMixin",
|
|
2055
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-mixin.js"
|
|
2056
|
-
}
|
|
2057
|
-
},
|
|
2058
2269
|
{
|
|
2059
2270
|
"name": "required-vertical-space",
|
|
2060
2271
|
"type": {
|
|
@@ -2067,18 +2278,6 @@
|
|
|
2067
2278
|
"package": "@vaadin/overlay/src/vaadin-overlay-position-mixin.js"
|
|
2068
2279
|
}
|
|
2069
2280
|
},
|
|
2070
|
-
{
|
|
2071
|
-
"name": "restore-focus-node",
|
|
2072
|
-
"type": {
|
|
2073
|
-
"text": "HTMLElement"
|
|
2074
|
-
},
|
|
2075
|
-
"description": "Set to specify the element which should be focused on overlay close,\nif `restoreFocusOnClose` is set to true.",
|
|
2076
|
-
"fieldName": "restoreFocusNode",
|
|
2077
|
-
"inheritedFrom": {
|
|
2078
|
-
"name": "OverlayFocusMixin",
|
|
2079
|
-
"package": "@vaadin/overlay/src/vaadin-overlay-focus-mixin.js"
|
|
2080
|
-
}
|
|
2081
|
-
},
|
|
2082
2281
|
{
|
|
2083
2282
|
"name": "restore-focus-on-close",
|
|
2084
2283
|
"type": {
|
|
@@ -2268,8 +2467,8 @@
|
|
|
2268
2467
|
}
|
|
2269
2468
|
},
|
|
2270
2469
|
"inheritedFrom": {
|
|
2271
|
-
"name": "
|
|
2272
|
-
"
|
|
2470
|
+
"name": "DatePickerMixin",
|
|
2471
|
+
"module": "src/vaadin-date-picker-mixin.js"
|
|
2273
2472
|
}
|
|
2274
2473
|
},
|
|
2275
2474
|
{
|
|
@@ -2321,7 +2520,6 @@
|
|
|
2321
2520
|
"text": "DatePickerDateMetadataProvider | null | undefined"
|
|
2322
2521
|
},
|
|
2323
2522
|
"description": "A function that provides metadata for the dates the calendar is about to render: whether they\nare disabled, and CSS `part` names for styling from outside using the `::part()` selector.\nUnlike `isDateDisabled`, which is called once per date, the metadata provider is called for\na range of dates at a time, and again as the calendar renders further dates.\n\nIt receives a `DatePickerDateRange` and returns an array of `DatePickerDateMetadata` objects\nfor the dates in that range that have metadata. It can return a `Promise` to load the metadata\nasynchronously, and `null` or `undefined` when no date in the range has metadata.\n\nThe returned array has the following structure:\n\n```js\n[\n // The date is an ISO 8601 string.\n { date: '2026-01-01', disabled: true },\n\n // Adds a custom part name to the date.\n { date: '2026-01-02', part: 'busy' },\n]\n```\n\nA date is disabled if its metadata marks it disabled, or `isDateDisabled` returns `true`, or\nit is outside `min` and `max`. Disabled dates are not selectable, and typing a disabled date in\nthe field makes it invalid. The provider does not affect which date is focused when opening the\noverlay. Use `initialPosition` property to provide a selectable date.\n\nWhile a returned `Promise` is pending, the dates it covers are not disabled yet and render with\nthe `loading` part. If the function throws or rejects, corresponding dates are requested again\nthe next time the user navigates.\n\nThe provider is used for validation also when the overlay is closed. Date is considered valid\nwhile the provider is pending, and is re-validated again after the metadata is loaded.\n\nKeep a stable reference to the function: assigning a new one clears the cache and re-fetches\nvisible range. Call `clearCache()` to re-fetch when the data behind the same function changed.",
|
|
2324
|
-
"attribute": "date-metadata-provider",
|
|
2325
2523
|
"inheritedFrom": {
|
|
2326
2524
|
"name": "DatePickerMixin",
|
|
2327
2525
|
"module": "src/vaadin-date-picker-mixin.js"
|
|
@@ -2337,8 +2535,8 @@
|
|
|
2337
2535
|
"description": "If true, the user cannot interact with this element.",
|
|
2338
2536
|
"attribute": "disabled",
|
|
2339
2537
|
"inheritedFrom": {
|
|
2340
|
-
"name": "
|
|
2341
|
-
"package": "@vaadin/a11y-base/src/
|
|
2538
|
+
"name": "DisabledMixin",
|
|
2539
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
2342
2540
|
}
|
|
2343
2541
|
},
|
|
2344
2542
|
{
|
|
@@ -2372,15 +2570,14 @@
|
|
|
2372
2570
|
{
|
|
2373
2571
|
"kind": "field",
|
|
2374
2572
|
"name": "i18n",
|
|
2375
|
-
"
|
|
2573
|
+
"description": "The object used to localize this component. To change the default\nlocalization, set this to an object that provides all properties, or\njust the individual properties you want to change.\n\nWhen not set, defaults to `undefined`.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n // An array with the full names of months starting\n // with January.\n monthNames: [\n 'January', 'February', 'March', 'April', 'May',\n 'June', 'July', 'August', 'September',\n 'October', 'November', 'December'\n ],\n\n // An array of weekday names starting with Sunday. Used\n // in screen reader announcements.\n weekdays: [\n 'Sunday', 'Monday', 'Tuesday', 'Wednesday',\n 'Thursday', 'Friday', 'Saturday'\n ],\n\n // An array of short weekday names starting with Sunday.\n // Displayed in the calendar.\n weekdaysShort: [\n 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'\n ],\n\n // An integer indicating the first day of the week\n // (0 = Sunday, 1 = Monday, etc.).\n firstDayOfWeek: 0,\n\n // Translation of the Today shortcut button text.\n today: 'Today',\n\n // Translation of the Cancel button text.\n cancel: 'Cancel',\n\n // Accessible name of the overlay content, announced by screen readers\n // when the overlay opens.\n dialogAccessibleName: 'Calendar',\n\n // Used for adjusting the year value when parsing dates with short years.\n // The year values between 0 and 99 are evaluated and adjusted.\n // Example: for a referenceDate of 1970-10-30;\n // dateToBeParsed: 40-10-30, result: 1940-10-30\n // dateToBeParsed: 80-10-30, result: 1980-10-30\n // dateToBeParsed: 10-10-30, result: 2010-10-30\n // Supported date format: ISO 8601 `\"YYYY-MM-DD\"` (default)\n // The default value is the current date.\n referenceDate: '',\n\n // A function to format given `Object` as\n // date string. Object is in the format `{ day: ..., month: ..., year: ... }`\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n formatDate: d => {\n // returns a string representation of the given\n // object in 'MM/DD/YYYY' -format\n },\n\n // A function to parse the given text to an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n // Must properly parse (at least) text formatted by `formatDate`.\n // Setting the property to null will disable keyboard input feature.\n // Note: The argument month is 0-based. This means that January = 0 and December = 11.\n parseDate: text => {\n // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to\n // an `Object` in the format `{ day: ..., month: ..., year: ... }`.\n }\n\n // A function to format given `monthName` and\n // `fullYear` integer as calendar title string.\n formatTitle: (monthName, fullYear) => {\n return monthName + ' ' + fullYear;\n }\n}\n```",
|
|
2376
2574
|
"type": {
|
|
2377
|
-
"text": "
|
|
2575
|
+
"text": "DatePickerI18n | undefined"
|
|
2378
2576
|
},
|
|
2379
|
-
"
|
|
2380
|
-
"attribute": "i18n",
|
|
2577
|
+
"privacy": "public",
|
|
2381
2578
|
"inheritedFrom": {
|
|
2382
|
-
"name": "
|
|
2383
|
-
"
|
|
2579
|
+
"name": "DatePickerMixin",
|
|
2580
|
+
"module": "src/vaadin-date-picker-mixin.js"
|
|
2384
2581
|
}
|
|
2385
2582
|
},
|
|
2386
2583
|
{
|
|
@@ -2419,7 +2616,6 @@
|
|
|
2419
2616
|
"text": "function(DatePickerDate): boolean | undefined"
|
|
2420
2617
|
},
|
|
2421
2618
|
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.\n\nThe function is called once per date and has to answer synchronously. Use\n`dateMetadataProvider` when the answer has to be loaded first, or when dates also need\ncustom part names. A date is disabled when either of the two disables it.",
|
|
2422
|
-
"attribute": "is-date-disabled",
|
|
2423
2619
|
"inheritedFrom": {
|
|
2424
2620
|
"name": "DatePickerMixin",
|
|
2425
2621
|
"module": "src/vaadin-date-picker-mixin.js"
|
|
@@ -2619,15 +2815,11 @@
|
|
|
2619
2815
|
],
|
|
2620
2816
|
"events": [
|
|
2621
2817
|
{
|
|
2622
|
-
"name": "change",
|
|
2623
2818
|
"type": {
|
|
2624
|
-
"text": "
|
|
2819
|
+
"text": "Event"
|
|
2625
2820
|
},
|
|
2626
2821
|
"description": "Fired when the user commits a value change.",
|
|
2627
|
-
"
|
|
2628
|
-
"name": "InputConstraintsMixin",
|
|
2629
|
-
"package": "@vaadin/field-base/src/input-constraints-mixin.js"
|
|
2630
|
-
}
|
|
2822
|
+
"name": "change"
|
|
2631
2823
|
},
|
|
2632
2824
|
{
|
|
2633
2825
|
"type": {
|
|
@@ -2644,15 +2836,11 @@
|
|
|
2644
2836
|
"name": "opened-changed"
|
|
2645
2837
|
},
|
|
2646
2838
|
{
|
|
2647
|
-
"name": "unparsable-change",
|
|
2648
2839
|
"type": {
|
|
2649
|
-
"text": "
|
|
2840
|
+
"text": "Event"
|
|
2650
2841
|
},
|
|
2651
2842
|
"description": "Fired when the user commits an unparsable value change and there is no change event.",
|
|
2652
|
-
"
|
|
2653
|
-
"name": "DatePickerMixin",
|
|
2654
|
-
"module": "src/vaadin-date-picker-mixin.js"
|
|
2655
|
-
}
|
|
2843
|
+
"name": "unparsable-change"
|
|
2656
2844
|
},
|
|
2657
2845
|
{
|
|
2658
2846
|
"type": {
|
|
@@ -2766,18 +2954,6 @@
|
|
|
2766
2954
|
"package": "@vaadin/field-base/src/clear-button-mixin.js"
|
|
2767
2955
|
}
|
|
2768
2956
|
},
|
|
2769
|
-
{
|
|
2770
|
-
"name": "date-metadata-provider",
|
|
2771
|
-
"type": {
|
|
2772
|
-
"text": "DatePickerDateMetadataProvider | null | undefined"
|
|
2773
|
-
},
|
|
2774
|
-
"description": "A function that provides metadata for the dates the calendar is about to render: whether they\nare disabled, and CSS `part` names for styling from outside using the `::part()` selector.\nUnlike `isDateDisabled`, which is called once per date, the metadata provider is called for\na range of dates at a time, and again as the calendar renders further dates.\n\nIt receives a `DatePickerDateRange` and returns an array of `DatePickerDateMetadata` objects\nfor the dates in that range that have metadata. It can return a `Promise` to load the metadata\nasynchronously, and `null` or `undefined` when no date in the range has metadata.\n\nThe returned array has the following structure:\n\n```js\n[\n // The date is an ISO 8601 string.\n { date: '2026-01-01', disabled: true },\n\n // Adds a custom part name to the date.\n { date: '2026-01-02', part: 'busy' },\n]\n```\n\nA date is disabled if its metadata marks it disabled, or `isDateDisabled` returns `true`, or\nit is outside `min` and `max`. Disabled dates are not selectable, and typing a disabled date in\nthe field makes it invalid. The provider does not affect which date is focused when opening the\noverlay. Use `initialPosition` property to provide a selectable date.\n\nWhile a returned `Promise` is pending, the dates it covers are not disabled yet and render with\nthe `loading` part. If the function throws or rejects, corresponding dates are requested again\nthe next time the user navigates.\n\nThe provider is used for validation also when the overlay is closed. Date is considered valid\nwhile the provider is pending, and is re-validated again after the metadata is loaded.\n\nKeep a stable reference to the function: assigning a new one clears the cache and re-fetches\nvisible range. Call `clearCache()` to re-fetch when the data behind the same function changed.",
|
|
2775
|
-
"fieldName": "dateMetadataProvider",
|
|
2776
|
-
"inheritedFrom": {
|
|
2777
|
-
"name": "DatePickerMixin",
|
|
2778
|
-
"module": "src/vaadin-date-picker-mixin.js"
|
|
2779
|
-
}
|
|
2780
|
-
},
|
|
2781
2957
|
{
|
|
2782
2958
|
"name": "disabled",
|
|
2783
2959
|
"type": {
|
|
@@ -2786,8 +2962,8 @@
|
|
|
2786
2962
|
"description": "If true, the user cannot interact with this element.",
|
|
2787
2963
|
"fieldName": "disabled",
|
|
2788
2964
|
"inheritedFrom": {
|
|
2789
|
-
"name": "
|
|
2790
|
-
"package": "@vaadin/a11y-base/src/
|
|
2965
|
+
"name": "DisabledMixin",
|
|
2966
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
2791
2967
|
}
|
|
2792
2968
|
},
|
|
2793
2969
|
{
|
|
@@ -2814,18 +2990,6 @@
|
|
|
2814
2990
|
"package": "@vaadin/field-base/src/field-mixin.js"
|
|
2815
2991
|
}
|
|
2816
2992
|
},
|
|
2817
|
-
{
|
|
2818
|
-
"name": "i18n",
|
|
2819
|
-
"type": {
|
|
2820
|
-
"text": "Object | undefined"
|
|
2821
|
-
},
|
|
2822
|
-
"description": "The object used to localize this component. To change the default\nlocalization, set this to an object that provides all properties, or\njust the individual properties you want to change.\n\nWhen not set, defaults to `undefined`.\n\nShould be overridden by subclasses to provide a custom JSDoc with the\ndefault I18N properties.",
|
|
2823
|
-
"fieldName": "i18n",
|
|
2824
|
-
"inheritedFrom": {
|
|
2825
|
-
"name": "I18nMixin",
|
|
2826
|
-
"package": "@vaadin/component-base/src/i18n-mixin.js"
|
|
2827
|
-
}
|
|
2828
|
-
},
|
|
2829
2993
|
{
|
|
2830
2994
|
"name": "initial-position",
|
|
2831
2995
|
"type": {
|
|
@@ -2850,18 +3014,6 @@
|
|
|
2850
3014
|
"package": "@vaadin/field-base/src/validate-mixin.js"
|
|
2851
3015
|
}
|
|
2852
3016
|
},
|
|
2853
|
-
{
|
|
2854
|
-
"name": "is-date-disabled",
|
|
2855
|
-
"type": {
|
|
2856
|
-
"text": "function(DatePickerDate): boolean | undefined"
|
|
2857
|
-
},
|
|
2858
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.\n\nThe function is called once per date and has to answer synchronously. Use\n`dateMetadataProvider` when the answer has to be loaded first, or when dates also need\ncustom part names. A date is disabled when either of the two disables it.",
|
|
2859
|
-
"fieldName": "isDateDisabled",
|
|
2860
|
-
"inheritedFrom": {
|
|
2861
|
-
"name": "DatePickerMixin",
|
|
2862
|
-
"module": "src/vaadin-date-picker-mixin.js"
|
|
2863
|
-
}
|
|
2864
|
-
},
|
|
2865
3017
|
{
|
|
2866
3018
|
"name": "label",
|
|
2867
3019
|
"type": {
|
|
@@ -3019,10 +3171,6 @@
|
|
|
3019
3171
|
"name": "DatePickerMixin",
|
|
3020
3172
|
"module": "src/vaadin-date-picker-mixin.js"
|
|
3021
3173
|
},
|
|
3022
|
-
{
|
|
3023
|
-
"name": "InputControlMixin",
|
|
3024
|
-
"package": "@vaadin/field-base/src/input-control-mixin.js"
|
|
3025
|
-
},
|
|
3026
3174
|
{
|
|
3027
3175
|
"name": "ThemableMixin",
|
|
3028
3176
|
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
@@ -3083,8 +3231,7 @@
|
|
|
3083
3231
|
"privacy": "public",
|
|
3084
3232
|
"type": {
|
|
3085
3233
|
"text": "date"
|
|
3086
|
-
}
|
|
3087
|
-
"attribute": "entered-date"
|
|
3234
|
+
}
|
|
3088
3235
|
},
|
|
3089
3236
|
{
|
|
3090
3237
|
"kind": "field",
|
|
@@ -3098,8 +3245,7 @@
|
|
|
3098
3245
|
"type": {
|
|
3099
3246
|
"text": "object"
|
|
3100
3247
|
},
|
|
3101
|
-
"description": "A `Date` object for the currently focused date."
|
|
3102
|
-
"attribute": "focused-date"
|
|
3248
|
+
"description": "A `Date` object for the currently focused date."
|
|
3103
3249
|
},
|
|
3104
3250
|
{
|
|
3105
3251
|
"kind": "field",
|
|
@@ -3107,8 +3253,7 @@
|
|
|
3107
3253
|
"privacy": "public",
|
|
3108
3254
|
"type": {
|
|
3109
3255
|
"text": "object"
|
|
3110
|
-
}
|
|
3111
|
-
"attribute": "i18n"
|
|
3256
|
+
}
|
|
3112
3257
|
},
|
|
3113
3258
|
{
|
|
3114
3259
|
"kind": "field",
|
|
@@ -3127,8 +3272,7 @@
|
|
|
3127
3272
|
"type": {
|
|
3128
3273
|
"text": "Function | undefined"
|
|
3129
3274
|
},
|
|
3130
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean."
|
|
3131
|
-
"attribute": "is-date-disabled"
|
|
3275
|
+
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean."
|
|
3132
3276
|
},
|
|
3133
3277
|
{
|
|
3134
3278
|
"kind": "field",
|
|
@@ -3137,8 +3281,7 @@
|
|
|
3137
3281
|
"type": {
|
|
3138
3282
|
"text": "date"
|
|
3139
3283
|
},
|
|
3140
|
-
"description": "The latest date that can be selected. All later dates will be disabled."
|
|
3141
|
-
"attribute": "max-date"
|
|
3284
|
+
"description": "The latest date that can be selected. All later dates will be disabled."
|
|
3142
3285
|
},
|
|
3143
3286
|
{
|
|
3144
3287
|
"kind": "field",
|
|
@@ -3147,8 +3290,7 @@
|
|
|
3147
3290
|
"type": {
|
|
3148
3291
|
"text": "date"
|
|
3149
3292
|
},
|
|
3150
|
-
"description": "The earliest date that can be selected. All earlier dates will be disabled."
|
|
3151
|
-
"attribute": "min-date"
|
|
3293
|
+
"description": "The earliest date that can be selected. All earlier dates will be disabled."
|
|
3152
3294
|
},
|
|
3153
3295
|
{
|
|
3154
3296
|
"kind": "field",
|
|
@@ -3157,8 +3299,7 @@
|
|
|
3157
3299
|
"type": {
|
|
3158
3300
|
"text": "object"
|
|
3159
3301
|
},
|
|
3160
|
-
"description": "A `Date` object defining the month to be displayed. Only year and\nmonth properties are actually used."
|
|
3161
|
-
"attribute": "month"
|
|
3302
|
+
"description": "A `Date` object defining the month to be displayed. Only year and\nmonth properties are actually used."
|
|
3162
3303
|
},
|
|
3163
3304
|
{
|
|
3164
3305
|
"kind": "field",
|
|
@@ -3167,8 +3308,7 @@
|
|
|
3167
3308
|
"type": {
|
|
3168
3309
|
"text": "object"
|
|
3169
3310
|
},
|
|
3170
|
-
"description": "A `Date` object for the currently selected date."
|
|
3171
|
-
"attribute": "selected-date"
|
|
3311
|
+
"description": "A `Date` object for the currently selected date."
|
|
3172
3312
|
},
|
|
3173
3313
|
{
|
|
3174
3314
|
"kind": "field",
|
|
@@ -3197,13 +3337,6 @@
|
|
|
3197
3337
|
},
|
|
3198
3338
|
"fieldName": "disabled"
|
|
3199
3339
|
},
|
|
3200
|
-
{
|
|
3201
|
-
"name": "entered-date",
|
|
3202
|
-
"type": {
|
|
3203
|
-
"text": "date"
|
|
3204
|
-
},
|
|
3205
|
-
"fieldName": "enteredDate"
|
|
3206
|
-
},
|
|
3207
3340
|
{
|
|
3208
3341
|
"name": "ignore-taps",
|
|
3209
3342
|
"type": {
|
|
@@ -3212,30 +3345,6 @@
|
|
|
3212
3345
|
"description": "Flag stating whether taps on the component should be ignored.",
|
|
3213
3346
|
"fieldName": "ignoreTaps"
|
|
3214
3347
|
},
|
|
3215
|
-
{
|
|
3216
|
-
"name": "is-date-disabled",
|
|
3217
|
-
"type": {
|
|
3218
|
-
"text": "Function | undefined"
|
|
3219
|
-
},
|
|
3220
|
-
"description": "A function to be used to determine whether the user can select a given date.\nReceives a `DatePickerDate` object of the date to be selected and should return a\nboolean.",
|
|
3221
|
-
"fieldName": "isDateDisabled"
|
|
3222
|
-
},
|
|
3223
|
-
{
|
|
3224
|
-
"name": "max-date",
|
|
3225
|
-
"type": {
|
|
3226
|
-
"text": "date"
|
|
3227
|
-
},
|
|
3228
|
-
"description": "The latest date that can be selected. All later dates will be disabled.",
|
|
3229
|
-
"fieldName": "maxDate"
|
|
3230
|
-
},
|
|
3231
|
-
{
|
|
3232
|
-
"name": "min-date",
|
|
3233
|
-
"type": {
|
|
3234
|
-
"text": "date"
|
|
3235
|
-
},
|
|
3236
|
-
"description": "The earliest date that can be selected. All earlier dates will be disabled.",
|
|
3237
|
-
"fieldName": "minDate"
|
|
3238
|
-
},
|
|
3239
3348
|
{
|
|
3240
3349
|
"name": "show-week-numbers",
|
|
3241
3350
|
"type": {
|