@ui5/webcomponents 2.26.0 → 2.27.0-rc.1
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/CHANGELOG.md +43 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/Avatar.d.ts +7 -0
- package/dist/Avatar.js +18 -5
- package/dist/Avatar.js.map +1 -1
- package/dist/ComboBoxItemGroup.d.ts +2 -0
- package/dist/ComboBoxItemGroup.js +2 -0
- package/dist/ComboBoxItemGroup.js.map +1 -1
- package/dist/DatePicker.d.ts +14 -0
- package/dist/DatePicker.js +14 -0
- package/dist/DatePicker.js.map +1 -1
- package/dist/DayPicker.d.ts +1 -0
- package/dist/DayPicker.js +4 -1
- package/dist/DayPicker.js.map +1 -1
- package/dist/DayPickerTemplate.js +1 -1
- package/dist/DayPickerTemplate.js.map +1 -1
- package/dist/Icon.js +3 -0
- package/dist/Icon.js.map +1 -1
- package/dist/List.js +1 -1
- package/dist/List.js.map +1 -1
- package/dist/ListBoxItemGroupTemplate.js +1 -1
- package/dist/ListBoxItemGroupTemplate.js.map +1 -1
- package/dist/ListItem.d.ts +4 -2
- package/dist/ListItem.js +5 -9
- package/dist/ListItem.js.map +1 -1
- package/dist/ListItemBaseTemplate.d.ts +2 -0
- package/dist/ListItemBaseTemplate.js +1 -1
- package/dist/ListItemBaseTemplate.js.map +1 -1
- package/dist/ListItemGroup.d.ts +7 -23
- package/dist/ListItemGroup.js +4 -21
- package/dist/ListItemGroup.js.map +1 -1
- package/dist/ListItemGroupBase.d.ts +41 -0
- package/dist/ListItemGroupBase.js +54 -0
- package/dist/ListItemGroupBase.js.map +1 -0
- package/dist/ListItemStandardTemplate.js +1 -1
- package/dist/ListItemStandardTemplate.js.map +1 -1
- package/dist/MultiComboBoxItemGroup.d.ts +2 -0
- package/dist/MultiComboBoxItemGroup.js +2 -0
- package/dist/MultiComboBoxItemGroup.js.map +1 -1
- package/dist/NumberInput.d.ts +271 -0
- package/dist/NumberInput.js +719 -0
- package/dist/NumberInput.js.map +1 -0
- package/dist/NumberInputTemplate.d.ts +2 -0
- package/dist/NumberInputTemplate.js +18 -0
- package/dist/NumberInputTemplate.js.map +1 -0
- package/dist/Option.d.ts +10 -0
- package/dist/Option.js +6 -0
- package/dist/Option.js.map +1 -1
- package/dist/OptionGroup.d.ts +34 -0
- package/dist/OptionGroup.js +61 -0
- package/dist/OptionGroup.js.map +1 -0
- package/dist/OptionGroupTemplate.d.ts +2 -0
- package/dist/OptionGroupTemplate.js +6 -0
- package/dist/OptionGroupTemplate.js.map +1 -0
- package/dist/OptionTemplate.js +6 -1
- package/dist/OptionTemplate.js.map +1 -1
- package/dist/Popover.js +5 -3
- package/dist/Popover.js.map +1 -1
- package/dist/Select.d.ts +19 -2
- package/dist/Select.js +79 -28
- package/dist/Select.js.map +1 -1
- package/dist/SelectPopoverTemplate.js +1 -1
- package/dist/SelectPopoverTemplate.js.map +1 -1
- package/dist/SelectTemplate.js +2 -1
- package/dist/SelectTemplate.js.map +1 -1
- package/dist/SplitButton.d.ts +7 -3
- package/dist/SplitButton.js +4 -4
- package/dist/SplitButton.js.map +1 -1
- package/dist/SplitButtonTemplate.js +1 -1
- package/dist/SplitButtonTemplate.js.map +1 -1
- package/dist/StepInput.d.ts +14 -127
- package/dist/StepInput.js +40 -472
- package/dist/StepInput.js.map +1 -1
- package/dist/StepInputTemplate.js +4 -15
- package/dist/StepInputTemplate.js.map +1 -1
- package/dist/SuggestionItemGroup.d.ts +2 -0
- package/dist/SuggestionItemGroup.js +2 -0
- package/dist/SuggestionItemGroup.js.map +1 -1
- package/dist/ToolbarButton.d.ts +18 -0
- package/dist/ToolbarButton.js +16 -0
- package/dist/ToolbarButton.js.map +1 -1
- package/dist/ToolbarButtonTemplate.js +1 -1
- package/dist/ToolbarButtonTemplate.js.map +1 -1
- package/dist/bundle.esm.js +2 -0
- package/dist/bundle.esm.js.map +1 -1
- package/dist/css/themes/NumberInput.css +1 -0
- package/dist/css/themes/OptionGroup.css +1 -0
- package/dist/css/themes/StepInput.css +1 -1
- package/dist/css/themes/TimePickerClock.css +1 -1
- package/dist/css/themes/TimeSelectionClocks.css +1 -1
- package/dist/css/themes/sap_fiori_3/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_dark/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_hcb/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_hcw/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_auto/parameters-bundle.css +30 -22
- package/dist/css/themes/sap_horizon_dark/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_hc_auto/parameters-bundle.css +31 -24
- package/dist/css/themes/sap_horizon_hcb/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_hcw/parameters-bundle.css +1 -1
- package/dist/custom-elements-internal.json +719 -156
- package/dist/custom-elements.json +658 -162
- package/dist/generated/assets/i18n/messagebundle_de.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_en.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_en_US_saprigi.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_pl.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_ru.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_dark/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_hcb/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_hcw/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_auto/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_dark/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_hc_auto/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_hcb/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_hcw/parameters-bundle.css.json +1 -1
- package/dist/generated/i18n/i18n-defaults.d.ts +8 -6
- package/dist/generated/i18n/i18n-defaults.js +8 -6
- package/dist/generated/i18n/i18n-defaults.js.map +1 -1
- package/dist/generated/themes/NumberInput.css.d.ts +2 -0
- package/dist/generated/themes/NumberInput.css.js +8 -0
- package/dist/generated/themes/NumberInput.css.js.map +1 -0
- package/dist/generated/themes/OptionGroup.css.d.ts +2 -0
- package/dist/generated/themes/OptionGroup.css.js +8 -0
- package/dist/generated/themes/OptionGroup.css.js.map +1 -0
- package/dist/generated/themes/StepInput.css.d.ts +1 -1
- package/dist/generated/themes/StepInput.css.js +1 -1
- package/dist/generated/themes/StepInput.css.js.map +1 -1
- package/dist/generated/themes/TimePickerClock.css.d.ts +1 -1
- package/dist/generated/themes/TimePickerClock.css.js +1 -1
- package/dist/generated/themes/TimePickerClock.css.js.map +1 -1
- package/dist/generated/themes/TimeSelectionClocks.css.d.ts +1 -1
- package/dist/generated/themes/TimeSelectionClocks.css.js +1 -1
- package/dist/generated/themes/TimeSelectionClocks.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_auto/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon_auto/parameters-bundle.css.js +30 -22
- package/dist/generated/themes/sap_horizon_auto/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_hc_auto/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon_hc_auto/parameters-bundle.css.js +31 -24
- package/dist/generated/themes/sap_horizon_hc_auto/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.d.ts +1 -1
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.js +1 -1
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.js.map +1 -1
- package/dist/vscode.html-custom-data.json +117 -17
- package/dist/web-types.json +266 -34
- package/package.json +9 -9
- package/src/DayPickerTemplate.tsx +1 -1
- package/src/ListBoxItemGroupTemplate.tsx +1 -1
- package/src/ListItemBaseTemplate.tsx +4 -0
- package/src/ListItemStandardTemplate.tsx +1 -1
- package/src/NumberInputTemplate.tsx +95 -0
- package/src/OptionGroupTemplate.tsx +20 -0
- package/src/OptionTemplate.tsx +6 -1
- package/src/SelectPopoverTemplate.tsx +1 -1
- package/src/SelectTemplate.tsx +6 -0
- package/src/SplitButtonTemplate.tsx +1 -2
- package/src/StepInputTemplate.tsx +23 -86
- package/src/ToolbarButtonTemplate.tsx +2 -0
- package/src/i18n/messagebundle.properties +13 -8
- package/src/i18n/messagebundle_de.properties +2 -2
- package/src/i18n/messagebundle_en.properties +2 -0
- package/src/i18n/messagebundle_en_US_saprigi.properties +7 -6
- package/src/i18n/messagebundle_pl.properties +1 -1
- package/src/i18n/messagebundle_ru.properties +1 -1
- package/src/themes/NumberInput.css +321 -0
- package/src/themes/OptionGroup.css +28 -0
- package/src/themes/StepInput.css +0 -276
- package/src/themes/TimePickerClock.css +1 -1
- package/src/themes/TimeSelectionClocks.css +1 -1
- package/src/themes/base/NumberInput-parameters.css +31 -0
- package/src/themes/base/sizes-parameters.css +3 -3
- package/src/themes/sap_fiori_3/parameters-bundle.css +1 -1
- package/src/themes/sap_fiori_3_dark/parameters-bundle.css +1 -1
- package/src/themes/sap_fiori_3_hcb/parameters-bundle.css +1 -1
- package/src/themes/sap_fiori_3_hcw/parameters-bundle.css +1 -1
- package/src/themes/sap_horizon/NumberInput-parameters.css +26 -0
- package/src/themes/sap_horizon/parameters-bundle.css +1 -1
- package/src/themes/sap_horizon_dark/NumberInput-parameters.css +26 -0
- package/src/themes/sap_horizon_dark/parameters-bundle.css +1 -1
- package/src/themes/sap_horizon_hcb/NumberInput-parameters.css +14 -0
- package/src/themes/sap_horizon_hcb/parameters-bundle.css +2 -1
- package/src/themes/sap_horizon_hcw/NumberInput-parameters.css +14 -0
- package/src/themes/sap_horizon_hcw/parameters-bundle.css +2 -1
- package/src/themes/base/StepInput-parameters.css +0 -25
- package/src/themes/sap_horizon/StepInput-parameters.css +0 -25
- package/src/themes/sap_horizon_dark/StepInput-parameters.css +0 -25
package/dist/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@ui5/webcomponents",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.27.0-rc.1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -2261,7 +2261,7 @@
|
|
|
2261
2261
|
},
|
|
2262
2262
|
{
|
|
2263
2263
|
"name": "header-text",
|
|
2264
|
-
"description": "Defines the header text of the
|
|
2264
|
+
"description": "Defines the header text of the group.",
|
|
2265
2265
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
2266
2266
|
},
|
|
2267
2267
|
{
|
|
@@ -2302,7 +2302,7 @@
|
|
|
2302
2302
|
},
|
|
2303
2303
|
{
|
|
2304
2304
|
"name": "header-text",
|
|
2305
|
-
"description": "Defines the header text of the
|
|
2305
|
+
"description": "Defines the header text of the group.",
|
|
2306
2306
|
"value": { "type": "string | undefined" }
|
|
2307
2307
|
},
|
|
2308
2308
|
{
|
|
@@ -2325,7 +2325,7 @@
|
|
|
2325
2325
|
},
|
|
2326
2326
|
{
|
|
2327
2327
|
"name": "ui5-date-picker",
|
|
2328
|
-
"description": "### Overview\n\nThe `ui5-date-picker` component provides an input field with assigned calendar which opens on user action.\nThe `ui5-date-picker` allows users to select a localized date using touch,\nmouse, or keyboard input. It consists of two parts: the date input field and the\ndate picker.\n\n### Usage\n\nThe user can enter a date by:\n\n- Using the calendar that opens in a popup\n- Typing it in directly in the input field\n\nWhen the user makes an entry and presses the enter key, the calendar shows the corresponding date.\nWhen the user directly triggers the calendar display, the actual date is displayed.\n\n### Formatting\n\nIf a date is entered by typing it into\nthe input field, it must fit to the used date format.\n\nSupported format options are pattern-based on Unicode LDML Date Format notation.\nFor more information, see [UTS #35: Unicode Locale Data Markup Language](https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table).\n\nFor example, if the valueFormat is \"yyyy-MM-dd\", the displayFormat is \"MMM d, y\", and the used locale is English, a valid value string is \"2015-07-30\", which leads to an output of \"Jul 30, 2015\".\nIf no placeholder is set to the DatePicker, the used displayFormat is displayed as a placeholder. If another placeholder is needed, it must be set.\n\n### Keyboard Handling\nThe `ui5-date-picker` provides advanced keyboard handling.\nIf the `ui5-date-picker` is focused,\nyou can open or close the drop-down by pressing [F4], [Alt] + [Up] or [Alt] + [Down] keys.\nOnce the drop-down is opened, you can use the [Up], [Down], [Left] or [Right] arrow keys\nto navigate through the dates and select one by pressing the `Space` or `Enter` keys. Moreover you can\nuse TAB to reach the buttons for changing month and year.\n\nIf the `ui5-date-picker` input field is focused and its corresponding picker dialog is not opened,\nthen users can increment or decrement the date referenced by `dateValue` property\nby using the following shortcuts:\n\n- [Page Down] - Decrements the corresponding day of the month by one\n- [Shift] + [Page Down] - Decrements the corresponding month by one\n- [Shift] + [Ctrl] + [Page Down] - Decrements the corresponding year by one\n- [Page Up] - Increments the corresponding day of the month by one\n- [Shift] + [Page Up] - Increments the corresponding month by one\n- [Shift] + [Ctrl] + [Page Up] - Increments the corresponding year by one\n\n### Calendar types\nThe component supports several calendar types - Gregorian, Buddhist, Islamic, Japanese and Persian.\nBy default the Gregorian Calendar is used. In order to use the Buddhist, Islamic, Japanese or Persian calendar,\nyou need to set the `primaryCalendarType` property and import one or more of the following modules:\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Buddhist.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Islamic.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Japanese.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Persian.js\";`\n\nOr, you can use the global configuration and set the `calendarType` key:\n\n```html\n<script data-id=\"sap-ui-config\" type=\"application/json\">\n\t{\n\t\t\"calendarType\": \"Japanese\"\n\t}\n<script>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/DatePicker.js\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter or on focusout.\n- **close** - Fired after the component's picker is closed.\n- **input** - Fired when the value of the component is changed at each key stroke.\n- **open** - Fired after the component's picker is opened.\n- **value-state-change** - Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if it's default action is\nprevented, the component will not update the value state.\n\n### **Methods:**\n - **formatValue(date: _Date_): _string_** - Formats a Java Script date object into a string representing a locale date\naccording to the `formatPattern` property of the DatePicker instance\n- **isInValidRange(value: _string_): _boolean_** - Checks if a date is between the minimum and maximum date.\n- **isValid(value: _string_): _boolean_** - @deprecated Use isValidValue or isValidDisplayValue instead - Checks if a value is valid against the current date format of the DatePicker.\n- **isValidDisplayValue(value: _string_): _boolean_** - Checks if a value is valid against the current date format of the DatePicker.\n- **isValidValue(value: _string_): _boolean_** - Checks if a value is valid against the current date format of the DatePicker.\n\n### **Slots:**\n - **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.\n\n### **CSS Parts:**\n - **input** - Used to style the input element. This part is forwarded to the underlying ui5-input element.",
|
|
2328
|
+
"description": "### Overview\n\nThe `ui5-date-picker` component provides an input field with assigned calendar which opens on user action.\nThe `ui5-date-picker` allows users to select a localized date using touch,\nmouse, or keyboard input. It consists of two parts: the date input field and the\ndate picker.\n\n### Usage\n\nThe user can enter a date by:\n\n- Using the calendar that opens in a popup\n- Typing it in directly in the input field\n\nWhen the user makes an entry and presses the enter key, the calendar shows the corresponding date.\nWhen the user directly triggers the calendar display, the actual date is displayed.\n\n### Formatting\n\nIf a date is entered by typing it into\nthe input field, it must fit to the used date format.\n\nSupported format options are pattern-based on Unicode LDML Date Format notation.\nFor more information, see [UTS #35: Unicode Locale Data Markup Language](https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table).\n\nFor example, if the valueFormat is \"yyyy-MM-dd\", the displayFormat is \"MMM d, y\", and the used locale is English, a valid value string is \"2015-07-30\", which leads to an output of \"Jul 30, 2015\".\nIf no placeholder is set to the DatePicker, the used displayFormat is displayed as a placeholder. If another placeholder is needed, it must be set.\n\n### Relative date input\n\nThe input field also accepts locale-aware relative date expressions sourced from the Unicode CLDR.\nThe following expressions are supported in English:\n\n- Day: \"today\", \"yesterday\", \"tomorrow\", \"in N days\", \"N days ago\"\n- Week: \"this week\", \"last week\", \"next week\", \"in N weeks\", \"N weeks ago\"\n- Month: \"this month\", \"last month\", \"next month\", \"in N months\", \"N months ago\"\n- Year: \"this year\", \"last year\", \"next year\", \"in N years\", \"N years ago\"\n\nThe recognized expressions are locale-specific — the equivalent terms in the user's language are used (for example, \"heute\" in German, \"bugün\" in Turkish).\nWeek, month, and year expressions resolve to an offset from today (for example, \"next week\" = today + 7 days).\nFor the full list of supported fields and patterns, see [CLDR Date Fields](https://unicode.org/reports/tr35/tr35-dates.html#Calendar_Fields).\n\n### Keyboard Handling\nThe `ui5-date-picker` provides advanced keyboard handling.\nIf the `ui5-date-picker` is focused,\nyou can open or close the drop-down by pressing [F4], [Alt] + [Up] or [Alt] + [Down] keys.\nOnce the drop-down is opened, you can use the [Up], [Down], [Left] or [Right] arrow keys\nto navigate through the dates and select one by pressing the `Space` or `Enter` keys. Moreover you can\nuse TAB to reach the buttons for changing month and year.\n\nIf the `ui5-date-picker` input field is focused and its corresponding picker dialog is not opened,\nthen users can increment or decrement the date referenced by `dateValue` property\nby using the following shortcuts:\n\n- [Page Down] - Decrements the corresponding day of the month by one\n- [Shift] + [Page Down] - Decrements the corresponding month by one\n- [Shift] + [Ctrl] + [Page Down] - Decrements the corresponding year by one\n- [Page Up] - Increments the corresponding day of the month by one\n- [Shift] + [Page Up] - Increments the corresponding month by one\n- [Shift] + [Ctrl] + [Page Up] - Increments the corresponding year by one\n\n### Calendar types\nThe component supports several calendar types - Gregorian, Buddhist, Islamic, Japanese and Persian.\nBy default the Gregorian Calendar is used. In order to use the Buddhist, Islamic, Japanese or Persian calendar,\nyou need to set the `primaryCalendarType` property and import one or more of the following modules:\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Buddhist.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Islamic.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Japanese.js\";`\n\n`import \"@ui5/webcomponents-localization/dist/features/calendar/Persian.js\";`\n\nOr, you can use the global configuration and set the `calendarType` key:\n\n```html\n<script data-id=\"sap-ui-config\" type=\"application/json\">\n\t{\n\t\t\"calendarType\": \"Japanese\"\n\t}\n<script>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/DatePicker.js\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter or on focusout.\n- **close** - Fired after the component's picker is closed.\n- **input** - Fired when the value of the component is changed at each key stroke.\n- **open** - Fired after the component's picker is opened.\n- **value-state-change** - Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if it's default action is\nprevented, the component will not update the value state.\n\n### **Methods:**\n - **formatValue(date: _Date_): _string_** - Formats a Java Script date object into a string representing a locale date\naccording to the `formatPattern` property of the DatePicker instance\n- **isInValidRange(value: _string_): _boolean_** - Checks if a date is between the minimum and maximum date.\n- **isValid(value: _string_): _boolean_** - @deprecated Use isValidValue or isValidDisplayValue instead - Checks if a value is valid against the current date format of the DatePicker.\n- **isValidDisplayValue(value: _string_): _boolean_** - Checks if a value is valid against the current date format of the DatePicker.\n- **isValidValue(value: _string_): _boolean_** - Checks if a value is valid against the current date format of the DatePicker.\n\n### **Slots:**\n - **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.\n\n### **CSS Parts:**\n - **input** - Used to style the input element. This part is forwarded to the underlying ui5-input element.",
|
|
2329
2329
|
"doc-url": "",
|
|
2330
2330
|
"attributes": [
|
|
2331
2331
|
{
|
|
@@ -5537,7 +5537,7 @@
|
|
|
5537
5537
|
},
|
|
5538
5538
|
{
|
|
5539
5539
|
"name": "type",
|
|
5540
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
5540
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
5541
5541
|
"value": {
|
|
5542
5542
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
5543
5543
|
"default": "\"Active\""
|
|
@@ -5612,7 +5612,7 @@
|
|
|
5612
5612
|
},
|
|
5613
5613
|
{
|
|
5614
5614
|
"name": "type",
|
|
5615
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
5615
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
5616
5616
|
"value": {
|
|
5617
5617
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
5618
5618
|
}
|
|
@@ -5632,7 +5632,7 @@
|
|
|
5632
5632
|
},
|
|
5633
5633
|
{
|
|
5634
5634
|
"name": "ui5-li-group",
|
|
5635
|
-
"description": "### Overview\nThe `ui5-li-group` is a special list item, used only to create groups of list items.\n\nThis is the item to use inside a `ui5-list`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents/dist/ListItemGroup.js\";`\n---\n\n\n### **Events:**\n - **move** - Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.\n- **move-over** - Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.\n\n### **Slots:**\n - **default** - Defines the items of the
|
|
5635
|
+
"description": "### Overview\nThe `ui5-li-group` is a special list item, used only to create groups of list items.\n\nThis is the item to use inside a `ui5-list`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents/dist/ListItemGroup.js\";`\n---\n\n\n### **Events:**\n - **move** - Fired when a movable list item is dropped onto a drop target.\n\n**Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.\n- **move-over** - Fired when a movable list item is moved over a potential drop target during a dragging operation.\n\nIf the new position is valid, prevent the default action of the event using `preventDefault()`.\n\n### **Slots:**\n - **default** - Defines the items of the group.\n- **header** - Defines the header of the component.\n\n**Note:** Using this slot, the default header text of group and the value of `headerText` property will be overwritten.\n\n### **CSS Parts:**\n - **header** - Used to style the header item of the group\n- **title** - Used to style the title of the group header",
|
|
5636
5636
|
"doc-url": "",
|
|
5637
5637
|
"attributes": [
|
|
5638
5638
|
{
|
|
@@ -5642,7 +5642,7 @@
|
|
|
5642
5642
|
},
|
|
5643
5643
|
{
|
|
5644
5644
|
"name": "header-text",
|
|
5645
|
-
"description": "Defines the header text of the
|
|
5645
|
+
"description": "Defines the header text of the group.",
|
|
5646
5646
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
5647
5647
|
},
|
|
5648
5648
|
{
|
|
@@ -5657,7 +5657,7 @@
|
|
|
5657
5657
|
"slots": [
|
|
5658
5658
|
{
|
|
5659
5659
|
"name": "default",
|
|
5660
|
-
"description": "Defines the items of the
|
|
5660
|
+
"description": "Defines the items of the group."
|
|
5661
5661
|
},
|
|
5662
5662
|
{
|
|
5663
5663
|
"name": "header",
|
|
@@ -5683,7 +5683,7 @@
|
|
|
5683
5683
|
},
|
|
5684
5684
|
{
|
|
5685
5685
|
"name": "header-text",
|
|
5686
|
-
"description": "Defines the header text of the
|
|
5686
|
+
"description": "Defines the header text of the group.",
|
|
5687
5687
|
"value": { "type": "string | undefined" }
|
|
5688
5688
|
},
|
|
5689
5689
|
{
|
|
@@ -5845,7 +5845,7 @@
|
|
|
5845
5845
|
},
|
|
5846
5846
|
{
|
|
5847
5847
|
"name": "type",
|
|
5848
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
5848
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
5849
5849
|
"value": {
|
|
5850
5850
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
5851
5851
|
"default": "\"Active\""
|
|
@@ -5964,7 +5964,7 @@
|
|
|
5964
5964
|
},
|
|
5965
5965
|
{
|
|
5966
5966
|
"name": "type",
|
|
5967
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
5967
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
5968
5968
|
"value": {
|
|
5969
5969
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
5970
5970
|
}
|
|
@@ -6214,7 +6214,7 @@
|
|
|
6214
6214
|
},
|
|
6215
6215
|
{
|
|
6216
6216
|
"name": "type",
|
|
6217
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
6217
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
6218
6218
|
"value": {
|
|
6219
6219
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
6220
6220
|
"default": "\"Active\""
|
|
@@ -6340,7 +6340,7 @@
|
|
|
6340
6340
|
},
|
|
6341
6341
|
{
|
|
6342
6342
|
"name": "type",
|
|
6343
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
6343
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
6344
6344
|
"value": {
|
|
6345
6345
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
6346
6346
|
}
|
|
@@ -6985,7 +6985,7 @@
|
|
|
6985
6985
|
},
|
|
6986
6986
|
{
|
|
6987
6987
|
"name": "header-text",
|
|
6988
|
-
"description": "Defines the header text of the
|
|
6988
|
+
"description": "Defines the header text of the group.",
|
|
6989
6989
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
6990
6990
|
},
|
|
6991
6991
|
{
|
|
@@ -7026,7 +7026,7 @@
|
|
|
7026
7026
|
},
|
|
7027
7027
|
{
|
|
7028
7028
|
"name": "header-text",
|
|
7029
|
-
"description": "Defines the header text of the
|
|
7029
|
+
"description": "Defines the header text of the group.",
|
|
7030
7030
|
"value": { "type": "string | undefined" }
|
|
7031
7031
|
},
|
|
7032
7032
|
{
|
|
@@ -7349,6 +7349,186 @@
|
|
|
7349
7349
|
]
|
|
7350
7350
|
}
|
|
7351
7351
|
},
|
|
7352
|
+
{
|
|
7353
|
+
"name": "ui5-number-input",
|
|
7354
|
+
"description": "### Overview\n\nThe `ui5-number-input` component is a numeric input field. It allows users to enter, edit and select numeric values.\n\n### Usage\n\nThe default step is 1 but the app developer can set a different one.\n\nApp developers can set a maximum and minimum value for `ui5-number-input`.\nThe increase/decrease button and the up/down keyboard navigation become disabled when\nthe value reaches the max/min or a new value is entered from the input which is greater/less than the max/min.\n\n#### When to use:\n\n- To enter or adjust numeric values.\n- To adjust values for a specific step.\n\n#### When not to use:\n\n- To enter a static number (for example, postal code, phone number, or ID). In this case,\nuse the regular `ui5-input` instead.\n- To enter dates and times. In this case, use date/time related components instead.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/NumberInput.js\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter or on focusout.\n- **input** - Fired when the value of the component changes at each keystroke.\n- **value-state-change** - Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if its default action is\nprevented, the component will not update the value state.\n\n### **Slots:**\n - **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.",
|
|
7355
|
+
"doc-url": "",
|
|
7356
|
+
"attributes": [
|
|
7357
|
+
{
|
|
7358
|
+
"name": "accessible-name",
|
|
7359
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
7360
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
7361
|
+
},
|
|
7362
|
+
{
|
|
7363
|
+
"name": "accessible-name-ref",
|
|
7364
|
+
"description": "Receives ID (or many IDs) of the elements that label the component.",
|
|
7365
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
7366
|
+
},
|
|
7367
|
+
{
|
|
7368
|
+
"name": "disabled",
|
|
7369
|
+
"description": "Determines whether the component is displayed as disabled.",
|
|
7370
|
+
"value": { "type": "boolean", "default": "false" }
|
|
7371
|
+
},
|
|
7372
|
+
{
|
|
7373
|
+
"name": "max",
|
|
7374
|
+
"description": "Defines a maximum value of the component.",
|
|
7375
|
+
"value": { "type": "number | undefined", "default": "undefined" }
|
|
7376
|
+
},
|
|
7377
|
+
{
|
|
7378
|
+
"name": "min",
|
|
7379
|
+
"description": "Defines a minimum value of the component.",
|
|
7380
|
+
"value": { "type": "number | undefined", "default": "undefined" }
|
|
7381
|
+
},
|
|
7382
|
+
{
|
|
7383
|
+
"name": "name",
|
|
7384
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
7385
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
7386
|
+
},
|
|
7387
|
+
{
|
|
7388
|
+
"name": "placeholder",
|
|
7389
|
+
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value.\n\n**Note:** When no placeholder is set, the format pattern is displayed as a placeholder.\nPassing an empty string as the value of this property will make the component appear empty - without placeholder or format pattern.",
|
|
7390
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
7391
|
+
},
|
|
7392
|
+
{
|
|
7393
|
+
"name": "readonly",
|
|
7394
|
+
"description": "Determines whether the component is displayed as read-only.",
|
|
7395
|
+
"value": { "type": "boolean", "default": "false" }
|
|
7396
|
+
},
|
|
7397
|
+
{
|
|
7398
|
+
"name": "required",
|
|
7399
|
+
"description": "Defines whether the component is required.",
|
|
7400
|
+
"value": { "type": "boolean", "default": "false" }
|
|
7401
|
+
},
|
|
7402
|
+
{
|
|
7403
|
+
"name": "step",
|
|
7404
|
+
"description": "Defines a step of increasing/decreasing the value of the component.",
|
|
7405
|
+
"value": { "type": "number", "default": "1" }
|
|
7406
|
+
},
|
|
7407
|
+
{
|
|
7408
|
+
"name": "value",
|
|
7409
|
+
"description": "Defines a value of the component.",
|
|
7410
|
+
"value": { "type": "number", "default": "0" }
|
|
7411
|
+
},
|
|
7412
|
+
{
|
|
7413
|
+
"name": "value-precision",
|
|
7414
|
+
"description": "Determines the number of digits after the decimal point of the component.",
|
|
7415
|
+
"value": { "type": "number", "default": "0" }
|
|
7416
|
+
},
|
|
7417
|
+
{
|
|
7418
|
+
"name": "value-state",
|
|
7419
|
+
"description": "Defines the value state of the component.",
|
|
7420
|
+
"value": {
|
|
7421
|
+
"type": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\"",
|
|
7422
|
+
"default": "\"None\""
|
|
7423
|
+
}
|
|
7424
|
+
}
|
|
7425
|
+
],
|
|
7426
|
+
"slots": [
|
|
7427
|
+
{
|
|
7428
|
+
"name": "valueStateMessage",
|
|
7429
|
+
"description": "Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state."
|
|
7430
|
+
}
|
|
7431
|
+
],
|
|
7432
|
+
"events": [
|
|
7433
|
+
{
|
|
7434
|
+
"name": "change",
|
|
7435
|
+
"description": "Fired when the input operation has finished by pressing Enter or on focusout."
|
|
7436
|
+
},
|
|
7437
|
+
{
|
|
7438
|
+
"name": "input",
|
|
7439
|
+
"description": "Fired when the value of the component changes at each keystroke."
|
|
7440
|
+
},
|
|
7441
|
+
{
|
|
7442
|
+
"name": "value-state-change",
|
|
7443
|
+
"description": "Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if its default action is\nprevented, the component will not update the value state."
|
|
7444
|
+
}
|
|
7445
|
+
],
|
|
7446
|
+
"js": {
|
|
7447
|
+
"properties": [
|
|
7448
|
+
{
|
|
7449
|
+
"name": "accessible-name",
|
|
7450
|
+
"description": "Defines the accessible ARIA name of the component.",
|
|
7451
|
+
"value": { "type": "string | undefined" }
|
|
7452
|
+
},
|
|
7453
|
+
{
|
|
7454
|
+
"name": "accessible-name-ref",
|
|
7455
|
+
"description": "Receives ID (or many IDs) of the elements that label the component.",
|
|
7456
|
+
"value": { "type": "string | undefined" }
|
|
7457
|
+
},
|
|
7458
|
+
{
|
|
7459
|
+
"name": "disabled",
|
|
7460
|
+
"description": "Determines whether the component is displayed as disabled.",
|
|
7461
|
+
"value": { "type": "boolean" }
|
|
7462
|
+
},
|
|
7463
|
+
{
|
|
7464
|
+
"name": "max",
|
|
7465
|
+
"description": "Defines a maximum value of the component.",
|
|
7466
|
+
"value": { "type": "number | undefined" }
|
|
7467
|
+
},
|
|
7468
|
+
{
|
|
7469
|
+
"name": "min",
|
|
7470
|
+
"description": "Defines a minimum value of the component.",
|
|
7471
|
+
"value": { "type": "number | undefined" }
|
|
7472
|
+
},
|
|
7473
|
+
{
|
|
7474
|
+
"name": "name",
|
|
7475
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.\n\n**Note:** This property is only applicable within the context of an HTML Form element.",
|
|
7476
|
+
"value": { "type": "string | undefined" }
|
|
7477
|
+
},
|
|
7478
|
+
{
|
|
7479
|
+
"name": "placeholder",
|
|
7480
|
+
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value.\n\n**Note:** When no placeholder is set, the format pattern is displayed as a placeholder.\nPassing an empty string as the value of this property will make the component appear empty - without placeholder or format pattern.",
|
|
7481
|
+
"value": { "type": "string | undefined" }
|
|
7482
|
+
},
|
|
7483
|
+
{
|
|
7484
|
+
"name": "readonly",
|
|
7485
|
+
"description": "Determines whether the component is displayed as read-only.",
|
|
7486
|
+
"value": { "type": "boolean" }
|
|
7487
|
+
},
|
|
7488
|
+
{
|
|
7489
|
+
"name": "required",
|
|
7490
|
+
"description": "Defines whether the component is required.",
|
|
7491
|
+
"value": { "type": "boolean" }
|
|
7492
|
+
},
|
|
7493
|
+
{
|
|
7494
|
+
"name": "step",
|
|
7495
|
+
"description": "Defines a step of increasing/decreasing the value of the component.",
|
|
7496
|
+
"value": { "type": "number" }
|
|
7497
|
+
},
|
|
7498
|
+
{
|
|
7499
|
+
"name": "value",
|
|
7500
|
+
"description": "Defines a value of the component.",
|
|
7501
|
+
"value": { "type": "number" }
|
|
7502
|
+
},
|
|
7503
|
+
{
|
|
7504
|
+
"name": "value-precision",
|
|
7505
|
+
"description": "Determines the number of digits after the decimal point of the component.",
|
|
7506
|
+
"value": { "type": "number" }
|
|
7507
|
+
},
|
|
7508
|
+
{
|
|
7509
|
+
"name": "value-state",
|
|
7510
|
+
"description": "Defines the value state of the component.",
|
|
7511
|
+
"value": {
|
|
7512
|
+
"type": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
|
|
7513
|
+
}
|
|
7514
|
+
}
|
|
7515
|
+
],
|
|
7516
|
+
"events": [
|
|
7517
|
+
{
|
|
7518
|
+
"name": "change",
|
|
7519
|
+
"description": "Fired when the input operation has finished by pressing Enter or on focusout."
|
|
7520
|
+
},
|
|
7521
|
+
{
|
|
7522
|
+
"name": "input",
|
|
7523
|
+
"description": "Fired when the value of the component changes at each keystroke."
|
|
7524
|
+
},
|
|
7525
|
+
{
|
|
7526
|
+
"name": "value-state-change",
|
|
7527
|
+
"description": "Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if its default action is\nprevented, the component will not update the value state."
|
|
7528
|
+
}
|
|
7529
|
+
]
|
|
7530
|
+
}
|
|
7531
|
+
},
|
|
7352
7532
|
{
|
|
7353
7533
|
"name": "ui5-option",
|
|
7354
7534
|
"description": "### Overview\n\nThe `ui5-option` component defines the content of an option in the `ui5-select`.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Option.js\";`\n---\n\n\n### **Events:**\n - **click** - Fired when the component is activated either with a mouse/tap or by using the Enter or Space key.\n\n**Note:** The event will not be fired if the `disabled` property is set to `true`.\n\n### **Slots:**\n - **default** - Defines the text of the component.\n\n**Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.",
|
|
@@ -7497,6 +7677,35 @@
|
|
|
7497
7677
|
]
|
|
7498
7678
|
}
|
|
7499
7679
|
},
|
|
7680
|
+
{
|
|
7681
|
+
"name": "ui5-option-group",
|
|
7682
|
+
"description": "### Overview\n\nThe `ui5-option-group` component is used to group options within a `ui5-select`.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/OptionGroup.js\";`\n---\n\n\n### **Slots:**\n - **default** - Defines the options of the group.\n\n**Note:** Use the `ui5-option` component to define the desired options.",
|
|
7683
|
+
"doc-url": "",
|
|
7684
|
+
"attributes": [
|
|
7685
|
+
{
|
|
7686
|
+
"name": "header-text",
|
|
7687
|
+
"description": "Defines the header text of the group.",
|
|
7688
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
7689
|
+
}
|
|
7690
|
+
],
|
|
7691
|
+
"slots": [
|
|
7692
|
+
{
|
|
7693
|
+
"name": "default",
|
|
7694
|
+
"description": "Defines the options of the group.\n\n**Note:** Use the `ui5-option` component to define the desired options."
|
|
7695
|
+
}
|
|
7696
|
+
],
|
|
7697
|
+
"events": [],
|
|
7698
|
+
"js": {
|
|
7699
|
+
"properties": [
|
|
7700
|
+
{
|
|
7701
|
+
"name": "header-text",
|
|
7702
|
+
"description": "Defines the header text of the group.",
|
|
7703
|
+
"value": { "type": "string | undefined" }
|
|
7704
|
+
}
|
|
7705
|
+
],
|
|
7706
|
+
"events": []
|
|
7707
|
+
}
|
|
7708
|
+
},
|
|
7500
7709
|
{
|
|
7501
7710
|
"name": "ui5-panel",
|
|
7502
7711
|
"description": "### Overview\n\nThe `ui5-panel` component is a container which has a header and a\ncontent area and is used\nfor grouping and displaying information. It can be collapsed to save space on the screen.\n\n### Guidelines:\n\n- Nesting two or more panels is not recommended.\n- Do not stack too many panels on one page.\n\n### Structure\nThe panel's header area consists of a title bar with a header text or custom header.\n\nThe header is clickable and can be used to toggle between the expanded and collapsed state. It includes an icon which rotates depending on the state.\n\nThe custom header can be set through the `header` slot and it may contain arbitraray content, such as: title, buttons or any other HTML elements.\n\nThe content area can contain an arbitrary set of controls.\n\n**Note:** The custom header is not clickable out of the box, but in this case the icon is interactive and allows to show/hide the content area.\n\n### Responsive Behavior\n\n- If the width of the panel is set to 100% (default), the panel and its children are\nresized responsively,\ndepending on its parent container.\n- If the panel has a fixed height, it will take up the space even if the panel is\ncollapsed.\n- When the panel is expandable (the `fixed` property is set to `false`),\nan arrow icon (pointing to the right) appears in front of the header.\n- When the animation is activated, expand/collapse uses a smooth animation to open or\nclose the content area.\n- When the panel expands/collapses, the arrow icon rotates 90 degrees\nclockwise/counter-clockwise.\n\n### Keyboard Handling\n\n#### Fast Navigation\nThis component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up].\nIn order to use this functionality, you need to import the following module:\n`import \"@ui5/webcomponents-base/dist/features/F6Navigation.js\"`\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Panel.js\";`\n---\n\n\n### **Events:**\n - **toggle** - Fired when the component is expanded/collapsed by user interaction.\n\n### **Slots:**\n - **default** - Defines the content of the component. The content is visible only when the component is expanded.\n- **header** - Defines the component header area.\n\n**Note:** When a header is provided, the `headerText` property is ignored.\n\n### **CSS Parts:**\n - **content** - Used to style the wrapper of the content.\n- **header** - Used to style the header.\n- **header-wrapper** - Used to style the outermost header wrapper, useful for adjusting sticky header position.",
|
|
@@ -8862,7 +9071,7 @@
|
|
|
8862
9071
|
},
|
|
8863
9072
|
{
|
|
8864
9073
|
"name": "ui5-select",
|
|
8865
|
-
"description": "### Overview\n\nThe `ui5-select` component is used to create a drop-down list.\n\n### Usage\n\nThere are two main usages of the `ui5-select>`.\n\n- With Option (`ui5-option`) web component:\n\nThe available options of the Select are defined by using the Option component.\nThe Option comes with predefined design and layout, including `icon`, `text` and `additional-text`.\n\n- With OptionCustom (`ui5-option-custom`) web component.\n\nOptions with custom content are defined by using the OptionCustom component.\nThe OptionCustom component comes with no predefined layout and it expects consumers to define it.\n\n### Selection\n\nThe options can be selected via user interaction (click or with the use of the Space and Enter keys)\nand programmatically - the Select component supports two distinct selection APIs, though mixing them is not supported:\n- The \"value\" property of the Select component\n- The \"selected\" property on individual options\n\n**Note:** If the \"value\" property is set but does not match any option,\nno option will be selected and the Select component will be displayed as empty.\n\n**Note:** when both \"value\" and \"selected\" are both used (although discouraged),\nthe \"value\" property will take precedence.\n\n### Keyboard Handling\n\nThe `ui5-select` provides advanced keyboard handling.\n\n- [F4] / [Alt] + [Up] / [Alt] + [Down] / [Space] or [Enter] - Opens/closes the drop-down.\n- [Up] or [Down] - If the drop-down is closed - changes selection to the next or the previous option. If the drop-down is opened - moves focus to the next or the previous option.\n- [Space], [Enter] - If the drop-down is opened - selects the focused option.\n- [Escape] - Closes the drop-down without changing the selection.\n- [Home] - Navigates to first option\n- [End] - Navigates to the last option\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Select\";`\n\n`import \"@ui5/webcomponents/dist/Option\";`\n`import \"@ui5/webcomponents/dist/OptionCustom\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the selected option changes.\n- **close** - Fired after the component's dropdown menu closes.\n- **live-change** - Fired when the user navigates through the options, but the selection is not finalized,\nor when pressing the ESC key to revert the current selection.\n- **open** - Fired after the component's dropdown menu opens.\n\n### **Slots:**\n - **default** - Defines the component options.\n\n**Note:** Only one selected option is allowed.\nIf more than one option is defined as selected, the last one would be considered as the selected one.\n\n**Note:** Use the `ui5-option` component to define the desired options.\n- **label** - Defines the HTML element that will be displayed in the component input part,\nrepresenting the selected option.\n\n**Note:** If not specified and `ui5-option-custom` is used,\neither the option's `display-text` or its textContent will be displayed.\n\n**Note:** If not specified and `ui5-option` is used,\nthe option's textContent will be displayed.\n- **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.\n\n**Note:** If the component has `suggestionItems`,\nthe `valueStateMessage` would be displayed as part of the same popover, if used on desktop, or dialog - on phone.\n\n### **CSS Parts:**\n - **popover** - Used to style the popover element",
|
|
9074
|
+
"description": "### Overview\n\nThe `ui5-select` component is used to create a drop-down list.\n\n### Usage\n\nThere are two main usages of the `ui5-select>`.\n\n- With Option (`ui5-option`) web component:\n\nThe available options of the Select are defined by using the Option component.\nThe Option comes with predefined design and layout, including `icon`, `text` and `additional-text`.\n\n- With OptionCustom (`ui5-option-custom`) web component.\n\nOptions with custom content are defined by using the OptionCustom component.\nThe OptionCustom component comes with no predefined layout and it expects consumers to define it.\n\n### Selection\n\nThe options can be selected via user interaction (click or with the use of the Space and Enter keys)\nand programmatically - the Select component supports two distinct selection APIs, though mixing them is not supported:\n- The \"value\" property of the Select component\n- The \"selected\" property on individual options\n\n**Note:** If the \"value\" property is set but does not match any option,\nno option will be selected and the Select component will be displayed as empty.\n\n**Note:** when both \"value\" and \"selected\" are both used (although discouraged),\nthe \"value\" property will take precedence.\n\n### Keyboard Handling\n\nThe `ui5-select` provides advanced keyboard handling.\n\n- [F4] / [Alt] + [Up] / [Alt] + [Down] / [Space] or [Enter] - Opens/closes the drop-down.\n- [Up] or [Down] - If the drop-down is closed - changes selection to the next or the previous option. If the drop-down is opened - moves focus to the next or the previous option.\n- [Space], [Enter] - If the drop-down is opened - selects the focused option.\n- [Escape] - Closes the drop-down without changing the selection.\n- [Home] - Navigates to first option\n- [End] - Navigates to the last option\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/Select\";`\n\n`import \"@ui5/webcomponents/dist/Option\";`\n`import \"@ui5/webcomponents/dist/OptionCustom\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the selected option changes.\n- **close** - Fired after the component's dropdown menu closes.\n- **live-change** - Fired when the user navigates through the options, but the selection is not finalized,\nor when pressing the ESC key to revert the current selection.\n- **open** - Fired after the component's dropdown menu opens.\n\n### **Slots:**\n - **default** - Defines the component options.\n\n**Note:** Only one selected option is allowed.\nIf more than one option is defined as selected, the last one would be considered as the selected one.\n\n**Note:** Use the `ui5-option` component to define the desired options.\nUse the `ui5-option-group` component to group options.\n- **label** - Defines the HTML element that will be displayed in the component input part,\nrepresenting the selected option.\n\n**Note:** If not specified and `ui5-option-custom` is used,\neither the option's `display-text` or its textContent will be displayed.\n\n**Note:** If not specified and `ui5-option` is used,\nthe option's textContent will be displayed.\n- **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.\n\n**Note:** If the component has `suggestionItems`,\nthe `valueStateMessage` would be displayed as part of the same popover, if used on desktop, or dialog - on phone.\n\n### **CSS Parts:**\n - **popover** - Used to style the popover element",
|
|
8866
9075
|
"doc-url": "",
|
|
8867
9076
|
"attributes": [
|
|
8868
9077
|
{
|
|
@@ -8940,7 +9149,7 @@
|
|
|
8940
9149
|
"slots": [
|
|
8941
9150
|
{
|
|
8942
9151
|
"name": "default",
|
|
8943
|
-
"description": "Defines the component options.\n\n**Note:** Only one selected option is allowed.\nIf more than one option is defined as selected, the last one would be considered as the selected one.\n\n**Note:** Use the `ui5-option` component to define the desired options."
|
|
9152
|
+
"description": "Defines the component options.\n\n**Note:** Only one selected option is allowed.\nIf more than one option is defined as selected, the last one would be considered as the selected one.\n\n**Note:** Use the `ui5-option` component to define the desired options.\nUse the `ui5-option-group` component to group options."
|
|
8944
9153
|
},
|
|
8945
9154
|
{
|
|
8946
9155
|
"name": "label",
|
|
@@ -9271,7 +9480,7 @@
|
|
|
9271
9480
|
"attributes": [
|
|
9272
9481
|
{
|
|
9273
9482
|
"name": "accessibility-attributes",
|
|
9274
|
-
"description": "Defines the additional accessibility attributes that will be applied to the component.\nThe `accessibilityAttributes` property accepts an object with the following optional fields:\n\n- **root**: Attributes that will be applied to the main (text) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **
|
|
9483
|
+
"description": "Defines the additional accessibility attributes that will be applied to the component.\nThe `accessibilityAttributes` property accepts an object with the following optional fields:\n\n- **root**: Attributes that will be applied to the main (text) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **title**: Specifies a tooltip or description for screen readers.\n Accepts any string value.\n\t- **ariaKeyShortcuts**: Defines keyboard shortcuts that activate or give focus to the button.\n\n- **arrowButton**: Attributes applied specifically to the arrow (split) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the arrow button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **expanded**: Indicates whether the popup triggered by the arrow button is currently expanded.\n Accepts boolean values: `true` or `false`.",
|
|
9275
9484
|
"value": {
|
|
9276
9485
|
"type": "SplitButtonAccessibilityAttributes",
|
|
9277
9486
|
"default": "{}"
|
|
@@ -9326,7 +9535,7 @@
|
|
|
9326
9535
|
"properties": [
|
|
9327
9536
|
{
|
|
9328
9537
|
"name": "accessibility-attributes",
|
|
9329
|
-
"description": "Defines the additional accessibility attributes that will be applied to the component.\nThe `accessibilityAttributes` property accepts an object with the following optional fields:\n\n- **root**: Attributes that will be applied to the main (text) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **
|
|
9538
|
+
"description": "Defines the additional accessibility attributes that will be applied to the component.\nThe `accessibilityAttributes` property accepts an object with the following optional fields:\n\n- **root**: Attributes that will be applied to the main (text) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **title**: Specifies a tooltip or description for screen readers.\n Accepts any string value.\n\t- **ariaKeyShortcuts**: Defines keyboard shortcuts that activate or give focus to the button.\n\n- **arrowButton**: Attributes applied specifically to the arrow (split) button.\n - **hasPopup**: Indicates the presence and type of popup triggered by the arrow button.\n Accepts string values: `\"dialog\"`, `\"grid\"`, `\"listbox\"`, `\"menu\"`, or `\"tree\"`.\n - **expanded**: Indicates whether the popup triggered by the arrow button is currently expanded.\n Accepts boolean values: `true` or `false`.",
|
|
9330
9539
|
"value": { "type": "SplitButtonAccessibilityAttributes" }
|
|
9331
9540
|
},
|
|
9332
9541
|
{
|
|
@@ -9371,7 +9580,7 @@
|
|
|
9371
9580
|
},
|
|
9372
9581
|
{
|
|
9373
9582
|
"name": "ui5-step-input",
|
|
9374
|
-
"description": "### Overview\n\nThe `ui5-step-input` consists of an input field and buttons with icons to increase/decrease the value\nwith the predefined step.\n\nThe user can change the value of the component by pressing the increase/decrease buttons,\nby typing a number directly, by using the keyboard up/down and page up/down,\nor by using the mouse scroll wheel. Decimal values are supported.\n\n### Usage\n\nThe default step is 1 but the app developer can set a different one.\n\nApp developers can set a maximum and minimum value for the `StepInput`.\nThe increase/decrease button and the up/down keyboard navigation become disabled when\nthe value reaches the max/min or a new value is entered from the input which is greater/less than the max/min.\n\n#### When to use:\n\n- To adjust amounts, quantities, or other values quickly.\n- To adjust values for a specific step.\n\n#### When not to use:\n\n- To enter a static number (for example, postal code, phone number, or ID). In this case,\nuse the regular `ui5-input` instead.\n- To display a value that rarely needs to be adjusted and does not pertain to a particular step.\nIn this case, use the regular `ui5-input` instead.\n- To enter dates and times. In this case, use date/time related components instead.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/StepInput.js\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter or on focusout.\n- **input** - Fired when the value of the component changes at each keystroke.\n- **value-state-change** - Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if it's default action is\nprevented, the component will not update the value state.\n\n### **Slots:**\n - **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component
|
|
9583
|
+
"description": "### Overview\n\nThe `ui5-step-input` consists of an input field and buttons with icons to increase/decrease the value\nwith the predefined step.\n\nThe user can change the value of the component by pressing the increase/decrease buttons,\nby typing a number directly, by using the keyboard up/down and page up/down,\nor by using the mouse scroll wheel. Decimal values are supported.\n\n### Usage\n\nThe default step is 1 but the app developer can set a different one.\n\nApp developers can set a maximum and minimum value for the `StepInput`.\nThe increase/decrease button and the up/down keyboard navigation become disabled when\nthe value reaches the max/min or a new value is entered from the input which is greater/less than the max/min.\n\n#### When to use:\n\n- To adjust amounts, quantities, or other values quickly.\n- To adjust values for a specific step.\n\n#### When not to use:\n\n- To enter a static number (for example, postal code, phone number, or ID). In this case,\nuse the regular `ui5-input` instead.\n- To display a value that rarely needs to be adjusted and does not pertain to a particular step.\nIn this case, use the regular `ui5-input` instead.\n- To enter dates and times. In this case, use date/time related components instead.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/StepInput.js\";`\n---\n\n\n### **Events:**\n - **change** - Fired when the input operation has finished by pressing Enter or on focusout.\n- **input** - Fired when the value of the component changes at each keystroke.\n- **value-state-change** - Fired before the value state of the component is updated internally.\nThe event is preventable, meaning that if it's default action is\nprevented, the component will not update the value state.\n\n### **Slots:**\n - **valueStateMessage** - Defines the value state message that will be displayed as pop up under the component.",
|
|
9375
9584
|
"doc-url": "",
|
|
9376
9585
|
"attributes": [
|
|
9377
9586
|
{
|
|
@@ -9401,12 +9610,12 @@
|
|
|
9401
9610
|
},
|
|
9402
9611
|
{
|
|
9403
9612
|
"name": "name",
|
|
9404
|
-
"description": "Determines the name by which the component will be identified upon submission in an HTML form
|
|
9613
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.",
|
|
9405
9614
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
9406
9615
|
},
|
|
9407
9616
|
{
|
|
9408
9617
|
"name": "placeholder",
|
|
9409
|
-
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value
|
|
9618
|
+
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value.",
|
|
9410
9619
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
9411
9620
|
},
|
|
9412
9621
|
{
|
|
@@ -9446,7 +9655,7 @@
|
|
|
9446
9655
|
"slots": [
|
|
9447
9656
|
{
|
|
9448
9657
|
"name": "valueStateMessage",
|
|
9449
|
-
"description": "Defines the value state message that will be displayed as pop up under the component
|
|
9658
|
+
"description": "Defines the value state message that will be displayed as pop up under the component."
|
|
9450
9659
|
}
|
|
9451
9660
|
],
|
|
9452
9661
|
"events": [
|
|
@@ -9492,12 +9701,12 @@
|
|
|
9492
9701
|
},
|
|
9493
9702
|
{
|
|
9494
9703
|
"name": "name",
|
|
9495
|
-
"description": "Determines the name by which the component will be identified upon submission in an HTML form
|
|
9704
|
+
"description": "Determines the name by which the component will be identified upon submission in an HTML form.",
|
|
9496
9705
|
"value": { "type": "string | undefined" }
|
|
9497
9706
|
},
|
|
9498
9707
|
{
|
|
9499
9708
|
"name": "placeholder",
|
|
9500
|
-
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value
|
|
9709
|
+
"description": "Defines a short hint, intended to aid the user with data entry when the\ncomponent has no value.",
|
|
9501
9710
|
"value": { "type": "string | undefined" }
|
|
9502
9711
|
},
|
|
9503
9712
|
{
|
|
@@ -9643,7 +9852,7 @@
|
|
|
9643
9852
|
},
|
|
9644
9853
|
{
|
|
9645
9854
|
"name": "header-text",
|
|
9646
|
-
"description": "Defines the header text of the
|
|
9855
|
+
"description": "Defines the header text of the group.",
|
|
9647
9856
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
9648
9857
|
},
|
|
9649
9858
|
{
|
|
@@ -9684,7 +9893,7 @@
|
|
|
9684
9893
|
},
|
|
9685
9894
|
{
|
|
9686
9895
|
"name": "header-text",
|
|
9687
|
-
"description": "Defines the header text of the
|
|
9896
|
+
"description": "Defines the header text of the group.",
|
|
9688
9897
|
"value": { "type": "string | undefined" }
|
|
9689
9898
|
},
|
|
9690
9899
|
{
|
|
@@ -9794,7 +10003,7 @@
|
|
|
9794
10003
|
},
|
|
9795
10004
|
{
|
|
9796
10005
|
"name": "type",
|
|
9797
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
10006
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
9798
10007
|
"value": {
|
|
9799
10008
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
9800
10009
|
"default": "\"Active\""
|
|
@@ -9917,7 +10126,7 @@
|
|
|
9917
10126
|
},
|
|
9918
10127
|
{
|
|
9919
10128
|
"name": "type",
|
|
9920
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
10129
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
9921
10130
|
"value": {
|
|
9922
10131
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
9923
10132
|
}
|
|
@@ -12610,6 +12819,11 @@
|
|
|
12610
12819
|
"default": "{}"
|
|
12611
12820
|
}
|
|
12612
12821
|
},
|
|
12822
|
+
{
|
|
12823
|
+
"name": "accessible-description",
|
|
12824
|
+
"description": "Defines the accessible description of the component.",
|
|
12825
|
+
"value": { "type": "string | undefined", "default": "undefined" }
|
|
12826
|
+
},
|
|
12613
12827
|
{
|
|
12614
12828
|
"name": "accessible-name",
|
|
12615
12829
|
"description": "Defines the accessible ARIA name of the component.",
|
|
@@ -12620,6 +12834,14 @@
|
|
|
12620
12834
|
"description": "Receives id(or many ids) of the elements that label the component.",
|
|
12621
12835
|
"value": { "type": "string | undefined", "default": "undefined" }
|
|
12622
12836
|
},
|
|
12837
|
+
{
|
|
12838
|
+
"name": "accessible-role",
|
|
12839
|
+
"description": "Defines the ARIA role of the component.\n\n**Note:** Use `ButtonAccessibleRole.Link` role only with a press handler that performs navigation.\nIn all other scenarios the default button semantics are recommended.",
|
|
12840
|
+
"value": {
|
|
12841
|
+
"type": "\"Button\" | \"Link\"",
|
|
12842
|
+
"default": "\"Button\""
|
|
12843
|
+
}
|
|
12844
|
+
},
|
|
12623
12845
|
{
|
|
12624
12846
|
"name": "design",
|
|
12625
12847
|
"description": "Defines the action design.",
|
|
@@ -12690,6 +12912,11 @@
|
|
|
12690
12912
|
"description": "Defines the additional accessibility attributes that will be applied to the component.\n\nThe following fields are supported:\n\n- **expanded**: Indicates whether the button, or another grouping element it controls, is currently expanded or collapsed.\nAccepts the following string values: `true` or `false`\n\n- **hasPopup**: Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by the button.\nAccepts the following string values: `dialog`, `grid`, `listbox`, `menu` or `tree`.\n\n- **controls**: Identifies the element (or elements) whose contents or presence are controlled by the button element.\nAccepts a lowercase string value.",
|
|
12691
12913
|
"value": { "type": "ButtonAccessibilityAttributes" }
|
|
12692
12914
|
},
|
|
12915
|
+
{
|
|
12916
|
+
"name": "accessible-description",
|
|
12917
|
+
"description": "Defines the accessible description of the component.",
|
|
12918
|
+
"value": { "type": "string | undefined" }
|
|
12919
|
+
},
|
|
12693
12920
|
{
|
|
12694
12921
|
"name": "accessible-name",
|
|
12695
12922
|
"description": "Defines the accessible ARIA name of the component.",
|
|
@@ -12700,6 +12927,11 @@
|
|
|
12700
12927
|
"description": "Receives id(or many ids) of the elements that label the component.",
|
|
12701
12928
|
"value": { "type": "string | undefined" }
|
|
12702
12929
|
},
|
|
12930
|
+
{
|
|
12931
|
+
"name": "accessible-role",
|
|
12932
|
+
"description": "Defines the ARIA role of the component.\n\n**Note:** Use `ButtonAccessibleRole.Link` role only with a press handler that performs navigation.\nIn all other scenarios the default button semantics are recommended.",
|
|
12933
|
+
"value": { "type": "\"Button\" | \"Link\"" }
|
|
12934
|
+
},
|
|
12703
12935
|
{
|
|
12704
12936
|
"name": "design",
|
|
12705
12937
|
"description": "Defines the action design.",
|
|
@@ -13336,7 +13568,7 @@
|
|
|
13336
13568
|
},
|
|
13337
13569
|
{
|
|
13338
13570
|
"name": "type",
|
|
13339
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
13571
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
13340
13572
|
"value": {
|
|
13341
13573
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
13342
13574
|
"default": "\"Active\""
|
|
@@ -13452,7 +13684,7 @@
|
|
|
13452
13684
|
},
|
|
13453
13685
|
{
|
|
13454
13686
|
"name": "type",
|
|
13455
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
13687
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
13456
13688
|
"value": {
|
|
13457
13689
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
13458
13690
|
}
|
|
@@ -13559,7 +13791,7 @@
|
|
|
13559
13791
|
},
|
|
13560
13792
|
{
|
|
13561
13793
|
"name": "type",
|
|
13562
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
13794
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
13563
13795
|
"value": {
|
|
13564
13796
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\"",
|
|
13565
13797
|
"default": "\"Active\""
|
|
@@ -13674,7 +13906,7 @@
|
|
|
13674
13906
|
},
|
|
13675
13907
|
{
|
|
13676
13908
|
"name": "type",
|
|
13677
|
-
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection
|
|
13909
|
+
"description": "Defines the visual indication and behavior of the list items.\nAvailable options are `Active` (by default), `Inactive`, `InactiveSelectable`, `Detail` and `Navigation`.\n\n**Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and hover,\nwhile with type `Inactive`, `InactiveSelectable` and `Detail` - will not.\n\n**Note:** `InactiveSelectable` behaves like `Inactive` but allows selection to be toggled\nvia the checkbox (Multi mode) or radio button (Single modes) when the list has a selection mode.\nClicking the item body or pressing Space/Enter does not trigger selection — only interacting\nwith the selection component directly does. The `item-click` event is not fired for this type.",
|
|
13678
13910
|
"value": {
|
|
13679
13911
|
"type": "\"Navigation\" | \"Inactive\" | \"InactiveSelectable\" | \"Active\" | \"Detail\""
|
|
13680
13912
|
}
|