@oracle/oraclejet-core-pack 14.0.0
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/oj-c/Avatar.json +458 -0
- package/oj-c/Button.json +536 -0
- package/oj-c/Collapsible.json +396 -0
- package/oj-c/FilePicker.json +555 -0
- package/oj-c/InputNumber.json +1321 -0
- package/oj-c/InputPassword.json +1164 -0
- package/oj-c/InputText.json +1411 -0
- package/oj-c/ListItemLayout.json +313 -0
- package/oj-c/MessageToast.json +334 -0
- package/oj-c/MeterBar.json +735 -0
- package/oj-c/MeterCircle.json +797 -0
- package/oj-c/ProgressBar.json +212 -0
- package/oj-c/ProgressCircle.json +223 -0
- package/oj-c/RatingGauge.json +495 -0
- package/oj-c/SelectMultiple.json +1143 -0
- package/oj-c/SelectSingle.json +1450 -0
- package/oj-c/SplitMenuButton.json +495 -0
- package/oj-c/TextArea.json +1283 -0
- package/oj-c/avatar/__webdriver__/AvatarWebElement.js +32 -0
- package/oj-c/avatar/__webdriver__/AvatarWebElementBase.js +87 -0
- package/oj-c/avatar/__webdriver__/index.js +74 -0
- package/oj-c/avatar/avatar-styles.css +10 -0
- package/oj-c/avatar/avatar.js +27 -0
- package/oj-c/avatar/component.json +227 -0
- package/oj-c/avatar/index.js +6 -0
- package/oj-c/avatar.js +6 -0
- package/oj-c/button/__tests__/button.test.js +20 -0
- package/oj-c/button/__webdriver__/ButtonWebElement.js +96 -0
- package/oj-c/button/__webdriver__/ButtonWebElementBase.js +96 -0
- package/oj-c/button/__webdriver__/index.js +74 -0
- package/oj-c/button/button-styles.css +11 -0
- package/oj-c/button/button.js +71 -0
- package/oj-c/button/component.json +243 -0
- package/oj-c/button/index.js +6 -0
- package/oj-c/button.js +6 -0
- package/oj-c/collapsible/__webdriver__/CollapsibleWebElement.js +116 -0
- package/oj-c/collapsible/__webdriver__/CollapsibleWebElementBase.js +60 -0
- package/oj-c/collapsible/__webdriver__/index.js +74 -0
- package/oj-c/collapsible/collapsible-styles.css +11 -0
- package/oj-c/collapsible/collapsible.js +69 -0
- package/oj-c/collapsible/component.json +184 -0
- package/oj-c/collapsible/index.js +6 -0
- package/oj-c/collapsible.js +6 -0
- package/oj-c/component.json +104 -0
- package/oj-c/corepackbundle.js +4049 -0
- package/oj-c/docs/avatar.html +149 -0
- package/oj-c/docs/button.html +149 -0
- package/oj-c/docs/collapsible.html +149 -0
- package/oj-c/docs/file-picker.html +149 -0
- package/oj-c/docs/index.html +168 -0
- package/oj-c/docs/input-number.html +149 -0
- package/oj-c/docs/input-password.html +149 -0
- package/oj-c/docs/input-text.html +149 -0
- package/oj-c/docs/jsDocMd.json +1 -0
- package/oj-c/docs/list-item-layout.html +149 -0
- package/oj-c/docs/message-toast.html +149 -0
- package/oj-c/docs/meter-bar.html +149 -0
- package/oj-c/docs/meter-circle.html +149 -0
- package/oj-c/docs/oj-c.Avatar.html +1778 -0
- package/oj-c/docs/oj-c.Button.html +2065 -0
- package/oj-c/docs/oj-c.Collapsible.html +1990 -0
- package/oj-c/docs/oj-c.FilePicker.html +2380 -0
- package/oj-c/docs/oj-c.InputNumber.html +5850 -0
- package/oj-c/docs/oj-c.InputPassword.html +4891 -0
- package/oj-c/docs/oj-c.InputText.html +5772 -0
- package/oj-c/docs/oj-c.ListItemLayout.html +1549 -0
- package/oj-c/docs/oj-c.MessageToast.html +1574 -0
- package/oj-c/docs/oj-c.MeterBar.html +3193 -0
- package/oj-c/docs/oj-c.MeterCircle.html +3502 -0
- package/oj-c/docs/oj-c.ProgressBar.html +1122 -0
- package/oj-c/docs/oj-c.ProgressCircle.html +1138 -0
- package/oj-c/docs/oj-c.RatingGauge.html +2320 -0
- package/oj-c/docs/oj-c.SelectMultiple.html +4720 -0
- package/oj-c/docs/oj-c.SelectSingle.html +5920 -0
- package/oj-c/docs/oj-c.SplitMenuButton.html +1891 -0
- package/oj-c/docs/oj-c.TextArea.html +5447 -0
- package/oj-c/docs/progress-bar.html +149 -0
- package/oj-c/docs/progress-circle.html +149 -0
- package/oj-c/docs/rating-gauge.html +149 -0
- package/oj-c/docs/scripts/deprecated.js +268 -0
- package/oj-c/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
- package/oj-c/docs/scripts/prettify/lang-css.js +9 -0
- package/oj-c/docs/scripts/prettify/prettify.js +35 -0
- package/oj-c/docs/select-multiple.html +149 -0
- package/oj-c/docs/select-single.html +149 -0
- package/oj-c/docs/split-menu-button.html +149 -0
- package/oj-c/docs/styles/images/bookmark.png +0 -0
- package/oj-c/docs/styles/images/linesarrowup.png +0 -0
- package/oj-c/docs/styles/images/linesarrowup_blue.png +0 -0
- package/oj-c/docs/styles/images/linesarrowup_hov.png +0 -0
- package/oj-c/docs/styles/images/linesarrowup_white.png +0 -0
- package/oj-c/docs/styles/images/oracle_logo_sm.png +0 -0
- package/oj-c/docs/styles/jsdoc-default.css +851 -0
- package/oj-c/docs/styles/prettify-jsdoc.css +111 -0
- package/oj-c/docs/styles/prettify-tomorrow.css +132 -0
- package/oj-c/docs/text-area.html +149 -0
- package/oj-c/editable-value/UNSAFE_useAssistiveText/useAssistiveText.js +57 -0
- package/oj-c/editable-value/UNSAFE_useComponentMessaging/useComponentMessaging.js +80 -0
- package/oj-c/editable-value/UNSAFE_useConverter/useConverter.js +56 -0
- package/oj-c/editable-value/UNSAFE_useConverterLifecycle/useConverterLifecycle.js +26 -0
- package/oj-c/editable-value/UNSAFE_useDeferredValidators/useDeferredValidators.js +22 -0
- package/oj-c/editable-value/UNSAFE_useEditableValue/useEditableValue.js +154 -0
- package/oj-c/editable-value/UNSAFE_useStaleIdentity/useStaleIdentity.js +17 -0
- package/oj-c/editable-value/UNSAFE_useValidationLifecycle/useValidationLifecycle.js +118 -0
- package/oj-c/editable-value/UNSAFE_useValidators/useValidators.js +153 -0
- package/oj-c/editable-value/UNSAFE_useValue/useValue.js +42 -0
- package/oj-c/editable-value/UNSAFE_useValueLifecycle/useValueLifecycle.js +27 -0
- package/oj-c/editable-value/component.json +9 -0
- package/oj-c/editable-value/utils/utils.js +31 -0
- package/oj-c/file-picker/__webdriver__/FilePickerWebElement.js +32 -0
- package/oj-c/file-picker/__webdriver__/FilePickerWebElementBase.js +87 -0
- package/oj-c/file-picker/__webdriver__/index.js +74 -0
- package/oj-c/file-picker/component.json +209 -0
- package/oj-c/file-picker/file-picker-styles.css +17 -0
- package/oj-c/file-picker/file-picker.js +59 -0
- package/oj-c/file-picker/index.js +6 -0
- package/oj-c/file-picker.js +6 -0
- package/oj-c/hooks/UNSAFE_useDataProvider/DataProviderHandler.js +89 -0
- package/oj-c/hooks/UNSAFE_useDataProvider/useDataProvider.js +25 -0
- package/oj-c/hooks/UNSAFE_useDataProvider/utils.js +202 -0
- package/oj-c/hooks/UNSAFE_useListData/__tests__/useListData.test.js +124 -0
- package/oj-c/hooks/UNSAFE_useListData/useListData.js +297 -0
- package/oj-c/hooks/UNSAFE_useTreeData/__tests__/useTreeData.test.js +62 -0
- package/oj-c/hooks/UNSAFE_useTreeData/useTreeData.js +130 -0
- package/oj-c/hooks/component.json +9 -0
- package/oj-c/input-number/__dev__/input-number.doc.mdx +31 -0
- package/oj-c/input-number/__webdriver__/InputNumberWebElement.js +32 -0
- package/oj-c/input-number/__webdriver__/InputNumberWebElementBase.js +339 -0
- package/oj-c/input-number/__webdriver__/index.js +74 -0
- package/oj-c/input-number/component.json +536 -0
- package/oj-c/input-number/index.js +6 -0
- package/oj-c/input-number/input-number-styles.css +13 -0
- package/oj-c/input-number/input-number.js +119 -0
- package/oj-c/input-number/stepBasisUtils.js +76 -0
- package/oj-c/input-number/useImplicitNumberConverter.js +12 -0
- package/oj-c/input-number/useImplicitNumberRangeValidator.js +28 -0
- package/oj-c/input-number/useNumberInputTextPreact.js +153 -0
- package/oj-c/input-number.js +6 -0
- package/oj-c/input-password/__webdriver__/InputPasswordWebElement.js +32 -0
- package/oj-c/input-password/__webdriver__/InputPasswordWebElementBase.js +258 -0
- package/oj-c/input-password/__webdriver__/index.js +74 -0
- package/oj-c/input-password/component.json +488 -0
- package/oj-c/input-password/index.js +6 -0
- package/oj-c/input-password/input-password-styles.css +13 -0
- package/oj-c/input-password/input-password.js +112 -0
- package/oj-c/input-password/useInputPasswordPreact.js +46 -0
- package/oj-c/input-password.js +6 -0
- package/oj-c/input-text/__dev__/input-text.doc.mdx +30 -0
- package/oj-c/input-text/__tests__/input-text.test.js +70 -0
- package/oj-c/input-text/__webdriver__/InputTextWebElement.js +32 -0
- package/oj-c/input-text/__webdriver__/InputTextWebElementBase.js +294 -0
- package/oj-c/input-text/__webdriver__/index.js +74 -0
- package/oj-c/input-text/component.json +580 -0
- package/oj-c/input-text/index.js +6 -0
- package/oj-c/input-text/input-text-styles.css +13 -0
- package/oj-c/input-text/input-text.js +118 -0
- package/oj-c/input-text/useInputTextPreact.js +46 -0
- package/oj-c/input-text.js +6 -0
- package/oj-c/list-item-layout/__webdriver__/ListItemLayoutWebElement.js +32 -0
- package/oj-c/list-item-layout/__webdriver__/ListItemLayoutWebElementBase.js +42 -0
- package/oj-c/list-item-layout/__webdriver__/index.js +74 -0
- package/oj-c/list-item-layout/component.json +139 -0
- package/oj-c/list-item-layout/index.js +6 -0
- package/oj-c/list-item-layout/list-item-layout-styles.css +12 -0
- package/oj-c/list-item-layout/list-item-layout.js +30 -0
- package/oj-c/list-item-layout.js +6 -0
- package/oj-c/message-toast/__webdriver__/MessageToastWebElement.js +32 -0
- package/oj-c/message-toast/__webdriver__/MessageToastWebElementBase.js +78 -0
- package/oj-c/message-toast/__webdriver__/index.js +74 -0
- package/oj-c/message-toast/component.json +244 -0
- package/oj-c/message-toast/index.js +6 -0
- package/oj-c/message-toast/message-toast-styles.css +8 -0
- package/oj-c/message-toast/message-toast.js +35 -0
- package/oj-c/message-toast.js +6 -0
- package/oj-c/metadata/allComponents.json +5552 -0
- package/oj-c/meter-bar/__webdriver__/MeterBarWebElement.js +32 -0
- package/oj-c/meter-bar/__webdriver__/MeterBarWebElementBase.js +195 -0
- package/oj-c/meter-bar/__webdriver__/index.js +74 -0
- package/oj-c/meter-bar/component.json +246 -0
- package/oj-c/meter-bar/index.js +6 -0
- package/oj-c/meter-bar/meter-bar-styles.css +21 -0
- package/oj-c/meter-bar/meter-bar.js +44 -0
- package/oj-c/meter-bar.js +6 -0
- package/oj-c/meter-circle/__webdriver__/MeterCircleWebElement.js +32 -0
- package/oj-c/meter-circle/__webdriver__/MeterCircleWebElementBase.js +213 -0
- package/oj-c/meter-circle/__webdriver__/index.js +74 -0
- package/oj-c/meter-circle/component.json +289 -0
- package/oj-c/meter-circle/index.js +6 -0
- package/oj-c/meter-circle/meter-circle-styles.css +14 -0
- package/oj-c/meter-circle/meter-circle.js +47 -0
- package/oj-c/meter-circle.js +6 -0
- package/oj-c/min/avatar/avatar-styles.css +10 -0
- package/oj-c/min/avatar.js +2 -0
- package/oj-c/min/avatar.js.map +1 -0
- package/oj-c/min/button/button-styles.css +11 -0
- package/oj-c/min/button.js +2 -0
- package/oj-c/min/button.js.map +1 -0
- package/oj-c/min/collapsible/collapsible-styles.css +11 -0
- package/oj-c/min/collapsible.js +2 -0
- package/oj-c/min/collapsible.js.map +1 -0
- package/oj-c/min/corepackbundle.css +226 -0
- package/oj-c/min/corepackbundle.js +6 -0
- package/oj-c/min/corepackbundle.js.map +1 -0
- package/oj-c/min/editable-value/UNSAFE_useAssistiveText/useAssistiveText.d.ts +32 -0
- package/oj-c/min/editable-value/UNSAFE_useAssistiveText/useAssistiveText.js +57 -0
- package/oj-c/min/editable-value/UNSAFE_useComponentMessaging/useComponentMessaging.d.ts +24 -0
- package/oj-c/min/editable-value/UNSAFE_useComponentMessaging/useComponentMessaging.js +80 -0
- package/oj-c/min/editable-value/UNSAFE_useConverter/useConverter.d.ts +14 -0
- package/oj-c/min/editable-value/UNSAFE_useConverter/useConverter.js +56 -0
- package/oj-c/min/editable-value/UNSAFE_useConverterLifecycle/useConverterLifecycle.d.ts +11 -0
- package/oj-c/min/editable-value/UNSAFE_useConverterLifecycle/useConverterLifecycle.js +26 -0
- package/oj-c/min/editable-value/UNSAFE_useDeferredValidators/useDeferredValidators.d.ts +8 -0
- package/oj-c/min/editable-value/UNSAFE_useDeferredValidators/useDeferredValidators.js +22 -0
- package/oj-c/min/editable-value/UNSAFE_useEditableValue/useEditableValue.d.ts +47 -0
- package/oj-c/min/editable-value/UNSAFE_useEditableValue/useEditableValue.js +154 -0
- package/oj-c/min/editable-value/UNSAFE_useStaleIdentity/useStaleIdentity.d.ts +5 -0
- package/oj-c/min/editable-value/UNSAFE_useStaleIdentity/useStaleIdentity.js +17 -0
- package/oj-c/min/editable-value/UNSAFE_useValidationLifecycle/useValidationLifecycle.d.ts +15 -0
- package/oj-c/min/editable-value/UNSAFE_useValidationLifecycle/useValidationLifecycle.js +118 -0
- package/oj-c/min/editable-value/UNSAFE_useValidators/useValidators.d.ts +35 -0
- package/oj-c/min/editable-value/UNSAFE_useValidators/useValidators.js +153 -0
- package/oj-c/min/editable-value/UNSAFE_useValue/useValue.d.ts +23 -0
- package/oj-c/min/editable-value/UNSAFE_useValue/useValue.js +42 -0
- package/oj-c/min/editable-value/UNSAFE_useValueLifecycle/useValueLifecycle.d.ts +9 -0
- package/oj-c/min/editable-value/UNSAFE_useValueLifecycle/useValueLifecycle.js +27 -0
- package/oj-c/min/editable-value/component.json +9 -0
- package/oj-c/min/editable-value/utils/utils.d.ts +6 -0
- package/oj-c/min/editable-value/utils/utils.js +31 -0
- package/oj-c/min/file-picker/file-picker-styles.css +17 -0
- package/oj-c/min/file-picker.js +2 -0
- package/oj-c/min/file-picker.js.map +1 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/DataProviderHandler.d.ts +18 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/DataProviderHandler.js +89 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/useDataProvider.d.ts +10 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/useDataProvider.js +25 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/utils.d.ts +3 -0
- package/oj-c/min/hooks/UNSAFE_useDataProvider/utils.js +202 -0
- package/oj-c/min/hooks/UNSAFE_useListData/__tests__/useListData.test.d.ts +1 -0
- package/oj-c/min/hooks/UNSAFE_useListData/__tests__/useListData.test.js +124 -0
- package/oj-c/min/hooks/UNSAFE_useListData/useListData.d.ts +21 -0
- package/oj-c/min/hooks/UNSAFE_useListData/useListData.js +297 -0
- package/oj-c/min/hooks/UNSAFE_useTreeData/__tests__/useTreeData.test.d.ts +1 -0
- package/oj-c/min/hooks/UNSAFE_useTreeData/__tests__/useTreeData.test.js +62 -0
- package/oj-c/min/hooks/UNSAFE_useTreeData/useTreeData.d.ts +27 -0
- package/oj-c/min/hooks/UNSAFE_useTreeData/useTreeData.js +130 -0
- package/oj-c/min/hooks/component.json +9 -0
- package/oj-c/min/input-number/input-number-styles.css +13 -0
- package/oj-c/min/input-number.js +2 -0
- package/oj-c/min/input-number.js.map +1 -0
- package/oj-c/min/input-password/input-password-styles.css +13 -0
- package/oj-c/min/input-password.js +2 -0
- package/oj-c/min/input-password.js.map +1 -0
- package/oj-c/min/input-text/input-text-styles.css +13 -0
- package/oj-c/min/input-text.js +2 -0
- package/oj-c/min/input-text.js.map +1 -0
- package/oj-c/min/list-item-layout/list-item-layout-styles.css +12 -0
- package/oj-c/min/list-item-layout.js +2 -0
- package/oj-c/min/list-item-layout.js.map +1 -0
- package/oj-c/min/message-toast/message-toast-styles.css +8 -0
- package/oj-c/min/message-toast.js +2 -0
- package/oj-c/min/message-toast.js.map +1 -0
- package/oj-c/min/meter-bar/meter-bar-styles.css +21 -0
- package/oj-c/min/meter-bar.js +2 -0
- package/oj-c/min/meter-bar.js.map +1 -0
- package/oj-c/min/meter-circle/meter-circle-styles.css +14 -0
- package/oj-c/min/meter-circle.js +2 -0
- package/oj-c/min/meter-circle.js.map +1 -0
- package/oj-c/min/progress-bar/progress-bar-styles.css +11 -0
- package/oj-c/min/progress-bar.js +2 -0
- package/oj-c/min/progress-bar.js.map +1 -0
- package/oj-c/min/progress-circle/progress-circle-styles.css +14 -0
- package/oj-c/min/progress-circle.js +2 -0
- package/oj-c/min/progress-circle.js.map +1 -0
- package/oj-c/min/rating-gauge/rating-gauge-styles.css +12 -0
- package/oj-c/min/rating-gauge.js +2 -0
- package/oj-c/min/rating-gauge.js.map +1 -0
- package/oj-c/min/select-common/UNSAFE_useDataProviderListeners/index.d.ts +2 -0
- package/oj-c/min/select-common/UNSAFE_useDataProviderListeners/index.js +6 -0
- package/oj-c/min/select-common/UNSAFE_useDataProviderListeners/useDataProviderListeners.d.ts +13 -0
- package/oj-c/min/select-common/UNSAFE_useDataProviderListeners/useDataProviderListeners.js +96 -0
- package/oj-c/min/select-common/UNSAFE_useWrapDataProvider/index.d.ts +1 -0
- package/oj-c/min/select-common/UNSAFE_useWrapDataProvider/index.js +6 -0
- package/oj-c/min/select-common/UNSAFE_useWrapDataProvider/useWrapDataProvider.d.ts +3 -0
- package/oj-c/min/select-common/UNSAFE_useWrapDataProvider/useWrapDataProvider.js +16 -0
- package/oj-c/min/select-common/UNSAFE_useWrapValueState/index.d.ts +1 -0
- package/oj-c/min/select-common/UNSAFE_useWrapValueState/index.js +6 -0
- package/oj-c/min/select-common/UNSAFE_useWrapValueState/useWrapValueState.d.ts +23 -0
- package/oj-c/min/select-common/UNSAFE_useWrapValueState/useWrapValueState.js +23 -0
- package/oj-c/min/select-common/component.json +9 -0
- package/oj-c/min/select-common/utils/utils.d.ts +10 -0
- package/oj-c/min/select-common/utils/utils.js +19 -0
- package/oj-c/min/select-multiple/select-multiple-styles.css +13 -0
- package/oj-c/min/select-multiple.js +3 -0
- package/oj-c/min/select-multiple.js.map +1 -0
- package/oj-c/min/select-single/select-single-styles.css +22 -0
- package/oj-c/min/select-single.js +3 -0
- package/oj-c/min/select-single.js.map +1 -0
- package/oj-c/min/split-menu-button/split-menu-button-styles.css +11 -0
- package/oj-c/min/split-menu-button.js +2 -0
- package/oj-c/min/split-menu-button.js.map +1 -0
- package/oj-c/min/text-area/text-area-styles.css +13 -0
- package/oj-c/min/text-area.js +2 -0
- package/oj-c/min/text-area.js.map +1 -0
- package/oj-c/min/utils/UNSAFE_focusTabUtils/focusUtils.d.ts +2 -0
- package/oj-c/min/utils/UNSAFE_focusTabUtils/focusUtils.js +23 -0
- package/oj-c/min/utils/UNSAFE_focusTabUtils/index.d.ts +1 -0
- package/oj-c/min/utils/UNSAFE_focusTabUtils/index.js +6 -0
- package/oj-c/min/utils/UNSAFE_keyUtils/index.d.ts +1 -0
- package/oj-c/min/utils/UNSAFE_keyUtils/index.js +19 -0
- package/oj-c/min/utils/UNSAFE_keyUtils/keySetUtils.d.ts +4 -0
- package/oj-c/min/utils/UNSAFE_keyUtils/keySetUtils.js +33 -0
- package/oj-c/min/utils/UNSAFE_meterUtils/index.d.ts +1 -0
- package/oj-c/min/utils/UNSAFE_meterUtils/index.js +6 -0
- package/oj-c/min/utils/UNSAFE_meterUtils/meterUtils.d.ts +2 -0
- package/oj-c/min/utils/UNSAFE_meterUtils/meterUtils.js +12 -0
- package/oj-c/min/utils/component.json +9 -0
- package/oj-c/progress-bar/__webdriver__/ProgressBarWebElement.js +32 -0
- package/oj-c/progress-bar/__webdriver__/ProgressBarWebElementBase.js +60 -0
- package/oj-c/progress-bar/__webdriver__/index.js +74 -0
- package/oj-c/progress-bar/component.json +123 -0
- package/oj-c/progress-bar/index.js +6 -0
- package/oj-c/progress-bar/progress-bar-styles.css +11 -0
- package/oj-c/progress-bar/progress-bar.js +26 -0
- package/oj-c/progress-bar.js +6 -0
- package/oj-c/progress-circle/__webdriver__/ProgressCircleWebElement.js +32 -0
- package/oj-c/progress-circle/__webdriver__/ProgressCircleWebElementBase.js +60 -0
- package/oj-c/progress-circle/__webdriver__/index.js +74 -0
- package/oj-c/progress-circle/component.json +128 -0
- package/oj-c/progress-circle/index.js +6 -0
- package/oj-c/progress-circle/progress-circle-styles.css +14 -0
- package/oj-c/progress-circle/progress-circle.js +26 -0
- package/oj-c/progress-circle.js +6 -0
- package/oj-c/rating-gauge/__webdriver__/RatingGaugeWebElement.js +32 -0
- package/oj-c/rating-gauge/__webdriver__/RatingGaugeWebElementBase.js +168 -0
- package/oj-c/rating-gauge/__webdriver__/index.js +74 -0
- package/oj-c/rating-gauge/component.json +188 -0
- package/oj-c/rating-gauge/index.js +6 -0
- package/oj-c/rating-gauge/rating-gauge-styles.css +12 -0
- package/oj-c/rating-gauge/rating-gauge.js +44 -0
- package/oj-c/rating-gauge.js +6 -0
- package/oj-c/select-common/UNSAFE_useDataProviderListeners/index.js +6 -0
- package/oj-c/select-common/UNSAFE_useDataProviderListeners/useDataProviderListeners.js +96 -0
- package/oj-c/select-common/UNSAFE_useWrapDataProvider/index.js +6 -0
- package/oj-c/select-common/UNSAFE_useWrapDataProvider/useWrapDataProvider.js +16 -0
- package/oj-c/select-common/UNSAFE_useWrapValueState/index.js +6 -0
- package/oj-c/select-common/UNSAFE_useWrapValueState/useWrapValueState.js +23 -0
- package/oj-c/select-common/component.json +9 -0
- package/oj-c/select-common/utils/utils.js +19 -0
- package/oj-c/select-multiple/__dev__/select-multiple.doc.mdx +30 -0
- package/oj-c/select-multiple/__webdriver__/SelectMultipleWebElement.js +32 -0
- package/oj-c/select-multiple/__webdriver__/SelectMultipleWebElementBase.js +258 -0
- package/oj-c/select-multiple/__webdriver__/index.js +74 -0
- package/oj-c/select-multiple/component.json +475 -0
- package/oj-c/select-multiple/index.js +6 -0
- package/oj-c/select-multiple/select-multiple-styles.css +13 -0
- package/oj-c/select-multiple/select-multiple.js +108 -0
- package/oj-c/select-multiple/useSelectMultiplePreact.js +123 -0
- package/oj-c/select-multiple/useSyncValueAndValueItems.js +125 -0
- package/oj-c/select-multiple/useValueItems.js +22 -0
- package/oj-c/select-multiple.js +6 -0
- package/oj-c/select-single/__dev__/select-single.doc.mdx +30 -0
- package/oj-c/select-single/__webdriver__/SelectSingleWebElement.js +32 -0
- package/oj-c/select-single/__webdriver__/SelectSingleWebElementBase.js +258 -0
- package/oj-c/select-single/__webdriver__/index.js +74 -0
- package/oj-c/select-single/component.json +545 -0
- package/oj-c/select-single/index.js +6 -0
- package/oj-c/select-single/select-single-styles.css +22 -0
- package/oj-c/select-single/select-single.js +108 -0
- package/oj-c/select-single/useSelectSinglePreact.js +157 -0
- package/oj-c/select-single/useSyncValueAndValueItem.js +110 -0
- package/oj-c/select-single/useValueItem.js +18 -0
- package/oj-c/select-single.js +6 -0
- package/oj-c/split-menu-button/__dev__/split-menu-button.doc.mdx +32 -0
- package/oj-c/split-menu-button/__tests__/split-menu-button.test.js +17 -0
- package/oj-c/split-menu-button/__webdriver__/SplitMenuButtonWebElement.js +32 -0
- package/oj-c/split-menu-button/__webdriver__/SplitMenuButtonWebElementBase.js +87 -0
- package/oj-c/split-menu-button/__webdriver__/index.js +74 -0
- package/oj-c/split-menu-button/component.json +205 -0
- package/oj-c/split-menu-button/index.js +6 -0
- package/oj-c/split-menu-button/split-menu-button-styles.css +11 -0
- package/oj-c/split-menu-button/split-menu-button.js +76 -0
- package/oj-c/split-menu-button.js +6 -0
- package/oj-c/text-area/__webdriver__/TextAreaWebElement.js +32 -0
- package/oj-c/text-area/__webdriver__/TextAreaWebElementBase.js +285 -0
- package/oj-c/text-area/__webdriver__/index.js +74 -0
- package/oj-c/text-area/component.json +497 -0
- package/oj-c/text-area/index.js +6 -0
- package/oj-c/text-area/text-area-styles.css +13 -0
- package/oj-c/text-area/text-area.js +138 -0
- package/oj-c/text-area/useTextAreaAutosizePreact.js +44 -0
- package/oj-c/text-area/useTextAreaPreact.js +46 -0
- package/oj-c/text-area.js +6 -0
- package/oj-c/types/avatar/avatar.d.ts +68 -0
- package/oj-c/types/avatar/index.d.ts +2 -0
- package/oj-c/types/button/__tests__/button.test.d.ts +1 -0
- package/oj-c/types/button/button.d.ts +91 -0
- package/oj-c/types/button/index.d.ts +2 -0
- package/oj-c/types/collapsible/collapsible.d.ts +88 -0
- package/oj-c/types/collapsible/index.d.ts +2 -0
- package/oj-c/types/editable-value/UNSAFE_useAssistiveText/useAssistiveText.d.ts +32 -0
- package/oj-c/types/editable-value/UNSAFE_useComponentMessaging/useComponentMessaging.d.ts +24 -0
- package/oj-c/types/editable-value/UNSAFE_useConverter/useConverter.d.ts +14 -0
- package/oj-c/types/editable-value/UNSAFE_useConverterLifecycle/useConverterLifecycle.d.ts +11 -0
- package/oj-c/types/editable-value/UNSAFE_useDeferredValidators/useDeferredValidators.d.ts +8 -0
- package/oj-c/types/editable-value/UNSAFE_useEditableValue/useEditableValue.d.ts +47 -0
- package/oj-c/types/editable-value/UNSAFE_useStaleIdentity/useStaleIdentity.d.ts +5 -0
- package/oj-c/types/editable-value/UNSAFE_useValidationLifecycle/useValidationLifecycle.d.ts +15 -0
- package/oj-c/types/editable-value/UNSAFE_useValidators/useValidators.d.ts +35 -0
- package/oj-c/types/editable-value/UNSAFE_useValue/useValue.d.ts +23 -0
- package/oj-c/types/editable-value/UNSAFE_useValueLifecycle/useValueLifecycle.d.ts +9 -0
- package/oj-c/types/editable-value/utils/utils.d.ts +6 -0
- package/oj-c/types/file-picker/file-picker.d.ts +103 -0
- package/oj-c/types/file-picker/index.d.ts +2 -0
- package/oj-c/types/hooks/UNSAFE_useDataProvider/DataProviderHandler.d.ts +18 -0
- package/oj-c/types/hooks/UNSAFE_useDataProvider/useDataProvider.d.ts +10 -0
- package/oj-c/types/hooks/UNSAFE_useDataProvider/utils.d.ts +3 -0
- package/oj-c/types/hooks/UNSAFE_useListData/__tests__/useListData.test.d.ts +1 -0
- package/oj-c/types/hooks/UNSAFE_useListData/useListData.d.ts +21 -0
- package/oj-c/types/hooks/UNSAFE_useTreeData/__tests__/useTreeData.test.d.ts +1 -0
- package/oj-c/types/hooks/UNSAFE_useTreeData/useTreeData.d.ts +27 -0
- package/oj-c/types/input-number/index.d.ts +2 -0
- package/oj-c/types/input-number/input-number.d.ts +231 -0
- package/oj-c/types/input-number/stepBasisUtils.d.ts +1 -0
- package/oj-c/types/input-number/useImplicitNumberConverter.d.ts +10 -0
- package/oj-c/types/input-number/useImplicitNumberRangeValidator.d.ts +17 -0
- package/oj-c/types/input-number/useNumberInputTextPreact.d.ts +54 -0
- package/oj-c/types/input-password/index.d.ts +2 -0
- package/oj-c/types/input-password/input-password.d.ts +183 -0
- package/oj-c/types/input-password/useInputPasswordPreact.d.ts +40 -0
- package/oj-c/types/input-text/__tests__/input-text.test.d.ts +1 -0
- package/oj-c/types/input-text/index.d.ts +2 -0
- package/oj-c/types/input-text/input-text.d.ts +212 -0
- package/oj-c/types/input-text/useInputTextPreact.d.ts +47 -0
- package/oj-c/types/list-item-layout/index.d.ts +2 -0
- package/oj-c/types/list-item-layout/list-item-layout.d.ts +53 -0
- package/oj-c/types/message-toast/index.d.ts +2 -0
- package/oj-c/types/message-toast/message-toast.d.ts +83 -0
- package/oj-c/types/meter-bar/index.d.ts +2 -0
- package/oj-c/types/meter-bar/meter-bar.d.ts +133 -0
- package/oj-c/types/meter-circle/index.d.ts +2 -0
- package/oj-c/types/meter-circle/meter-circle.d.ts +148 -0
- package/oj-c/types/progress-bar/index.d.ts +2 -0
- package/oj-c/types/progress-bar/progress-bar.d.ts +53 -0
- package/oj-c/types/progress-circle/index.d.ts +2 -0
- package/oj-c/types/progress-circle/progress-circle.d.ts +53 -0
- package/oj-c/types/rating-gauge/index.d.ts +2 -0
- package/oj-c/types/rating-gauge/rating-gauge.d.ts +109 -0
- package/oj-c/types/select-common/UNSAFE_useDataProviderListeners/index.d.ts +2 -0
- package/oj-c/types/select-common/UNSAFE_useDataProviderListeners/useDataProviderListeners.d.ts +13 -0
- package/oj-c/types/select-common/UNSAFE_useWrapDataProvider/index.d.ts +1 -0
- package/oj-c/types/select-common/UNSAFE_useWrapDataProvider/useWrapDataProvider.d.ts +3 -0
- package/oj-c/types/select-common/UNSAFE_useWrapValueState/index.d.ts +1 -0
- package/oj-c/types/select-common/UNSAFE_useWrapValueState/useWrapValueState.d.ts +23 -0
- package/oj-c/types/select-common/utils/utils.d.ts +10 -0
- package/oj-c/types/select-multiple/index.d.ts +2 -0
- package/oj-c/types/select-multiple/select-multiple.d.ts +176 -0
- package/oj-c/types/select-multiple/useSelectMultiplePreact.d.ts +42 -0
- package/oj-c/types/select-multiple/useSyncValueAndValueItems.d.ts +17 -0
- package/oj-c/types/select-multiple/useValueItems.d.ts +6 -0
- package/oj-c/types/select-single/index.d.ts +2 -0
- package/oj-c/types/select-single/select-single.d.ts +186 -0
- package/oj-c/types/select-single/useSelectSinglePreact.d.ts +42 -0
- package/oj-c/types/select-single/useSyncValueAndValueItem.d.ts +17 -0
- package/oj-c/types/select-single/useValueItem.d.ts +5 -0
- package/oj-c/types/split-menu-button/__tests__/split-menu-button.test.d.ts +1 -0
- package/oj-c/types/split-menu-button/index.d.ts +2 -0
- package/oj-c/types/split-menu-button/split-menu-button.d.ts +93 -0
- package/oj-c/types/text-area/index.d.ts +2 -0
- package/oj-c/types/text-area/text-area.d.ts +209 -0
- package/oj-c/types/text-area/useTextAreaAutosizePreact.d.ts +44 -0
- package/oj-c/types/text-area/useTextAreaPreact.d.ts +44 -0
- package/oj-c/types/utils/UNSAFE_focusTabUtils/focusUtils.d.ts +2 -0
- package/oj-c/types/utils/UNSAFE_focusTabUtils/index.d.ts +1 -0
- package/oj-c/types/utils/UNSAFE_keyUtils/index.d.ts +1 -0
- package/oj-c/types/utils/UNSAFE_keyUtils/keySetUtils.d.ts +4 -0
- package/oj-c/types/utils/UNSAFE_meterUtils/index.d.ts +1 -0
- package/oj-c/types/utils/UNSAFE_meterUtils/meterUtils.d.ts +2 -0
- package/oj-c/utils/UNSAFE_focusTabUtils/focusUtils.js +23 -0
- package/oj-c/utils/UNSAFE_focusTabUtils/index.js +6 -0
- package/oj-c/utils/UNSAFE_keyUtils/index.js +19 -0
- package/oj-c/utils/UNSAFE_keyUtils/keySetUtils.js +33 -0
- package/oj-c/utils/UNSAFE_meterUtils/index.js +6 -0
- package/oj-c/utils/UNSAFE_meterUtils/meterUtils.js +12 -0
- package/oj-c/utils/component.json +9 -0
- package/package.json +22 -0
- package/webdriver/docs/.nojekyll +1 -0
- package/webdriver/docs/assets/highlight.css +78 -0
- package/webdriver/docs/assets/icons.css +1043 -0
- package/webdriver/docs/assets/icons.png +0 -0
- package/webdriver/docs/assets/icons@2x.png +0 -0
- package/webdriver/docs/assets/main.js +52 -0
- package/webdriver/docs/assets/search.js +1 -0
- package/webdriver/docs/assets/style.css +1414 -0
- package/webdriver/docs/assets/widgets.png +0 -0
- package/webdriver/docs/assets/widgets@2x.png +0 -0
- package/webdriver/docs/classes/AvatarWebElement.html +117 -0
- package/webdriver/docs/classes/ButtonWebElement.html +163 -0
- package/webdriver/docs/classes/CollapsibleWebElement.html +111 -0
- package/webdriver/docs/classes/FilePickerWebElement.html +117 -0
- package/webdriver/docs/classes/InputNumberWebElement.html +231 -0
- package/webdriver/docs/classes/InputPasswordWebElement.html +195 -0
- package/webdriver/docs/classes/InputTextWebElement.html +211 -0
- package/webdriver/docs/classes/ListItemLayoutWebElement.html +97 -0
- package/webdriver/docs/classes/MessageToastWebElement.html +113 -0
- package/webdriver/docs/classes/MeterBarWebElement.html +153 -0
- package/webdriver/docs/classes/MeterCircleWebElement.html +159 -0
- package/webdriver/docs/classes/ProgressBarWebElement.html +105 -0
- package/webdriver/docs/classes/ProgressCircleWebElement.html +105 -0
- package/webdriver/docs/classes/RatingGaugeWebElement.html +147 -0
- package/webdriver/docs/classes/SelectMultipleWebElement.html +196 -0
- package/webdriver/docs/classes/SelectSingleWebElement.html +196 -0
- package/webdriver/docs/classes/SplitMenuButtonWebElement.html +117 -0
- package/webdriver/docs/classes/TextAreaWebElement.html +207 -0
- package/webdriver/docs/index.html +16 -0
- package/webdriver/docs/modules.html +181 -0
- package/webdriver/index.js +34 -0
- package/webdriver/index.ts +18 -0
|
@@ -0,0 +1,4720 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Element: <oj-c-select-multiple></title>
|
|
6
|
+
|
|
7
|
+
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
+
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
+
<!--[if lt IE 9]>
|
|
10
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
+
<![endif]-->
|
|
12
|
+
<script src="scripts/deprecated.js"></script>
|
|
13
|
+
|
|
14
|
+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
15
|
+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
16
|
+
</head>
|
|
17
|
+
|
|
18
|
+
<body>
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<nav id="nav" data-current-item="navItem32">
|
|
22
|
+
<h2>Oracle® JET</h2>
|
|
23
|
+
<h2>Core Pack Components</h2>
|
|
24
|
+
<h3>14.0.0</h3
|
|
25
|
+
<div class="deprecation-checkboxes" style="display: none">
|
|
26
|
+
<ul style="list-style: none; display: none;">
|
|
27
|
+
<li style="margin-top:0px">
|
|
28
|
+
<label for="deprecated">
|
|
29
|
+
<div class="deprecated-cb-common"><input type="checkbox" id="deprecated"><span style="padding:2px">Show Deprecated APIs</span></div>
|
|
30
|
+
</label>
|
|
31
|
+
</li>
|
|
32
|
+
<li style="margin-top:0px">
|
|
33
|
+
<label for="jsonly"></label>
|
|
34
|
+
<div class="deprecated-cb-common"><input type="checkbox" id="jsonly"><span style="padding:2px 12px 2px 2px">Javascript Only APIs</span></div>
|
|
35
|
+
</li>
|
|
36
|
+
</ul>
|
|
37
|
+
</div>
|
|
38
|
+
<ul><li id="idx"><h2 id="navIndex"><a href="index.html" id="navIndexFocusable">Index</a></h2></li><li><div id="nav_toggle">
|
|
39
|
+
<input type="radio" id="elements_rb" name="toggle" value="Elements">
|
|
40
|
+
<label for="elements">Elements</label>
|
|
41
|
+
<input type="radio" id="modules_rb" name="toggle" value="Modules">
|
|
42
|
+
<label for="modules">Modules</label><br>
|
|
43
|
+
</div></li><li id="nav_elements" style="display: none"><h3 id="navElements">Elements</h3><ul class="subList"><li id="navItem0"><a href="oj-c.Avatar.html"><oj-c-avatar></a></li><li id="navItem1"><a href="oj-c.Button.html"><oj-c-button></a></li><li id="navItem2"><a href="oj-c.Collapsible.html"><oj-c-collapsible></a></li><li id="navItem3"><a href="oj-c.FilePicker.html"><oj-c-file-picker></a></li><li id="navItem4"><a href="oj-c.InputNumber.html"><oj-c-input-number></a></li><li id="navItem5"><a href="oj-c.InputPassword.html"><oj-c-input-password></a></li><li id="navItem6"><a href="oj-c.InputText.html"><oj-c-input-text></a></li><li id="navItem7"><a href="oj-c.ListItemLayout.html"><oj-c-list-item-layout></a></li><li id="navItem8"><a href="oj-c.MessageToast.html"><oj-c-message-toast></a></li><li id="navItem9"><a href="oj-c.MeterBar.html"><oj-c-meter-bar></a></li><li id="navItem10"><a href="oj-c.MeterCircle.html"><oj-c-meter-circle></a></li><li id="navItem11"><a href="oj-c.ProgressBar.html"><oj-c-progress-bar></a></li><li id="navItem12"><a href="oj-c.ProgressCircle.html"><oj-c-progress-circle></a></li><li id="navItem13"><a href="oj-c.RatingGauge.html"><oj-c-rating-gauge></a></li><li id="navItem14"><a href="oj-c.SelectMultiple.html"><oj-c-select-multiple></a></li><li id="navItem15"><a href="oj-c.SelectSingle.html"><oj-c-select-single></a></li><li id="navItem16"><a href="oj-c.SplitMenuButton.html"><oj-c-split-menu-button></a></li><li id="navItem17"><a href="oj-c.TextArea.html"><oj-c-text-area></a></li></ul></li><li id="nav_modules" style="display: none"><h3 id="navElements">Modules</h3><ul class="subList_lev2"><li class="module">
|
|
44
|
+
<div id="avatar" class="module_element">
|
|
45
|
+
<a href="avatar.html">avatar</a>
|
|
46
|
+
</div><ul class="subList_lev3"><li id="navItem18"><a href="oj-c.Avatar.html"><oj-c-avatar></a></li></ul></li><li class="module">
|
|
47
|
+
<div id="button" class="module_element">
|
|
48
|
+
<a href="button.html">button</a>
|
|
49
|
+
</div><ul class="subList_lev3"><li id="navItem19"><a href="oj-c.Button.html"><oj-c-button></a></li></ul></li><li class="module">
|
|
50
|
+
<div id="collapsible" class="module_element">
|
|
51
|
+
<a href="collapsible.html">collapsible</a>
|
|
52
|
+
</div><ul class="subList_lev3"><li id="navItem20"><a href="oj-c.Collapsible.html"><oj-c-collapsible></a></li></ul></li><li class="module">
|
|
53
|
+
<div id="file-picker" class="module_element">
|
|
54
|
+
<a href="file-picker.html">file-picker</a>
|
|
55
|
+
</div><ul class="subList_lev3"><li id="navItem21"><a href="oj-c.FilePicker.html"><oj-c-file-picker></a></li></ul></li><li class="module">
|
|
56
|
+
<div id="input-number" class="module_element">
|
|
57
|
+
<a href="input-number.html">input-number</a>
|
|
58
|
+
</div><ul class="subList_lev3"><li id="navItem22"><a href="oj-c.InputNumber.html"><oj-c-input-number></a></li></ul></li><li class="module">
|
|
59
|
+
<div id="input-password" class="module_element">
|
|
60
|
+
<a href="input-password.html">input-password</a>
|
|
61
|
+
</div><ul class="subList_lev3"><li id="navItem23"><a href="oj-c.InputPassword.html"><oj-c-input-password></a></li></ul></li><li class="module">
|
|
62
|
+
<div id="input-text" class="module_element">
|
|
63
|
+
<a href="input-text.html">input-text</a>
|
|
64
|
+
</div><ul class="subList_lev3"><li id="navItem24"><a href="oj-c.InputText.html"><oj-c-input-text></a></li></ul></li><li class="module">
|
|
65
|
+
<div id="list-item-layout" class="module_element">
|
|
66
|
+
<a href="list-item-layout.html">list-item-layout</a>
|
|
67
|
+
</div><ul class="subList_lev3"><li id="navItem25"><a href="oj-c.ListItemLayout.html"><oj-c-list-item-layout></a></li></ul></li><li class="module">
|
|
68
|
+
<div id="message-toast" class="module_element">
|
|
69
|
+
<a href="message-toast.html">message-toast</a>
|
|
70
|
+
</div><ul class="subList_lev3"><li id="navItem26"><a href="oj-c.MessageToast.html"><oj-c-message-toast></a></li></ul></li><li class="module">
|
|
71
|
+
<div id="meter-bar" class="module_element">
|
|
72
|
+
<a href="meter-bar.html">meter-bar</a>
|
|
73
|
+
</div><ul class="subList_lev3"><li id="navItem27"><a href="oj-c.MeterBar.html"><oj-c-meter-bar></a></li></ul></li><li class="module">
|
|
74
|
+
<div id="meter-circle" class="module_element">
|
|
75
|
+
<a href="meter-circle.html">meter-circle</a>
|
|
76
|
+
</div><ul class="subList_lev3"><li id="navItem28"><a href="oj-c.MeterCircle.html"><oj-c-meter-circle></a></li></ul></li><li class="module">
|
|
77
|
+
<div id="progress-bar" class="module_element">
|
|
78
|
+
<a href="progress-bar.html">progress-bar</a>
|
|
79
|
+
</div><ul class="subList_lev3"><li id="navItem29"><a href="oj-c.ProgressBar.html"><oj-c-progress-bar></a></li></ul></li><li class="module">
|
|
80
|
+
<div id="progress-circle" class="module_element">
|
|
81
|
+
<a href="progress-circle.html">progress-circle</a>
|
|
82
|
+
</div><ul class="subList_lev3"><li id="navItem30"><a href="oj-c.ProgressCircle.html"><oj-c-progress-circle></a></li></ul></li><li class="module">
|
|
83
|
+
<div id="rating-gauge" class="module_element">
|
|
84
|
+
<a href="rating-gauge.html">rating-gauge</a>
|
|
85
|
+
</div><ul class="subList_lev3"><li id="navItem31"><a href="oj-c.RatingGauge.html"><oj-c-rating-gauge></a></li></ul></li><li class="module">
|
|
86
|
+
<div id="select-multiple" class="module_element">
|
|
87
|
+
<a href="select-multiple.html">select-multiple</a>
|
|
88
|
+
</div><ul class="subList_lev3"><li id="navItem32"><a href="oj-c.SelectMultiple.html"><oj-c-select-multiple></a></li></ul></li><li class="module">
|
|
89
|
+
<div id="select-single" class="module_element">
|
|
90
|
+
<a href="select-single.html">select-single</a>
|
|
91
|
+
</div><ul class="subList_lev3"><li id="navItem33"><a href="oj-c.SelectSingle.html"><oj-c-select-single></a></li></ul></li><li class="module">
|
|
92
|
+
<div id="split-menu-button" class="module_element">
|
|
93
|
+
<a href="split-menu-button.html">split-menu-button</a>
|
|
94
|
+
</div><ul class="subList_lev3"><li id="navItem34"><a href="oj-c.SplitMenuButton.html"><oj-c-split-menu-button></a></li></ul></li><li class="module">
|
|
95
|
+
<div id="text-area" class="module_element">
|
|
96
|
+
<a href="text-area.html">text-area</a>
|
|
97
|
+
</div><ul class="subList_lev3"><li id="navItem35"><a href="oj-c.TextArea.html"><oj-c-text-area></a></li></ul></li></ul></li></ul>
|
|
98
|
+
</nav>
|
|
99
|
+
|
|
100
|
+
<div id="main">
|
|
101
|
+
|
|
102
|
+
<button onclick="topFunction()" id="jump-to-top-btn" title="Go to top"></button>
|
|
103
|
+
<div class="page-title">
|
|
104
|
+
<h1>Element: <oj-c-select-multiple></h1>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<p class="product-docs-header">
|
|
108
|
+
<span style="font-weight:bold">Oracle® JavaScript Extension Toolkit (JET)<br>
|
|
109
|
+
14.0.0</span><br>
|
|
110
|
+
</p>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<dl class="details">
|
|
124
|
+
|
|
125
|
+
<dt class="tag-since">Since:</dt>
|
|
126
|
+
<dd class="tag-since"><ul class="dummy"><li>13.0.0</li></ul></dd>
|
|
127
|
+
|
|
128
|
+
<dt class="tag-module">Module:</dt>
|
|
129
|
+
<dd class="tag-module"><ul class="dummy"><li>select-multiple</li></ul></dd>
|
|
130
|
+
|
|
131
|
+
</dl>
|
|
132
|
+
|
|
133
|
+
<section id="quick-nav" class="">
|
|
134
|
+
<header><h2>QuickNav</h2></header>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<div class="quick-nav-section3">
|
|
139
|
+
<h3> <a href="#members-section">Attributes</a></h3>
|
|
140
|
+
<ul class="optionsSubList">
|
|
141
|
+
|
|
142
|
+
<li><div><a href="#containerReadonly">container-readonly</a></div>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
<li><div><a href="#data">data</a></div>
|
|
147
|
+
|
|
148
|
+
</li>
|
|
149
|
+
|
|
150
|
+
<li><div><a href="#disabled">disabled</a></div>
|
|
151
|
+
|
|
152
|
+
</li>
|
|
153
|
+
|
|
154
|
+
<li><div><a href="javascript:void(0)" ><b>display-options</b></a></div>
|
|
155
|
+
|
|
156
|
+
<ul class='optionsInnerSubList'>
|
|
157
|
+
|
|
158
|
+
<li><div><a href="#displayOptions.messages">messages</a></div>
|
|
159
|
+
|
|
160
|
+
</ul></li>
|
|
161
|
+
|
|
162
|
+
<li><div><a href="javascript:void(0)" ><b>help</b></a></div>
|
|
163
|
+
|
|
164
|
+
<ul class='optionsInnerSubList'>
|
|
165
|
+
|
|
166
|
+
<li><div><a href="#help.instruction">instruction</a></div>
|
|
167
|
+
|
|
168
|
+
</ul></li>
|
|
169
|
+
|
|
170
|
+
<li><div><a href="javascript:void(0)" ><b>help-hints</b></a></div>
|
|
171
|
+
|
|
172
|
+
<ul class='optionsInnerSubList'>
|
|
173
|
+
|
|
174
|
+
<li><div><a href="#helpHints.definition">definition</a></div>
|
|
175
|
+
|
|
176
|
+
</li>
|
|
177
|
+
|
|
178
|
+
<li><div><a href="#helpHints.source">source</a></div>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
<li><div><a href="#helpHints.sourceText">source-text</a></div>
|
|
183
|
+
|
|
184
|
+
</ul></li>
|
|
185
|
+
|
|
186
|
+
<li><div><a href="#itemText">item-text</a></div>
|
|
187
|
+
|
|
188
|
+
</li>
|
|
189
|
+
|
|
190
|
+
<li><div><a href="#labelEdge">label-edge</a></div>
|
|
191
|
+
|
|
192
|
+
</li>
|
|
193
|
+
|
|
194
|
+
<li><div><a href="#labelHint">label-hint</a></div>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
<li><div><a href="#labelStartWidth">label-start-width</a></div>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
<li><div><a href="#labelWrapping">label-wrapping</a></div>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
<li><div><a href="javascript:void(0)" ><b>messages-custom</b></a></div>
|
|
207
|
+
|
|
208
|
+
<ul class='optionsInnerSubList'>
|
|
209
|
+
|
|
210
|
+
<li><div><a href="#messagesCustom[].detail">detail</a></div>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
<li><div><a href="#messagesCustom[].severity">severity</a></div>
|
|
215
|
+
|
|
216
|
+
</li>
|
|
217
|
+
|
|
218
|
+
<li><div><a href="#messagesCustom[].summary">summary</a></div>
|
|
219
|
+
|
|
220
|
+
</ul></li>
|
|
221
|
+
|
|
222
|
+
<li><div><a href="#placeholder">placeholder</a></div>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
<li><div><a href="#readonly">readonly</a></div>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
<li><div><a href="#required">required</a></div>
|
|
231
|
+
|
|
232
|
+
</li>
|
|
233
|
+
|
|
234
|
+
<li><div><a href="#requiredMessageDetail">required-message-detail</a></div>
|
|
235
|
+
|
|
236
|
+
</li>
|
|
237
|
+
|
|
238
|
+
<li><div><a href="#textAlign">text-align</a></div>
|
|
239
|
+
|
|
240
|
+
</li>
|
|
241
|
+
|
|
242
|
+
<li><div><a href="#userAssistanceDensity">user-assistance-density</a></div>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
<li><div><a href="#valid">valid</a></div>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
<li><div><a href="#value">value</a></div>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
<li><div><a href="#valueItems">value-items</a></div>
|
|
255
|
+
|
|
256
|
+
</li>
|
|
257
|
+
|
|
258
|
+
<li><div><a href="#virtualKeyboard">virtual-keyboard</a></div>
|
|
259
|
+
|
|
260
|
+
</ul>
|
|
261
|
+
<script type="text/javascript" >
|
|
262
|
+
var innerSubLists = document.getElementsByClassName('optionsInnerSubList');
|
|
263
|
+
for (var i=0; i<innerSubLists.length; i++) {
|
|
264
|
+
innerSubLists[i].parentNode.onclick=function(event) {
|
|
265
|
+
event.stopPropagation();
|
|
266
|
+
// Only interpret the click event if the <a> element is the target and do nothing if click occurred elsewhere on the div
|
|
267
|
+
if (event.target.parentNode == this.firstChild.firstChild) {
|
|
268
|
+
// toggle only the clicked sub properties list and not any nested ones
|
|
269
|
+
var subProperties = this.getElementsByClassName('optionsInnerSubList');
|
|
270
|
+
subProperties[0].style.display = (subProperties[0].style.display=='block' ? 'none' : 'block');
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
</script>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
</div>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<div class="quick-nav-section3">
|
|
287
|
+
<h3><a href="#methods-section">Methods</a></h3>
|
|
288
|
+
<ul class="subList">
|
|
289
|
+
|
|
290
|
+
<li><a href="#getProperty">getProperty</a></li>
|
|
291
|
+
|
|
292
|
+
<li><a href="#reset">reset</a></li>
|
|
293
|
+
|
|
294
|
+
<li><a href="#setProperties">setProperties</a></li>
|
|
295
|
+
|
|
296
|
+
<li><a href="#setProperty">setProperty</a></li>
|
|
297
|
+
|
|
298
|
+
<li><a href="#showMessages">showMessages</a></li>
|
|
299
|
+
|
|
300
|
+
<li><a href="#validate">validate</a></li>
|
|
301
|
+
|
|
302
|
+
</ul>
|
|
303
|
+
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<div class="quick-nav-section3">
|
|
309
|
+
<h3>Other Topics</h3>
|
|
310
|
+
<ul class="subList">
|
|
311
|
+
|
|
312
|
+
<li><a href="#touch-section">Touch Section</a></li>
|
|
313
|
+
|
|
314
|
+
<li><a href="#keyboard-section">Keyboard Section</a></li>
|
|
315
|
+
|
|
316
|
+
<li><a href="#a11y-section">Accessibility Section</a></li>
|
|
317
|
+
|
|
318
|
+
</ul>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</section>
|
|
322
|
+
|
|
323
|
+
<section class="">
|
|
324
|
+
<header>
|
|
325
|
+
|
|
326
|
+
</br>
|
|
327
|
+
|
|
328
|
+
<div class="class-description">
|
|
329
|
+
<p><h3 id="selectMultipleOverview-section">
|
|
330
|
+
JET Select Multiple
|
|
331
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#selectMultipleOverview-section"></a>
|
|
332
|
+
</h3>
|
|
333
|
+
<p>Description: JET Select Multiple provides support for multi-select and search filtering.</p>
|
|
334
|
+
|
|
335
|
+
<p>A JET Select Multiple can be created with the following markup.</p>
|
|
336
|
+
|
|
337
|
+
<pre class="prettyprint"><code>
|
|
338
|
+
<oj-c-select-multiple data="[[dataProvider]]" item-text="label" label-hint="Select Multiple">
|
|
339
|
+
</oj-c-select-multiple>
|
|
340
|
+
</code></pre>
|
|
341
|
+
|
|
342
|
+
<h4>Data</h4>
|
|
343
|
+
<p>The only way to provide data to JET Select Multiple is through a
|
|
344
|
+
<a href="DataProvider.html">DataProvider</a>. For cases with
|
|
345
|
+
a small set of fixed data, use an <a href="ArrayDataProvider.html">ArrayDataProvider</a>.</p>
|
|
346
|
+
|
|
347
|
+
<h3 id="diff-section">
|
|
348
|
+
Differences between Select and Combobox components
|
|
349
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#diff-section"></a>
|
|
350
|
+
</h3>
|
|
351
|
+
|
|
352
|
+
<p>
|
|
353
|
+
oj-c-select-* components and oj-combobox-* components may look and feel similar,
|
|
354
|
+
but these components are different and are intended for very different use cases.
|
|
355
|
+
</p>
|
|
356
|
+
|
|
357
|
+
<p>
|
|
358
|
+
While oj-c-select-* components allow a user to filter the data in the dropdown,
|
|
359
|
+
it is not possible to enter values that are not available in the data.
|
|
360
|
+
This makes oj-c-select-* components ideal for usecases where the user can only
|
|
361
|
+
select values that are available in the dropdown, but not provide custom
|
|
362
|
+
values of their own.
|
|
363
|
+
</p>
|
|
364
|
+
|
|
365
|
+
<p>
|
|
366
|
+
In contrast, oj-combobox-* components allow a user to enter new values that are
|
|
367
|
+
not available in the data in addition to using the text field for filtering dropdown data.
|
|
368
|
+
This makes oj-combobox-* components ideal for usecases where the users can provide
|
|
369
|
+
custom values in addition to those that are already available in the dropdown data.
|
|
370
|
+
</p>
|
|
371
|
+
|
|
372
|
+
<p>
|
|
373
|
+
Application developers should consider the above differences when choosing between
|
|
374
|
+
Select and Combobox components.
|
|
375
|
+
Additionally, applications are advised to use oj-c-select-multiple instead of oj-select-many.
|
|
376
|
+
</p>
|
|
377
|
+
|
|
378
|
+
<h3 id="validation-section">
|
|
379
|
+
Validation and Messaging
|
|
380
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#validation-section"></a>
|
|
381
|
+
</h3>
|
|
382
|
+
|
|
383
|
+
<p>
|
|
384
|
+
An editable component runs validation (normal or deferred) based on the action performed on it
|
|
385
|
+
(either by end-user or page author), and the state it was in when the action occurred. Examples
|
|
386
|
+
of actions are - creating a component, user changing the value of the component by interacting
|
|
387
|
+
with it, the app setting a value programmatically, the app calling the validate() method etc. At
|
|
388
|
+
the time the action occurs, the component could already be showing errors, or can have a deferred
|
|
389
|
+
error or have no errors.
|
|
390
|
+
</p>
|
|
391
|
+
<p>
|
|
392
|
+
These factors also determine whether validation errors/messages get shown to the user immediately
|
|
393
|
+
or get deferred. The following sections highlight the kinds of validation that are run and how
|
|
394
|
+
messages get handled.
|
|
395
|
+
</p>
|
|
396
|
+
|
|
397
|
+
<h4 id="normal-validation-section">
|
|
398
|
+
Normal Validation
|
|
399
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#normal-validation-section"></a>
|
|
400
|
+
</h4>
|
|
401
|
+
Normal validation is run in the following cases on the display value, using the converter and
|
|
402
|
+
validators (this includes async-validators) set on the component,
|
|
403
|
+
and validation errors are reported to user immediately.
|
|
404
|
+
<ul>
|
|
405
|
+
<li>When value changes as a result of user interaction all messages are cleared, including custom
|
|
406
|
+
messages added by the app, and full validation is run on the UI value. The steps performed are
|
|
407
|
+
outlined below.
|
|
408
|
+
<ol>
|
|
409
|
+
<li>All messages are cleared and <code class="prettyprint">messagesCustom</code> property is cleared</li>
|
|
410
|
+
<li>If no converter is present then processing continues to next step. If a converter is
|
|
411
|
+
present, the UI value is first converted (i.e., parsed). If there is a parse error then
|
|
412
|
+
the messages are shown and processing returns.</li>
|
|
413
|
+
<li>If there are no validators setup for the component then the value is set on the component.
|
|
414
|
+
Otherwise all validators are run in sequence using the parsed value from the previous step. The
|
|
415
|
+
implicit required is run first if the component is marked required. When a validation error is
|
|
416
|
+
encountered it is remembered and the next validator in the sequence is run.
|
|
417
|
+
<ul><li>NOTE: The value is trimmed before required validation is run</li></ul>
|
|
418
|
+
</li>
|
|
419
|
+
<li>At the end of the validation run if there are errors, the messages are shown
|
|
420
|
+
and processing returns. If there are async-validators, those errors are shown as soon as they
|
|
421
|
+
come in, and not until all validators, sync and async validators, are complete, does processing
|
|
422
|
+
return, that is, value and valid are updated. If there are no errors, then the
|
|
423
|
+
<code class="prettyprint">value</code> property is updated and the formatted value displayed on the
|
|
424
|
+
UI.</li>
|
|
425
|
+
</ol>
|
|
426
|
+
</li>
|
|
427
|
+
<li>When the <code class="prettyprint">validate</code> method is called by app, all messages are
|
|
428
|
+
cleared and full validation run using the display value. See <code class="prettyprint">validate</code>
|
|
429
|
+
method on the sub-classes for details. Note: JET validation is designed to catch user input errors, and not invalid
|
|
430
|
+
data passed from the server; this should be caught on the server.</li>
|
|
431
|
+
<li>When certain properties change through programmatic intervention by app, the component
|
|
432
|
+
determines whether it needs to run normal validation based on the state the component is in.
|
|
433
|
+
Refer to the <a href="#mixed-validation-section">Mixed Validation</a> section below for details. </li>
|
|
434
|
+
</ul>
|
|
435
|
+
|
|
436
|
+
<h4 id="deferred-validation-section">
|
|
437
|
+
Deferred Validation
|
|
438
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#deferred-validation-section"></a>
|
|
439
|
+
</h4>
|
|
440
|
+
Deferred validation is run in the following cases on the component value using the implicit
|
|
441
|
+
required validator if required is true, and validation errors are deferred, i.e., not shown to user immediately.
|
|
442
|
+
Refer to the <a href="#deferred-messages-section">Showing Deferred Messages</a> section to
|
|
443
|
+
understand how deferred messages can be shown.
|
|
444
|
+
<ul>
|
|
445
|
+
<li>When a component is created and it is required deferred validation is run and no messages are cleared
|
|
446
|
+
prior to running validation.
|
|
447
|
+
Refer to the <a href="#deferred-validators-section">Validators
|
|
448
|
+
Participating in Deferred Validation</a> section for details.</li>
|
|
449
|
+
<li>When the <code class="prettyprint">value</code> property changes due to programmatic
|
|
450
|
+
intervention deferred validation is run, after all messages and messagesCustom property are cleared.</li>
|
|
451
|
+
<li>When the <code class="prettyprint">reset</code> method is called, deferred validation is run
|
|
452
|
+
after all messages and messagesCustom property are cleared.</li>
|
|
453
|
+
<li>When certain properties change through programmatic intervention by app, the component
|
|
454
|
+
determines whether it needs to run deferred validation based on the state the component is in.
|
|
455
|
+
Refer to the <a href="#mixed-validation-section">Mixed Validation</a> section below for details.</li>
|
|
456
|
+
</ul>
|
|
457
|
+
|
|
458
|
+
<h4 id="mixed-validation-section">
|
|
459
|
+
Mixed Validation
|
|
460
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#mixed-validation-section"></a>
|
|
461
|
+
</h4>
|
|
462
|
+
Either deferred or normal validation is run in the following cases based on the state the
|
|
463
|
+
component is in and any validation errors encountered are either hidden or shown to user.
|
|
464
|
+
<ul>
|
|
465
|
+
<li>when disabled property changes. See <a href="#disabled">disabled</a> property for details.</li>
|
|
466
|
+
<li>when converter property changes. See <a href="#converter">converter</a> property for details.</li>
|
|
467
|
+
<li>when required property changes. See <a href="#required">required</a> property for details.</li>
|
|
468
|
+
<li>when validators property changes. See <a href="#validators">validators</a> property for details.</li>
|
|
469
|
+
</ul>
|
|
470
|
+
|
|
471
|
+
<h3 id="deferred-messages-section">
|
|
472
|
+
Showing Deferred Messages
|
|
473
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#deferred-messages-section"></a>
|
|
474
|
+
</h3>
|
|
475
|
+
Deferred validation messages are displayed only when page author requests for it explicitly in
|
|
476
|
+
one of the following ways:
|
|
477
|
+
<ul>
|
|
478
|
+
<li>calls the <a href="#showMessages"><code class="prettyprint">showMessages</code></a> method on the component</li>
|
|
479
|
+
</ul>
|
|
480
|
+
|
|
481
|
+
<h3 id="deferred-validators-section">
|
|
482
|
+
Validators Participating in Deferred Validation
|
|
483
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#deferred-validators-section"></a>
|
|
484
|
+
</h3>
|
|
485
|
+
The required validator is the only validator type that participates in deferred validation.
|
|
486
|
+
The required property needs to be set to true for the required validator to run.
|
|
487
|
+
|
|
488
|
+
<h3 id="user-assistance-text-section">
|
|
489
|
+
User Assistance Text
|
|
490
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#user-assistance-text-section"></a>
|
|
491
|
+
</h3>
|
|
492
|
+
<p>
|
|
493
|
+
User assistive text provides guidance to help the user understand what data to enter or select.
|
|
494
|
+
</p>
|
|
495
|
+
<p>
|
|
496
|
+
By default all user assistance text shows inline.
|
|
497
|
+
For input components, it shows when the field takes focus. In other components
|
|
498
|
+
it shows all the time. See the user-assistance-density property for other ways
|
|
499
|
+
the user assistance text can render, like in 'compact' mode, it will render as an icon on the label
|
|
500
|
+
which when clicked will show the user assistance text in a notewindow.
|
|
501
|
+
</p>
|
|
502
|
+
<p>
|
|
503
|
+
The JET form component properties that are used for user assistance text are help.instruction,
|
|
504
|
+
validator and converter hints, and help-hints.
|
|
505
|
+
In the Redwood theme for clarity only one user assistance text shows to the user.
|
|
506
|
+
The precedence rules are:
|
|
507
|
+
<ul>
|
|
508
|
+
<li>help.instruction shows;</li>
|
|
509
|
+
<li>if no help.instruction, then validator hint shows;</li>
|
|
510
|
+
<li>if no help.instruction or validator hint, then help-hints.definition shows;</li>
|
|
511
|
+
<li>if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.</li>
|
|
512
|
+
<li>help-hints.source always shows along side the above.</li>
|
|
513
|
+
</ul>
|
|
514
|
+
</p>
|
|
515
|
+
<p>Sometimes a validator or converter hint shows that you do not want to show. To not show it,
|
|
516
|
+
set the display-options.validator-hint and/or display-options.converter-hint property to 'none'.
|
|
517
|
+
</p>
|
|
518
|
+
<p>required and placeholder properties also can be used to guide the user.
|
|
519
|
+
In Redwood, a required field shows the word Required under the field
|
|
520
|
+
when the field is empty and does not have focus.
|
|
521
|
+
Placeholder is shown when the field is empty and has focus.
|
|
522
|
+
</p>
|
|
523
|
+
|
|
524
|
+
<h3 id="touch-section">
|
|
525
|
+
Touch End User Information
|
|
526
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#touch-section"></a>
|
|
527
|
+
</h3>
|
|
528
|
+
|
|
529
|
+
<table class="keyboard-table">
|
|
530
|
+
<thead>
|
|
531
|
+
<tr>
|
|
532
|
+
<th>Target</th>
|
|
533
|
+
<th>Gesture</th>
|
|
534
|
+
<th>Action</th>
|
|
535
|
+
</tr>
|
|
536
|
+
</thead>
|
|
537
|
+
<tbody>
|
|
538
|
+
<tr>
|
|
539
|
+
<td>Input field</td>
|
|
540
|
+
<td><kbd>Tap</kbd></td>
|
|
541
|
+
<td> If the drop down is not open, expand the drop down list.
|
|
542
|
+
If hints, title or messages exist in a notewindow,
|
|
543
|
+
pop up the notewindow.</td>
|
|
544
|
+
</tr>
|
|
545
|
+
<tr>
|
|
546
|
+
<td>Arrow button</td>
|
|
547
|
+
<td><kbd>Tap</kbd></td>
|
|
548
|
+
<td> If the drop down is not open, expand the drop down list. Otherwise, close the drop down list.</td>
|
|
549
|
+
</tr>
|
|
550
|
+
<tr>
|
|
551
|
+
<td>Option item</td>
|
|
552
|
+
<td><kbd>Tap</kbd></td>
|
|
553
|
+
<td> Tap on an option item in the drop down list to select.</td>
|
|
554
|
+
</tr>
|
|
555
|
+
<tr>
|
|
556
|
+
<td>Selected values count</td>
|
|
557
|
+
<td><kbd>Tap</kbd></td>
|
|
558
|
+
<td> Toggle the drop down list between the full list of items and the list of only
|
|
559
|
+
selected items. If the drop down is not open, expand the drop down list.</td>
|
|
560
|
+
</tr>
|
|
561
|
+
</tbody>
|
|
562
|
+
</table>
|
|
563
|
+
|
|
564
|
+
<h3 id="keyboard-section">
|
|
565
|
+
Keyboard End User Information
|
|
566
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#keyboard-section"></a>
|
|
567
|
+
</h3>
|
|
568
|
+
|
|
569
|
+
<table class="keyboard-table">
|
|
570
|
+
<thead>
|
|
571
|
+
<tr>
|
|
572
|
+
<th>Target</th>
|
|
573
|
+
<th>Key</th>
|
|
574
|
+
<th>Action</th>
|
|
575
|
+
</tr>
|
|
576
|
+
</thead>
|
|
577
|
+
<tbody>
|
|
578
|
+
<tr>
|
|
579
|
+
<td>Option item</td>
|
|
580
|
+
<td><kbd>Space</kbd></td>
|
|
581
|
+
<td> Select the highlighted choice from the drop down.</td>
|
|
582
|
+
</tr>
|
|
583
|
+
<tr>
|
|
584
|
+
<td>Input field</td>
|
|
585
|
+
<td><kbd>Esc</kbd></td>
|
|
586
|
+
<td> Collapse the drop down list. If the drop down is already closed, do nothing.</td>
|
|
587
|
+
</tr>
|
|
588
|
+
<tr>
|
|
589
|
+
<td>Drop down</td>
|
|
590
|
+
<td><kbd>UpArrow or DownArrow</kbd></td>
|
|
591
|
+
<td> Highlight the option item on the drop down list in the direction of the arrow.
|
|
592
|
+
If the drop down is not open, expand the drop down list.</td>
|
|
593
|
+
</tr>
|
|
594
|
+
<tr>
|
|
595
|
+
<td>Drop down</td>
|
|
596
|
+
<td><kbd>Esc</kbd></td>
|
|
597
|
+
<td> Collapse the drop down list. If the drop down is already closed, do nothing.</td>
|
|
598
|
+
</tr>
|
|
599
|
+
<tr>
|
|
600
|
+
<td>Selected values count</td>
|
|
601
|
+
<td><kbd>Enter or Space</kbd></td>
|
|
602
|
+
<td> Toggle the drop down list between the full list of items and the list of only
|
|
603
|
+
selected items. If the drop down is not open, expand the drop down list.</td>
|
|
604
|
+
</tr>
|
|
605
|
+
<tr>
|
|
606
|
+
<td>Selected values count</td>
|
|
607
|
+
<td><kbd>Esc</kbd></td>
|
|
608
|
+
<td> Collapse the drop down list. If the drop down is already closed, do nothing.</td>
|
|
609
|
+
</tr>
|
|
610
|
+
<tr>
|
|
611
|
+
<td>Select</td>
|
|
612
|
+
<td><kbd>Tab In</kbd></td>
|
|
613
|
+
<td>Set focus to the Select. If hints, title or messages exist in a notewindow,
|
|
614
|
+
pop up the notewindow.</td>
|
|
615
|
+
</tr>
|
|
616
|
+
</tbody>
|
|
617
|
+
</table>
|
|
618
|
+
|
|
619
|
+
<h3 id="perf-section">
|
|
620
|
+
Performance
|
|
621
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#perf-section"></a>
|
|
622
|
+
</h3>
|
|
623
|
+
|
|
624
|
+
<h4>Page Load</h4>
|
|
625
|
+
<p>If there are initially selected values, setting the <a href="#valueItems">valueItems</a> attribute initially can improve page load performance because the element will not have to fetch the selected data from the data provider.</p>
|
|
626
|
+
<p>The dropdown data isn't fetched until the user opens the dropdown.</p>
|
|
627
|
+
|
|
628
|
+
<h3 id="a11y-section">
|
|
629
|
+
Accessibility
|
|
630
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#a11y-section"></a>
|
|
631
|
+
</h3>
|
|
632
|
+
|
|
633
|
+
<p>
|
|
634
|
+
For accessibility, set the <a href="#labelHint">label-hint</a> property.
|
|
635
|
+
If there is no visible label, then to make this accessible to screen reader users,
|
|
636
|
+
set the <a href="#labelHint">label-hint</a> and <a href="#labelEdge">label-edge</a>='none'
|
|
637
|
+
which renders an aria-label with the label-hint text.
|
|
638
|
+
</p>
|
|
639
|
+
|
|
640
|
+
<p>
|
|
641
|
+
The placeholder text is not read reliably by the screen reader. For accessibility reasons,
|
|
642
|
+
you need to associate the text to its JET form component using aria-describedby.
|
|
643
|
+
</p>
|
|
644
|
+
|
|
645
|
+
<p>
|
|
646
|
+
Disabled content: JET supports an accessible luminosity contrast ratio,
|
|
647
|
+
as specified in <a href="http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast">WCAG 2.0 - Section 1.4.3 "Contrast"</a>,
|
|
648
|
+
in the themes that are accessible. (See the "Theming" chapter of the JET Developer Guide for more information on which
|
|
649
|
+
themes are accessible.) Note that Section 1.4.3 says that text or images of text that are part of an inactive user
|
|
650
|
+
interface component have no contrast requirement. Because disabled content may not meet the minimum contrast ratio
|
|
651
|
+
required of enabled content, it cannot be used to convey meaningful information.
|
|
652
|
+
</p></p>
|
|
653
|
+
</div>
|
|
654
|
+
</br>
|
|
655
|
+
|
|
656
|
+
</header>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
<article>
|
|
660
|
+
<div class="container-overview">
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<div class="usage-section">
|
|
664
|
+
<h3 id="usage-section">Usage<a class="bookmarkable-link" title="Bookmarkable Link" href="#usage-section"></a></h3>
|
|
665
|
+
|
|
666
|
+
<dt class="null" style="margin-right: 100px;"><h5><span>Signature: </span><p> <span class="name type-signature">interface CSelectMultipleElement<K extends string | number,D extends Record<string, <a href="CustomElementOverview.html#ce-attrs-any-section">any</a>>></span></p></h5></dt>
|
|
667
|
+
|
|
668
|
+
<dl>
|
|
669
|
+
<dt><h5>Typescript Import Format</h5></dt>
|
|
670
|
+
<dd><pre class="prettyprint"><code>//To typecheck the element APIs, import as below.<br>import {CSelectMultipleElement} from "oj-c/select-multiple";<br><br>//For the transpiled javascript to load the element's module, import as below<br>import "oj-c/select-multiple";</code></pre></dd>
|
|
671
|
+
</dl>
|
|
672
|
+
|
|
673
|
+
<p>For additional information visit:</p>
|
|
674
|
+
<ul>
|
|
675
|
+
|
|
676
|
+
<li><a href="../../../jsdocs/CustomElementOverview.html" target="_blank">Using JET Custom Elements</a></li>
|
|
677
|
+
|
|
678
|
+
<li><a href="../../../jsdocs/TypescriptOverview.html" target="_blank">Using JET with TypeScript</a></li>
|
|
679
|
+
<li><a href="../../../jsdocs/ModuleLoadingOverview.html" target="_blank">JET Module Loading</a></li>
|
|
680
|
+
</ul>
|
|
681
|
+
|
|
682
|
+
<p class="important">Note: Application logic should not interact with the component's properties or invoke its methods
|
|
683
|
+
until the <a href="../../../jsdocs/oj.BusyContext.html" target="_blank">BusyContext</a> indicates that the component is ready for interaction.</p>
|
|
684
|
+
|
|
685
|
+
</div>
|
|
686
|
+
<br>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<dl class="details">
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</dl>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</div>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<h3 id="members-section" class="subsection-title">
|
|
743
|
+
Attributes
|
|
744
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#members-section"></a>
|
|
745
|
+
</h3>
|
|
746
|
+
|
|
747
|
+
<dl>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
<dt class="">
|
|
751
|
+
|
|
752
|
+
<h4 id="containerReadonly" class="name">
|
|
753
|
+
|
|
754
|
+
<span class="type-signature"></span>container-readonly<span class="type-signature"> :boolean</span>
|
|
755
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#containerReadonly"></a>
|
|
756
|
+
|
|
757
|
+
</h4>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</dt>
|
|
761
|
+
|
|
762
|
+
<dd class="">
|
|
763
|
+
|
|
764
|
+
<div class="description">
|
|
765
|
+
Specifies whether an ancestor container, like oj-form-layout, is readonly.
|
|
766
|
+
This affects whether a readonly component renders in full or mixed readonly mode.
|
|
767
|
+
This is also currently used to determine if there is an ancestor container by checking if the value
|
|
768
|
+
is not equal to undefined.
|
|
769
|
+
</div>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<dl class="details">
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</dl>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
<h5>Names</h5>
|
|
809
|
+
<table class="keyboard-table">
|
|
810
|
+
<thead>
|
|
811
|
+
<tr>
|
|
812
|
+
<th>Item</th>
|
|
813
|
+
<th>Name</th>
|
|
814
|
+
</tr>
|
|
815
|
+
</thead>
|
|
816
|
+
<tbody>
|
|
817
|
+
<tr>
|
|
818
|
+
<td>Property</td>
|
|
819
|
+
<td><code class="prettyprint">containerReadonly</code></td>
|
|
820
|
+
</tr>
|
|
821
|
+
|
|
822
|
+
<tr>
|
|
823
|
+
<td>Property change event</td>
|
|
824
|
+
<td><code class="prettyprint">containerReadonlyChanged</code></td>
|
|
825
|
+
</tr>
|
|
826
|
+
<tr>
|
|
827
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
828
|
+
<td><code class="pretty-print-noprettify">on-container-readonly-changed</code></td>
|
|
829
|
+
</tr>
|
|
830
|
+
|
|
831
|
+
</tbody>
|
|
832
|
+
</table>
|
|
833
|
+
|
|
834
|
+
</dd>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<dt class="">
|
|
838
|
+
|
|
839
|
+
<h4 id="data" class="name">
|
|
840
|
+
|
|
841
|
+
<span class="type-signature"></span>data<span class="type-signature"> :DataProvider<K, D>|null</span>
|
|
842
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#data"></a>
|
|
843
|
+
|
|
844
|
+
</h4>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</dt>
|
|
848
|
+
|
|
849
|
+
<dd class="">
|
|
850
|
+
|
|
851
|
+
<div class="description">
|
|
852
|
+
The data for the Select Multiple.
|
|
853
|
+
</div>
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<dl class="details">
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<dt class="tag-default">Default Value:</dt>
|
|
865
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">null</code></li></ul></dd>
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
</dl>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<h5>Names</h5>
|
|
896
|
+
<table class="keyboard-table">
|
|
897
|
+
<thead>
|
|
898
|
+
<tr>
|
|
899
|
+
<th>Item</th>
|
|
900
|
+
<th>Name</th>
|
|
901
|
+
</tr>
|
|
902
|
+
</thead>
|
|
903
|
+
<tbody>
|
|
904
|
+
<tr>
|
|
905
|
+
<td>Property</td>
|
|
906
|
+
<td><code class="prettyprint">data</code></td>
|
|
907
|
+
</tr>
|
|
908
|
+
|
|
909
|
+
<tr>
|
|
910
|
+
<td>Property change event</td>
|
|
911
|
+
<td><code class="prettyprint">dataChanged</code></td>
|
|
912
|
+
</tr>
|
|
913
|
+
<tr>
|
|
914
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
915
|
+
<td><code class="pretty-print-noprettify">on-data-changed</code></td>
|
|
916
|
+
</tr>
|
|
917
|
+
|
|
918
|
+
</tbody>
|
|
919
|
+
</table>
|
|
920
|
+
|
|
921
|
+
</dd>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
<dt class="">
|
|
925
|
+
|
|
926
|
+
<h4 id="disabled" class="name">
|
|
927
|
+
|
|
928
|
+
<span class="type-signature"></span>disabled<span class="type-signature"> :boolean</span>
|
|
929
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#disabled"></a>
|
|
930
|
+
|
|
931
|
+
</h4>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
</dt>
|
|
935
|
+
|
|
936
|
+
<dd class="">
|
|
937
|
+
|
|
938
|
+
<div class="description">
|
|
939
|
+
Whether the component is disabled. The default is false.
|
|
940
|
+
|
|
941
|
+
<p>
|
|
942
|
+
When the <code class="prettyprint">disabled</code> property changes due to programmatic
|
|
943
|
+
intervention, the component may clear messages and run validation in some cases. </br>
|
|
944
|
+
<ul>
|
|
945
|
+
<li>when a required component is initialized as disabled
|
|
946
|
+
<code class="prettyprint">value="{{currentValue}}" required disabled</code>,
|
|
947
|
+
deferred validation is skipped.</li>
|
|
948
|
+
<li>when a disabled component is enabled,
|
|
949
|
+
<ul>
|
|
950
|
+
<li>if component is invalid and showing messages then all component messages are cleared,
|
|
951
|
+
and full validation run using the display value.
|
|
952
|
+
<ul>
|
|
953
|
+
<li>if there are validation errors, they are shown.</li>
|
|
954
|
+
<li>if no errors result from the validation, the <code class="prettyprint">value</code>
|
|
955
|
+
property is updated. Page authors can listen to the <code class="prettyprint">valueChanged</code>
|
|
956
|
+
event to clear custom errors.</li>
|
|
957
|
+
</ul>
|
|
958
|
+
</li>
|
|
959
|
+
|
|
960
|
+
<li>if component is valid and has no errors then deferred validation is run.
|
|
961
|
+
<ul>
|
|
962
|
+
<li>if there is a deferred validation error, then the valid property is updated. </li>
|
|
963
|
+
</ul>
|
|
964
|
+
</li>
|
|
965
|
+
<li>if component is invalid and deferred errors then component messages are cleared and
|
|
966
|
+
deferred validation re-run.
|
|
967
|
+
<ul>
|
|
968
|
+
<li>if there is a deferred validation error, then the valid property is updated.</li>
|
|
969
|
+
</ul>
|
|
970
|
+
</li>
|
|
971
|
+
</ul>
|
|
972
|
+
</li>
|
|
973
|
+
<li>when enabled component is disabled then no validation is run and the component appears
|
|
974
|
+
disabled.</li>
|
|
975
|
+
</ul>
|
|
976
|
+
</p>
|
|
977
|
+
</div>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
<dl class="details">
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
<dt class="tag-default">Default Value:</dt>
|
|
989
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">false</code></li></ul></dd>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
</dl>
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
<h5>Names</h5>
|
|
1020
|
+
<table class="keyboard-table">
|
|
1021
|
+
<thead>
|
|
1022
|
+
<tr>
|
|
1023
|
+
<th>Item</th>
|
|
1024
|
+
<th>Name</th>
|
|
1025
|
+
</tr>
|
|
1026
|
+
</thead>
|
|
1027
|
+
<tbody>
|
|
1028
|
+
<tr>
|
|
1029
|
+
<td>Property</td>
|
|
1030
|
+
<td><code class="prettyprint">disabled</code></td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
|
|
1033
|
+
<tr>
|
|
1034
|
+
<td>Property change event</td>
|
|
1035
|
+
<td><code class="prettyprint">disabledChanged</code></td>
|
|
1036
|
+
</tr>
|
|
1037
|
+
<tr>
|
|
1038
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1039
|
+
<td><code class="pretty-print-noprettify">on-disabled-changed</code></td>
|
|
1040
|
+
</tr>
|
|
1041
|
+
|
|
1042
|
+
</tbody>
|
|
1043
|
+
</table>
|
|
1044
|
+
|
|
1045
|
+
</dd>
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
<dt class="">
|
|
1049
|
+
|
|
1050
|
+
<h4 id="displayOptions" class="name">
|
|
1051
|
+
|
|
1052
|
+
<span class="type-signature"></span>display-options<span class="type-signature"> :Object</span>
|
|
1053
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#displayOptions"></a>
|
|
1054
|
+
|
|
1055
|
+
</h4>
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
</dt>
|
|
1059
|
+
|
|
1060
|
+
<dd class="">
|
|
1061
|
+
|
|
1062
|
+
<div class="description">
|
|
1063
|
+
Display options for auxiliary content that determines whether or not it should be displayed.
|
|
1064
|
+
</div>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
<dl class="details">
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
</dl>
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
<h5>Names</h5>
|
|
1104
|
+
<table class="keyboard-table">
|
|
1105
|
+
<thead>
|
|
1106
|
+
<tr>
|
|
1107
|
+
<th>Item</th>
|
|
1108
|
+
<th>Name</th>
|
|
1109
|
+
</tr>
|
|
1110
|
+
</thead>
|
|
1111
|
+
<tbody>
|
|
1112
|
+
<tr>
|
|
1113
|
+
<td>Property</td>
|
|
1114
|
+
<td><code class="prettyprint">displayOptions</code></td>
|
|
1115
|
+
</tr>
|
|
1116
|
+
|
|
1117
|
+
<tr>
|
|
1118
|
+
<td>Property change event</td>
|
|
1119
|
+
<td><code class="prettyprint">displayOptionsChanged</code></td>
|
|
1120
|
+
</tr>
|
|
1121
|
+
<tr>
|
|
1122
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1123
|
+
<td><code class="pretty-print-noprettify">on-display-options-changed</code></td>
|
|
1124
|
+
</tr>
|
|
1125
|
+
|
|
1126
|
+
</tbody>
|
|
1127
|
+
</table>
|
|
1128
|
+
|
|
1129
|
+
</dd>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
<dt class="">
|
|
1133
|
+
|
|
1134
|
+
<h4 id="displayOptions.messages" class="name">
|
|
1135
|
+
|
|
1136
|
+
<span class="type-signature"></span>display-options.messages<span class="type-signature"> :"display"|"none"</span>
|
|
1137
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#displayOptions.messages"></a>
|
|
1138
|
+
|
|
1139
|
+
</h4>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</dt>
|
|
1143
|
+
|
|
1144
|
+
<dd class="">
|
|
1145
|
+
|
|
1146
|
+
<div class="description">
|
|
1147
|
+
Display options for auxiliary message text.
|
|
1148
|
+
</div>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<dl class="details">
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
<dt class="tag-default">Default Value:</dt>
|
|
1160
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">"display"</code></li></ul></dd>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
</dl>
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<h5>Names</h5>
|
|
1191
|
+
<table class="keyboard-table">
|
|
1192
|
+
<thead>
|
|
1193
|
+
<tr>
|
|
1194
|
+
<th>Item</th>
|
|
1195
|
+
<th>Name</th>
|
|
1196
|
+
</tr>
|
|
1197
|
+
</thead>
|
|
1198
|
+
<tbody>
|
|
1199
|
+
<tr>
|
|
1200
|
+
<td>Property</td>
|
|
1201
|
+
<td><code class="prettyprint">displayOptions.messages</code></td>
|
|
1202
|
+
</tr>
|
|
1203
|
+
|
|
1204
|
+
</tbody>
|
|
1205
|
+
</table>
|
|
1206
|
+
|
|
1207
|
+
</dd>
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
<dt class="">
|
|
1211
|
+
|
|
1212
|
+
<h4 id="help" class="name">
|
|
1213
|
+
|
|
1214
|
+
<span class="type-signature"></span>help<span class="type-signature"> :Object</span>
|
|
1215
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#help"></a>
|
|
1216
|
+
|
|
1217
|
+
</h4>
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
</dt>
|
|
1221
|
+
|
|
1222
|
+
<dd class="">
|
|
1223
|
+
|
|
1224
|
+
<div class="description">
|
|
1225
|
+
Form component help information.
|
|
1226
|
+
</div>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
<dl class="details">
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
</dl>
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
<h5>Names</h5>
|
|
1266
|
+
<table class="keyboard-table">
|
|
1267
|
+
<thead>
|
|
1268
|
+
<tr>
|
|
1269
|
+
<th>Item</th>
|
|
1270
|
+
<th>Name</th>
|
|
1271
|
+
</tr>
|
|
1272
|
+
</thead>
|
|
1273
|
+
<tbody>
|
|
1274
|
+
<tr>
|
|
1275
|
+
<td>Property</td>
|
|
1276
|
+
<td><code class="prettyprint">help</code></td>
|
|
1277
|
+
</tr>
|
|
1278
|
+
|
|
1279
|
+
<tr>
|
|
1280
|
+
<td>Property change event</td>
|
|
1281
|
+
<td><code class="prettyprint">helpChanged</code></td>
|
|
1282
|
+
</tr>
|
|
1283
|
+
<tr>
|
|
1284
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1285
|
+
<td><code class="pretty-print-noprettify">on-help-changed</code></td>
|
|
1286
|
+
</tr>
|
|
1287
|
+
|
|
1288
|
+
</tbody>
|
|
1289
|
+
</table>
|
|
1290
|
+
|
|
1291
|
+
</dd>
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
<dt class="">
|
|
1295
|
+
|
|
1296
|
+
<h4 id="help.instruction" class="name">
|
|
1297
|
+
|
|
1298
|
+
<span class="type-signature"></span>help.instruction<span class="type-signature"> :string</span>
|
|
1299
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#help.instruction"></a>
|
|
1300
|
+
|
|
1301
|
+
</h4>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
</dt>
|
|
1305
|
+
|
|
1306
|
+
<dd class="">
|
|
1307
|
+
|
|
1308
|
+
<div class="description">
|
|
1309
|
+
A type of user assistance text. User assistance text is used to provide guidance to
|
|
1310
|
+
help the user understand what data to enter or select.
|
|
1311
|
+
</div>
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
<dl class="details">
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<dt class="tag-default">Default Value:</dt>
|
|
1323
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">""</code></li></ul></dd>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
</dl>
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
<h5>Names</h5>
|
|
1354
|
+
<table class="keyboard-table">
|
|
1355
|
+
<thead>
|
|
1356
|
+
<tr>
|
|
1357
|
+
<th>Item</th>
|
|
1358
|
+
<th>Name</th>
|
|
1359
|
+
</tr>
|
|
1360
|
+
</thead>
|
|
1361
|
+
<tbody>
|
|
1362
|
+
<tr>
|
|
1363
|
+
<td>Property</td>
|
|
1364
|
+
<td><code class="prettyprint">help.instruction</code></td>
|
|
1365
|
+
</tr>
|
|
1366
|
+
|
|
1367
|
+
</tbody>
|
|
1368
|
+
</table>
|
|
1369
|
+
|
|
1370
|
+
</dd>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
<dt class="">
|
|
1374
|
+
|
|
1375
|
+
<h4 id="helpHints" class="name">
|
|
1376
|
+
|
|
1377
|
+
<span class="type-signature"></span>help-hints<span class="type-signature"> :Object</span>
|
|
1378
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#helpHints"></a>
|
|
1379
|
+
|
|
1380
|
+
</h4>
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
</dt>
|
|
1384
|
+
|
|
1385
|
+
<dd class="">
|
|
1386
|
+
|
|
1387
|
+
<div class="description">
|
|
1388
|
+
The helpHints object contains a definition property and a source property.
|
|
1389
|
+
</div>
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
<dl class="details">
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
</dl>
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
<h5>Names</h5>
|
|
1429
|
+
<table class="keyboard-table">
|
|
1430
|
+
<thead>
|
|
1431
|
+
<tr>
|
|
1432
|
+
<th>Item</th>
|
|
1433
|
+
<th>Name</th>
|
|
1434
|
+
</tr>
|
|
1435
|
+
</thead>
|
|
1436
|
+
<tbody>
|
|
1437
|
+
<tr>
|
|
1438
|
+
<td>Property</td>
|
|
1439
|
+
<td><code class="prettyprint">helpHints</code></td>
|
|
1440
|
+
</tr>
|
|
1441
|
+
|
|
1442
|
+
<tr>
|
|
1443
|
+
<td>Property change event</td>
|
|
1444
|
+
<td><code class="prettyprint">helpHintsChanged</code></td>
|
|
1445
|
+
</tr>
|
|
1446
|
+
<tr>
|
|
1447
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1448
|
+
<td><code class="pretty-print-noprettify">on-help-hints-changed</code></td>
|
|
1449
|
+
</tr>
|
|
1450
|
+
|
|
1451
|
+
</tbody>
|
|
1452
|
+
</table>
|
|
1453
|
+
|
|
1454
|
+
</dd>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
<dt class="">
|
|
1458
|
+
|
|
1459
|
+
<h4 id="helpHints.definition" class="name">
|
|
1460
|
+
|
|
1461
|
+
<span class="type-signature"></span>help-hints.definition<span class="type-signature"> :string</span>
|
|
1462
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#helpHints.definition"></a>
|
|
1463
|
+
|
|
1464
|
+
</h4>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
</dt>
|
|
1468
|
+
|
|
1469
|
+
<dd class="">
|
|
1470
|
+
|
|
1471
|
+
<div class="description">
|
|
1472
|
+
A type of user assistance text. User assistance text is used to provide guidance to help
|
|
1473
|
+
the user understand what data to enter or select. help-hints could come from a help system.
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
<dl class="details">
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
<dt class="tag-default">Default Value:</dt>
|
|
1486
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">""</code></li></ul></dd>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
</dl>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
<h5>Names</h5>
|
|
1517
|
+
<table class="keyboard-table">
|
|
1518
|
+
<thead>
|
|
1519
|
+
<tr>
|
|
1520
|
+
<th>Item</th>
|
|
1521
|
+
<th>Name</th>
|
|
1522
|
+
</tr>
|
|
1523
|
+
</thead>
|
|
1524
|
+
<tbody>
|
|
1525
|
+
<tr>
|
|
1526
|
+
<td>Property</td>
|
|
1527
|
+
<td><code class="prettyprint">helpHints.definition</code></td>
|
|
1528
|
+
</tr>
|
|
1529
|
+
|
|
1530
|
+
</tbody>
|
|
1531
|
+
</table>
|
|
1532
|
+
|
|
1533
|
+
</dd>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
<dt class="">
|
|
1537
|
+
|
|
1538
|
+
<h4 id="helpHints.source" class="name">
|
|
1539
|
+
|
|
1540
|
+
<span class="type-signature"></span>help-hints.source<span class="type-signature"> :string</span>
|
|
1541
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#helpHints.source"></a>
|
|
1542
|
+
|
|
1543
|
+
</h4>
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
</dt>
|
|
1547
|
+
|
|
1548
|
+
<dd class="">
|
|
1549
|
+
|
|
1550
|
+
<div class="description">
|
|
1551
|
+
Help source URL associated with the component.
|
|
1552
|
+
</div>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
<dl class="details">
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
<dt class="tag-default">Default Value:</dt>
|
|
1564
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">""</code></li></ul></dd>
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
</dl>
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
<h5>Names</h5>
|
|
1595
|
+
<table class="keyboard-table">
|
|
1596
|
+
<thead>
|
|
1597
|
+
<tr>
|
|
1598
|
+
<th>Item</th>
|
|
1599
|
+
<th>Name</th>
|
|
1600
|
+
</tr>
|
|
1601
|
+
</thead>
|
|
1602
|
+
<tbody>
|
|
1603
|
+
<tr>
|
|
1604
|
+
<td>Property</td>
|
|
1605
|
+
<td><code class="prettyprint">helpHints.source</code></td>
|
|
1606
|
+
</tr>
|
|
1607
|
+
|
|
1608
|
+
</tbody>
|
|
1609
|
+
</table>
|
|
1610
|
+
|
|
1611
|
+
</dd>
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
<dt class="">
|
|
1615
|
+
|
|
1616
|
+
<h4 id="helpHints.sourceText" class="name">
|
|
1617
|
+
|
|
1618
|
+
<span class="type-signature"></span>help-hints.source-text<span class="type-signature"> :string</span>
|
|
1619
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#helpHints.sourceText"></a>
|
|
1620
|
+
|
|
1621
|
+
</h4>
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
</dt>
|
|
1625
|
+
|
|
1626
|
+
<dd class="">
|
|
1627
|
+
|
|
1628
|
+
<div class="description">
|
|
1629
|
+
Custom text to be used for the source link.
|
|
1630
|
+
</div>
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
<dl class="details">
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
</dl>
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
<h5>Names</h5>
|
|
1670
|
+
<table class="keyboard-table">
|
|
1671
|
+
<thead>
|
|
1672
|
+
<tr>
|
|
1673
|
+
<th>Item</th>
|
|
1674
|
+
<th>Name</th>
|
|
1675
|
+
</tr>
|
|
1676
|
+
</thead>
|
|
1677
|
+
<tbody>
|
|
1678
|
+
<tr>
|
|
1679
|
+
<td>Property</td>
|
|
1680
|
+
<td><code class="prettyprint">helpHints.sourceText</code></td>
|
|
1681
|
+
</tr>
|
|
1682
|
+
|
|
1683
|
+
</tbody>
|
|
1684
|
+
</table>
|
|
1685
|
+
|
|
1686
|
+
</dd>
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
<dt class="">
|
|
1690
|
+
|
|
1691
|
+
<h4 id="itemText" class="name">
|
|
1692
|
+
|
|
1693
|
+
<span class="type-signature"></span>item-text<span class="type-signature"> :keyof D|(itemContext: ItemContext<K, D>) => string</span>
|
|
1694
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#itemText"></a>
|
|
1695
|
+
|
|
1696
|
+
</h4>
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
</dt>
|
|
1700
|
+
|
|
1701
|
+
<dd class="">
|
|
1702
|
+
|
|
1703
|
+
<div class="description">
|
|
1704
|
+
Specifies how to get the text string to render for a data item.
|
|
1705
|
+
This attribute can be set to either:
|
|
1706
|
+
<ul>
|
|
1707
|
+
<li>a string that specifies the name of a top level data attribute to render as text, or</li>
|
|
1708
|
+
<li>a callback function that takes a properties object and returns the text string to
|
|
1709
|
+
display</li>
|
|
1710
|
+
</ul>
|
|
1711
|
+
|
|
1712
|
+
<p>This text will be rendered for the selected value of the component and for each data item
|
|
1713
|
+
in the dropdown. When rendered for the dropdown items, default matching search term
|
|
1714
|
+
highlighting will be applied.</p>
|
|
1715
|
+
</div>
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
<dl class="details">
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
</dl>
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
<h5>Names</h5>
|
|
1755
|
+
<table class="keyboard-table">
|
|
1756
|
+
<thead>
|
|
1757
|
+
<tr>
|
|
1758
|
+
<th>Item</th>
|
|
1759
|
+
<th>Name</th>
|
|
1760
|
+
</tr>
|
|
1761
|
+
</thead>
|
|
1762
|
+
<tbody>
|
|
1763
|
+
<tr>
|
|
1764
|
+
<td>Property</td>
|
|
1765
|
+
<td><code class="prettyprint">itemText</code></td>
|
|
1766
|
+
</tr>
|
|
1767
|
+
|
|
1768
|
+
<tr>
|
|
1769
|
+
<td>Property change event</td>
|
|
1770
|
+
<td><code class="prettyprint">itemTextChanged</code></td>
|
|
1771
|
+
</tr>
|
|
1772
|
+
<tr>
|
|
1773
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1774
|
+
<td><code class="pretty-print-noprettify">on-item-text-changed</code></td>
|
|
1775
|
+
</tr>
|
|
1776
|
+
|
|
1777
|
+
</tbody>
|
|
1778
|
+
</table>
|
|
1779
|
+
|
|
1780
|
+
</dd>
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
<dt class="">
|
|
1784
|
+
|
|
1785
|
+
<h4 id="labelEdge" class="name">
|
|
1786
|
+
|
|
1787
|
+
<span class="type-signature"></span>label-edge<span class="type-signature"> :"inside"|"none"|"start"|"top"</span>
|
|
1788
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#labelEdge"></a>
|
|
1789
|
+
|
|
1790
|
+
</h4>
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
</dt>
|
|
1794
|
+
|
|
1795
|
+
<dd class="">
|
|
1796
|
+
|
|
1797
|
+
<div class="description">
|
|
1798
|
+
Specifies how the label of the component is positioned when the label-hint
|
|
1799
|
+
attribute is set on the component.
|
|
1800
|
+
</div>
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
<dl class="details">
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
1811
|
+
|
|
1812
|
+
<dl>
|
|
1813
|
+
|
|
1814
|
+
<table class="props">
|
|
1815
|
+
<thead>
|
|
1816
|
+
<tr>
|
|
1817
|
+
|
|
1818
|
+
<th>Value</th>
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
<th class="last">Description</th>
|
|
1827
|
+
|
|
1828
|
+
</tr>
|
|
1829
|
+
</thead>
|
|
1830
|
+
|
|
1831
|
+
<tbody>
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
<tr>
|
|
1835
|
+
|
|
1836
|
+
<td class="name"><code>inside</code></td>
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
<td class="description last">The label floats over the input element, but moves up on focus or when the component has a value (default, if unspecified).
|
|
1845
|
+
</td>
|
|
1846
|
+
|
|
1847
|
+
</tr>
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
<tr>
|
|
1852
|
+
|
|
1853
|
+
<td class="name"><code>none</code></td>
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
<td class="description last">The component will not create a label, but instead set the aria-label property on the input element.
|
|
1862
|
+
</td>
|
|
1863
|
+
|
|
1864
|
+
</tr>
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
<tr>
|
|
1869
|
+
|
|
1870
|
+
<td class="name"><code>start</code></td>
|
|
1871
|
+
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
<td class="description last">The label will be placed before the start of the component.
|
|
1879
|
+
</td>
|
|
1880
|
+
|
|
1881
|
+
</tr>
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
<tr>
|
|
1886
|
+
|
|
1887
|
+
<td class="name"><code>top</code></td>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
<td class="description last">The label will be placed on top of the component.
|
|
1896
|
+
</td>
|
|
1897
|
+
|
|
1898
|
+
</tr>
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
</tbody>
|
|
1902
|
+
</table></dl>
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
</dl>
|
|
1932
|
+
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
<h5>Names</h5>
|
|
1936
|
+
<table class="keyboard-table">
|
|
1937
|
+
<thead>
|
|
1938
|
+
<tr>
|
|
1939
|
+
<th>Item</th>
|
|
1940
|
+
<th>Name</th>
|
|
1941
|
+
</tr>
|
|
1942
|
+
</thead>
|
|
1943
|
+
<tbody>
|
|
1944
|
+
<tr>
|
|
1945
|
+
<td>Property</td>
|
|
1946
|
+
<td><code class="prettyprint">labelEdge</code></td>
|
|
1947
|
+
</tr>
|
|
1948
|
+
|
|
1949
|
+
<tr>
|
|
1950
|
+
<td>Property change event</td>
|
|
1951
|
+
<td><code class="prettyprint">labelEdgeChanged</code></td>
|
|
1952
|
+
</tr>
|
|
1953
|
+
<tr>
|
|
1954
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
1955
|
+
<td><code class="pretty-print-noprettify">on-label-edge-changed</code></td>
|
|
1956
|
+
</tr>
|
|
1957
|
+
|
|
1958
|
+
</tbody>
|
|
1959
|
+
</table>
|
|
1960
|
+
|
|
1961
|
+
</dd>
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
<dt class="">
|
|
1965
|
+
|
|
1966
|
+
<h4 id="labelHint" class="name">
|
|
1967
|
+
|
|
1968
|
+
<span class="type-signature"></span>label-hint<span class="type-signature"> :string</span>
|
|
1969
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#labelHint"></a>
|
|
1970
|
+
|
|
1971
|
+
</h4>
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
</dt>
|
|
1975
|
+
|
|
1976
|
+
<dd class="">
|
|
1977
|
+
|
|
1978
|
+
<div class="description">
|
|
1979
|
+
Represents a hint for rendering a label on the component.
|
|
1980
|
+
This is used in combination with the label-edge attribute to control how the label should be rendered.
|
|
1981
|
+
</div>
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
<dl class="details">
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
</dl>
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
<h5>Names</h5>
|
|
2021
|
+
<table class="keyboard-table">
|
|
2022
|
+
<thead>
|
|
2023
|
+
<tr>
|
|
2024
|
+
<th>Item</th>
|
|
2025
|
+
<th>Name</th>
|
|
2026
|
+
</tr>
|
|
2027
|
+
</thead>
|
|
2028
|
+
<tbody>
|
|
2029
|
+
<tr>
|
|
2030
|
+
<td>Property</td>
|
|
2031
|
+
<td><code class="prettyprint">labelHint</code></td>
|
|
2032
|
+
</tr>
|
|
2033
|
+
|
|
2034
|
+
<tr>
|
|
2035
|
+
<td>Property change event</td>
|
|
2036
|
+
<td><code class="prettyprint">labelHintChanged</code></td>
|
|
2037
|
+
</tr>
|
|
2038
|
+
<tr>
|
|
2039
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2040
|
+
<td><code class="pretty-print-noprettify">on-label-hint-changed</code></td>
|
|
2041
|
+
</tr>
|
|
2042
|
+
|
|
2043
|
+
</tbody>
|
|
2044
|
+
</table>
|
|
2045
|
+
|
|
2046
|
+
</dd>
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
<dt class="">
|
|
2050
|
+
|
|
2051
|
+
<h4 id="labelStartWidth" class="name">
|
|
2052
|
+
|
|
2053
|
+
<span class="type-signature"></span>label-start-width<span class="type-signature"> :string</span>
|
|
2054
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#labelStartWidth"></a>
|
|
2055
|
+
|
|
2056
|
+
</h4>
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
</dt>
|
|
2060
|
+
|
|
2061
|
+
<dd class="">
|
|
2062
|
+
|
|
2063
|
+
<div class="description">
|
|
2064
|
+
The width of the label when labelEdge is 'start'
|
|
2065
|
+
</div>
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
<dl class="details">
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
</dl>
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
<h5>Names</h5>
|
|
2105
|
+
<table class="keyboard-table">
|
|
2106
|
+
<thead>
|
|
2107
|
+
<tr>
|
|
2108
|
+
<th>Item</th>
|
|
2109
|
+
<th>Name</th>
|
|
2110
|
+
</tr>
|
|
2111
|
+
</thead>
|
|
2112
|
+
<tbody>
|
|
2113
|
+
<tr>
|
|
2114
|
+
<td>Property</td>
|
|
2115
|
+
<td><code class="prettyprint">labelStartWidth</code></td>
|
|
2116
|
+
</tr>
|
|
2117
|
+
|
|
2118
|
+
<tr>
|
|
2119
|
+
<td>Property change event</td>
|
|
2120
|
+
<td><code class="prettyprint">labelStartWidthChanged</code></td>
|
|
2121
|
+
</tr>
|
|
2122
|
+
<tr>
|
|
2123
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2124
|
+
<td><code class="pretty-print-noprettify">on-label-start-width-changed</code></td>
|
|
2125
|
+
</tr>
|
|
2126
|
+
|
|
2127
|
+
</tbody>
|
|
2128
|
+
</table>
|
|
2129
|
+
|
|
2130
|
+
</dd>
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
<dt class="">
|
|
2134
|
+
|
|
2135
|
+
<h4 id="labelWrapping" class="name">
|
|
2136
|
+
|
|
2137
|
+
<span class="type-signature"></span>label-wrapping<span class="type-signature"> :"truncate"|"wrap"</span>
|
|
2138
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#labelWrapping"></a>
|
|
2139
|
+
|
|
2140
|
+
</h4>
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
</dt>
|
|
2144
|
+
|
|
2145
|
+
<dd class="">
|
|
2146
|
+
|
|
2147
|
+
<div class="description">
|
|
2148
|
+
Should the labels wrap or truncate when there is not enough available space.
|
|
2149
|
+
</div>
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
<dl class="details">
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
2160
|
+
|
|
2161
|
+
<dl>
|
|
2162
|
+
|
|
2163
|
+
<table class="props">
|
|
2164
|
+
<thead>
|
|
2165
|
+
<tr>
|
|
2166
|
+
|
|
2167
|
+
<th>Value</th>
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
<th class="last">Description</th>
|
|
2176
|
+
|
|
2177
|
+
</tr>
|
|
2178
|
+
</thead>
|
|
2179
|
+
|
|
2180
|
+
<tbody>
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
<tr>
|
|
2184
|
+
|
|
2185
|
+
<td class="name"><code>truncate</code></td>
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
<td class="description last">Label will truncate if needed.
|
|
2194
|
+
</td>
|
|
2195
|
+
|
|
2196
|
+
</tr>
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
<tr>
|
|
2201
|
+
|
|
2202
|
+
<td class="name"><code>wrap</code></td>
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
<td class="description last">Label will wrap if needed.
|
|
2211
|
+
</td>
|
|
2212
|
+
|
|
2213
|
+
</tr>
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
</tbody>
|
|
2217
|
+
</table></dl>
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
</dl>
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
<h5>Names</h5>
|
|
2251
|
+
<table class="keyboard-table">
|
|
2252
|
+
<thead>
|
|
2253
|
+
<tr>
|
|
2254
|
+
<th>Item</th>
|
|
2255
|
+
<th>Name</th>
|
|
2256
|
+
</tr>
|
|
2257
|
+
</thead>
|
|
2258
|
+
<tbody>
|
|
2259
|
+
<tr>
|
|
2260
|
+
<td>Property</td>
|
|
2261
|
+
<td><code class="prettyprint">labelWrapping</code></td>
|
|
2262
|
+
</tr>
|
|
2263
|
+
|
|
2264
|
+
<tr>
|
|
2265
|
+
<td>Property change event</td>
|
|
2266
|
+
<td><code class="prettyprint">labelWrappingChanged</code></td>
|
|
2267
|
+
</tr>
|
|
2268
|
+
<tr>
|
|
2269
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2270
|
+
<td><code class="pretty-print-noprettify">on-label-wrapping-changed</code></td>
|
|
2271
|
+
</tr>
|
|
2272
|
+
|
|
2273
|
+
</tbody>
|
|
2274
|
+
</table>
|
|
2275
|
+
|
|
2276
|
+
</dd>
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
<dt class="">
|
|
2280
|
+
|
|
2281
|
+
<h4 id="messagesCustom" class="name">
|
|
2282
|
+
|
|
2283
|
+
<span class="type-signature"></span>messages-custom<span class="type-signature"> :Array<ComponentMessageItem></span>
|
|
2284
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#messagesCustom"></a>
|
|
2285
|
+
|
|
2286
|
+
</h4>
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
</dt>
|
|
2290
|
+
|
|
2291
|
+
<dd class="">
|
|
2292
|
+
|
|
2293
|
+
<div class="description">
|
|
2294
|
+
List of messages an app would add to the component when it has business/custom validation
|
|
2295
|
+
errors that it wants the component to show. This allows the app to perform further validation
|
|
2296
|
+
before sending data to the server. When this option is set the message shows to the
|
|
2297
|
+
user right away. To clear the custom message, set <code class="prettyprint">messagesCustom</code>
|
|
2298
|
+
back to an empty array.<br/>
|
|
2299
|
+
<p>
|
|
2300
|
+
See the <a href="#validation-section">Validation and Messages</a> section
|
|
2301
|
+
for details on when the component clears <code class="prettyprint">messagesCustom</code>;
|
|
2302
|
+
for example, when full validation is run.
|
|
2303
|
+
</p>
|
|
2304
|
+
</div>
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
<dl class="details">
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
<dt class="tag-default">Default Value:</dt>
|
|
2316
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">[]</code></li></ul></dd>
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
<dt class="tag-default">Supports writeback:</dt>
|
|
2321
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">true</code></li></ul></dd>
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
</dl>
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
|
|
2349
|
+
<h5>Names</h5>
|
|
2350
|
+
<table class="keyboard-table">
|
|
2351
|
+
<thead>
|
|
2352
|
+
<tr>
|
|
2353
|
+
<th>Item</th>
|
|
2354
|
+
<th>Name</th>
|
|
2355
|
+
</tr>
|
|
2356
|
+
</thead>
|
|
2357
|
+
<tbody>
|
|
2358
|
+
<tr>
|
|
2359
|
+
<td>Property</td>
|
|
2360
|
+
<td><code class="prettyprint">messagesCustom</code></td>
|
|
2361
|
+
</tr>
|
|
2362
|
+
|
|
2363
|
+
<tr>
|
|
2364
|
+
<td>Property change event</td>
|
|
2365
|
+
<td><code class="prettyprint">messagesCustomChanged</code></td>
|
|
2366
|
+
</tr>
|
|
2367
|
+
<tr>
|
|
2368
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2369
|
+
<td><code class="pretty-print-noprettify">on-messages-custom-changed</code></td>
|
|
2370
|
+
</tr>
|
|
2371
|
+
|
|
2372
|
+
</tbody>
|
|
2373
|
+
</table>
|
|
2374
|
+
|
|
2375
|
+
</dd>
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
<dt class="">
|
|
2379
|
+
|
|
2380
|
+
<h4 id="messagesCustom[].detail" class="name">
|
|
2381
|
+
|
|
2382
|
+
<span class="type-signature"></span>messagesCustom[].detail<span class="type-signature"> :string</span>
|
|
2383
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#messagesCustom[].detail"></a>
|
|
2384
|
+
|
|
2385
|
+
</h4>
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
</dt>
|
|
2389
|
+
|
|
2390
|
+
<dd class="">
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
|
|
2395
|
+
<dl class="details">
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
</dl>
|
|
2426
|
+
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
<div class="description">
|
|
2430
|
+
<b>Note: </b> This property is a subproperty of an array-valued property. <i>Such properties cannot be set individually
|
|
2431
|
+
either at init time via HTML attribute syntax or at runtime via JavaScript.</i> Instead, the outermost array-valued attribute, and its ancestor attributes,
|
|
2432
|
+
can be set at init time or runtime.
|
|
2433
|
+
</div>
|
|
2434
|
+
|
|
2435
|
+
</dd>
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
<dt class="">
|
|
2439
|
+
|
|
2440
|
+
<h4 id="messagesCustom[].severity" class="name">
|
|
2441
|
+
|
|
2442
|
+
<span class="type-signature"></span>messagesCustom[].severity<span class="type-signature"> :"error"|"confirmation"|"info"|"warning"</span>
|
|
2443
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#messagesCustom[].severity"></a>
|
|
2444
|
+
|
|
2445
|
+
</h4>
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
</dt>
|
|
2449
|
+
|
|
2450
|
+
<dd class="">
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
<dl class="details">
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
</dl>
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
<div class="description">
|
|
2490
|
+
<b>Note: </b> This property is a subproperty of an array-valued property. <i>Such properties cannot be set individually
|
|
2491
|
+
either at init time via HTML attribute syntax or at runtime via JavaScript.</i> Instead, the outermost array-valued attribute, and its ancestor attributes,
|
|
2492
|
+
can be set at init time or runtime.
|
|
2493
|
+
</div>
|
|
2494
|
+
|
|
2495
|
+
</dd>
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
<dt class="">
|
|
2499
|
+
|
|
2500
|
+
<h4 id="messagesCustom[].summary" class="name">
|
|
2501
|
+
|
|
2502
|
+
<span class="type-signature"></span>messagesCustom[].summary<span class="type-signature"> :string</span>
|
|
2503
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#messagesCustom[].summary"></a>
|
|
2504
|
+
|
|
2505
|
+
</h4>
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
</dt>
|
|
2509
|
+
|
|
2510
|
+
<dd class="">
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
<dl class="details">
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
</dl>
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
<div class="description">
|
|
2550
|
+
<b>Note: </b> This property is a subproperty of an array-valued property. <i>Such properties cannot be set individually
|
|
2551
|
+
either at init time via HTML attribute syntax or at runtime via JavaScript.</i> Instead, the outermost array-valued attribute, and its ancestor attributes,
|
|
2552
|
+
can be set at init time or runtime.
|
|
2553
|
+
</div>
|
|
2554
|
+
|
|
2555
|
+
</dd>
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
<dt class="">
|
|
2559
|
+
|
|
2560
|
+
<h4 id="placeholder" class="name">
|
|
2561
|
+
|
|
2562
|
+
<span class="type-signature"></span>placeholder<span class="type-signature"> :string</span>
|
|
2563
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#placeholder"></a>
|
|
2564
|
+
|
|
2565
|
+
</h4>
|
|
2566
|
+
|
|
2567
|
+
|
|
2568
|
+
</dt>
|
|
2569
|
+
|
|
2570
|
+
<dd class="">
|
|
2571
|
+
|
|
2572
|
+
<div class="description">
|
|
2573
|
+
The placeholder text to set on the element.
|
|
2574
|
+
</div>
|
|
2575
|
+
|
|
2576
|
+
|
|
2577
|
+
|
|
2578
|
+
|
|
2579
|
+
<dl class="details">
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
|
|
2587
|
+
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
|
|
2592
|
+
|
|
2593
|
+
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
</dl>
|
|
2610
|
+
|
|
2611
|
+
|
|
2612
|
+
|
|
2613
|
+
<h5>Names</h5>
|
|
2614
|
+
<table class="keyboard-table">
|
|
2615
|
+
<thead>
|
|
2616
|
+
<tr>
|
|
2617
|
+
<th>Item</th>
|
|
2618
|
+
<th>Name</th>
|
|
2619
|
+
</tr>
|
|
2620
|
+
</thead>
|
|
2621
|
+
<tbody>
|
|
2622
|
+
<tr>
|
|
2623
|
+
<td>Property</td>
|
|
2624
|
+
<td><code class="prettyprint">placeholder</code></td>
|
|
2625
|
+
</tr>
|
|
2626
|
+
|
|
2627
|
+
<tr>
|
|
2628
|
+
<td>Property change event</td>
|
|
2629
|
+
<td><code class="prettyprint">placeholderChanged</code></td>
|
|
2630
|
+
</tr>
|
|
2631
|
+
<tr>
|
|
2632
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2633
|
+
<td><code class="pretty-print-noprettify">on-placeholder-changed</code></td>
|
|
2634
|
+
</tr>
|
|
2635
|
+
|
|
2636
|
+
</tbody>
|
|
2637
|
+
</table>
|
|
2638
|
+
|
|
2639
|
+
</dd>
|
|
2640
|
+
|
|
2641
|
+
|
|
2642
|
+
<dt class="">
|
|
2643
|
+
|
|
2644
|
+
<h4 id="readonly" class="name">
|
|
2645
|
+
|
|
2646
|
+
<span class="type-signature"></span>readonly<span class="type-signature"> :boolean</span>
|
|
2647
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#readonly"></a>
|
|
2648
|
+
|
|
2649
|
+
</h4>
|
|
2650
|
+
|
|
2651
|
+
|
|
2652
|
+
</dt>
|
|
2653
|
+
|
|
2654
|
+
<dd class="">
|
|
2655
|
+
|
|
2656
|
+
<div class="description">
|
|
2657
|
+
Whether the component is readonly. The readonly property sets or returns whether an element
|
|
2658
|
+
is readonly, or not. A readonly element cannot be modified. However, a user can tab to it,
|
|
2659
|
+
highlight it, focus on it, and copy the text from it. If you want to prevent the user from
|
|
2660
|
+
interacting with the element, use the disabled property instead.
|
|
2661
|
+
</div>
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
<dl class="details">
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
|
|
2671
|
+
|
|
2672
|
+
<dt class="tag-default">Default Value:</dt>
|
|
2673
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">false</code></li></ul></dd>
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
|
|
2678
|
+
|
|
2679
|
+
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
|
|
2686
|
+
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
|
|
2697
|
+
|
|
2698
|
+
|
|
2699
|
+
</dl>
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
|
|
2703
|
+
<h5>Names</h5>
|
|
2704
|
+
<table class="keyboard-table">
|
|
2705
|
+
<thead>
|
|
2706
|
+
<tr>
|
|
2707
|
+
<th>Item</th>
|
|
2708
|
+
<th>Name</th>
|
|
2709
|
+
</tr>
|
|
2710
|
+
</thead>
|
|
2711
|
+
<tbody>
|
|
2712
|
+
<tr>
|
|
2713
|
+
<td>Property</td>
|
|
2714
|
+
<td><code class="prettyprint">readonly</code></td>
|
|
2715
|
+
</tr>
|
|
2716
|
+
|
|
2717
|
+
<tr>
|
|
2718
|
+
<td>Property change event</td>
|
|
2719
|
+
<td><code class="prettyprint">readonlyChanged</code></td>
|
|
2720
|
+
</tr>
|
|
2721
|
+
<tr>
|
|
2722
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2723
|
+
<td><code class="pretty-print-noprettify">on-readonly-changed</code></td>
|
|
2724
|
+
</tr>
|
|
2725
|
+
|
|
2726
|
+
</tbody>
|
|
2727
|
+
</table>
|
|
2728
|
+
|
|
2729
|
+
</dd>
|
|
2730
|
+
|
|
2731
|
+
|
|
2732
|
+
<dt class="">
|
|
2733
|
+
|
|
2734
|
+
<h4 id="required" class="name">
|
|
2735
|
+
|
|
2736
|
+
<span class="type-signature"></span>required<span class="type-signature"> :boolean</span>
|
|
2737
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#required"></a>
|
|
2738
|
+
|
|
2739
|
+
</h4>
|
|
2740
|
+
|
|
2741
|
+
|
|
2742
|
+
</dt>
|
|
2743
|
+
|
|
2744
|
+
<dd class="">
|
|
2745
|
+
|
|
2746
|
+
<div class="description">
|
|
2747
|
+
<p>
|
|
2748
|
+
This property set to <code class="prettyprint">false</code> implies that a value is not required to be provided by the user.
|
|
2749
|
+
This is the default.
|
|
2750
|
+
This property set to <code class="prettyprint">true</code> implies that a value is required to be provided by the user.
|
|
2751
|
+
</p>
|
|
2752
|
+
<p>
|
|
2753
|
+
In the Redwood theme, by default, a Required text is rendered inline when the field is empty.
|
|
2754
|
+
If user-assistance-density is 'compact', it will show on the label as an icon.
|
|
2755
|
+
</p>
|
|
2756
|
+
<p>The Required error text is based on Redwood UX designs, and it is not recommended that
|
|
2757
|
+
it be changed.
|
|
2758
|
+
To override the required error message,
|
|
2759
|
+
use the <code class="prettyprint">required-message-detail</code> attribute.
|
|
2760
|
+
The component's label text is passed in as a token {label} and can be used in the message detail.
|
|
2761
|
+
</p>
|
|
2762
|
+
<p>When required is set to true, an implicit
|
|
2763
|
+
required validator is created, i.e.,
|
|
2764
|
+
<code class="prettyprint">new RequiredValidator()</code>. The required validator is the only
|
|
2765
|
+
validator to run during initial render, and its error is not shown to the user at this time;
|
|
2766
|
+
this is called deferred validation. The required validator also runs during normal validation;
|
|
2767
|
+
this is when the errors are shown to the user.
|
|
2768
|
+
See the <a href="#validation-section">Validation and Messaging</a> section for details.
|
|
2769
|
+
</p>
|
|
2770
|
+
<p>
|
|
2771
|
+
When the <code class="prettyprint">required</code> property changes due to programmatic intervention,
|
|
2772
|
+
the component may clear component messages and run validation, based on the current state it's in. </br>
|
|
2773
|
+
|
|
2774
|
+
<h4>Running Validation when required property changes</h4>
|
|
2775
|
+
<ul>
|
|
2776
|
+
<li>if component is valid when required is set to true, then it runs deferred validation on
|
|
2777
|
+
the value property. If the field is empty, the valid state is invalidHidden. No errors are
|
|
2778
|
+
shown to the user.
|
|
2779
|
+
</li>
|
|
2780
|
+
<li>if component is invalid and has deferred messages when required is set to false, then
|
|
2781
|
+
component messages are cleared (messages-custom messages are not cleared)
|
|
2782
|
+
but no deferred validation is run because required is false.
|
|
2783
|
+
</li>
|
|
2784
|
+
<li>if component is invalid and currently showing invalid messages when required is set, then
|
|
2785
|
+
component messages are cleared and normal validation is run using the current display value.
|
|
2786
|
+
<ul>
|
|
2787
|
+
<li>if there are validation errors, then <code class="prettyprint">value</code>
|
|
2788
|
+
property is not updated and the error is shown.
|
|
2789
|
+
</li>
|
|
2790
|
+
<li>if no errors result from the validation, the <code class="prettyprint">value</code>
|
|
2791
|
+
property is updated; page author can listen to the <code class="prettyprint">valueChanged</code>
|
|
2792
|
+
event on the component to clear custom errors.</li>
|
|
2793
|
+
</ul>
|
|
2794
|
+
</li>
|
|
2795
|
+
</ul>
|
|
2796
|
+
|
|
2797
|
+
<h4>Clearing Messages when required property changes</h4>
|
|
2798
|
+
<ul>
|
|
2799
|
+
<li>Only messages created by the component, like validation messages, are cleared when the required property changes.</li>
|
|
2800
|
+
<li><code class="prettyprint">messagesCustom</code> property is not cleared.</li>
|
|
2801
|
+
</ul>
|
|
2802
|
+
|
|
2803
|
+
</p>
|
|
2804
|
+
</div>
|
|
2805
|
+
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
<dl class="details">
|
|
2810
|
+
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
|
|
2814
|
+
|
|
2815
|
+
<dt class="tag-default">Default Value:</dt>
|
|
2816
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">false</code></li></ul></dd>
|
|
2817
|
+
|
|
2818
|
+
|
|
2819
|
+
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
|
|
2823
|
+
|
|
2824
|
+
|
|
2825
|
+
|
|
2826
|
+
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
|
|
2831
|
+
|
|
2832
|
+
|
|
2833
|
+
|
|
2834
|
+
|
|
2835
|
+
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
</dl>
|
|
2843
|
+
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
<h5>Names</h5>
|
|
2847
|
+
<table class="keyboard-table">
|
|
2848
|
+
<thead>
|
|
2849
|
+
<tr>
|
|
2850
|
+
<th>Item</th>
|
|
2851
|
+
<th>Name</th>
|
|
2852
|
+
</tr>
|
|
2853
|
+
</thead>
|
|
2854
|
+
<tbody>
|
|
2855
|
+
<tr>
|
|
2856
|
+
<td>Property</td>
|
|
2857
|
+
<td><code class="prettyprint">required</code></td>
|
|
2858
|
+
</tr>
|
|
2859
|
+
|
|
2860
|
+
<tr>
|
|
2861
|
+
<td>Property change event</td>
|
|
2862
|
+
<td><code class="prettyprint">requiredChanged</code></td>
|
|
2863
|
+
</tr>
|
|
2864
|
+
<tr>
|
|
2865
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2866
|
+
<td><code class="pretty-print-noprettify">on-required-changed</code></td>
|
|
2867
|
+
</tr>
|
|
2868
|
+
|
|
2869
|
+
</tbody>
|
|
2870
|
+
</table>
|
|
2871
|
+
|
|
2872
|
+
</dd>
|
|
2873
|
+
|
|
2874
|
+
|
|
2875
|
+
<dt class="">
|
|
2876
|
+
|
|
2877
|
+
<h4 id="requiredMessageDetail" class="name">
|
|
2878
|
+
|
|
2879
|
+
<span class="type-signature"></span>required-message-detail<span class="type-signature"> :string</span>
|
|
2880
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#requiredMessageDetail"></a>
|
|
2881
|
+
|
|
2882
|
+
</h4>
|
|
2883
|
+
|
|
2884
|
+
|
|
2885
|
+
</dt>
|
|
2886
|
+
|
|
2887
|
+
<dd class="">
|
|
2888
|
+
|
|
2889
|
+
<div class="description">
|
|
2890
|
+
<p>
|
|
2891
|
+
The component-specific message detail when the required validation fails.
|
|
2892
|
+
If the component needs a required validation error message that is different from the default,
|
|
2893
|
+
set this property. It should be a translated string.
|
|
2894
|
+
</p>
|
|
2895
|
+
</div>
|
|
2896
|
+
|
|
2897
|
+
|
|
2898
|
+
|
|
2899
|
+
|
|
2900
|
+
<dl class="details">
|
|
2901
|
+
|
|
2902
|
+
|
|
2903
|
+
|
|
2904
|
+
|
|
2905
|
+
|
|
2906
|
+
|
|
2907
|
+
|
|
2908
|
+
|
|
2909
|
+
|
|
2910
|
+
|
|
2911
|
+
|
|
2912
|
+
|
|
2913
|
+
|
|
2914
|
+
|
|
2915
|
+
|
|
2916
|
+
|
|
2917
|
+
|
|
2918
|
+
|
|
2919
|
+
|
|
2920
|
+
|
|
2921
|
+
|
|
2922
|
+
|
|
2923
|
+
|
|
2924
|
+
|
|
2925
|
+
|
|
2926
|
+
|
|
2927
|
+
|
|
2928
|
+
|
|
2929
|
+
|
|
2930
|
+
</dl>
|
|
2931
|
+
|
|
2932
|
+
|
|
2933
|
+
|
|
2934
|
+
<h5>Names</h5>
|
|
2935
|
+
<table class="keyboard-table">
|
|
2936
|
+
<thead>
|
|
2937
|
+
<tr>
|
|
2938
|
+
<th>Item</th>
|
|
2939
|
+
<th>Name</th>
|
|
2940
|
+
</tr>
|
|
2941
|
+
</thead>
|
|
2942
|
+
<tbody>
|
|
2943
|
+
<tr>
|
|
2944
|
+
<td>Property</td>
|
|
2945
|
+
<td><code class="prettyprint">requiredMessageDetail</code></td>
|
|
2946
|
+
</tr>
|
|
2947
|
+
|
|
2948
|
+
<tr>
|
|
2949
|
+
<td>Property change event</td>
|
|
2950
|
+
<td><code class="prettyprint">requiredMessageDetailChanged</code></td>
|
|
2951
|
+
</tr>
|
|
2952
|
+
<tr>
|
|
2953
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
2954
|
+
<td><code class="pretty-print-noprettify">on-required-message-detail-changed</code></td>
|
|
2955
|
+
</tr>
|
|
2956
|
+
|
|
2957
|
+
</tbody>
|
|
2958
|
+
</table>
|
|
2959
|
+
|
|
2960
|
+
</dd>
|
|
2961
|
+
|
|
2962
|
+
|
|
2963
|
+
<dt class="">
|
|
2964
|
+
|
|
2965
|
+
<h4 id="textAlign" class="name">
|
|
2966
|
+
|
|
2967
|
+
<span class="type-signature"></span>text-align<span class="type-signature"> :"start"|"end"|"right"</span>
|
|
2968
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#textAlign"></a>
|
|
2969
|
+
|
|
2970
|
+
</h4>
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
</dt>
|
|
2974
|
+
|
|
2975
|
+
<dd class="">
|
|
2976
|
+
|
|
2977
|
+
<div class="description">
|
|
2978
|
+
Specifies how the text is aligned within the text field
|
|
2979
|
+
</div>
|
|
2980
|
+
|
|
2981
|
+
|
|
2982
|
+
|
|
2983
|
+
|
|
2984
|
+
<dl class="details">
|
|
2985
|
+
|
|
2986
|
+
|
|
2987
|
+
|
|
2988
|
+
|
|
2989
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
2990
|
+
|
|
2991
|
+
<dl>
|
|
2992
|
+
|
|
2993
|
+
<table class="props">
|
|
2994
|
+
<thead>
|
|
2995
|
+
<tr>
|
|
2996
|
+
|
|
2997
|
+
<th>Value</th>
|
|
2998
|
+
|
|
2999
|
+
|
|
3000
|
+
|
|
3001
|
+
|
|
3002
|
+
|
|
3003
|
+
|
|
3004
|
+
|
|
3005
|
+
<th class="last">Description</th>
|
|
3006
|
+
|
|
3007
|
+
</tr>
|
|
3008
|
+
</thead>
|
|
3009
|
+
|
|
3010
|
+
<tbody>
|
|
3011
|
+
|
|
3012
|
+
|
|
3013
|
+
<tr>
|
|
3014
|
+
|
|
3015
|
+
<td class="name"><code>end</code></td>
|
|
3016
|
+
|
|
3017
|
+
|
|
3018
|
+
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
|
|
3022
|
+
|
|
3023
|
+
<td class="description last">Aligns text right when reading direction is ltr and left when reading direction is rtl.
|
|
3024
|
+
</td>
|
|
3025
|
+
|
|
3026
|
+
</tr>
|
|
3027
|
+
|
|
3028
|
+
|
|
3029
|
+
|
|
3030
|
+
<tr>
|
|
3031
|
+
|
|
3032
|
+
<td class="name"><code>right</code></td>
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
|
|
3036
|
+
|
|
3037
|
+
|
|
3038
|
+
|
|
3039
|
+
|
|
3040
|
+
<td class="description last">Aligns text right regardless of reading direction, often used for numbers.
|
|
3041
|
+
</td>
|
|
3042
|
+
|
|
3043
|
+
</tr>
|
|
3044
|
+
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
<tr>
|
|
3048
|
+
|
|
3049
|
+
<td class="name"><code>start</code></td>
|
|
3050
|
+
|
|
3051
|
+
|
|
3052
|
+
|
|
3053
|
+
|
|
3054
|
+
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
<td class="description last">Aligns text left when reading direction is ltr and right when reading direction is rtl (default, if unspecified).
|
|
3058
|
+
</td>
|
|
3059
|
+
|
|
3060
|
+
</tr>
|
|
3061
|
+
|
|
3062
|
+
|
|
3063
|
+
</tbody>
|
|
3064
|
+
</table></dl>
|
|
3065
|
+
|
|
3066
|
+
|
|
3067
|
+
|
|
3068
|
+
|
|
3069
|
+
|
|
3070
|
+
|
|
3071
|
+
|
|
3072
|
+
|
|
3073
|
+
|
|
3074
|
+
|
|
3075
|
+
|
|
3076
|
+
|
|
3077
|
+
|
|
3078
|
+
|
|
3079
|
+
|
|
3080
|
+
|
|
3081
|
+
|
|
3082
|
+
|
|
3083
|
+
|
|
3084
|
+
|
|
3085
|
+
|
|
3086
|
+
|
|
3087
|
+
|
|
3088
|
+
|
|
3089
|
+
|
|
3090
|
+
|
|
3091
|
+
|
|
3092
|
+
|
|
3093
|
+
</dl>
|
|
3094
|
+
|
|
3095
|
+
|
|
3096
|
+
|
|
3097
|
+
<h5>Names</h5>
|
|
3098
|
+
<table class="keyboard-table">
|
|
3099
|
+
<thead>
|
|
3100
|
+
<tr>
|
|
3101
|
+
<th>Item</th>
|
|
3102
|
+
<th>Name</th>
|
|
3103
|
+
</tr>
|
|
3104
|
+
</thead>
|
|
3105
|
+
<tbody>
|
|
3106
|
+
<tr>
|
|
3107
|
+
<td>Property</td>
|
|
3108
|
+
<td><code class="prettyprint">textAlign</code></td>
|
|
3109
|
+
</tr>
|
|
3110
|
+
|
|
3111
|
+
<tr>
|
|
3112
|
+
<td>Property change event</td>
|
|
3113
|
+
<td><code class="prettyprint">textAlignChanged</code></td>
|
|
3114
|
+
</tr>
|
|
3115
|
+
<tr>
|
|
3116
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3117
|
+
<td><code class="pretty-print-noprettify">on-text-align-changed</code></td>
|
|
3118
|
+
</tr>
|
|
3119
|
+
|
|
3120
|
+
</tbody>
|
|
3121
|
+
</table>
|
|
3122
|
+
|
|
3123
|
+
</dd>
|
|
3124
|
+
|
|
3125
|
+
|
|
3126
|
+
<dt class="">
|
|
3127
|
+
|
|
3128
|
+
<h4 id="userAssistanceDensity" class="name">
|
|
3129
|
+
|
|
3130
|
+
<span class="type-signature"></span>user-assistance-density<span class="type-signature"> :"reflow"|"efficient"</span>
|
|
3131
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#userAssistanceDensity"></a>
|
|
3132
|
+
|
|
3133
|
+
</h4>
|
|
3134
|
+
|
|
3135
|
+
|
|
3136
|
+
</dt>
|
|
3137
|
+
|
|
3138
|
+
<dd class="">
|
|
3139
|
+
|
|
3140
|
+
<div class="description">
|
|
3141
|
+
Specifies the density of the form component's user assistance presentation. It can be shown inline with
|
|
3142
|
+
reserved rows to prevent reflow if a user assistance text shows up, inline without reserved rows that would
|
|
3143
|
+
reflow if a user assistance text shows up, or it can be shown compactly in a popup instead.
|
|
3144
|
+
</div>
|
|
3145
|
+
|
|
3146
|
+
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
<dl class="details">
|
|
3150
|
+
|
|
3151
|
+
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
3155
|
+
|
|
3156
|
+
<dl>
|
|
3157
|
+
|
|
3158
|
+
<table class="props">
|
|
3159
|
+
<thead>
|
|
3160
|
+
<tr>
|
|
3161
|
+
|
|
3162
|
+
<th>Value</th>
|
|
3163
|
+
|
|
3164
|
+
|
|
3165
|
+
|
|
3166
|
+
|
|
3167
|
+
|
|
3168
|
+
|
|
3169
|
+
|
|
3170
|
+
<th class="last">Description</th>
|
|
3171
|
+
|
|
3172
|
+
</tr>
|
|
3173
|
+
</thead>
|
|
3174
|
+
|
|
3175
|
+
<tbody>
|
|
3176
|
+
|
|
3177
|
+
|
|
3178
|
+
<tr>
|
|
3179
|
+
|
|
3180
|
+
<td class="name"><code>efficient</code></td>
|
|
3181
|
+
|
|
3182
|
+
|
|
3183
|
+
|
|
3184
|
+
|
|
3185
|
+
|
|
3186
|
+
|
|
3187
|
+
|
|
3188
|
+
<td class="description last">Messages, help, hints, and required are all shown inline under the field with reserved space.
|
|
3189
|
+
</td>
|
|
3190
|
+
|
|
3191
|
+
</tr>
|
|
3192
|
+
|
|
3193
|
+
|
|
3194
|
+
|
|
3195
|
+
<tr>
|
|
3196
|
+
|
|
3197
|
+
<td class="name"><code>reflow</code></td>
|
|
3198
|
+
|
|
3199
|
+
|
|
3200
|
+
|
|
3201
|
+
|
|
3202
|
+
|
|
3203
|
+
|
|
3204
|
+
|
|
3205
|
+
<td class="description last">Messages, help, hints, and required are all shown inline under the field with no reserved space.
|
|
3206
|
+
</td>
|
|
3207
|
+
|
|
3208
|
+
</tr>
|
|
3209
|
+
|
|
3210
|
+
|
|
3211
|
+
</tbody>
|
|
3212
|
+
</table></dl>
|
|
3213
|
+
|
|
3214
|
+
|
|
3215
|
+
|
|
3216
|
+
|
|
3217
|
+
<dt class="tag-default">Default Value:</dt>
|
|
3218
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">"reflow"</code></li></ul></dd>
|
|
3219
|
+
|
|
3220
|
+
|
|
3221
|
+
|
|
3222
|
+
|
|
3223
|
+
|
|
3224
|
+
|
|
3225
|
+
|
|
3226
|
+
|
|
3227
|
+
|
|
3228
|
+
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
|
|
3232
|
+
|
|
3233
|
+
|
|
3234
|
+
|
|
3235
|
+
|
|
3236
|
+
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
|
|
3242
|
+
|
|
3243
|
+
|
|
3244
|
+
</dl>
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
<h5>Names</h5>
|
|
3249
|
+
<table class="keyboard-table">
|
|
3250
|
+
<thead>
|
|
3251
|
+
<tr>
|
|
3252
|
+
<th>Item</th>
|
|
3253
|
+
<th>Name</th>
|
|
3254
|
+
</tr>
|
|
3255
|
+
</thead>
|
|
3256
|
+
<tbody>
|
|
3257
|
+
<tr>
|
|
3258
|
+
<td>Property</td>
|
|
3259
|
+
<td><code class="prettyprint">userAssistanceDensity</code></td>
|
|
3260
|
+
</tr>
|
|
3261
|
+
|
|
3262
|
+
<tr>
|
|
3263
|
+
<td>Property change event</td>
|
|
3264
|
+
<td><code class="prettyprint">userAssistanceDensityChanged</code></td>
|
|
3265
|
+
</tr>
|
|
3266
|
+
<tr>
|
|
3267
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3268
|
+
<td><code class="pretty-print-noprettify">on-user-assistance-density-changed</code></td>
|
|
3269
|
+
</tr>
|
|
3270
|
+
|
|
3271
|
+
</tbody>
|
|
3272
|
+
</table>
|
|
3273
|
+
|
|
3274
|
+
</dd>
|
|
3275
|
+
|
|
3276
|
+
|
|
3277
|
+
<dt class="">
|
|
3278
|
+
|
|
3279
|
+
<h4 id="valid" class="name">
|
|
3280
|
+
|
|
3281
|
+
<span class="type-signature">(readonly) </span>valid<span class="type-signature"> :"valid"|"pending"|"invalidHidden"|"invalidShown"</span>
|
|
3282
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#valid"></a>
|
|
3283
|
+
|
|
3284
|
+
</h4>
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
</dt>
|
|
3288
|
+
|
|
3289
|
+
<dd class="">
|
|
3290
|
+
|
|
3291
|
+
<div class="description">
|
|
3292
|
+
<p>
|
|
3293
|
+
The current valid state of the component. It is evaluated on initial render.
|
|
3294
|
+
It is re-evaluated
|
|
3295
|
+
<ul>
|
|
3296
|
+
<li>after each validator (validators or async-validators) is run (full or deferred)</li>
|
|
3297
|
+
<li>when messagesCustom is updated,
|
|
3298
|
+
since messagesCustom can be added by the app developer any time.</li>
|
|
3299
|
+
<li>when showMessages() is called. Since showMessages() moves the
|
|
3300
|
+
hidden messages into messages shown,
|
|
3301
|
+
if the valid state was "invalidHidden" then it would become "invalidShown".</li>
|
|
3302
|
+
<li>when the required property has changed. If a component is empty and has required
|
|
3303
|
+
set, the valid state may be "invalidHidden" (if no invalid messages are being shown as well).
|
|
3304
|
+
If required property is removed, the valid state would change to "valid".</li>
|
|
3305
|
+
</ul>
|
|
3306
|
+
</p>
|
|
3307
|
+
<p>
|
|
3308
|
+
Note: New valid states may be added to the list of valid values in future releases.
|
|
3309
|
+
Any new values will start with "invalid"
|
|
3310
|
+
if it is an invalid state, "pending" if it is pending state,
|
|
3311
|
+
and "valid" if it is a valid state.
|
|
3312
|
+
</p>
|
|
3313
|
+
</div>
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
|
|
3317
|
+
|
|
3318
|
+
<dl class="details">
|
|
3319
|
+
|
|
3320
|
+
|
|
3321
|
+
|
|
3322
|
+
|
|
3323
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
3324
|
+
|
|
3325
|
+
<dl>
|
|
3326
|
+
|
|
3327
|
+
<table class="props">
|
|
3328
|
+
<thead>
|
|
3329
|
+
<tr>
|
|
3330
|
+
|
|
3331
|
+
<th>Value</th>
|
|
3332
|
+
|
|
3333
|
+
|
|
3334
|
+
|
|
3335
|
+
|
|
3336
|
+
|
|
3337
|
+
|
|
3338
|
+
|
|
3339
|
+
<th class="last">Description</th>
|
|
3340
|
+
|
|
3341
|
+
</tr>
|
|
3342
|
+
</thead>
|
|
3343
|
+
|
|
3344
|
+
<tbody>
|
|
3345
|
+
|
|
3346
|
+
|
|
3347
|
+
<tr>
|
|
3348
|
+
|
|
3349
|
+
<td class="name"><code>invalidHidden</code></td>
|
|
3350
|
+
|
|
3351
|
+
|
|
3352
|
+
|
|
3353
|
+
|
|
3354
|
+
|
|
3355
|
+
|
|
3356
|
+
|
|
3357
|
+
<td class="description last">The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity 'error'.
|
|
3358
|
+
</td>
|
|
3359
|
+
|
|
3360
|
+
</tr>
|
|
3361
|
+
|
|
3362
|
+
|
|
3363
|
+
|
|
3364
|
+
<tr>
|
|
3365
|
+
|
|
3366
|
+
<td class="name"><code>invalidShown</code></td>
|
|
3367
|
+
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
|
|
3371
|
+
|
|
3372
|
+
|
|
3373
|
+
|
|
3374
|
+
<td class="description last">The component has invalid messages showing. An invalid message is one with severity 'error'.
|
|
3375
|
+
</td>
|
|
3376
|
+
|
|
3377
|
+
</tr>
|
|
3378
|
+
|
|
3379
|
+
|
|
3380
|
+
|
|
3381
|
+
<tr>
|
|
3382
|
+
|
|
3383
|
+
<td class="name"><code>pending</code></td>
|
|
3384
|
+
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
|
|
3391
|
+
<td class="description last">The component is waiting for the validation state to be determined. The 'pending' state is set at the start of the convert/validate process.
|
|
3392
|
+
</td>
|
|
3393
|
+
|
|
3394
|
+
</tr>
|
|
3395
|
+
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
<tr>
|
|
3399
|
+
|
|
3400
|
+
<td class="name"><code>valid</code></td>
|
|
3401
|
+
|
|
3402
|
+
|
|
3403
|
+
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
<td class="description last">The component is valid
|
|
3409
|
+
</td>
|
|
3410
|
+
|
|
3411
|
+
</tr>
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
</tbody>
|
|
3415
|
+
</table></dl>
|
|
3416
|
+
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
|
|
3422
|
+
<dt class="tag-default">Supports writeback:</dt>
|
|
3423
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">true</code></li></ul></dd>
|
|
3424
|
+
|
|
3425
|
+
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
|
|
3430
|
+
|
|
3431
|
+
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
|
|
3435
|
+
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
|
|
3442
|
+
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
|
|
3447
|
+
</dl>
|
|
3448
|
+
|
|
3449
|
+
|
|
3450
|
+
|
|
3451
|
+
<h5>Names</h5>
|
|
3452
|
+
<table class="keyboard-table">
|
|
3453
|
+
<thead>
|
|
3454
|
+
<tr>
|
|
3455
|
+
<th>Item</th>
|
|
3456
|
+
<th>Name</th>
|
|
3457
|
+
</tr>
|
|
3458
|
+
</thead>
|
|
3459
|
+
<tbody>
|
|
3460
|
+
<tr>
|
|
3461
|
+
<td>Property</td>
|
|
3462
|
+
<td><code class="prettyprint">valid</code></td>
|
|
3463
|
+
</tr>
|
|
3464
|
+
|
|
3465
|
+
<tr>
|
|
3466
|
+
<td>Property change event</td>
|
|
3467
|
+
<td><code class="prettyprint">validChanged</code></td>
|
|
3468
|
+
</tr>
|
|
3469
|
+
<tr>
|
|
3470
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3471
|
+
<td><code class="pretty-print-noprettify">on-valid-changed</code></td>
|
|
3472
|
+
</tr>
|
|
3473
|
+
|
|
3474
|
+
</tbody>
|
|
3475
|
+
</table>
|
|
3476
|
+
|
|
3477
|
+
</dd>
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
<dt class="">
|
|
3481
|
+
|
|
3482
|
+
<h4 id="value" class="name">
|
|
3483
|
+
|
|
3484
|
+
<span class="type-signature"></span>value<span class="type-signature"> :Set<K>|null</span>
|
|
3485
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#value"></a>
|
|
3486
|
+
|
|
3487
|
+
</h4>
|
|
3488
|
+
|
|
3489
|
+
|
|
3490
|
+
</dt>
|
|
3491
|
+
|
|
3492
|
+
<dd class="">
|
|
3493
|
+
|
|
3494
|
+
<div class="description">
|
|
3495
|
+
The value of the component.
|
|
3496
|
+
|
|
3497
|
+
<p>
|
|
3498
|
+
When the <code class="prettyprint">value</code> property changes due to programmatic
|
|
3499
|
+
intervention, the component always clears all messages
|
|
3500
|
+
including <code class="prettyprint">messagesCustom</code>, runs deferred validation, and
|
|
3501
|
+
always refreshes the UI display value.</br>
|
|
3502
|
+
|
|
3503
|
+
<h4>Running Validation</h4>
|
|
3504
|
+
<ul>
|
|
3505
|
+
<li>component always runs deferred validation; the
|
|
3506
|
+
<code class="prettyprint">valid</code> property is updated with the result.</li>
|
|
3507
|
+
</ul>
|
|
3508
|
+
</p>
|
|
3509
|
+
</div>
|
|
3510
|
+
|
|
3511
|
+
|
|
3512
|
+
|
|
3513
|
+
|
|
3514
|
+
<dl class="details">
|
|
3515
|
+
|
|
3516
|
+
|
|
3517
|
+
|
|
3518
|
+
|
|
3519
|
+
|
|
3520
|
+
<dt class="tag-default">Default Value:</dt>
|
|
3521
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">null</code></li></ul></dd>
|
|
3522
|
+
|
|
3523
|
+
|
|
3524
|
+
|
|
3525
|
+
<dt class="tag-default">Supports writeback:</dt>
|
|
3526
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">true</code></li></ul></dd>
|
|
3527
|
+
|
|
3528
|
+
|
|
3529
|
+
|
|
3530
|
+
|
|
3531
|
+
|
|
3532
|
+
|
|
3533
|
+
|
|
3534
|
+
|
|
3535
|
+
|
|
3536
|
+
|
|
3537
|
+
|
|
3538
|
+
|
|
3539
|
+
|
|
3540
|
+
|
|
3541
|
+
|
|
3542
|
+
|
|
3543
|
+
|
|
3544
|
+
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
|
|
3548
|
+
|
|
3549
|
+
|
|
3550
|
+
</dl>
|
|
3551
|
+
|
|
3552
|
+
|
|
3553
|
+
|
|
3554
|
+
<h5>Names</h5>
|
|
3555
|
+
<table class="keyboard-table">
|
|
3556
|
+
<thead>
|
|
3557
|
+
<tr>
|
|
3558
|
+
<th>Item</th>
|
|
3559
|
+
<th>Name</th>
|
|
3560
|
+
</tr>
|
|
3561
|
+
</thead>
|
|
3562
|
+
<tbody>
|
|
3563
|
+
<tr>
|
|
3564
|
+
<td>Property</td>
|
|
3565
|
+
<td><code class="prettyprint">value</code></td>
|
|
3566
|
+
</tr>
|
|
3567
|
+
|
|
3568
|
+
<tr>
|
|
3569
|
+
<td>Property change event</td>
|
|
3570
|
+
<td><code class="prettyprint">valueChanged</code></td>
|
|
3571
|
+
</tr>
|
|
3572
|
+
<tr>
|
|
3573
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3574
|
+
<td><code class="pretty-print-noprettify">on-value-changed</code></td>
|
|
3575
|
+
</tr>
|
|
3576
|
+
|
|
3577
|
+
</tbody>
|
|
3578
|
+
</table>
|
|
3579
|
+
|
|
3580
|
+
</dd>
|
|
3581
|
+
|
|
3582
|
+
|
|
3583
|
+
<dt class="">
|
|
3584
|
+
|
|
3585
|
+
<h4 id="valueItems" class="name">
|
|
3586
|
+
|
|
3587
|
+
<span class="type-signature"></span>value-items<span class="type-signature"> :Map<K, ItemContext<K, D>>|null</span>
|
|
3588
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#valueItems"></a>
|
|
3589
|
+
|
|
3590
|
+
</h4>
|
|
3591
|
+
|
|
3592
|
+
|
|
3593
|
+
</dt>
|
|
3594
|
+
|
|
3595
|
+
<dd class="">
|
|
3596
|
+
|
|
3597
|
+
<div class="description">
|
|
3598
|
+
The <code class="prettyprint">valueItems</code> is similar to the
|
|
3599
|
+
<code class="prettyprint">value</code>, but is a map of objects that
|
|
3600
|
+
contain both a key and data, and optional metadata.
|
|
3601
|
+
The keys will be set as the <code class="prettyprint">value</code> of the element.
|
|
3602
|
+
The <code class="prettyprint">value</code> and <code class="prettyprint">valueItems</code>
|
|
3603
|
+
are kept in sync, both during programmatic property sets as well as during interactive user
|
|
3604
|
+
selection.
|
|
3605
|
+
If initially both are set, the selected values in the <code class="prettyprint">value</code>
|
|
3606
|
+
attribute have precedence.
|
|
3607
|
+
<p>Note: If there is an initial selection, setting it via the
|
|
3608
|
+
<code class="prettyprint">valueItems</code> attribute initially can improve page load
|
|
3609
|
+
performance because the element will not have to fetch the selected data from the data
|
|
3610
|
+
provider.</p>
|
|
3611
|
+
<p>If <code class="prettyprint">valueItems</code> is not specified or the selected value is
|
|
3612
|
+
missing, then the selected data will be fetched from the data provider.</p>
|
|
3613
|
+
</div>
|
|
3614
|
+
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
<dl class="details">
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
<dt class="tag-default">Default Value:</dt>
|
|
3625
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">null</code></li></ul></dd>
|
|
3626
|
+
|
|
3627
|
+
|
|
3628
|
+
|
|
3629
|
+
<dt class="tag-default">Supports writeback:</dt>
|
|
3630
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">true</code></li></ul></dd>
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
|
|
3634
|
+
|
|
3635
|
+
|
|
3636
|
+
|
|
3637
|
+
|
|
3638
|
+
|
|
3639
|
+
|
|
3640
|
+
|
|
3641
|
+
|
|
3642
|
+
|
|
3643
|
+
|
|
3644
|
+
|
|
3645
|
+
|
|
3646
|
+
|
|
3647
|
+
|
|
3648
|
+
|
|
3649
|
+
|
|
3650
|
+
|
|
3651
|
+
|
|
3652
|
+
|
|
3653
|
+
|
|
3654
|
+
</dl>
|
|
3655
|
+
|
|
3656
|
+
|
|
3657
|
+
|
|
3658
|
+
<h5>Names</h5>
|
|
3659
|
+
<table class="keyboard-table">
|
|
3660
|
+
<thead>
|
|
3661
|
+
<tr>
|
|
3662
|
+
<th>Item</th>
|
|
3663
|
+
<th>Name</th>
|
|
3664
|
+
</tr>
|
|
3665
|
+
</thead>
|
|
3666
|
+
<tbody>
|
|
3667
|
+
<tr>
|
|
3668
|
+
<td>Property</td>
|
|
3669
|
+
<td><code class="prettyprint">valueItems</code></td>
|
|
3670
|
+
</tr>
|
|
3671
|
+
|
|
3672
|
+
<tr>
|
|
3673
|
+
<td>Property change event</td>
|
|
3674
|
+
<td><code class="prettyprint">valueItemsChanged</code></td>
|
|
3675
|
+
</tr>
|
|
3676
|
+
<tr>
|
|
3677
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3678
|
+
<td><code class="pretty-print-noprettify">on-value-items-changed</code></td>
|
|
3679
|
+
</tr>
|
|
3680
|
+
|
|
3681
|
+
</tbody>
|
|
3682
|
+
</table>
|
|
3683
|
+
|
|
3684
|
+
</dd>
|
|
3685
|
+
|
|
3686
|
+
|
|
3687
|
+
<dt class="">
|
|
3688
|
+
|
|
3689
|
+
<h4 id="virtualKeyboard" class="name">
|
|
3690
|
+
|
|
3691
|
+
<span class="type-signature"></span>virtual-keyboard<span class="type-signature"> :"number"|"auto"|"email"|"search"|"tel"|"text"|"url"</span>
|
|
3692
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#virtualKeyboard"></a>
|
|
3693
|
+
|
|
3694
|
+
</h4>
|
|
3695
|
+
|
|
3696
|
+
|
|
3697
|
+
</dt>
|
|
3698
|
+
|
|
3699
|
+
<dd class="">
|
|
3700
|
+
|
|
3701
|
+
<div class="description">
|
|
3702
|
+
The type of virtual keyboard to display for entering a value on mobile browsers. This attribute has no effect on desktop browsers.
|
|
3703
|
+
</div>
|
|
3704
|
+
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
|
|
3708
|
+
<dl class="details">
|
|
3709
|
+
|
|
3710
|
+
|
|
3711
|
+
|
|
3712
|
+
|
|
3713
|
+
<h5 class="subsection-title">Supported Values:</h5>
|
|
3714
|
+
|
|
3715
|
+
<dl>
|
|
3716
|
+
|
|
3717
|
+
<table class="props">
|
|
3718
|
+
<thead>
|
|
3719
|
+
<tr>
|
|
3720
|
+
|
|
3721
|
+
<th>Value</th>
|
|
3722
|
+
|
|
3723
|
+
|
|
3724
|
+
|
|
3725
|
+
|
|
3726
|
+
|
|
3727
|
+
|
|
3728
|
+
|
|
3729
|
+
<th class="last">Description</th>
|
|
3730
|
+
|
|
3731
|
+
</tr>
|
|
3732
|
+
</thead>
|
|
3733
|
+
|
|
3734
|
+
<tbody>
|
|
3735
|
+
|
|
3736
|
+
|
|
3737
|
+
<tr>
|
|
3738
|
+
|
|
3739
|
+
<td class="name"><code>auto</code></td>
|
|
3740
|
+
|
|
3741
|
+
|
|
3742
|
+
|
|
3743
|
+
|
|
3744
|
+
|
|
3745
|
+
|
|
3746
|
+
|
|
3747
|
+
<td class="description last">The component will determine the best mobile virtual keyboard to use (default, if unspecified).
|
|
3748
|
+
</td>
|
|
3749
|
+
|
|
3750
|
+
</tr>
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
|
|
3754
|
+
<tr>
|
|
3755
|
+
|
|
3756
|
+
<td class="name"><code>email</code></td>
|
|
3757
|
+
|
|
3758
|
+
|
|
3759
|
+
|
|
3760
|
+
|
|
3761
|
+
|
|
3762
|
+
|
|
3763
|
+
|
|
3764
|
+
<td class="description last">Use a mobile virtual keyboard for entering email addresses.
|
|
3765
|
+
</td>
|
|
3766
|
+
|
|
3767
|
+
</tr>
|
|
3768
|
+
|
|
3769
|
+
|
|
3770
|
+
|
|
3771
|
+
<tr>
|
|
3772
|
+
|
|
3773
|
+
<td class="name"><code>number</code></td>
|
|
3774
|
+
|
|
3775
|
+
|
|
3776
|
+
|
|
3777
|
+
|
|
3778
|
+
|
|
3779
|
+
|
|
3780
|
+
|
|
3781
|
+
<td class="description last">Use a mobile virtual keyboard for entering numbers. Note that on Android and Windows Mobile, the 'number' keyboard does not contain the minus sign. This value should not be used on fields that accept negative values.
|
|
3782
|
+
</td>
|
|
3783
|
+
|
|
3784
|
+
</tr>
|
|
3785
|
+
|
|
3786
|
+
|
|
3787
|
+
|
|
3788
|
+
<tr>
|
|
3789
|
+
|
|
3790
|
+
<td class="name"><code>search</code></td>
|
|
3791
|
+
|
|
3792
|
+
|
|
3793
|
+
|
|
3794
|
+
|
|
3795
|
+
|
|
3796
|
+
|
|
3797
|
+
|
|
3798
|
+
<td class="description last">Use a mobile virtual keyboard for entering search terms.
|
|
3799
|
+
</td>
|
|
3800
|
+
|
|
3801
|
+
</tr>
|
|
3802
|
+
|
|
3803
|
+
|
|
3804
|
+
|
|
3805
|
+
<tr>
|
|
3806
|
+
|
|
3807
|
+
<td class="name"><code>tel</code></td>
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
|
|
3811
|
+
|
|
3812
|
+
|
|
3813
|
+
|
|
3814
|
+
|
|
3815
|
+
<td class="description last">Use a mobile virtual keyboard for entering telephone numbers.
|
|
3816
|
+
</td>
|
|
3817
|
+
|
|
3818
|
+
</tr>
|
|
3819
|
+
|
|
3820
|
+
|
|
3821
|
+
|
|
3822
|
+
<tr>
|
|
3823
|
+
|
|
3824
|
+
<td class="name"><code>text</code></td>
|
|
3825
|
+
|
|
3826
|
+
|
|
3827
|
+
|
|
3828
|
+
|
|
3829
|
+
|
|
3830
|
+
|
|
3831
|
+
|
|
3832
|
+
<td class="description last">Use a mobile virtual keyboard for entering text.
|
|
3833
|
+
</td>
|
|
3834
|
+
|
|
3835
|
+
</tr>
|
|
3836
|
+
|
|
3837
|
+
|
|
3838
|
+
|
|
3839
|
+
<tr>
|
|
3840
|
+
|
|
3841
|
+
<td class="name"><code>url</code></td>
|
|
3842
|
+
|
|
3843
|
+
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
|
|
3847
|
+
|
|
3848
|
+
|
|
3849
|
+
<td class="description last">Use a mobile virtual keyboard for URL entry.
|
|
3850
|
+
</td>
|
|
3851
|
+
|
|
3852
|
+
</tr>
|
|
3853
|
+
|
|
3854
|
+
|
|
3855
|
+
</tbody>
|
|
3856
|
+
</table></dl>
|
|
3857
|
+
|
|
3858
|
+
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
<dt class="tag-default">Default Value:</dt>
|
|
3862
|
+
<dd class="tag-default"><ul class="dummy"><li><code class="prettyprint">"auto"</code></li></ul></dd>
|
|
3863
|
+
|
|
3864
|
+
|
|
3865
|
+
|
|
3866
|
+
|
|
3867
|
+
|
|
3868
|
+
|
|
3869
|
+
|
|
3870
|
+
|
|
3871
|
+
|
|
3872
|
+
|
|
3873
|
+
|
|
3874
|
+
|
|
3875
|
+
|
|
3876
|
+
|
|
3877
|
+
|
|
3878
|
+
|
|
3879
|
+
|
|
3880
|
+
|
|
3881
|
+
|
|
3882
|
+
|
|
3883
|
+
|
|
3884
|
+
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
|
|
3888
|
+
</dl>
|
|
3889
|
+
|
|
3890
|
+
|
|
3891
|
+
|
|
3892
|
+
<h5>Names</h5>
|
|
3893
|
+
<table class="keyboard-table">
|
|
3894
|
+
<thead>
|
|
3895
|
+
<tr>
|
|
3896
|
+
<th>Item</th>
|
|
3897
|
+
<th>Name</th>
|
|
3898
|
+
</tr>
|
|
3899
|
+
</thead>
|
|
3900
|
+
<tbody>
|
|
3901
|
+
<tr>
|
|
3902
|
+
<td>Property</td>
|
|
3903
|
+
<td><code class="prettyprint">virtualKeyboard</code></td>
|
|
3904
|
+
</tr>
|
|
3905
|
+
|
|
3906
|
+
<tr>
|
|
3907
|
+
<td>Property change event</td>
|
|
3908
|
+
<td><code class="prettyprint">virtualKeyboardChanged</code></td>
|
|
3909
|
+
</tr>
|
|
3910
|
+
<tr>
|
|
3911
|
+
<td>Property change listener attribute (<span class="important">must be of type function, see <a href="../../../jsdocs/CustomElementOverview.html#ce-events-section" target="_blank">Events and Listeners</a> for additional information.</span>)</td>
|
|
3912
|
+
<td><code class="pretty-print-noprettify">on-virtual-keyboard-changed</code></td>
|
|
3913
|
+
</tr>
|
|
3914
|
+
|
|
3915
|
+
</tbody>
|
|
3916
|
+
</table>
|
|
3917
|
+
|
|
3918
|
+
</dd>
|
|
3919
|
+
|
|
3920
|
+
</dl>
|
|
3921
|
+
|
|
3922
|
+
|
|
3923
|
+
<h3 id="methods-section" class="subsection-title">
|
|
3924
|
+
Methods
|
|
3925
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#methods-section"></a>
|
|
3926
|
+
</h3>
|
|
3927
|
+
|
|
3928
|
+
<dl>
|
|
3929
|
+
|
|
3930
|
+
|
|
3931
|
+
<dt class="">
|
|
3932
|
+
|
|
3933
|
+
|
|
3934
|
+
|
|
3935
|
+
<h4 id="getProperty" class="name">
|
|
3936
|
+
|
|
3937
|
+
<span class="type-signature"></span>getProperty<span class="signature">(property)</span><span class="type-signature"> : {<a href="CustomElementOverview.html#ce-attrs-any-section">any</a>}</span>
|
|
3938
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#getProperty"></a>
|
|
3939
|
+
|
|
3940
|
+
</h4>
|
|
3941
|
+
|
|
3942
|
+
|
|
3943
|
+
|
|
3944
|
+
|
|
3945
|
+
|
|
3946
|
+
</dt>
|
|
3947
|
+
<dd class="">
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
<div class="description">
|
|
3951
|
+
Retrieves the value of a property or a subproperty.
|
|
3952
|
+
|
|
3953
|
+
</div>
|
|
3954
|
+
|
|
3955
|
+
|
|
3956
|
+
|
|
3957
|
+
|
|
3958
|
+
|
|
3959
|
+
|
|
3960
|
+
|
|
3961
|
+
|
|
3962
|
+
|
|
3963
|
+
|
|
3964
|
+
|
|
3965
|
+
<h5>Parameters:</h5>
|
|
3966
|
+
|
|
3967
|
+
|
|
3968
|
+
<table class="params">
|
|
3969
|
+
<thead>
|
|
3970
|
+
<tr>
|
|
3971
|
+
|
|
3972
|
+
<th>Name</th>
|
|
3973
|
+
|
|
3974
|
+
|
|
3975
|
+
<th>Type</th>
|
|
3976
|
+
|
|
3977
|
+
|
|
3978
|
+
|
|
3979
|
+
|
|
3980
|
+
|
|
3981
|
+
<th class="last">Description</th>
|
|
3982
|
+
</tr>
|
|
3983
|
+
</thead>
|
|
3984
|
+
|
|
3985
|
+
<tbody>
|
|
3986
|
+
|
|
3987
|
+
|
|
3988
|
+
<tr>
|
|
3989
|
+
|
|
3990
|
+
<td class="name"><code>property</code></td>
|
|
3991
|
+
|
|
3992
|
+
|
|
3993
|
+
<td class="type">
|
|
3994
|
+
|
|
3995
|
+
</td>
|
|
3996
|
+
|
|
3997
|
+
|
|
3998
|
+
|
|
3999
|
+
|
|
4000
|
+
<td class="description last">The property name to get. Supports dot notation for subproperty access.
|
|
4001
|
+
</td>
|
|
4002
|
+
</tr>
|
|
4003
|
+
|
|
4004
|
+
|
|
4005
|
+
</tbody>
|
|
4006
|
+
</table>
|
|
4007
|
+
|
|
4008
|
+
|
|
4009
|
+
|
|
4010
|
+
<dl class="details">
|
|
4011
|
+
|
|
4012
|
+
|
|
4013
|
+
|
|
4014
|
+
|
|
4015
|
+
|
|
4016
|
+
|
|
4017
|
+
|
|
4018
|
+
|
|
4019
|
+
|
|
4020
|
+
|
|
4021
|
+
|
|
4022
|
+
|
|
4023
|
+
|
|
4024
|
+
|
|
4025
|
+
|
|
4026
|
+
|
|
4027
|
+
|
|
4028
|
+
|
|
4029
|
+
|
|
4030
|
+
|
|
4031
|
+
|
|
4032
|
+
|
|
4033
|
+
|
|
4034
|
+
|
|
4035
|
+
|
|
4036
|
+
|
|
4037
|
+
|
|
4038
|
+
|
|
4039
|
+
|
|
4040
|
+
</dl>
|
|
4041
|
+
|
|
4042
|
+
|
|
4043
|
+
|
|
4044
|
+
|
|
4045
|
+
|
|
4046
|
+
|
|
4047
|
+
|
|
4048
|
+
<h5>Returns:</h5>
|
|
4049
|
+
|
|
4050
|
+
|
|
4051
|
+
|
|
4052
|
+
|
|
4053
|
+
<dl>
|
|
4054
|
+
<dt>
|
|
4055
|
+
Type
|
|
4056
|
+
</dt>
|
|
4057
|
+
<dd>
|
|
4058
|
+
|
|
4059
|
+
<span class="param-type"><a href="CustomElementOverview.html#ce-attrs-any-section">any</a></span>
|
|
4060
|
+
|
|
4061
|
+
|
|
4062
|
+
</dd>
|
|
4063
|
+
</dl>
|
|
4064
|
+
|
|
4065
|
+
|
|
4066
|
+
|
|
4067
|
+
|
|
4068
|
+
|
|
4069
|
+
</dd>
|
|
4070
|
+
|
|
4071
|
+
|
|
4072
|
+
|
|
4073
|
+
<dt class="">
|
|
4074
|
+
|
|
4075
|
+
|
|
4076
|
+
|
|
4077
|
+
<h4 id="reset" class="name">
|
|
4078
|
+
|
|
4079
|
+
<span class="type-signature"></span>reset<span class="signature"></span><span class="type-signature"> : {<a href="CustomElementOverview.html#ce-attrs-any-section">any</a>}</span>
|
|
4080
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#reset"></a>
|
|
4081
|
+
|
|
4082
|
+
</h4>
|
|
4083
|
+
|
|
4084
|
+
|
|
4085
|
+
|
|
4086
|
+
|
|
4087
|
+
|
|
4088
|
+
</dt>
|
|
4089
|
+
<dd class="">
|
|
4090
|
+
|
|
4091
|
+
|
|
4092
|
+
<div class="description">
|
|
4093
|
+
Resets the component by clearing all messages and messagesCustom attribute
|
|
4094
|
+
and updates the component's display value using the attribute value.
|
|
4095
|
+
User entered values will be erased when this method is called.
|
|
4096
|
+
|
|
4097
|
+
</div>
|
|
4098
|
+
|
|
4099
|
+
|
|
4100
|
+
|
|
4101
|
+
|
|
4102
|
+
|
|
4103
|
+
|
|
4104
|
+
|
|
4105
|
+
|
|
4106
|
+
|
|
4107
|
+
|
|
4108
|
+
|
|
4109
|
+
|
|
4110
|
+
|
|
4111
|
+
<dl class="details">
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
|
|
4115
|
+
|
|
4116
|
+
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
|
|
4135
|
+
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
|
|
4141
|
+
</dl>
|
|
4142
|
+
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
|
|
4149
|
+
<h5>Returns:</h5>
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
|
|
4153
|
+
|
|
4154
|
+
<dl>
|
|
4155
|
+
<dt>
|
|
4156
|
+
Type
|
|
4157
|
+
</dt>
|
|
4158
|
+
<dd>
|
|
4159
|
+
|
|
4160
|
+
<span class="param-type"><a href="CustomElementOverview.html#ce-attrs-any-section">any</a></span>
|
|
4161
|
+
|
|
4162
|
+
|
|
4163
|
+
</dd>
|
|
4164
|
+
</dl>
|
|
4165
|
+
|
|
4166
|
+
|
|
4167
|
+
|
|
4168
|
+
|
|
4169
|
+
|
|
4170
|
+
</dd>
|
|
4171
|
+
|
|
4172
|
+
|
|
4173
|
+
|
|
4174
|
+
<dt class="">
|
|
4175
|
+
|
|
4176
|
+
|
|
4177
|
+
|
|
4178
|
+
<h4 id="setProperties" class="name">
|
|
4179
|
+
|
|
4180
|
+
<span class="type-signature"></span>setProperties<span class="signature">(properties)</span><span class="type-signature"> : {void}</span>
|
|
4181
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#setProperties"></a>
|
|
4182
|
+
|
|
4183
|
+
</h4>
|
|
4184
|
+
|
|
4185
|
+
|
|
4186
|
+
|
|
4187
|
+
|
|
4188
|
+
|
|
4189
|
+
</dt>
|
|
4190
|
+
<dd class="">
|
|
4191
|
+
|
|
4192
|
+
|
|
4193
|
+
<div class="description">
|
|
4194
|
+
Performs a batch set of properties.
|
|
4195
|
+
|
|
4196
|
+
</div>
|
|
4197
|
+
|
|
4198
|
+
|
|
4199
|
+
|
|
4200
|
+
|
|
4201
|
+
|
|
4202
|
+
|
|
4203
|
+
|
|
4204
|
+
|
|
4205
|
+
|
|
4206
|
+
|
|
4207
|
+
|
|
4208
|
+
<h5>Parameters:</h5>
|
|
4209
|
+
|
|
4210
|
+
|
|
4211
|
+
<table class="params">
|
|
4212
|
+
<thead>
|
|
4213
|
+
<tr>
|
|
4214
|
+
|
|
4215
|
+
<th>Name</th>
|
|
4216
|
+
|
|
4217
|
+
|
|
4218
|
+
<th>Type</th>
|
|
4219
|
+
|
|
4220
|
+
|
|
4221
|
+
|
|
4222
|
+
|
|
4223
|
+
|
|
4224
|
+
<th class="last">Description</th>
|
|
4225
|
+
</tr>
|
|
4226
|
+
</thead>
|
|
4227
|
+
|
|
4228
|
+
<tbody>
|
|
4229
|
+
|
|
4230
|
+
|
|
4231
|
+
<tr>
|
|
4232
|
+
|
|
4233
|
+
<td class="name"><code>properties</code></td>
|
|
4234
|
+
|
|
4235
|
+
|
|
4236
|
+
<td class="type">
|
|
4237
|
+
|
|
4238
|
+
</td>
|
|
4239
|
+
|
|
4240
|
+
|
|
4241
|
+
|
|
4242
|
+
|
|
4243
|
+
<td class="description last">An object containing the property and value pairs to set.
|
|
4244
|
+
</td>
|
|
4245
|
+
</tr>
|
|
4246
|
+
|
|
4247
|
+
|
|
4248
|
+
</tbody>
|
|
4249
|
+
</table>
|
|
4250
|
+
|
|
4251
|
+
|
|
4252
|
+
|
|
4253
|
+
<dl class="details">
|
|
4254
|
+
|
|
4255
|
+
|
|
4256
|
+
|
|
4257
|
+
|
|
4258
|
+
|
|
4259
|
+
|
|
4260
|
+
|
|
4261
|
+
|
|
4262
|
+
|
|
4263
|
+
|
|
4264
|
+
|
|
4265
|
+
|
|
4266
|
+
|
|
4267
|
+
|
|
4268
|
+
|
|
4269
|
+
|
|
4270
|
+
|
|
4271
|
+
|
|
4272
|
+
|
|
4273
|
+
|
|
4274
|
+
|
|
4275
|
+
|
|
4276
|
+
|
|
4277
|
+
|
|
4278
|
+
|
|
4279
|
+
|
|
4280
|
+
|
|
4281
|
+
|
|
4282
|
+
|
|
4283
|
+
</dl>
|
|
4284
|
+
|
|
4285
|
+
|
|
4286
|
+
|
|
4287
|
+
|
|
4288
|
+
|
|
4289
|
+
|
|
4290
|
+
|
|
4291
|
+
<h5>Returns:</h5>
|
|
4292
|
+
|
|
4293
|
+
|
|
4294
|
+
|
|
4295
|
+
|
|
4296
|
+
<dl>
|
|
4297
|
+
<dt>
|
|
4298
|
+
Type
|
|
4299
|
+
</dt>
|
|
4300
|
+
<dd>
|
|
4301
|
+
|
|
4302
|
+
<span class="param-type">void</span>
|
|
4303
|
+
|
|
4304
|
+
|
|
4305
|
+
</dd>
|
|
4306
|
+
</dl>
|
|
4307
|
+
|
|
4308
|
+
|
|
4309
|
+
|
|
4310
|
+
|
|
4311
|
+
|
|
4312
|
+
</dd>
|
|
4313
|
+
|
|
4314
|
+
|
|
4315
|
+
|
|
4316
|
+
<dt class="">
|
|
4317
|
+
|
|
4318
|
+
|
|
4319
|
+
|
|
4320
|
+
<h4 id="setProperty" class="name">
|
|
4321
|
+
|
|
4322
|
+
<span class="type-signature"></span>setProperty<span class="signature">(property, value)</span><span class="type-signature"> : {void}</span>
|
|
4323
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#setProperty"></a>
|
|
4324
|
+
|
|
4325
|
+
</h4>
|
|
4326
|
+
|
|
4327
|
+
|
|
4328
|
+
|
|
4329
|
+
|
|
4330
|
+
|
|
4331
|
+
</dt>
|
|
4332
|
+
<dd class="">
|
|
4333
|
+
|
|
4334
|
+
|
|
4335
|
+
<div class="description">
|
|
4336
|
+
Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.
|
|
4337
|
+
|
|
4338
|
+
</div>
|
|
4339
|
+
|
|
4340
|
+
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
|
|
4344
|
+
|
|
4345
|
+
|
|
4346
|
+
|
|
4347
|
+
|
|
4348
|
+
|
|
4349
|
+
|
|
4350
|
+
<h5>Parameters:</h5>
|
|
4351
|
+
|
|
4352
|
+
|
|
4353
|
+
<table class="params">
|
|
4354
|
+
<thead>
|
|
4355
|
+
<tr>
|
|
4356
|
+
|
|
4357
|
+
<th>Name</th>
|
|
4358
|
+
|
|
4359
|
+
|
|
4360
|
+
<th>Type</th>
|
|
4361
|
+
|
|
4362
|
+
|
|
4363
|
+
|
|
4364
|
+
|
|
4365
|
+
|
|
4366
|
+
<th class="last">Description</th>
|
|
4367
|
+
</tr>
|
|
4368
|
+
</thead>
|
|
4369
|
+
|
|
4370
|
+
<tbody>
|
|
4371
|
+
|
|
4372
|
+
|
|
4373
|
+
<tr>
|
|
4374
|
+
|
|
4375
|
+
<td class="name"><code>property</code></td>
|
|
4376
|
+
|
|
4377
|
+
|
|
4378
|
+
<td class="type">
|
|
4379
|
+
|
|
4380
|
+
</td>
|
|
4381
|
+
|
|
4382
|
+
|
|
4383
|
+
|
|
4384
|
+
|
|
4385
|
+
<td class="description last">The property name to set. Supports dot notation for subproperty access.
|
|
4386
|
+
</td>
|
|
4387
|
+
</tr>
|
|
4388
|
+
|
|
4389
|
+
|
|
4390
|
+
|
|
4391
|
+
<tr>
|
|
4392
|
+
|
|
4393
|
+
<td class="name"><code>value</code></td>
|
|
4394
|
+
|
|
4395
|
+
|
|
4396
|
+
<td class="type">
|
|
4397
|
+
|
|
4398
|
+
</td>
|
|
4399
|
+
|
|
4400
|
+
|
|
4401
|
+
|
|
4402
|
+
|
|
4403
|
+
<td class="description last">The new value to set the property to.
|
|
4404
|
+
</td>
|
|
4405
|
+
</tr>
|
|
4406
|
+
|
|
4407
|
+
|
|
4408
|
+
</tbody>
|
|
4409
|
+
</table>
|
|
4410
|
+
|
|
4411
|
+
|
|
4412
|
+
|
|
4413
|
+
<dl class="details">
|
|
4414
|
+
|
|
4415
|
+
|
|
4416
|
+
|
|
4417
|
+
|
|
4418
|
+
|
|
4419
|
+
|
|
4420
|
+
|
|
4421
|
+
|
|
4422
|
+
|
|
4423
|
+
|
|
4424
|
+
|
|
4425
|
+
|
|
4426
|
+
|
|
4427
|
+
|
|
4428
|
+
|
|
4429
|
+
|
|
4430
|
+
|
|
4431
|
+
|
|
4432
|
+
|
|
4433
|
+
|
|
4434
|
+
|
|
4435
|
+
|
|
4436
|
+
|
|
4437
|
+
|
|
4438
|
+
|
|
4439
|
+
|
|
4440
|
+
|
|
4441
|
+
|
|
4442
|
+
|
|
4443
|
+
</dl>
|
|
4444
|
+
|
|
4445
|
+
|
|
4446
|
+
|
|
4447
|
+
|
|
4448
|
+
|
|
4449
|
+
|
|
4450
|
+
|
|
4451
|
+
<h5>Returns:</h5>
|
|
4452
|
+
|
|
4453
|
+
|
|
4454
|
+
|
|
4455
|
+
|
|
4456
|
+
<dl>
|
|
4457
|
+
<dt>
|
|
4458
|
+
Type
|
|
4459
|
+
</dt>
|
|
4460
|
+
<dd>
|
|
4461
|
+
|
|
4462
|
+
<span class="param-type">void</span>
|
|
4463
|
+
|
|
4464
|
+
|
|
4465
|
+
</dd>
|
|
4466
|
+
</dl>
|
|
4467
|
+
|
|
4468
|
+
|
|
4469
|
+
|
|
4470
|
+
|
|
4471
|
+
|
|
4472
|
+
</dd>
|
|
4473
|
+
|
|
4474
|
+
|
|
4475
|
+
|
|
4476
|
+
<dt class="">
|
|
4477
|
+
|
|
4478
|
+
|
|
4479
|
+
|
|
4480
|
+
<h4 id="showMessages" class="name">
|
|
4481
|
+
|
|
4482
|
+
<span class="type-signature"></span>showMessages<span class="signature"></span><span class="type-signature"> : {<a href="CustomElementOverview.html#ce-attrs-any-section">any</a>}</span>
|
|
4483
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#showMessages"></a>
|
|
4484
|
+
|
|
4485
|
+
</h4>
|
|
4486
|
+
|
|
4487
|
+
|
|
4488
|
+
|
|
4489
|
+
|
|
4490
|
+
|
|
4491
|
+
</dt>
|
|
4492
|
+
<dd class="">
|
|
4493
|
+
|
|
4494
|
+
|
|
4495
|
+
<div class="description">
|
|
4496
|
+
Takes all deferred messages and shows them.
|
|
4497
|
+
It then updates the valid property;
|
|
4498
|
+
e.g., if the valid state was "invalidHidden" before showMessages(),
|
|
4499
|
+
the valid state will become "invalidShown" after showMessages().
|
|
4500
|
+
If there were no deferred messages this method simply returns.
|
|
4501
|
+
|
|
4502
|
+
</div>
|
|
4503
|
+
|
|
4504
|
+
|
|
4505
|
+
|
|
4506
|
+
|
|
4507
|
+
|
|
4508
|
+
|
|
4509
|
+
|
|
4510
|
+
|
|
4511
|
+
|
|
4512
|
+
|
|
4513
|
+
|
|
4514
|
+
|
|
4515
|
+
|
|
4516
|
+
<dl class="details">
|
|
4517
|
+
|
|
4518
|
+
|
|
4519
|
+
|
|
4520
|
+
|
|
4521
|
+
|
|
4522
|
+
|
|
4523
|
+
|
|
4524
|
+
|
|
4525
|
+
|
|
4526
|
+
|
|
4527
|
+
|
|
4528
|
+
|
|
4529
|
+
|
|
4530
|
+
|
|
4531
|
+
|
|
4532
|
+
|
|
4533
|
+
|
|
4534
|
+
|
|
4535
|
+
|
|
4536
|
+
|
|
4537
|
+
|
|
4538
|
+
|
|
4539
|
+
|
|
4540
|
+
|
|
4541
|
+
|
|
4542
|
+
|
|
4543
|
+
|
|
4544
|
+
|
|
4545
|
+
|
|
4546
|
+
</dl>
|
|
4547
|
+
|
|
4548
|
+
|
|
4549
|
+
|
|
4550
|
+
|
|
4551
|
+
|
|
4552
|
+
|
|
4553
|
+
|
|
4554
|
+
<h5>Returns:</h5>
|
|
4555
|
+
|
|
4556
|
+
|
|
4557
|
+
|
|
4558
|
+
|
|
4559
|
+
<dl>
|
|
4560
|
+
<dt>
|
|
4561
|
+
Type
|
|
4562
|
+
</dt>
|
|
4563
|
+
<dd>
|
|
4564
|
+
|
|
4565
|
+
<span class="param-type"><a href="CustomElementOverview.html#ce-attrs-any-section">any</a></span>
|
|
4566
|
+
|
|
4567
|
+
|
|
4568
|
+
</dd>
|
|
4569
|
+
</dl>
|
|
4570
|
+
|
|
4571
|
+
|
|
4572
|
+
|
|
4573
|
+
|
|
4574
|
+
|
|
4575
|
+
</dd>
|
|
4576
|
+
|
|
4577
|
+
|
|
4578
|
+
|
|
4579
|
+
<dt class="">
|
|
4580
|
+
|
|
4581
|
+
|
|
4582
|
+
|
|
4583
|
+
<h4 id="validate" class="name">
|
|
4584
|
+
|
|
4585
|
+
<span class="type-signature"></span>validate<span class="signature"></span><span class="type-signature"> : {Promise}</span>
|
|
4586
|
+
<a class="bookmarkable-link" title="Bookmarkable Link" href="#validate"></a>
|
|
4587
|
+
|
|
4588
|
+
</h4>
|
|
4589
|
+
|
|
4590
|
+
|
|
4591
|
+
|
|
4592
|
+
|
|
4593
|
+
|
|
4594
|
+
</dt>
|
|
4595
|
+
<dd class="">
|
|
4596
|
+
|
|
4597
|
+
|
|
4598
|
+
<div class="description">
|
|
4599
|
+
Validates the component's display value using the converter and
|
|
4600
|
+
all validators registered on the component and updates the value
|
|
4601
|
+
option by performing the following steps.
|
|
4602
|
+
<ol>
|
|
4603
|
+
<li>All messages are cleared, including custom messages added by the app.<li>
|
|
4604
|
+
<li>
|
|
4605
|
+
If no converter is present then processing continues to next step. If a converter is present,
|
|
4606
|
+
the UI value is first converted (i.e., parsed). If there is a parse error then the messages are shown.
|
|
4607
|
+
</li>
|
|
4608
|
+
<li>
|
|
4609
|
+
If there are no validators setup for the component the value option is updated using the display value.
|
|
4610
|
+
Otherwise all validators are run in sequence using the parsed value from the previous step.
|
|
4611
|
+
The implicit required validator is run first if the component is marked required.
|
|
4612
|
+
When a validation error is encountered it is remembered and the next validator in the sequence is run.
|
|
4613
|
+
</li>
|
|
4614
|
+
<li>
|
|
4615
|
+
At the end of validation if there are errors, the messages are shown.
|
|
4616
|
+
If there were no errors, then the value option is updated.
|
|
4617
|
+
</li>
|
|
4618
|
+
</ol>
|
|
4619
|
+
|
|
4620
|
+
</div>
|
|
4621
|
+
|
|
4622
|
+
|
|
4623
|
+
|
|
4624
|
+
|
|
4625
|
+
|
|
4626
|
+
|
|
4627
|
+
|
|
4628
|
+
|
|
4629
|
+
|
|
4630
|
+
|
|
4631
|
+
|
|
4632
|
+
|
|
4633
|
+
|
|
4634
|
+
<dl class="details">
|
|
4635
|
+
|
|
4636
|
+
|
|
4637
|
+
|
|
4638
|
+
|
|
4639
|
+
|
|
4640
|
+
|
|
4641
|
+
|
|
4642
|
+
|
|
4643
|
+
|
|
4644
|
+
|
|
4645
|
+
|
|
4646
|
+
|
|
4647
|
+
|
|
4648
|
+
|
|
4649
|
+
|
|
4650
|
+
|
|
4651
|
+
|
|
4652
|
+
|
|
4653
|
+
|
|
4654
|
+
|
|
4655
|
+
|
|
4656
|
+
|
|
4657
|
+
|
|
4658
|
+
|
|
4659
|
+
|
|
4660
|
+
|
|
4661
|
+
|
|
4662
|
+
|
|
4663
|
+
|
|
4664
|
+
</dl>
|
|
4665
|
+
|
|
4666
|
+
|
|
4667
|
+
|
|
4668
|
+
|
|
4669
|
+
|
|
4670
|
+
|
|
4671
|
+
|
|
4672
|
+
<h5>Returns:</h5>
|
|
4673
|
+
|
|
4674
|
+
|
|
4675
|
+
<div class="param-desc">
|
|
4676
|
+
<p>Promise resolves to "valid" if there were no converter parse errors and the component
|
|
4677
|
+
passed all validations. The Promise resolves to "invalid" if there were converter
|
|
4678
|
+
parse errors or if there were validation errors.</p>
|
|
4679
|
+
</div>
|
|
4680
|
+
|
|
4681
|
+
|
|
4682
|
+
|
|
4683
|
+
<dl>
|
|
4684
|
+
<dt>
|
|
4685
|
+
Type
|
|
4686
|
+
</dt>
|
|
4687
|
+
<dd>
|
|
4688
|
+
|
|
4689
|
+
<span class="param-type">Promise</span>
|
|
4690
|
+
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
|
|
4696
|
+
|
|
4697
|
+
|
|
4698
|
+
|
|
4699
|
+
</dd>
|
|
4700
|
+
|
|
4701
|
+
|
|
4702
|
+
</dl>
|
|
4703
|
+
|
|
4704
|
+
</article>
|
|
4705
|
+
|
|
4706
|
+
|
|
4707
|
+
</section>
|
|
4708
|
+
|
|
4709
|
+
|
|
4710
|
+
|
|
4711
|
+
|
|
4712
|
+
<footer>
|
|
4713
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Fri Jan 06 2023 02:37:41 GMT+0000 (Coordinated Universal Time)<br>
|
|
4714
|
+
<span class="product-docs-footer">Copyright © 2014, 2023 Oracle. All rights reserved.<span>
|
|
4715
|
+
</footer>
|
|
4716
|
+
</div>
|
|
4717
|
+
|
|
4718
|
+
<script> prettyPrint(); </script>
|
|
4719
|
+
</body>
|
|
4720
|
+
</html>
|