@globalpayments/vega 2.77.1 → 2.78.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/dist/cjs/{app-globals-1021e33e.js → app-globals-55e26945.js} +6 -6
- package/dist/cjs/{breakpoints-751d433a.js → breakpoints-a8ff22f0.js} +1 -1
- package/dist/cjs/{child-nodes-event-prevent-slimmer-cc6d2919.js → child-nodes-event-prevent-slimmer-dd0bb8b6.js} +1 -1
- package/dist/cjs/{code-block-f9b86a25.js → code-block-1a5fafed.js} +2 -2
- package/dist/cjs/{component-value-history-controller-slimmer.abstract-6bcff70b.js → component-value-history-controller-slimmer.abstract-42683f23.js} +4 -4
- package/dist/cjs/{date-required-rule-d3c2d088.js → date-required-rule-ad536cb5.js} +1 -1
- package/dist/cjs/{design-token-b21879b6.js → design-token-45ebd5e4.js} +3 -3
- package/dist/cjs/{dto-renderer-manager-e2823eb8.js → dto-renderer-manager-7557d562.js} +3 -3
- package/dist/cjs/{element-appender-slimmer-40d39bba.js → element-appender-slimmer-16ec8591.js} +5 -5
- package/dist/cjs/{event-emit-slimmer-062cdcb8.js → event-emit-slimmer-c84121c8.js} +1 -1
- package/dist/cjs/{form-field-controller-slimmer-1b3a1388.js → form-field-controller-slimmer-73f5849e.js} +4 -4
- package/dist/cjs/{image-annotation-action-b83283d4.js → image-annotation-action-f275863e.js} +3 -3
- package/dist/cjs/index.cjs.js +18 -18
- package/dist/cjs/{inject-keyboard-manager-ea5c598e.js → inject-keyboard-manager-6667c0f1.js} +1 -1
- package/dist/cjs/{internal-translation-controller-1f84ab0a.js → internal-translation-controller-24df468f.js} +1 -0
- package/dist/cjs/{internal-vega-event-manager-f7ecf3d4.js → internal-vega-event-manager-cc0f511c.js} +2 -2
- package/dist/cjs/{keyboard-manager-16494c34.js → keyboard-manager-7de7ecfd.js} +1 -1
- package/dist/cjs/{keyboard-manager-slimmer-5b8fa209.js → keyboard-manager-slimmer-b44f0dc9.js} +1 -1
- package/dist/cjs/loader.cjs.js +13 -13
- package/dist/cjs/{month-view-generator-1a57578d.js → month-view-generator-36c42772.js} +1 -1
- package/dist/cjs/{page-resize-observer-slimmer-7f065ee1.js → page-resize-observer-slimmer-e050cd26.js} +1 -1
- package/dist/cjs/{public-rules-5bd1624d.js → public-rules-6c6cb4ac.js} +9 -9
- package/dist/cjs/{range-7a038973.js → range-e298d4aa.js} +1 -1
- package/dist/cjs/{responsive-format-facade-0b65ce4a.js → responsive-format-facade-bddac47c.js} +3 -3
- package/dist/cjs/{rich-text-editor-required-rule-d984c0b6.js → rich-text-editor-required-rule-6346a888.js} +1 -1
- package/dist/cjs/{string-format-strategy.abstract-714bfad2.js → string-format-strategy.abstract-814d66c4.js} +1 -1
- package/dist/cjs/{string-input-formatter-slimmer-9ef2ec7a.js → string-input-formatter-slimmer-749e3cfe.js} +3 -3
- package/dist/cjs/{string-mask-strategy-bd2c18df.js → string-mask-strategy-d00871c2.js} +2 -2
- package/dist/cjs/{style-formatter-7a4e9811.js → style-formatter-94c1a1ff.js} +2 -2
- package/dist/cjs/{sub-state-notify-slimmer-58121111.js → sub-state-notify-slimmer-ac1dae32.js} +1 -1
- package/dist/cjs/{sub-state-observer-slimmer-1dfbc4c3.js → sub-state-observer-slimmer-e692d849.js} +1 -1
- package/dist/cjs/{time-required-rule-50784b9f.js → time-required-rule-f1f3c8c2.js} +1 -1
- package/dist/cjs/{token-extension-5a1c473e.js → token-extension-1e98ddf3.js} +7 -7
- package/dist/cjs/{translation-slimmer-2c207e34.js → translation-slimmer-3fa03d81.js} +1 -1
- package/dist/cjs/{type-guard-cd0376d4.js → type-guard-a0d9ff1f.js} +2 -2
- package/dist/cjs/{ui-32e69595.js → ui-024696c0.js} +8 -1
- package/dist/cjs/{valid-credit-card-number-rule-3f8dc897.js → valid-credit-card-number-rule-cba7d66a.js} +1 -1
- package/dist/cjs/vega-accordion.cjs.entry.js +9 -9
- package/dist/cjs/vega-app-header-button.cjs.entry.js +11 -11
- package/dist/cjs/vega-banner.cjs.entry.js +3 -3
- package/dist/cjs/vega-box.cjs.entry.js +8 -8
- package/dist/cjs/vega-breadcrumb.cjs.entry.js +4 -4
- package/dist/cjs/vega-button-circle.cjs.entry.js +11 -11
- package/dist/cjs/vega-button-group_2.cjs.entry.js +7 -7
- package/dist/cjs/vega-button-link.cjs.entry.js +4 -4
- package/dist/cjs/vega-button.cjs.entry.js +11 -11
- package/dist/cjs/vega-calendar_4.cjs.entry.js +14 -14
- package/dist/cjs/vega-card.cjs.entry.js +6 -6
- package/dist/cjs/vega-carousel.cjs.entry.js +9 -9
- package/dist/cjs/vega-checkbox_2.cjs.entry.js +11 -11
- package/dist/cjs/vega-chip.cjs.entry.js +11 -11
- package/dist/cjs/vega-code-block.cjs.entry.js +16 -15
- package/dist/cjs/vega-color-picker.cjs.entry.js +10 -10
- package/dist/cjs/vega-combo-box.cjs.entry.js +14 -14
- package/dist/cjs/vega-date-picker_2.cjs.entry.js +23 -23
- package/dist/cjs/vega-dialog_2.cjs.entry.js +11 -11
- package/dist/cjs/vega-divider.cjs.entry.js +7 -7
- package/dist/cjs/vega-dropdown_5.cjs.entry.js +17 -17
- package/dist/cjs/vega-env-manager-23b8b23c.js +2 -2
- package/dist/cjs/{vega-event-id-ee01d8dd.js → vega-event-id-c08ce3d3.js} +2 -0
- package/dist/cjs/vega-field-label.cjs.entry.js +3 -3
- package/dist/cjs/vega-file-uploader.cjs.entry.js +11 -11
- package/dist/cjs/vega-flag-icon.cjs.entry.js +6 -6
- package/dist/cjs/vega-flex.cjs.entry.js +9 -9
- package/dist/cjs/vega-font.cjs.entry.js +7 -7
- package/dist/cjs/vega-form.cjs.entry.js +13 -13
- package/dist/cjs/vega-grid.cjs.entry.js +6 -6
- package/dist/cjs/vega-icon.cjs.entry.js +6 -6
- package/dist/cjs/vega-image-uploader.cjs.entry.js +14 -14
- package/dist/cjs/vega-input-credit-card.cjs.entry.js +16 -16
- package/dist/cjs/vega-input-numeric.cjs.entry.js +102 -42
- package/dist/cjs/vega-input-passcode.cjs.entry.js +77 -34
- package/dist/cjs/vega-input-phone-number.cjs.entry.js +91 -41
- package/dist/cjs/vega-input-range.cjs.entry.js +27 -12
- package/dist/cjs/vega-input-select.cjs.entry.js +17 -17
- package/dist/cjs/vega-input.cjs.entry.js +201 -69
- package/dist/cjs/{vega-internal-event-id-f2465f1b.js → vega-internal-event-id-e0aeac45.js} +2 -0
- package/dist/cjs/vega-item-toggle.cjs.entry.js +4 -4
- package/dist/cjs/vega-left-nav_5.cjs.entry.js +13 -13
- package/dist/cjs/vega-loader-wrapper_2.cjs.entry.js +6 -6
- package/dist/cjs/vega-page-notification_2.cjs.entry.js +1 -1
- package/dist/cjs/vega-pagination-page-selector-mobile.cjs.entry.js +4 -4
- package/dist/cjs/vega-pagination-page-size-selector-mobile.cjs.entry.js +4 -4
- package/dist/cjs/vega-pagination.cjs.entry.js +12 -12
- package/dist/cjs/vega-popover_2.cjs.entry.js +14 -14
- package/dist/cjs/vega-progress-tracker_2.cjs.entry.js +12 -12
- package/dist/cjs/vega-radio_2.cjs.entry.js +14 -14
- package/dist/cjs/vega-rich-text-content.cjs.entry.js +10 -10
- package/dist/cjs/vega-rich-text-editor_4.cjs.entry.js +474 -379
- package/dist/cjs/vega-segment-control.cjs.entry.js +6 -6
- package/dist/cjs/vega-selection-chip_2.cjs.entry.js +14 -14
- package/dist/cjs/vega-selection-tile_2.cjs.entry.js +12 -12
- package/dist/cjs/vega-sidenav_3.cjs.entry.js +12 -12
- package/dist/cjs/vega-signature-capture.cjs.entry.js +14 -14
- package/dist/cjs/vega-stepper.cjs.entry.js +12 -12
- package/dist/cjs/vega-tab-group_2.cjs.entry.js +7 -7
- package/dist/cjs/vega-table_11.cjs.entry.js +14 -14
- package/dist/cjs/vega-text.cjs.entry.js +3 -3
- package/dist/cjs/vega-textarea.cjs.entry.js +110 -42
- package/dist/cjs/vega-time-picker_2.cjs.entry.js +18 -18
- package/dist/cjs/vega-toggle-switch.cjs.entry.js +10 -10
- package/dist/cjs/vega-tooltip_2.cjs.entry.js +10 -10
- package/dist/cjs/vega.cjs.js +13 -13
- package/dist/cjs/{wait-for-component-did-render-70a01bf9.js → wait-for-component-did-render-cbebfc33.js} +1 -1
- package/dist/collection/components/vega-checkbox/vega-checkbox-group/vega-checkbox-group.js +1 -1
- package/dist/collection/components/vega-code-block/slimmers/renderers/vega-code-block-content-renderer.js +4 -0
- package/dist/collection/components/vega-flex/vega-flex.css +32 -0
- package/dist/collection/components/vega-flex/vega-flex.js +1 -1
- package/dist/collection/components/vega-grid/vega-grid.js +2 -2
- package/dist/collection/components/vega-input/slimmers/renderers/vega-input-input-container-renderer.js +1 -1
- package/dist/collection/components/vega-input/slimmers/renderers/vega-input-prefix-slot-renderer.js +1 -1
- package/dist/collection/components/vega-input/vega-input.js +358 -100
- package/dist/collection/components/vega-input-credit-card/vega-input-credit-card.js +1 -1
- package/dist/collection/components/vega-input-numeric/vega-input-numeric.js +175 -49
- package/dist/collection/components/vega-input-passcode/vega-input-passcode.js +123 -35
- package/dist/collection/components/vega-input-phone-number/vega-input-phone-number.js +145 -56
- package/dist/collection/components/vega-input-range/slimmers/renderers/vega-input-range-input-renderer.js +15 -0
- package/dist/collection/components/vega-input-select/vega-input-select.js +6 -5
- package/dist/collection/components/vega-radio/vega-radio-group/vega-radio-group.js +1 -1
- package/dist/collection/components/vega-rich-text-editor/slimmers/renderers/tools/source-edit-toolbar-button-slimmer.js +2 -2
- package/dist/collection/components/vega-rich-text-editor/slimmers/renderers/vega-rich-text-editor-renderer.js +4 -17
- package/dist/collection/components/vega-rich-text-editor/slimmers/renderers/vega-rich-text-editor-source-view-renderer.js +102 -0
- package/dist/collection/components/vega-rich-text-editor/vega-rich-text-editor.js +49 -1
- package/dist/collection/components/vega-stepper/vega-stepper.js +1 -1
- package/dist/collection/components/vega-textarea/vega-textarea.js +183 -52
- package/dist/collection/constants/ui.js +9 -1
- package/dist/collection/helpers/event-manager/event-id/component-event-id-map.js +2 -2
- package/dist/collection/helpers/event-manager/event-id/vega-event-id.js +1 -0
- package/dist/collection/helpers/event-manager/event-id/vega-internal-event-id.js +1 -0
- package/dist/collection/helpers/translation/locales/en.js +1 -0
- package/dist/collection/helpers/translation/tests/internal-translation-controller.test.js +2 -0
- package/dist/collection/helpers/translation/tests/translation.test.js +14 -0
- package/dist/esm/{app-globals-0b3b7111.js → app-globals-3b97bb20.js} +6 -6
- package/dist/esm/{breakpoints-56e5407b.js → breakpoints-13353e09.js} +1 -1
- package/dist/esm/{child-nodes-event-prevent-slimmer-331312b8.js → child-nodes-event-prevent-slimmer-4feabae0.js} +1 -1
- package/dist/esm/{code-block-2408a812.js → code-block-d65bab61.js} +2 -2
- package/dist/esm/{component-value-history-controller-slimmer.abstract-ac40820f.js → component-value-history-controller-slimmer.abstract-556fcf2a.js} +4 -4
- package/dist/esm/{date-required-rule-09d5aa16.js → date-required-rule-4ffd9cae.js} +1 -1
- package/dist/esm/{design-token-7dec1eab.js → design-token-b518a2aa.js} +3 -3
- package/dist/esm/{dto-renderer-manager-d413de1e.js → dto-renderer-manager-73df5cbe.js} +3 -3
- package/dist/esm/{element-appender-slimmer-5d573612.js → element-appender-slimmer-36b7a572.js} +5 -5
- package/dist/esm/{event-emit-slimmer-ffaecb9a.js → event-emit-slimmer-f879fd58.js} +1 -1
- package/dist/esm/{form-field-controller-slimmer-e1a5a884.js → form-field-controller-slimmer-9a880420.js} +4 -4
- package/dist/esm/{image-annotation-action-54936eaa.js → image-annotation-action-eb3dcad5.js} +3 -3
- package/dist/esm/index.js +18 -18
- package/dist/esm/{inject-keyboard-manager-9339bba8.js → inject-keyboard-manager-e5481833.js} +1 -1
- package/dist/esm/{internal-translation-controller-113a6288.js → internal-translation-controller-0787a7a7.js} +1 -0
- package/dist/esm/{internal-vega-event-manager-32a3d848.js → internal-vega-event-manager-3aebbe55.js} +2 -2
- package/dist/esm/{keyboard-manager-f9bfa678.js → keyboard-manager-4dfc625f.js} +1 -1
- package/dist/esm/{keyboard-manager-slimmer-c8898843.js → keyboard-manager-slimmer-87bf68f1.js} +1 -1
- package/dist/esm/loader.js +13 -13
- package/dist/esm/{month-view-generator-160a9feb.js → month-view-generator-94134ec5.js} +1 -1
- package/dist/esm/{page-resize-observer-slimmer-d6af0d86.js → page-resize-observer-slimmer-e0505250.js} +1 -1
- package/dist/esm/{public-rules-41561e6e.js → public-rules-49912d52.js} +9 -9
- package/dist/esm/{range-a5d78e69.js → range-0a22b512.js} +1 -1
- package/dist/esm/{responsive-format-facade-2a36c54a.js → responsive-format-facade-b3799ff9.js} +3 -3
- package/dist/esm/{rich-text-editor-required-rule-b09039da.js → rich-text-editor-required-rule-d86e3a51.js} +1 -1
- package/dist/esm/{string-format-strategy.abstract-944f759b.js → string-format-strategy.abstract-e40a0df7.js} +1 -1
- package/dist/esm/{string-input-formatter-slimmer-2508d88b.js → string-input-formatter-slimmer-076764fc.js} +3 -3
- package/dist/esm/{string-mask-strategy-f9e252a2.js → string-mask-strategy-df1f5707.js} +2 -2
- package/dist/esm/{style-formatter-6db1e890.js → style-formatter-95255392.js} +2 -2
- package/dist/esm/{sub-state-notify-slimmer-5133f1a8.js → sub-state-notify-slimmer-f4b3b0b9.js} +1 -1
- package/dist/esm/{sub-state-observer-slimmer-478c9f41.js → sub-state-observer-slimmer-058feaf0.js} +1 -1
- package/dist/esm/{time-required-rule-c7cfb257.js → time-required-rule-b4af75ae.js} +1 -1
- package/dist/esm/{token-extension-25df8dbb.js → token-extension-ffd98170.js} +7 -7
- package/dist/esm/{translation-slimmer-9f0339aa.js → translation-slimmer-e788cae4.js} +1 -1
- package/dist/esm/{type-guard-af324dcd.js → type-guard-f69d2935.js} +2 -2
- package/dist/esm/{ui-28fd4193.js → ui-41f725b7.js} +8 -1
- package/dist/esm/{valid-credit-card-number-rule-099dba7d.js → valid-credit-card-number-rule-c023326d.js} +1 -1
- package/dist/esm/vega-accordion.entry.js +9 -9
- package/dist/esm/vega-app-header-button.entry.js +11 -11
- package/dist/esm/vega-banner.entry.js +3 -3
- package/dist/esm/vega-box.entry.js +8 -8
- package/dist/esm/vega-breadcrumb.entry.js +4 -4
- package/dist/esm/vega-button-circle.entry.js +11 -11
- package/dist/esm/vega-button-group_2.entry.js +7 -7
- package/dist/esm/vega-button-link.entry.js +4 -4
- package/dist/esm/vega-button.entry.js +11 -11
- package/dist/esm/vega-calendar_4.entry.js +14 -14
- package/dist/esm/vega-card.entry.js +6 -6
- package/dist/esm/vega-carousel.entry.js +9 -9
- package/dist/esm/vega-checkbox_2.entry.js +11 -11
- package/dist/esm/vega-chip.entry.js +11 -11
- package/dist/esm/vega-code-block.entry.js +16 -15
- package/dist/esm/vega-color-picker.entry.js +10 -10
- package/dist/esm/vega-combo-box.entry.js +14 -14
- package/dist/esm/vega-date-picker_2.entry.js +23 -23
- package/dist/esm/vega-dialog_2.entry.js +11 -11
- package/dist/esm/vega-divider.entry.js +7 -7
- package/dist/esm/vega-dropdown_5.entry.js +17 -17
- package/dist/esm/vega-env-manager-8f8dc473.js +2 -2
- package/dist/esm/{vega-event-id-38aa77a0.js → vega-event-id-fdc58a67.js} +2 -1
- package/dist/esm/vega-field-label.entry.js +3 -3
- package/dist/esm/vega-file-uploader.entry.js +11 -11
- package/dist/esm/vega-flag-icon.entry.js +6 -6
- package/dist/esm/vega-flex.entry.js +9 -9
- package/dist/esm/vega-font.entry.js +7 -7
- package/dist/esm/vega-form.entry.js +13 -13
- package/dist/esm/vega-grid.entry.js +6 -6
- package/dist/esm/vega-icon.entry.js +6 -6
- package/dist/esm/vega-image-uploader.entry.js +14 -14
- package/dist/esm/vega-input-credit-card.entry.js +16 -16
- package/dist/esm/vega-input-numeric.entry.js +102 -42
- package/dist/esm/vega-input-passcode.entry.js +77 -34
- package/dist/esm/vega-input-phone-number.entry.js +91 -41
- package/dist/esm/vega-input-range.entry.js +27 -12
- package/dist/esm/vega-input-select.entry.js +17 -17
- package/dist/esm/vega-input.entry.js +201 -69
- package/dist/esm/{vega-internal-event-id-799d012e.js → vega-internal-event-id-12783594.js} +2 -1
- package/dist/esm/vega-item-toggle.entry.js +4 -4
- package/dist/esm/vega-left-nav_5.entry.js +13 -13
- package/dist/esm/vega-loader-wrapper_2.entry.js +6 -6
- package/dist/esm/vega-page-notification_2.entry.js +1 -1
- package/dist/esm/vega-pagination-page-selector-mobile.entry.js +4 -4
- package/dist/esm/vega-pagination-page-size-selector-mobile.entry.js +4 -4
- package/dist/esm/vega-pagination.entry.js +12 -12
- package/dist/esm/vega-popover_2.entry.js +14 -14
- package/dist/esm/vega-progress-tracker_2.entry.js +12 -12
- package/dist/esm/vega-radio_2.entry.js +14 -14
- package/dist/esm/vega-rich-text-content.entry.js +10 -10
- package/dist/esm/vega-rich-text-editor_4.entry.js +474 -379
- package/dist/esm/vega-segment-control.entry.js +6 -6
- package/dist/esm/vega-selection-chip_2.entry.js +14 -14
- package/dist/esm/vega-selection-tile_2.entry.js +12 -12
- package/dist/esm/vega-sidenav_3.entry.js +12 -12
- package/dist/esm/vega-signature-capture.entry.js +14 -14
- package/dist/esm/vega-stepper.entry.js +12 -12
- package/dist/esm/vega-tab-group_2.entry.js +7 -7
- package/dist/esm/vega-table_11.entry.js +14 -14
- package/dist/esm/vega-text.entry.js +3 -3
- package/dist/esm/vega-textarea.entry.js +110 -42
- package/dist/esm/vega-time-picker_2.entry.js +18 -18
- package/dist/esm/vega-toggle-switch.entry.js +10 -10
- package/dist/esm/vega-tooltip_2.entry.js +10 -10
- package/dist/esm/vega.js +13 -13
- package/dist/esm/{wait-for-component-did-render-b08ef07b.js → wait-for-component-did-render-4d0a3428.js} +1 -1
- package/dist/sri/vega-sri-manifest.json +345 -345
- package/dist/types/components/vega-input/vega-input.d.ts +317 -79
- package/dist/types/components/vega-input-numeric/vega-input-numeric.d.ts +117 -42
- package/dist/types/components/vega-input-passcode/vega-input-passcode.d.ts +82 -28
- package/dist/types/components/vega-input-phone-number/vega-input-phone-number.d.ts +99 -34
- package/dist/types/components/vega-input-range/slimmers/renderers/vega-input-range-input-renderer.d.ts +8 -0
- package/dist/types/components/vega-input-select/vega-input-select.d.ts +2 -2
- package/dist/types/components/vega-rich-text-editor/slimmers/renderers/tools/source-edit-toolbar-button-slimmer.d.ts +1 -1
- package/dist/types/components/vega-rich-text-editor/slimmers/renderers/vega-rich-text-editor-renderer.d.ts +1 -3
- package/dist/types/components/vega-rich-text-editor/slimmers/renderers/vega-rich-text-editor-source-view-renderer.d.ts +37 -0
- package/dist/types/components/vega-rich-text-editor/vega-rich-text-editor.d.ts +16 -0
- package/dist/types/components/vega-textarea/vega-textarea.d.ts +123 -41
- package/dist/types/components.d.ts +418 -218
- package/dist/types/constants/ui.d.ts +2 -2
- package/dist/types/helpers/event-manager/event-id/vega-event-id.d.ts +1 -0
- package/dist/types/helpers/event-manager/event-id/vega-internal-event-id.d.ts +1 -0
- package/dist/types/helpers/translation/interface.d.ts +2 -1
- package/dist/types/types/type-guard.d.ts +3 -3
- package/dist/vega/index.esm.js +1 -1
- package/dist/vega/p-0009e0bc.entry.js +1 -0
- package/dist/vega/{p-1a9b361b.js → p-02976501.js} +1 -1
- package/dist/vega/{p-bf6fc19f.entry.js → p-03280f85.entry.js} +1 -1
- package/dist/vega/{p-a79fdf2f.js → p-03b1e442.js} +1 -1
- package/dist/vega/{p-33f9ad94.entry.js → p-0681ffee.entry.js} +1 -1
- package/dist/vega/{p-e4c99b72.entry.js → p-093aa0cb.entry.js} +1 -1
- package/dist/vega/{p-3b9fc697.entry.js → p-1828f9e6.entry.js} +1 -1
- package/dist/vega/{p-d70e1b75.entry.js → p-19883e27.entry.js} +1 -1
- package/dist/vega/p-1e015382.js +1 -0
- package/dist/vega/{p-eab9d999.entry.js → p-1ff45314.entry.js} +1 -1
- package/dist/vega/{p-9a3a5b9e.js → p-24b4c64f.js} +1 -1
- package/dist/vega/{p-c7a9960f.entry.js → p-2e7ec8e0.entry.js} +1 -1
- package/dist/vega/{p-0ac9a732.entry.js → p-309b5016.entry.js} +1 -1
- package/dist/vega/{p-c871619c.entry.js → p-3592a26d.entry.js} +1 -1
- package/dist/vega/{p-b35bb4a2.entry.js → p-383e235a.entry.js} +1 -1
- package/dist/vega/p-3992038a.js +1 -0
- package/dist/vega/{p-02c9796a.js → p-3a537cd0.js} +1 -1
- package/dist/vega/{p-e0fb1f60.entry.js → p-3b7ad04b.entry.js} +1 -1
- package/dist/vega/{p-d0975995.entry.js → p-3d4b8066.entry.js} +1 -1
- package/dist/vega/{p-7d7aaff9.entry.js → p-3e484d99.entry.js} +1 -1
- package/dist/vega/{p-70444f6f.entry.js → p-3fd3861c.entry.js} +1 -1
- package/dist/vega/{p-600f7d6c.js → p-4079e932.js} +1 -1
- package/dist/vega/{p-5eb7f382.js → p-43df17a1.js} +1 -1
- package/dist/vega/{p-e1c017d1.entry.js → p-473ceda5.entry.js} +1 -1
- package/dist/vega/{p-ffb3e479.entry.js → p-474b97cf.entry.js} +1 -1
- package/dist/vega/{p-242fbcad.entry.js → p-47c202eb.entry.js} +1 -1
- package/dist/vega/p-4e0344bc.entry.js +1 -0
- package/dist/vega/{p-ed9ad4fd.entry.js → p-4efe9cd8.entry.js} +1 -1
- package/dist/vega/{p-36a09524.entry.js → p-536ad3d7.entry.js} +1 -1
- package/dist/vega/{p-3237be8b.entry.js → p-53e0b2bd.entry.js} +1 -1
- package/dist/vega/p-57180993.entry.js +1 -0
- package/dist/vega/{p-e827d56d.js → p-5b238c6d.js} +1 -1
- package/dist/vega/p-5ba34330.js +1 -0
- package/dist/vega/{p-acbb96b3.entry.js → p-5e1d0f21.entry.js} +1 -1
- package/dist/vega/{p-cf6bfac7.js → p-5ed5aa26.js} +1 -1
- package/dist/vega/p-5f377954.js +1 -1
- package/dist/vega/{p-d64fab3d.js → p-5f81beae.js} +1 -1
- package/dist/vega/{p-ef603656.entry.js → p-6a8ac66d.entry.js} +1 -1
- package/dist/vega/{p-051bbce6.js → p-6b3776ec.js} +1 -1
- package/dist/vega/{p-aaf9b39f.entry.js → p-6b4021f0.entry.js} +1 -1
- package/dist/vega/{p-4f146dae.js → p-6cf28c27.js} +1 -1
- package/dist/vega/{p-0037068c.entry.js → p-71cd1d9e.entry.js} +1 -1
- package/dist/vega/{p-ddce3e0e.entry.js → p-7440325c.entry.js} +1 -1
- package/dist/vega/p-764425e4.entry.js +1 -0
- package/dist/vega/{p-ff287001.entry.js → p-77908e45.entry.js} +1 -1
- package/dist/vega/{p-4c060ba9.js → p-7ade785e.js} +1 -1
- package/dist/vega/{p-c857e6e2.js → p-7db5e003.js} +1 -1
- package/dist/vega/{p-021d4ae4.js → p-7db918f4.js} +1 -1
- package/dist/vega/{p-ea96b0f9.entry.js → p-7f398d23.entry.js} +1 -1
- package/dist/vega/{p-1ccba615.entry.js → p-7f665911.entry.js} +1 -1
- package/dist/vega/{p-9466619f.entry.js → p-840f156e.entry.js} +1 -1
- package/dist/vega/{p-a17312a6.js → p-87379d3c.js} +1 -1
- package/dist/vega/{p-638d30a5.entry.js → p-87ed06cd.entry.js} +1 -1
- package/dist/vega/{p-fc049028.js → p-882a220c.js} +1 -1
- package/dist/vega/p-898bcb24.js +1 -0
- package/dist/vega/{p-d07f5d5a.entry.js → p-8fbb677e.entry.js} +1 -1
- package/dist/vega/p-9493d87a.js +1 -0
- package/dist/vega/{p-c7b9b7c2.js → p-951c0172.js} +1 -1
- package/dist/vega/p-95919581.entry.js +1 -0
- package/dist/vega/{p-7c39ce96.js → p-95d1b547.js} +1 -1
- package/dist/vega/{p-c086529c.entry.js → p-99c8f9a4.entry.js} +1 -1
- package/dist/vega/{p-7127f966.js → p-9c713bc0.js} +1 -1
- package/dist/vega/{p-da0fd3dc.entry.js → p-9dc77b66.entry.js} +1 -1
- package/dist/vega/{p-4d7d5583.js → p-9f467a59.js} +1 -1
- package/dist/vega/p-a113fd15.entry.js +1 -0
- package/dist/vega/{p-a0e69236.entry.js → p-a253e791.entry.js} +1 -1
- package/dist/vega/{p-4d4bf82a.entry.js → p-a3272850.entry.js} +1 -1
- package/dist/vega/{p-27b0af38.entry.js → p-a432708d.entry.js} +1 -1
- package/dist/vega/p-a57a7ab8.entry.js +1 -0
- package/dist/vega/{p-f65cb0b6.entry.js → p-a58bd510.entry.js} +1 -1
- package/dist/vega/{p-6188e783.js → p-a957e15f.js} +1 -1
- package/dist/vega/{p-38e850c3.js → p-abb81b7b.js} +1 -1
- package/dist/vega/{p-67b0ccdc.entry.js → p-ae6ed091.entry.js} +1 -1
- package/dist/vega/{p-2c2193f2.entry.js → p-b5e31243.entry.js} +1 -1
- package/dist/vega/{p-718c74ba.js → p-b88ca09b.js} +1 -1
- package/dist/vega/{p-a800bf6d.js → p-b901d624.js} +1 -1
- package/dist/vega/p-ba475520.entry.js +1 -0
- package/dist/vega/{p-ffd080db.js → p-bf04ff19.js} +1 -1
- package/dist/vega/{p-1a51bf6f.js → p-c208a3b7.js} +1 -1
- package/dist/vega/{p-c61bcd92.entry.js → p-c25577ae.entry.js} +1 -1
- package/dist/vega/{p-cbeb47be.entry.js → p-c2560608.entry.js} +1 -1
- package/dist/vega/{p-10e51081.js → p-c2df94f6.js} +1 -1
- package/dist/vega/{p-9feaac4b.entry.js → p-c3eec160.entry.js} +1 -1
- package/dist/vega/{p-f5fcd13e.entry.js → p-c6031d3f.entry.js} +1 -1
- package/dist/vega/{p-da552ddf.entry.js → p-c87cf96a.entry.js} +1 -1
- package/dist/vega/{p-19270396.entry.js → p-cc243e62.entry.js} +1 -1
- package/dist/vega/{p-af2110fc.entry.js → p-cd3d177b.entry.js} +1 -1
- package/dist/vega/{p-be1a210b.js → p-d0687ec0.js} +1 -1
- package/dist/vega/{p-7cde8489.js → p-d25db724.js} +1 -1
- package/dist/vega/{p-dfb12762.js → p-d42dbe39.js} +1 -1
- package/dist/vega/{p-1033e4c4.entry.js → p-d5570331.entry.js} +1 -1
- package/dist/vega/p-d5797747.js +1 -0
- package/dist/vega/{p-9adfcd47.entry.js → p-d7434f44.entry.js} +1 -1
- package/dist/vega/p-db92453f.entry.js +1 -0
- package/dist/vega/{p-0a3a285b.entry.js → p-e5be807b.entry.js} +1 -1
- package/dist/vega/p-e6f0097f.js +1 -0
- package/dist/vega/{p-e8775a56.entry.js → p-e7a8b61e.entry.js} +1 -1
- package/dist/vega/{p-d2ee5711.entry.js → p-f46f6679.entry.js} +1 -1
- package/dist/vega/{p-41d14339.entry.js → p-f49e8cc5.entry.js} +1 -1
- package/dist/vega/{p-9863e7a1.entry.js → p-f5b6059d.entry.js} +1 -1
- package/dist/vega/{p-68846f0d.js → p-fb40a829.js} +1 -1
- package/dist/vega/vega.esm.js +1 -1
- package/package.json +3 -2
- package/dist/vega/p-15335b69.entry.js +0 -1
- package/dist/vega/p-22f3d35c.entry.js +0 -1
- package/dist/vega/p-23427f6a.entry.js +0 -1
- package/dist/vega/p-2466316a.js +0 -1
- package/dist/vega/p-40f39194.js +0 -1
- package/dist/vega/p-77167587.entry.js +0 -1
- package/dist/vega/p-78ecfea0.entry.js +0 -1
- package/dist/vega/p-999950d1.js +0 -1
- package/dist/vega/p-9e36f7ff.entry.js +0 -1
- package/dist/vega/p-9f9d9a53.entry.js +0 -1
- package/dist/vega/p-ab834f06.js +0 -1
- package/dist/vega/p-b7f3221f.js +0 -1
- package/dist/vega/p-b8c10187.js +0 -1
- package/dist/vega/p-d2fc470e.entry.js +0 -1
- package/dist/vega/p-e841c1fe.entry.js +0 -1
- package/dist/vega/p-faa9a3bd.js +0 -1
|
@@ -2032,158 +2032,185 @@ export namespace Components {
|
|
|
2032
2032
|
}
|
|
2033
2033
|
interface VegaInput {
|
|
2034
2034
|
/**
|
|
2035
|
-
*
|
|
2035
|
+
* Enables or disables automatic validation as the user interacts with the input. When `true`, the component validates the input value in real-time against all configured validation rules (`required`, `min`, `max`, `minLength`, `maxLength`, `email`, and custom `validationRules`). Validation is triggered on blur and during input, updating the `isValid` property accordingly. Set to `false` when you need to manage validation manually (e.g., only on form submission).
|
|
2036
|
+
* @default true
|
|
2036
2037
|
* @vegaVersion 1.0.10
|
|
2037
2038
|
*/
|
|
2038
2039
|
"autoValidation": boolean;
|
|
2039
2040
|
/**
|
|
2040
|
-
* Controls the autofill behavior
|
|
2041
|
+
* Controls the browser's autofill and autocomplete behavior for this input. Set to a semantic token (e.g., `'email'`, `'tel'`, `'street-address'`) to help the browser suggest previously saved values. Set to `'off'` to disable autocomplete suggestions entirely. See the full list of valid tokens: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete
|
|
2042
|
+
* @default 'off'
|
|
2041
2043
|
* @vegaVersion 1.0.5
|
|
2042
2044
|
*/
|
|
2043
2045
|
"autocomplete": InputAutocompleteTypes;
|
|
2044
2046
|
/**
|
|
2045
|
-
*
|
|
2047
|
+
* When `true`, disables the ability to copy from or paste into the input field. This is useful for security-sensitive fields (e.g., password confirmation) where you want to prevent users from pasting values. Both keyboard shortcuts and context menu copy/paste actions are blocked.
|
|
2048
|
+
* @default false
|
|
2046
2049
|
* @vegaVersion 2.1.0
|
|
2047
2050
|
*/
|
|
2048
2051
|
"disableCopyPaste": boolean;
|
|
2049
2052
|
/**
|
|
2050
|
-
*
|
|
2053
|
+
* When `true`, disables the input field, preventing user interaction. A disabled input cannot receive focus, does not respond to click or keyboard events, and is visually styled with reduced opacity to indicate its inactive state. Disabled fields are excluded from form validation.
|
|
2054
|
+
* @default false
|
|
2051
2055
|
* @vegaVersion 1.3.0
|
|
2052
2056
|
*/
|
|
2053
2057
|
"disabled": boolean;
|
|
2054
2058
|
/**
|
|
2055
|
-
*
|
|
2059
|
+
* Programmatically removes focus from the underlying native `<input>` element. Use this method when you need to dismiss the keyboard on mobile or move focus away from the input programmatically. Calling this method triggers the `vegaBlur` event and, if `autoValidation` is enabled, validation will be executed.
|
|
2060
|
+
* @returns A promise that resolves once blur has been applied.
|
|
2056
2061
|
* @vegaVersion 1.12.0
|
|
2057
2062
|
*/
|
|
2058
2063
|
"doBlur": () => Promise<void>;
|
|
2059
2064
|
/**
|
|
2060
|
-
*
|
|
2065
|
+
* Programmatically sets focus on the underlying native `<input>` element. Use this method when you need to direct the user's attention to this input (e.g., after form validation fails or on page load). Calling this method triggers the `vegaFocus` event.
|
|
2066
|
+
* @returns A promise that resolves once focus has been applied.
|
|
2061
2067
|
* @vegaVersion 1.12.0
|
|
2062
2068
|
*/
|
|
2063
2069
|
"doFocus": () => Promise<void>;
|
|
2064
2070
|
/**
|
|
2065
|
-
*
|
|
2066
|
-
* @deprecated Please use `type='email'` instead.
|
|
2071
|
+
* When `true`, enforces email format validation on the input value. The validation checks that the entered text conforms to standard email formatting rules (e.g., `user@domain.com`). An invalid email will cause `isValid` to be set to `false` when validation is triggered.
|
|
2072
|
+
* @deprecated Please use `type='email'` instead, which provides the same validation along with optimized mobile keyboard and browser autofill support.
|
|
2073
|
+
* @default false
|
|
2067
2074
|
* @vegaVersion 1.0.5
|
|
2068
2075
|
*/
|
|
2069
2076
|
"email": boolean;
|
|
2070
2077
|
/**
|
|
2071
|
-
*
|
|
2078
|
+
* Programmatically closes the suggestions dropdown. Use this method when you need to dismiss the dropdown in response to an external event (e.g., pressing Escape, clicking outside, or completing a selection workflow).
|
|
2079
|
+
* @returns A promise that resolves once the dropdown is hidden.
|
|
2072
2080
|
* @vegaVersion 2.75.0
|
|
2073
2081
|
*/
|
|
2074
2082
|
"hideSuggestionsDropdown": () => Promise<void>;
|
|
2075
2083
|
/**
|
|
2076
|
-
*
|
|
2084
|
+
* Displays a helper text message below the input field. Use this to provide additional guidance about the expected input, such as format requirements (e.g., `'Must be at least 8 characters'`) or contextual tips. The hint is rendered via the `<vega-hint>` sub-component and is replaced by an error message when validation fails.
|
|
2085
|
+
* @default ''
|
|
2077
2086
|
* @vegaVersion 1.3.0
|
|
2078
2087
|
*/
|
|
2079
2088
|
"hint": string;
|
|
2080
2089
|
/**
|
|
2081
|
-
*
|
|
2090
|
+
* Provides a hint to the browser about the type of virtual keyboard to display on mobile devices, independent of the `type` attribute. - `'text'` — Standard text keyboard. - `'numeric'` — Numeric keypad (digits only), useful for PIN codes or quantities. See https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/inputmode for more details.
|
|
2082
2091
|
* @vegaVersion 2.71.0
|
|
2083
2092
|
*/
|
|
2084
2093
|
"inputmode": 'text' | 'numeric';
|
|
2085
2094
|
/**
|
|
2086
|
-
*
|
|
2095
|
+
* Reflects the current validation state of the input field. - `true` — The field value passes all validation rules; no error styling is shown. - `false` — The field value is invalid; error styling and messages are displayed. - `null` — Validation has not yet been triggered (initial state). This property is automatically updated when `autoValidation` is `true`. It can also be set programmatically to force a specific validation state (e.g., after server-side validation).
|
|
2096
|
+
* @default null
|
|
2087
2097
|
* @vegaVersion 1.3.0
|
|
2088
2098
|
*/
|
|
2089
2099
|
"isValid": boolean;
|
|
2090
2100
|
/**
|
|
2091
|
-
* Specifies the label
|
|
2101
|
+
* Specifies the visible label text displayed above the input field. The label provides an accessible, descriptive title that helps users identify the purpose or content expected in the input field. It is rendered as a `<vega-field-label>` element and is associated with the native `<input>` for accessibility (screen readers, click-to-focus). When set to an empty string, no label is rendered.
|
|
2102
|
+
* @default ''
|
|
2092
2103
|
* @vegaVersion 1.0.5
|
|
2093
2104
|
*/
|
|
2094
2105
|
"label": string;
|
|
2095
2106
|
/**
|
|
2096
|
-
*
|
|
2107
|
+
* Configures an optional action button displayed at the trailing end of the field label. Use this to provide contextual actions such as a "Forgot password?" link, a help tooltip trigger, or any custom label-level action. When clicked, the `vegaLabelButtonClick` event is emitted.
|
|
2108
|
+
* @default null
|
|
2097
2109
|
* @vegaVersion 2.68.0
|
|
2098
2110
|
*/
|
|
2099
2111
|
"labelSuffixButtonConfig": Nullable<LabelSuffixButtonConfig>;
|
|
2100
2112
|
/**
|
|
2101
|
-
* @deprecated Please use `
|
|
2113
|
+
* @deprecated Please use `labelSuffixButtonConfig` instead. Configures an optional action button displayed at the trailing end of the field label. This can be used to provide contextual actions such as a "Forgot password?" link or an info tooltip trigger.
|
|
2114
|
+
* @default null
|
|
2102
2115
|
* @vegaVersion 2.25.0
|
|
2103
2116
|
*/
|
|
2104
2117
|
"labelSuffixButtonProps": Nullable<LabelSuffixButtonProps>;
|
|
2105
2118
|
/**
|
|
2106
|
-
*
|
|
2119
|
+
* Configures input masking to automatically format the user's input according to a predefined pattern. Supports built-in mask types (`'phone'`, `'zipcode'`, `'taxId'`, `'thousand-comma'`, `'number'`) as well as custom masks via `'custom'` or `'custom-formatter'` strategies. Pass a single `MaskConfigType` object or an array of configs to apply multiple masks. Each config specifies the mask `type`, optional formatting `options`, and a `trigger` (`'input'` or `'blur'`) to control when formatting is applied.
|
|
2107
2120
|
* @vegaVersion 1.3.0
|
|
2108
2121
|
*/
|
|
2109
2122
|
"maskConfig": MaskConfigType | MaskConfigType[];
|
|
2110
2123
|
/**
|
|
2111
|
-
* Sets the maximum allowable numeric value for the input value.
|
|
2124
|
+
* Sets the maximum allowable numeric value for the input. When set, a `MaxNumberRule` validation is applied automatically. If the user enters a number above this threshold, the field will be marked as invalid. Only applies when the input value is numeric.
|
|
2125
|
+
* @default null
|
|
2112
2126
|
* @vegaVersion 1.0.5
|
|
2113
2127
|
*/
|
|
2114
2128
|
"max": number | null;
|
|
2115
2129
|
/**
|
|
2116
|
-
* Sets the maximum length
|
|
2130
|
+
* Sets the maximum character length allowed for the input value. When set, a `MaxStringLengthRule` validation is applied automatically. If the user enters more characters than specified, the field will be marked as invalid when validation is triggered.
|
|
2131
|
+
* @default null
|
|
2117
2132
|
* @vegaVersion 1.0.5
|
|
2118
2133
|
*/
|
|
2119
2134
|
"maxLength": number;
|
|
2120
2135
|
/**
|
|
2121
|
-
* Sets the minimum allowable numeric value for the input value.
|
|
2136
|
+
* Sets the minimum allowable numeric value for the input. When set, a `MinNumberRule` validation is applied automatically. If the user enters a number below this threshold, the field will be marked as invalid. Only applies when the input value is numeric.
|
|
2137
|
+
* @default null
|
|
2122
2138
|
* @vegaVersion 1.0.5
|
|
2123
2139
|
*/
|
|
2124
2140
|
"min": number | null;
|
|
2125
2141
|
/**
|
|
2126
|
-
* Sets the minimum length
|
|
2142
|
+
* Sets the minimum character length required for the input value. When set, a `MinStringLengthRule` validation is applied automatically. If the user enters fewer characters than specified, the field will be marked as invalid when validation is triggered.
|
|
2143
|
+
* @default null
|
|
2127
2144
|
* @vegaVersion 1.0.5
|
|
2128
2145
|
*/
|
|
2129
2146
|
"minLength": number;
|
|
2130
2147
|
/**
|
|
2131
|
-
*
|
|
2148
|
+
* Sets the `name` attribute on the underlying native `<input>` element. This is used to identify the field when submitting form data and is also used by the browser's autocomplete feature to recall previously entered values.
|
|
2149
|
+
* @default ''
|
|
2132
2150
|
* @vegaVersion 1.0.5
|
|
2133
2151
|
*/
|
|
2134
2152
|
"name": string;
|
|
2135
2153
|
/**
|
|
2136
|
-
*
|
|
2154
|
+
* Sets the placeholder text displayed inside the input when the value is empty. Use this to provide a short hint about the expected input format or content (e.g., `'Enter your email'`, `'MM/DD/YYYY'`). The placeholder text disappears as soon as the user begins typing. **Note:** Placeholder text is not a substitute for a `label` — always provide a descriptive label for accessibility.
|
|
2137
2155
|
* @vegaVersion 1.3.0
|
|
2138
2156
|
*/
|
|
2139
2157
|
"placeholder": string;
|
|
2140
2158
|
/**
|
|
2141
|
-
*
|
|
2159
|
+
* Displays a Vega icon at the leading (left) side of the input field, providing visual context about the expected input. Pass a valid Vega icon name (e.g., `'search'`, `'email'`, `'lock'`). The icon is rendered inside the input container and does not affect the input's value or validation.
|
|
2142
2160
|
* @vegaVersion 1.0.5
|
|
2143
2161
|
*/
|
|
2144
2162
|
"prefixIcon": string;
|
|
2145
2163
|
/**
|
|
2146
|
-
*
|
|
2164
|
+
* Marks the input field as required for form submission. When `true`, a required-field validation rule is automatically applied. If `autoValidation` is enabled, the field will display a validation error when the user leaves it empty. A visual required indicator (asterisk) is shown next to the label.
|
|
2165
|
+
* @default false
|
|
2147
2166
|
* @vegaVersion 1.0.5
|
|
2148
2167
|
*/
|
|
2149
2168
|
"required": boolean;
|
|
2150
2169
|
/**
|
|
2151
|
-
*
|
|
2170
|
+
* Controls whether a clear (✕) icon button is displayed inside the input when the field has a non-empty value. When `true`, clicking the clear icon resets the input value to an empty string and emits a `vegaChange` event. Set to `false` to hide the icon (e.g., for inputs where clearing is not desired, such as read-only displays).
|
|
2171
|
+
* @default true
|
|
2152
2172
|
* @vegaVersion 1.3.0
|
|
2153
2173
|
*/
|
|
2154
2174
|
"showClearIcon": boolean;
|
|
2155
2175
|
/**
|
|
2156
|
-
*
|
|
2176
|
+
* Programmatically opens the suggestions dropdown. Use this method when you need to display the dropdown independently of user input — for example, to show all available suggestions on focus or in response to an external trigger. Requires `suggestionsDropdownSource` to be set.
|
|
2177
|
+
* @param dropdownConfig - Optional configuration to customize the dropdown behavior (e.g., itemDisplayRule, caseSensitive).
|
|
2178
|
+
* @returns A promise that resolves once the dropdown is displayed.
|
|
2157
2179
|
* @vegaVersion 2.75.0
|
|
2158
2180
|
*/
|
|
2159
2181
|
"showSuggestionsDropdown": (dropdownConfig?: VegaInputSuggestionsDropdownConfig) => Promise<void>;
|
|
2160
2182
|
/**
|
|
2161
|
-
*
|
|
2183
|
+
* Sets the visual size variant of the input field, affecting its height and internal padding. - `'default'` — Standard height (40px), suitable for most form layouts. - `'small'` — Compact height (32px), useful in dense or inline layouts. Such as table cells or toolbars.
|
|
2184
|
+
* @default 'default'
|
|
2162
2185
|
* @vegaVersion 1.3.0
|
|
2163
2186
|
*/
|
|
2164
2187
|
"size": 'default' | 'small';
|
|
2165
2188
|
/**
|
|
2166
|
-
*
|
|
2189
|
+
* Provides the data source for the input's autocomplete suggestion dropdown. Pass an array of `VegaDropdownSourceItem` objects to enable the suggestions feature. The dropdown appears as the user types, filtering items that match the current input value. When the user selects a suggestion, the `vegaSuggestionItemClick` event is emitted. **Important:** You must set this property to at least an empty array (`[]`) to enable the suggestion dropdown. If left `undefined`, the feature is disabled.
|
|
2167
2190
|
* @vegaVersion 2.75.0
|
|
2168
2191
|
*/
|
|
2169
2192
|
"suggestionsDropdownSource": VegaDropdownSourceItem[];
|
|
2170
2193
|
/**
|
|
2171
|
-
*
|
|
2194
|
+
* Sets the HTML input type, which controls the browser's input behavior, on-screen keyboard layout, and built-in validation. - `'text'` — Standard single-line text input. - `'email'` — Optimized for email entry; triggers email validation automatically. - `'password'` — Masks the entered characters; displays a show/hide toggle icon. - `'number'` — Restricts input to numeric values; may show increment/decrement controls. - `'hidden'` — Renders the input as invisible (useful for programmatic form values).
|
|
2195
|
+
* @default 'text'
|
|
2172
2196
|
* @vegaVersion 1.0.9
|
|
2173
2197
|
*/
|
|
2174
2198
|
"type": InputType;
|
|
2175
2199
|
/**
|
|
2176
|
-
*
|
|
2200
|
+
* An array of custom validation rules applied to the input field in addition to the built-in rules derived from `required`, `min`, `max`, `minLength`, `maxLength`, and `email` props. Each rule is a `FormFieldValidationRule` object that defines a validation function and an associated error message. Rules are evaluated in order; the first failing rule's message is displayed.
|
|
2201
|
+
* @default []
|
|
2177
2202
|
* @vegaVersion 1.0.10
|
|
2178
2203
|
*/
|
|
2179
2204
|
"validationRules": FormFieldValidationRule<unknown>[];
|
|
2180
2205
|
/**
|
|
2181
|
-
*
|
|
2206
|
+
* The current value of the input field. Use this property to programmatically set or read the input's value. The value is two-way bound — it updates when the user types and can be set externally to pre-fill or reset the field. When a `maskConfig` is applied, the displayed value may differ from the raw value (e.g., formatted phone numbers). The `vegaChange` event emits the current value whenever it changes.
|
|
2207
|
+
* @default ''
|
|
2182
2208
|
* @vegaVersion 1.0.5
|
|
2183
2209
|
*/
|
|
2184
2210
|
"value": string;
|
|
2185
2211
|
/**
|
|
2186
|
-
*
|
|
2212
|
+
* Controls when the `vegaChange` event is emitted, allowing you to choose between real-time updates and committed-value updates. - `'input'` — Fires on every keystroke as the user types (real-time). - `'change'` — Fires only when the input loses focus or the user presses Enter, similar to the native HTML `change` event behavior. Use `'change'` for expensive operations (e.g., API calls) where you only need the final committed value. Use `'input'` for live search or filtering scenarios.
|
|
2213
|
+
* @default 'input'
|
|
2187
2214
|
* @vegaVersion 2.24.0
|
|
2188
2215
|
*/
|
|
2189
2216
|
"valueUpdateTrigger": InputValueUpdateTriggeredBy;
|
|
@@ -2247,231 +2274,271 @@ export namespace Components {
|
|
|
2247
2274
|
}
|
|
2248
2275
|
interface VegaInputNumeric {
|
|
2249
2276
|
/**
|
|
2250
|
-
* Determines whether the input
|
|
2277
|
+
* Determines whether the numeric input should be validated automatically as the user interacts with it. When `true`, validation rules (including `required`, `min`, `max`, and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
2278
|
+
* @default true
|
|
2251
2279
|
* @vegaVersion 2.29.0
|
|
2252
2280
|
*/
|
|
2253
2281
|
"autoValidation": boolean;
|
|
2254
2282
|
/**
|
|
2255
|
-
*
|
|
2283
|
+
* Specifies whether the numeric input field is disabled. When `true`, the field is non-interactive — the user cannot type, focus, or use keyboard controls to change the value.
|
|
2284
|
+
* @default false
|
|
2256
2285
|
* @vegaVersion 2.29.0
|
|
2257
2286
|
*/
|
|
2258
2287
|
"disabled": boolean;
|
|
2259
2288
|
/**
|
|
2260
|
-
*
|
|
2289
|
+
* Supplementary helper message displayed below the input field that assists users in understanding the expected value or range. Visible at all times (not just on focus).
|
|
2290
|
+
* @default undefined
|
|
2261
2291
|
* @vegaVersion 2.29.0
|
|
2262
2292
|
*/
|
|
2263
2293
|
"hint": string;
|
|
2264
2294
|
/**
|
|
2265
|
-
*
|
|
2295
|
+
* When `true`, restricts user input to whole numbers only — decimal points and fractional digits are rejected. Useful for fields like quantity, count, or age.
|
|
2296
|
+
* @default false
|
|
2266
2297
|
* @vegaVersion 2.29.0
|
|
2267
2298
|
*/
|
|
2268
2299
|
"integerOnly": boolean;
|
|
2269
2300
|
/**
|
|
2270
|
-
*
|
|
2301
|
+
* Reflects the current validation status of the numeric input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
2302
|
+
* @default null
|
|
2271
2303
|
* @vegaVersion 2.29.0
|
|
2272
2304
|
*/
|
|
2273
2305
|
"isValid": boolean;
|
|
2274
2306
|
/**
|
|
2275
|
-
*
|
|
2307
|
+
* Specifies the visible label text rendered above the numeric input. The label identifies the purpose of the field and serves as the accessible name for screen readers.
|
|
2308
|
+
* @default ''
|
|
2276
2309
|
* @vegaVersion 2.29.0
|
|
2277
2310
|
*/
|
|
2278
2311
|
"label": string;
|
|
2279
2312
|
/**
|
|
2280
|
-
*
|
|
2313
|
+
* The step value used when the user presses `Shift` + `ArrowUp` or `Shift` + `ArrowDown` to increment or decrement the value by a larger amount. This enables quick coarse-grained adjustments. For smaller steps, see `minorIncrement`.
|
|
2314
|
+
* @default 10
|
|
2281
2315
|
* @vegaVersion 2.29.0
|
|
2282
2316
|
*/
|
|
2283
2317
|
"majorIncrement": number;
|
|
2284
2318
|
/**
|
|
2285
|
-
* Sets the maximum allowable value for the numeric input.
|
|
2319
|
+
* Sets the maximum allowable value for the numeric input. When set, the built-in `MaxNumberRule` is applied during validation. Values above this threshold will cause validation to fail. Set to `null` to remove the upper bound.
|
|
2320
|
+
* @default null
|
|
2286
2321
|
* @vegaVersion 2.63.0
|
|
2287
2322
|
*/
|
|
2288
2323
|
"max": number | null;
|
|
2289
2324
|
/**
|
|
2290
|
-
* Sets the minimum allowable value for the numeric input.
|
|
2325
|
+
* Sets the minimum allowable value for the numeric input. When set, the built-in `MinNumberRule` is applied during validation. Values below this threshold will cause validation to fail. Set to `null` to remove the lower bound.
|
|
2326
|
+
* @default null
|
|
2291
2327
|
* @vegaVersion 2.63.0
|
|
2292
2328
|
*/
|
|
2293
2329
|
"min": number | null;
|
|
2294
2330
|
/**
|
|
2295
|
-
*
|
|
2331
|
+
* The step value used when the user presses the `ArrowUp` or `ArrowDown` key to increment or decrement the value. This controls fine-grained adjustments to the numeric input. For larger jumps, see `majorIncrement` (activated with `Shift` + arrow keys).
|
|
2332
|
+
* @default 1
|
|
2296
2333
|
* @vegaVersion 2.29.0
|
|
2297
2334
|
*/
|
|
2298
2335
|
"minorIncrement": number;
|
|
2299
2336
|
/**
|
|
2300
|
-
* Specifies
|
|
2337
|
+
* Specifies placeholder text displayed inside the input field when it is empty. The placeholder disappears once the user begins typing and is typically used to indicate the expected format (e.g., `'0.00'`).
|
|
2338
|
+
* @default undefined
|
|
2301
2339
|
* @vegaVersion 2.29.0
|
|
2302
2340
|
*/
|
|
2303
2341
|
"placeholder": string;
|
|
2304
2342
|
/**
|
|
2305
|
-
*
|
|
2343
|
+
* Name of a Vega icon rendered before (to the left of) the input field, providing additional visual context. The icon is purely decorative and does not affect the input value.
|
|
2344
|
+
* @default undefined
|
|
2306
2345
|
* @vegaVersion 2.29.0
|
|
2307
2346
|
*/
|
|
2308
2347
|
"prefixIcon": string;
|
|
2309
2348
|
/**
|
|
2310
|
-
*
|
|
2349
|
+
* Text displayed before (to the left of) the numeric value inside the input field. Use this to provide contextual information such as a currency symbol (e.g., `'$'`) or unit prefix.
|
|
2350
|
+
* @default ''
|
|
2311
2351
|
* @vegaVersion 2.29.0
|
|
2312
2352
|
*/
|
|
2313
2353
|
"prefixText": string;
|
|
2314
2354
|
/**
|
|
2315
|
-
* Determines whether the input
|
|
2355
|
+
* Determines whether the numeric input field must have a value before the form can be submitted. When `true`, the built-in `RequiredFieldRule` is applied during validation and a required indicator is shown on the label.
|
|
2356
|
+
* @default undefined
|
|
2316
2357
|
* @vegaVersion 2.29.0
|
|
2317
2358
|
*/
|
|
2318
2359
|
"required": boolean;
|
|
2319
2360
|
/**
|
|
2320
|
-
*
|
|
2361
|
+
* Controls whether a clear (×) icon button is shown inside the input field when a value is present. Clicking the button resets the value to an empty string and triggers the `vegaChange` event.
|
|
2362
|
+
* @default true
|
|
2321
2363
|
* @vegaVersion 2.53.0
|
|
2322
2364
|
*/
|
|
2323
2365
|
"showClearIcon": boolean;
|
|
2324
2366
|
/**
|
|
2325
|
-
*
|
|
2367
|
+
* Controls the visual size of the numeric input field. - `'medium'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs or inline editing.
|
|
2368
|
+
* @default 'medium'
|
|
2326
2369
|
* @vegaVersion 2.29.0
|
|
2327
2370
|
*/
|
|
2328
2371
|
"size": 'medium' | 'small';
|
|
2329
2372
|
/**
|
|
2330
|
-
*
|
|
2373
|
+
* Text displayed after (to the right of) the numeric value inside the input field. Use this to provide contextual information such as a unit suffix (e.g., `'%'`, `'kg'`, `'USD'`).
|
|
2374
|
+
* @default undefined
|
|
2331
2375
|
* @vegaVersion 2.29.0
|
|
2332
2376
|
*/
|
|
2333
2377
|
"suffixText": string;
|
|
2334
2378
|
/**
|
|
2335
|
-
*
|
|
2379
|
+
* When `true`, the numeric input automatically formats the displayed value with thousand separators (commas) as the user types (e.g., `1,000,000`). The underlying `value` property remains an unformatted numeric string.
|
|
2380
|
+
* @default false
|
|
2336
2381
|
* @vegaVersion 2.29.0
|
|
2337
2382
|
*/
|
|
2338
2383
|
"thousandComma": boolean;
|
|
2339
2384
|
/**
|
|
2340
|
-
*
|
|
2385
|
+
* An array of custom validation rules applied to the numeric input in addition to the built-in rules (`RequiredFieldRule`, `MinNumberRule`, `MaxNumberRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
2386
|
+
* @default []
|
|
2341
2387
|
* @vegaVersion 2.29.0
|
|
2342
2388
|
*/
|
|
2343
2389
|
"validationRules": FormFieldValidationRule1<unknown>[];
|
|
2344
2390
|
/**
|
|
2345
|
-
*
|
|
2391
|
+
* The current value of the numeric input field, represented as a string. This property is mutable and will be updated when the user types or uses keyboard increment/decrement actions. It can also be set externally to pre-populate or reset the field. When `thousandComma` is enabled, the display is formatted with separators but the underlying value remains unformatted. Changes to this property trigger the `vegaChange` event.
|
|
2392
|
+
* @default ''
|
|
2346
2393
|
* @vegaVersion 2.29.0
|
|
2347
2394
|
*/
|
|
2348
2395
|
"value": string;
|
|
2349
2396
|
}
|
|
2350
2397
|
interface VegaInputPasscode {
|
|
2351
2398
|
/**
|
|
2352
|
-
* Determines whether the input
|
|
2399
|
+
* Determines whether the passcode input should be validated automatically as the user types. When `true`, validation rules (including `required` and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
2400
|
+
* @default true
|
|
2353
2401
|
* @vegaVersion 2.66.0
|
|
2354
2402
|
*/
|
|
2355
2403
|
"autoValidation": boolean;
|
|
2356
2404
|
/**
|
|
2357
|
-
*
|
|
2405
|
+
* Specifies whether the passcode input is disabled. When `true`, all individual input boxes become non-interactive — the user cannot type, paste, or focus any box.
|
|
2406
|
+
* @default false
|
|
2358
2407
|
* @vegaVersion 2.66.0
|
|
2359
2408
|
*/
|
|
2360
2409
|
"disabled": boolean;
|
|
2361
2410
|
/**
|
|
2362
|
-
*
|
|
2411
|
+
* Supplementary helper message displayed below the passcode input that assists users in understanding the expected input. For example, `'Enter the 4-digit code sent to your email'`.
|
|
2412
|
+
* @default ''
|
|
2363
2413
|
* @vegaVersion 2.66.0
|
|
2364
2414
|
*/
|
|
2365
2415
|
"hint": string;
|
|
2366
2416
|
/**
|
|
2367
|
-
* Specifies the
|
|
2417
|
+
* Specifies the type of characters accepted by each passcode box. - `'numeric'` — Only digits `0`–`9` are accepted. - `'text'` — Any non-space character is accepted. Spaces are always rejected regardless of the selected type.
|
|
2418
|
+
* @default 'numeric'
|
|
2368
2419
|
* @vegaVersion 2.66.0
|
|
2369
2420
|
*/
|
|
2370
2421
|
"inputType": 'numeric' | 'text';
|
|
2371
2422
|
/**
|
|
2372
|
-
*
|
|
2423
|
+
* Reflects the current validation status of the passcode input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
2424
|
+
* @default null
|
|
2373
2425
|
* @vegaVersion 2.66.0
|
|
2374
2426
|
*/
|
|
2375
2427
|
"isValid": boolean | null;
|
|
2376
2428
|
/**
|
|
2377
|
-
* Specifies the label
|
|
2429
|
+
* Specifies the visible label text rendered above the passcode input. The label identifies the purpose of the field (e.g., "Enter verification code") and serves as the accessible name for screen readers.
|
|
2430
|
+
* @default ''
|
|
2378
2431
|
* @vegaVersion 2.66.0
|
|
2379
2432
|
*/
|
|
2380
2433
|
"label": string;
|
|
2381
2434
|
/**
|
|
2382
|
-
* Specifies the number of input boxes
|
|
2435
|
+
* Specifies the number of individual input boxes rendered for the passcode. Each box accepts a single character. Common values are `4` for a PIN and `6` for a two-factor authentication code.
|
|
2436
|
+
* @default 4
|
|
2383
2437
|
* @vegaVersion 2.66.0
|
|
2384
2438
|
*/
|
|
2385
2439
|
"length": number;
|
|
2386
2440
|
/**
|
|
2387
|
-
* Determines whether the
|
|
2441
|
+
* Determines whether the passcode field must have a value before the form can be submitted. When `true`, the built-in `RequiredFieldRule` is applied during validation and a required indicator is shown on the label.
|
|
2442
|
+
* @default false
|
|
2388
2443
|
* @vegaVersion 2.66.0
|
|
2389
2444
|
*/
|
|
2390
2445
|
"required": boolean;
|
|
2391
2446
|
/**
|
|
2392
|
-
*
|
|
2447
|
+
* Controls the visual size of the passcode input boxes. - `'medium'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs.
|
|
2448
|
+
* @default 'medium'
|
|
2393
2449
|
* @vegaVersion 2.66.0
|
|
2394
2450
|
*/
|
|
2395
2451
|
"size": 'medium' | 'small';
|
|
2396
2452
|
/**
|
|
2397
|
-
*
|
|
2453
|
+
* An array of custom validation rules applied to the passcode input in addition to the built-in `RequiredFieldRule`. Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
2454
|
+
* @default []
|
|
2398
2455
|
* @vegaVersion 2.66.0
|
|
2399
2456
|
*/
|
|
2400
2457
|
"validationRules": FormFieldValidationRule<unknown>[];
|
|
2401
2458
|
/**
|
|
2402
|
-
*
|
|
2459
|
+
* The current value of the passcode input, represented as a concatenated string of all box values (e.g., `'1234'` for a 4-digit passcode). This property is mutable and reflected to the host element attribute. It updates as the user types into the boxes and can be set externally to pre-populate or reset the field.
|
|
2460
|
+
* @default ''
|
|
2403
2461
|
* @vegaVersion 2.66.0
|
|
2404
2462
|
*/
|
|
2405
2463
|
"value": string;
|
|
2406
2464
|
}
|
|
2407
2465
|
interface VegaInputPhoneNumber {
|
|
2408
2466
|
/**
|
|
2409
|
-
*
|
|
2467
|
+
* An array of country codes available for selection in the country dropdown. Each entry must be a two-letter uppercase ISO 3166-1 alpha-2 code. By default all 245 supported codes are loaded, but providing a smaller subset improves initial render performance.
|
|
2468
|
+
* @default VegaCountryCode[] (all 245 codes)
|
|
2410
2469
|
* @vegaVersion 2.18.0
|
|
2411
|
-
* @defaultValue ['US', 'CN', ...]{@link VegaCountryCode }
|
|
2412
2470
|
*/
|
|
2413
2471
|
"allowedCountryCodes": VegaCountryCode[];
|
|
2414
2472
|
/**
|
|
2415
|
-
* Determines whether the phone number input
|
|
2473
|
+
* Determines whether the phone number input should be validated automatically as the user interacts with it. When `true`, validation rules (including `required`, `ValidPhoneNumberRule`, and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
2474
|
+
* @default true
|
|
2416
2475
|
* @vegaVersion 2.18.0
|
|
2417
2476
|
*/
|
|
2418
2477
|
"autoValidation": boolean;
|
|
2419
2478
|
/**
|
|
2420
|
-
* Specifies the
|
|
2479
|
+
* Specifies the currently selected country using a two-letter uppercase ISO 3166-1 alpha-2 code (e.g., `'US'`, `'GB'`, `'CN'`). The country code determines the flag icon and calling code prefix displayed in the country selector. Changing this value updates the phone number prefix accordingly.
|
|
2480
|
+
* @default 'US'
|
|
2421
2481
|
* @vegaVersion 2.18.0
|
|
2422
|
-
* @defaultValue US
|
|
2423
2482
|
*/
|
|
2424
2483
|
"countryCode": VegaCountryCode;
|
|
2425
2484
|
/**
|
|
2426
|
-
*
|
|
2485
|
+
* Specifies whether the phone number input field is disabled. When `true`, both the country selector and the phone number text field become non-interactive — the user cannot type, select a country, or focus any part of the component.
|
|
2486
|
+
* @default false
|
|
2427
2487
|
* @vegaVersion 2.18.0
|
|
2428
2488
|
*/
|
|
2429
2489
|
"disabled": boolean;
|
|
2430
2490
|
/**
|
|
2431
|
-
*
|
|
2491
|
+
* Controls whether the `value` property can be an empty string. - `true` — The `value` property is cleared to `''` when the user deletes all digits from the input field. - `false` — The `value` property always retains at least the country calling code prefix (e.g., `'+1'` for US) even when no phone number digits have been entered.
|
|
2492
|
+
* @default false
|
|
2432
2493
|
* @vegaVersion 2.35.0
|
|
2433
2494
|
*/
|
|
2434
2495
|
"emptyValueEnabled": boolean;
|
|
2435
2496
|
/**
|
|
2436
|
-
*
|
|
2497
|
+
* Supplementary helper message displayed below the phone number input that assists users in understanding the expected value or provides additional context (e.g., `'We will send a verification code to this number'`).
|
|
2498
|
+
* @default ''
|
|
2437
2499
|
* @vegaVersion 2.18.0
|
|
2438
2500
|
*/
|
|
2439
2501
|
"hint": string;
|
|
2440
2502
|
/**
|
|
2441
|
-
*
|
|
2503
|
+
* Reflects the current validation status of the phone number input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
2504
|
+
* @default null
|
|
2442
2505
|
* @vegaVersion 2.18.0
|
|
2443
2506
|
*/
|
|
2444
2507
|
"isValid": boolean;
|
|
2445
2508
|
/**
|
|
2446
|
-
* Specifies the label
|
|
2509
|
+
* Specifies the visible label text rendered above the phone number input. The label identifies the purpose of the field and serves as the accessible name for screen readers.
|
|
2510
|
+
* @default ''
|
|
2447
2511
|
* @vegaVersion 2.18.0
|
|
2448
2512
|
*/
|
|
2449
2513
|
"label": string;
|
|
2450
2514
|
/**
|
|
2451
|
-
* Specifies
|
|
2515
|
+
* Specifies placeholder text displayed inside the phone number text field when it is empty. The placeholder disappears once the user begins typing and is typically used to indicate the expected format (e.g., `'(555) 555-5555'`).
|
|
2516
|
+
* @default undefined
|
|
2452
2517
|
* @vegaVersion 2.18.0
|
|
2453
2518
|
*/
|
|
2454
2519
|
"placeholder": string;
|
|
2455
2520
|
/**
|
|
2456
|
-
* Determines whether the phone number input field is required.
|
|
2521
|
+
* Determines whether the phone number input field must have a value before the form can be submitted. When `true`, the built-in `InputPhoneNumberRequiredRule` is applied during validation and a required indicator is shown on the label.
|
|
2522
|
+
* @default false
|
|
2457
2523
|
* @vegaVersion 2.18.0
|
|
2458
2524
|
*/
|
|
2459
2525
|
"required": boolean;
|
|
2460
2526
|
/**
|
|
2461
|
-
*
|
|
2527
|
+
* Controls the visual size of the phone number input field. - `'default'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs.
|
|
2528
|
+
* @default 'default'
|
|
2462
2529
|
* @vegaVersion 2.18.0
|
|
2463
2530
|
*/
|
|
2464
2531
|
"size": 'default' | 'small';
|
|
2465
2532
|
/**
|
|
2466
|
-
*
|
|
2533
|
+
* An array of custom validation rules applied to the phone number input in addition to the built-in rules (`InputPhoneNumberRequiredRule`, `ValidPhoneNumberRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
2534
|
+
* @default []
|
|
2467
2535
|
* @vegaVersion 2.18.0
|
|
2468
2536
|
*/
|
|
2469
2537
|
"validationRules": FormFieldValidationRule<unknown>[];
|
|
2470
2538
|
/**
|
|
2471
|
-
*
|
|
2472
|
-
* @
|
|
2539
|
+
* The current value of the phone number input in [E.164](https://en.wikipedia.org/wiki/E.164) format (e.g., `'+14155552671'`). This property is mutable and reflected to the host element attribute. It updates as the user types and can be set externally to pre-populate or reset the field. When `emptyValueEnabled` is `false` and no digits have been entered, the value defaults to the country calling code prefix (e.g., `'+1'` for US).
|
|
2540
|
+
* @default '+1'
|
|
2473
2541
|
* @vegaVersion 2.18.0
|
|
2474
|
-
* @defaultValue +1
|
|
2475
2542
|
*/
|
|
2476
2543
|
"value": string;
|
|
2477
2544
|
}
|
|
@@ -2619,7 +2686,7 @@ export namespace Components {
|
|
|
2619
2686
|
*/
|
|
2620
2687
|
"selectType": SelectType;
|
|
2621
2688
|
/**
|
|
2622
|
-
* Allows customization of the text displayed within the select field when single or multiple items are selected. The default format for the selected label is
|
|
2689
|
+
* Allows customization of the text displayed within the select field when single or multiple items are selected. The default format for the selected label is `{0} Selected` for multiple mode only. To enable all modes, use the `SelectedLabelTypeForAllModes` type. For single mode, the default format is the `displayName` of the selected item if not set For multiple mode, the default format is `{0} Selected` if not set
|
|
2623
2690
|
* @vegaVersion 1.35.0
|
|
2624
2691
|
*/
|
|
2625
2692
|
"selectedLabel": SelectedLabelType | SelectedLabelTypeForAllModes;
|
|
@@ -4256,77 +4323,92 @@ export namespace Components {
|
|
|
4256
4323
|
}
|
|
4257
4324
|
interface VegaTextarea {
|
|
4258
4325
|
/**
|
|
4259
|
-
* Determines whether
|
|
4326
|
+
* Determines whether the text area should be validated automatically as the user types. When `true`, validation rules (including `required`, `minLength`, `maxLength`, and custom `validationRules`) are evaluated on blur and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
4327
|
+
* @default true
|
|
4260
4328
|
* @vegaVersion 1.11.0
|
|
4261
4329
|
*/
|
|
4262
4330
|
"autoValidation": boolean;
|
|
4263
4331
|
/**
|
|
4264
|
-
* Specifies whether the text area is disabled.
|
|
4332
|
+
* Specifies whether the text area is disabled. When `true`, the text area is non-interactive — the user cannot type, focus, or select the field. The disabled state is reflected as an HTML attribute for CSS styling.
|
|
4333
|
+
* @default false
|
|
4265
4334
|
* @vegaVersion 1.11.0
|
|
4266
4335
|
*/
|
|
4267
4336
|
"disabled": boolean;
|
|
4268
4337
|
/**
|
|
4269
|
-
* Provides a supplementary
|
|
4338
|
+
* Provides a supplementary helper message displayed below the text area that assists users in understanding the expected value or format. The hint is visible at all times (not just on focus) and is typically used for guidance such as character requirements or formatting rules.
|
|
4339
|
+
* @default ''
|
|
4270
4340
|
* @vegaVersion 1.11.0
|
|
4271
4341
|
*/
|
|
4272
4342
|
"hint": string;
|
|
4273
4343
|
/**
|
|
4274
|
-
*
|
|
4344
|
+
* Reflects the current validation status of the text area. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state. The value is reflected as an HTML attribute.
|
|
4345
|
+
* @default null
|
|
4275
4346
|
* @vegaVersion 1.11.0
|
|
4276
4347
|
*/
|
|
4277
4348
|
"isValid": boolean;
|
|
4278
4349
|
/**
|
|
4279
|
-
* Specifies the label
|
|
4350
|
+
* Specifies the visible label text rendered above the text area. The label helps identify the purpose or content expected within the field and also serves as the accessible `aria-label` for screen readers when present. Clicking the label will focus the text area.
|
|
4351
|
+
* @default ''
|
|
4280
4352
|
* @vegaVersion 1.11.0
|
|
4281
4353
|
*/
|
|
4282
4354
|
"label": string;
|
|
4283
4355
|
/**
|
|
4284
|
-
*
|
|
4356
|
+
* Configuration object for an optional suffix button rendered beside the field label. Use this to provide an inline action (e.g., a help or info button) next to the label text. When the button is clicked, the `vegaLabelButtonClick` event is emitted. Set to `null` to hide the suffix button.
|
|
4357
|
+
* @default null
|
|
4285
4358
|
* @vegaVersion 2.68.0
|
|
4286
4359
|
*/
|
|
4287
4360
|
"labelSuffixButtonConfig": Nullable<LabelSuffixButtonConfig>;
|
|
4288
4361
|
/**
|
|
4289
|
-
* Specifies the maximum number of characters (UTF-16 code units)
|
|
4362
|
+
* Specifies the maximum number of characters (UTF-16 code units) that the user can enter in the text area. The native `maxlength` attribute is applied to the inner `<textarea>` element. When `showCounter` is `true`, the maximum value is displayed alongside the current character count (e.g., `42/200`). Exceeding this limit triggers a visual warning on the counter and fails the `MaxStringLengthRule` during validation. Set to `null` to allow unlimited input.
|
|
4363
|
+
* @default null
|
|
4290
4364
|
* @vegaVersion 1.11.0
|
|
4291
4365
|
*/
|
|
4292
4366
|
"maxLength": number;
|
|
4293
4367
|
/**
|
|
4294
|
-
* Specifies the minimum number of characters (UTF-16 code units)
|
|
4368
|
+
* Specifies the minimum number of characters (UTF-16 code units) that the user must enter in the text area for the value to be considered valid. The native `minlength` attribute is applied to the inner `<textarea>` element. When set, the `MinStringLengthRule` is applied during validation. Set to `null` to impose no minimum length.
|
|
4369
|
+
* @default null
|
|
4295
4370
|
* @vegaVersion 1.11.0
|
|
4296
4371
|
*/
|
|
4297
4372
|
"minLength": number;
|
|
4298
4373
|
/**
|
|
4299
|
-
* Specifies a placeholder string that displays as a
|
|
4374
|
+
* Specifies a placeholder string that displays as a temporary hint or example within the text area. The placeholder text is shown when the field is empty and disappears once the user begins typing. Use this to indicate the expected format or content of the input, for example `'Enter your comments here...'`.
|
|
4375
|
+
* @default ''
|
|
4300
4376
|
* @vegaVersion 1.11.0
|
|
4301
4377
|
*/
|
|
4302
4378
|
"placeholder": string;
|
|
4303
4379
|
/**
|
|
4304
|
-
* Determines whether the
|
|
4380
|
+
* Determines whether the text area must have a non-empty value before the form can be submitted. When `true`, a required-field indicator is shown on the label and the built-in `RequiredFieldRule` is applied during validation.
|
|
4381
|
+
* @default false
|
|
4305
4382
|
* @vegaVersion 1.11.0
|
|
4306
4383
|
*/
|
|
4307
4384
|
"required": boolean;
|
|
4308
4385
|
/**
|
|
4309
|
-
* Determines whether the text area is
|
|
4386
|
+
* Determines whether the user can vertically resize the text area by dragging its bottom-right corner. When `false`, the resize handle is hidden via CSS and the text area height is fixed.
|
|
4387
|
+
* @default true
|
|
4310
4388
|
* @vegaVersion 2.19.0
|
|
4311
4389
|
*/
|
|
4312
4390
|
"resizable": boolean;
|
|
4313
4391
|
/**
|
|
4314
|
-
* Specifies the number of visible lines in the
|
|
4392
|
+
* Specifies the number of visible text lines in the text area, controlling its initial height. Accepts integers ≥ 2. For optimal display, values below 2 are internally adjusted to 4 rows.
|
|
4393
|
+
* @default 5
|
|
4315
4394
|
* @vegaVersion 2.63.0
|
|
4316
4395
|
*/
|
|
4317
4396
|
"rows": number;
|
|
4318
4397
|
/**
|
|
4319
|
-
* Determines whether to display a character counter
|
|
4398
|
+
* Determines whether to display a live character counter below the text area. When `true`, the counter shows the current character count. If `maxLength` is also set, the counter displays in the format `current/max` and visually highlights when the limit is exceeded.
|
|
4399
|
+
* @default false
|
|
4320
4400
|
* @vegaVersion 1.11.0
|
|
4321
4401
|
*/
|
|
4322
4402
|
"showCounter": boolean;
|
|
4323
4403
|
/**
|
|
4324
|
-
*
|
|
4404
|
+
* An array of custom validation rules applied to the text area in addition to the built-in rules (`RequiredFieldRule`, `MinStringLengthRule`, `MaxStringLengthRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
4405
|
+
* @default []
|
|
4325
4406
|
* @vegaVersion 1.11.0
|
|
4326
4407
|
*/
|
|
4327
4408
|
"validationRules": FormFieldValidationRule<unknown>[];
|
|
4328
4409
|
/**
|
|
4329
|
-
*
|
|
4410
|
+
* The current value (content) of the text area field. This property is mutable and will be updated programmatically when the user types into the text area. It can also be set externally to pre-populate or reset the field. Changes to this property trigger the `vegaChange` event and update the character counter if `showCounter` is enabled. Supports two-way binding in framework wrappers.
|
|
4411
|
+
* @default ''
|
|
4330
4412
|
* @vegaVersion 1.11.0
|
|
4331
4413
|
*/
|
|
4332
4414
|
"value": string;
|
|
@@ -8021,215 +8103,251 @@ declare namespace LocalJSX {
|
|
|
8021
8103
|
}
|
|
8022
8104
|
interface VegaInput {
|
|
8023
8105
|
/**
|
|
8024
|
-
*
|
|
8106
|
+
* Enables or disables automatic validation as the user interacts with the input. When `true`, the component validates the input value in real-time against all configured validation rules (`required`, `min`, `max`, `minLength`, `maxLength`, `email`, and custom `validationRules`). Validation is triggered on blur and during input, updating the `isValid` property accordingly. Set to `false` when you need to manage validation manually (e.g., only on form submission).
|
|
8107
|
+
* @default true
|
|
8025
8108
|
* @vegaVersion 1.0.10
|
|
8026
8109
|
*/
|
|
8027
8110
|
"autoValidation"?: boolean;
|
|
8028
8111
|
/**
|
|
8029
|
-
* Controls the autofill behavior
|
|
8112
|
+
* Controls the browser's autofill and autocomplete behavior for this input. Set to a semantic token (e.g., `'email'`, `'tel'`, `'street-address'`) to help the browser suggest previously saved values. Set to `'off'` to disable autocomplete suggestions entirely. See the full list of valid tokens: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete
|
|
8113
|
+
* @default 'off'
|
|
8030
8114
|
* @vegaVersion 1.0.5
|
|
8031
8115
|
*/
|
|
8032
8116
|
"autocomplete"?: InputAutocompleteTypes;
|
|
8033
8117
|
/**
|
|
8034
|
-
*
|
|
8118
|
+
* When `true`, disables the ability to copy from or paste into the input field. This is useful for security-sensitive fields (e.g., password confirmation) where you want to prevent users from pasting values. Both keyboard shortcuts and context menu copy/paste actions are blocked.
|
|
8119
|
+
* @default false
|
|
8035
8120
|
* @vegaVersion 2.1.0
|
|
8036
8121
|
*/
|
|
8037
8122
|
"disableCopyPaste"?: boolean;
|
|
8038
8123
|
/**
|
|
8039
|
-
*
|
|
8124
|
+
* When `true`, disables the input field, preventing user interaction. A disabled input cannot receive focus, does not respond to click or keyboard events, and is visually styled with reduced opacity to indicate its inactive state. Disabled fields are excluded from form validation.
|
|
8125
|
+
* @default false
|
|
8040
8126
|
* @vegaVersion 1.3.0
|
|
8041
8127
|
*/
|
|
8042
8128
|
"disabled"?: boolean;
|
|
8043
8129
|
/**
|
|
8044
|
-
*
|
|
8045
|
-
* @deprecated Please use `type='email'` instead.
|
|
8130
|
+
* When `true`, enforces email format validation on the input value. The validation checks that the entered text conforms to standard email formatting rules (e.g., `user@domain.com`). An invalid email will cause `isValid` to be set to `false` when validation is triggered.
|
|
8131
|
+
* @deprecated Please use `type='email'` instead, which provides the same validation along with optimized mobile keyboard and browser autofill support.
|
|
8132
|
+
* @default false
|
|
8046
8133
|
* @vegaVersion 1.0.5
|
|
8047
8134
|
*/
|
|
8048
8135
|
"email"?: boolean;
|
|
8049
8136
|
/**
|
|
8050
|
-
*
|
|
8137
|
+
* Displays a helper text message below the input field. Use this to provide additional guidance about the expected input, such as format requirements (e.g., `'Must be at least 8 characters'`) or contextual tips. The hint is rendered via the `<vega-hint>` sub-component and is replaced by an error message when validation fails.
|
|
8138
|
+
* @default ''
|
|
8051
8139
|
* @vegaVersion 1.3.0
|
|
8052
8140
|
*/
|
|
8053
8141
|
"hint"?: string;
|
|
8054
8142
|
/**
|
|
8055
|
-
*
|
|
8143
|
+
* Provides a hint to the browser about the type of virtual keyboard to display on mobile devices, independent of the `type` attribute. - `'text'` — Standard text keyboard. - `'numeric'` — Numeric keypad (digits only), useful for PIN codes or quantities. See https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/inputmode for more details.
|
|
8056
8144
|
* @vegaVersion 2.71.0
|
|
8057
8145
|
*/
|
|
8058
8146
|
"inputmode"?: 'text' | 'numeric';
|
|
8059
8147
|
/**
|
|
8060
|
-
*
|
|
8148
|
+
* Reflects the current validation state of the input field. - `true` — The field value passes all validation rules; no error styling is shown. - `false` — The field value is invalid; error styling and messages are displayed. - `null` — Validation has not yet been triggered (initial state). This property is automatically updated when `autoValidation` is `true`. It can also be set programmatically to force a specific validation state (e.g., after server-side validation).
|
|
8149
|
+
* @default null
|
|
8061
8150
|
* @vegaVersion 1.3.0
|
|
8062
8151
|
*/
|
|
8063
8152
|
"isValid"?: boolean;
|
|
8064
8153
|
/**
|
|
8065
|
-
* Specifies the label
|
|
8154
|
+
* Specifies the visible label text displayed above the input field. The label provides an accessible, descriptive title that helps users identify the purpose or content expected in the input field. It is rendered as a `<vega-field-label>` element and is associated with the native `<input>` for accessibility (screen readers, click-to-focus). When set to an empty string, no label is rendered.
|
|
8155
|
+
* @default ''
|
|
8066
8156
|
* @vegaVersion 1.0.5
|
|
8067
8157
|
*/
|
|
8068
8158
|
"label"?: string;
|
|
8069
8159
|
/**
|
|
8070
|
-
*
|
|
8160
|
+
* Configures an optional action button displayed at the trailing end of the field label. Use this to provide contextual actions such as a "Forgot password?" link, a help tooltip trigger, or any custom label-level action. When clicked, the `vegaLabelButtonClick` event is emitted.
|
|
8161
|
+
* @default null
|
|
8071
8162
|
* @vegaVersion 2.68.0
|
|
8072
8163
|
*/
|
|
8073
8164
|
"labelSuffixButtonConfig"?: Nullable<LabelSuffixButtonConfig>;
|
|
8074
8165
|
/**
|
|
8075
|
-
* @deprecated Please use `
|
|
8166
|
+
* @deprecated Please use `labelSuffixButtonConfig` instead. Configures an optional action button displayed at the trailing end of the field label. This can be used to provide contextual actions such as a "Forgot password?" link or an info tooltip trigger.
|
|
8167
|
+
* @default null
|
|
8076
8168
|
* @vegaVersion 2.25.0
|
|
8077
8169
|
*/
|
|
8078
8170
|
"labelSuffixButtonProps"?: Nullable<LabelSuffixButtonProps>;
|
|
8079
8171
|
/**
|
|
8080
|
-
*
|
|
8172
|
+
* Configures input masking to automatically format the user's input according to a predefined pattern. Supports built-in mask types (`'phone'`, `'zipcode'`, `'taxId'`, `'thousand-comma'`, `'number'`) as well as custom masks via `'custom'` or `'custom-formatter'` strategies. Pass a single `MaskConfigType` object or an array of configs to apply multiple masks. Each config specifies the mask `type`, optional formatting `options`, and a `trigger` (`'input'` or `'blur'`) to control when formatting is applied.
|
|
8081
8173
|
* @vegaVersion 1.3.0
|
|
8082
8174
|
*/
|
|
8083
8175
|
"maskConfig"?: MaskConfigType | MaskConfigType[];
|
|
8084
8176
|
/**
|
|
8085
|
-
* Sets the maximum allowable numeric value for the input value.
|
|
8177
|
+
* Sets the maximum allowable numeric value for the input. When set, a `MaxNumberRule` validation is applied automatically. If the user enters a number above this threshold, the field will be marked as invalid. Only applies when the input value is numeric.
|
|
8178
|
+
* @default null
|
|
8086
8179
|
* @vegaVersion 1.0.5
|
|
8087
8180
|
*/
|
|
8088
8181
|
"max"?: number | null;
|
|
8089
8182
|
/**
|
|
8090
|
-
* Sets the maximum length
|
|
8183
|
+
* Sets the maximum character length allowed for the input value. When set, a `MaxStringLengthRule` validation is applied automatically. If the user enters more characters than specified, the field will be marked as invalid when validation is triggered.
|
|
8184
|
+
* @default null
|
|
8091
8185
|
* @vegaVersion 1.0.5
|
|
8092
8186
|
*/
|
|
8093
8187
|
"maxLength"?: number;
|
|
8094
8188
|
/**
|
|
8095
|
-
* Sets the minimum allowable numeric value for the input value.
|
|
8189
|
+
* Sets the minimum allowable numeric value for the input. When set, a `MinNumberRule` validation is applied automatically. If the user enters a number below this threshold, the field will be marked as invalid. Only applies when the input value is numeric.
|
|
8190
|
+
* @default null
|
|
8096
8191
|
* @vegaVersion 1.0.5
|
|
8097
8192
|
*/
|
|
8098
8193
|
"min"?: number | null;
|
|
8099
8194
|
/**
|
|
8100
|
-
* Sets the minimum length
|
|
8195
|
+
* Sets the minimum character length required for the input value. When set, a `MinStringLengthRule` validation is applied automatically. If the user enters fewer characters than specified, the field will be marked as invalid when validation is triggered.
|
|
8196
|
+
* @default null
|
|
8101
8197
|
* @vegaVersion 1.0.5
|
|
8102
8198
|
*/
|
|
8103
8199
|
"minLength"?: number;
|
|
8104
8200
|
/**
|
|
8105
|
-
*
|
|
8201
|
+
* Sets the `name` attribute on the underlying native `<input>` element. This is used to identify the field when submitting form data and is also used by the browser's autocomplete feature to recall previously entered values.
|
|
8202
|
+
* @default ''
|
|
8106
8203
|
* @vegaVersion 1.0.5
|
|
8107
8204
|
*/
|
|
8108
8205
|
"name"?: string;
|
|
8109
8206
|
/**
|
|
8110
|
-
*
|
|
8207
|
+
* Native-namespace alias for the `vegaBlur` event. Emitted at the same time and under the same conditions as `vegaBlur`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8208
|
+
* @eventDetail `undefined` — No payload; listen for the event occurrence only.
|
|
8111
8209
|
* @eventSemantics namespace:native
|
|
8112
8210
|
* @vegaVersion 2.0.0
|
|
8113
8211
|
*/
|
|
8114
8212
|
"onBlur"?: (event: VegaInputCustomEvent<undefined>) => void;
|
|
8115
8213
|
/**
|
|
8116
|
-
*
|
|
8214
|
+
* Native-namespace alias for the `vegaChange` event. Emitted at the same time and under the same conditions as `vegaChange`. Use this event when integrating with frameworks that expect native-style event names (e.g., `@change` in Vue or Angular).
|
|
8215
|
+
* @eventDetail `string` — The current input value after the change.
|
|
8117
8216
|
* @eventSemantics namespace:native
|
|
8118
8217
|
* @vegaVersion 2.0.0
|
|
8119
8218
|
*/
|
|
8120
8219
|
"onChange"?: (event: VegaInputCustomEvent<string>) => void;
|
|
8121
8220
|
/**
|
|
8122
|
-
*
|
|
8221
|
+
* Native-namespace alias for the `vegaFocus` event. Emitted at the same time and under the same conditions as `vegaFocus`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8222
|
+
* @eventDetail `undefined` — No payload; listen for the event occurrence only.
|
|
8123
8223
|
* @eventSemantics namespace:native
|
|
8124
8224
|
* @vegaVersion 2.0.0
|
|
8125
8225
|
*/
|
|
8126
8226
|
"onFocus"?: (event: VegaInputCustomEvent<undefined>) => void;
|
|
8127
8227
|
/**
|
|
8128
|
-
*
|
|
8228
|
+
* Native-namespace alias for the `vegaLabelButtonClick` event. Emitted at the same time and under the same conditions as `vegaLabelButtonClick`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8229
|
+
* @eventDetail `void` — No payload.
|
|
8129
8230
|
* @eventSemantics namespace:native
|
|
8130
8231
|
* @vegaVersion 2.25.0
|
|
8131
8232
|
*/
|
|
8132
8233
|
"onLabelButtonClick"?: (event: VegaInputCustomEvent<any>) => void;
|
|
8133
8234
|
/**
|
|
8134
|
-
*
|
|
8235
|
+
* Native-namespace alias for the `vegaNativeInputChange` event. Emitted at the same time and under the same conditions as `vegaNativeInputChange`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8236
|
+
* @eventDetail `string` — The raw value from the native input element.
|
|
8135
8237
|
* @eventSemantics namespace:native
|
|
8136
8238
|
* @vegaVersion 2.75.0
|
|
8137
8239
|
*/
|
|
8138
8240
|
"onNativeInputChange"?: (event: VegaInputCustomEvent<string>) => void;
|
|
8139
8241
|
/**
|
|
8140
|
-
*
|
|
8242
|
+
* Native-namespace alias for the `vegaPaste` event. Emitted at the same time and under the same conditions as `vegaPaste`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8243
|
+
* @eventDetail `DataTransferType` — An object containing the pasted data, including the MIME type and raw text content from the clipboard.
|
|
8141
8244
|
* @eventSemantics namespace:native
|
|
8142
8245
|
* @vegaVersion 2.66.0
|
|
8143
8246
|
*/
|
|
8144
8247
|
"onPaste"?: (event: VegaInputCustomEvent<DataTransferType>) => void;
|
|
8145
8248
|
/**
|
|
8146
|
-
*
|
|
8249
|
+
* Native-namespace alias for the `vegaSuggestionItemClick` event. Emitted at the same time and under the same conditions as `vegaSuggestionItemClick`. Use this event when integrating with frameworks that expect native-style event names.
|
|
8250
|
+
* @eventDetail `VegaDropdownSourceItem` — The full data object of the selected suggestion item, including its `label`, `value`, and any custom properties.
|
|
8147
8251
|
* @eventSemantics namespace:native
|
|
8148
8252
|
* @vegaVersion 2.75.0
|
|
8149
8253
|
*/
|
|
8150
8254
|
"onSuggestionItemClick"?: (event: VegaInputCustomEvent<VegaDropdownSourceItem>) => void;
|
|
8151
8255
|
/**
|
|
8152
|
-
*
|
|
8256
|
+
* Emitted when the input field loses focus. This event fires after the underlying native `<input>` element's `blur` event. Useful for triggering validation, saving state, or updating UI when the user navigates away from the field.
|
|
8257
|
+
* @eventDetail `undefined` — No payload; listen for the event occurrence only.
|
|
8153
8258
|
* @vegaVersion 1.3.0
|
|
8154
8259
|
*/
|
|
8155
8260
|
"onVegaBlur"?: (event: VegaInputCustomEvent<undefined>) => void;
|
|
8156
8261
|
/**
|
|
8157
|
-
*
|
|
8262
|
+
* Emitted when the input value changes. The timing of this event depends on the `valueUpdateTrigger` prop: - When `valueUpdateTrigger` is `'input'` (default), fires on every keystroke. - When `valueUpdateTrigger` is `'change'`, fires on blur or when the user presses Enter. Also fires when the user clicks the clear icon or when the value is programmatically updated.
|
|
8263
|
+
* @eventDetail `string` — The current input value after the change.
|
|
8158
8264
|
* @vegaVersion 1.0.10
|
|
8159
8265
|
*/
|
|
8160
8266
|
"onVegaChange"?: (event: VegaInputCustomEvent<string>) => void;
|
|
8161
8267
|
/**
|
|
8162
|
-
*
|
|
8268
|
+
* Emitted when the input field receives focus. This event fires after the underlying native `<input>` element's `focus` event, including when focus is set programmatically via the `doFocus()` method. Useful for highlighting the field, showing contextual help, or opening a suggestions dropdown.
|
|
8269
|
+
* @eventDetail `undefined` — No payload; listen for the event occurrence only.
|
|
8163
8270
|
* @vegaVersion 1.12.0
|
|
8164
8271
|
*/
|
|
8165
8272
|
"onVegaFocus"?: (event: VegaInputCustomEvent<undefined>) => void;
|
|
8166
8273
|
/**
|
|
8167
|
-
*
|
|
8274
|
+
* Emitted when the user clicks the suffix button in the field label. This event only fires when a `labelSuffixButtonConfig` (or the deprecated `labelSuffixButtonProps`) is provided. Use it to handle contextual actions such as opening a tooltip, navigating to a help page, or triggering a "Forgot password?" flow.
|
|
8275
|
+
* @eventDetail `void` — No payload.
|
|
8168
8276
|
* @vegaVersion 2.25.0
|
|
8169
8277
|
*/
|
|
8170
8278
|
"onVegaLabelButtonClick"?: (event: VegaInputCustomEvent<any>) => void;
|
|
8171
8279
|
/**
|
|
8172
|
-
*
|
|
8280
|
+
* Emitted on every native `input` event from the underlying `<input>` element, regardless of the `valueUpdateTrigger` setting. This event fires on every keystroke and provides the raw input value. Use this for real-time monitoring (e.g., driving a suggestions dropdown) while keeping `vegaChange` set to `'change'` trigger for the main value binding.
|
|
8281
|
+
* @eventDetail `string` — The raw value from the native input element.
|
|
8173
8282
|
* @vegaVersion 2.75.0
|
|
8174
8283
|
*/
|
|
8175
8284
|
"onVegaNativeInputChange"?: (event: VegaInputCustomEvent<string>) => void;
|
|
8176
8285
|
/**
|
|
8177
|
-
*
|
|
8286
|
+
* Emitted when the user pastes content into the input field. This event fires regardless of the `disableCopyPaste` setting — the paste action is blocked visually, but the event still propagates for tracking purposes. Use this to inspect or transform pasted data before it is applied.
|
|
8287
|
+
* @eventDetail `DataTransferType` — An object containing the pasted data, including the MIME type and raw text content from the clipboard.
|
|
8178
8288
|
* @vegaVersion 2.66.0
|
|
8179
8289
|
*/
|
|
8180
8290
|
"onVegaPaste"?: (event: VegaInputCustomEvent<DataTransferType>) => void;
|
|
8181
8291
|
/**
|
|
8182
|
-
*
|
|
8292
|
+
* Emitted when the user selects an item from the suggestions dropdown. This event only fires when the `suggestionsDropdownSource` prop is set. Use it to respond to the user's selection — for example, to populate related fields, navigate to a detail page, or trigger a search.
|
|
8293
|
+
* @eventDetail `VegaDropdownSourceItem` — The full data object of the selected suggestion item, including its `label`, `value`, and any custom properties.
|
|
8183
8294
|
* @vegaVersion 2.75.0
|
|
8184
8295
|
*/
|
|
8185
8296
|
"onVegaSuggestionItemClick"?: (event: VegaInputCustomEvent<VegaDropdownSourceItem>) => void;
|
|
8186
8297
|
/**
|
|
8187
|
-
*
|
|
8298
|
+
* Sets the placeholder text displayed inside the input when the value is empty. Use this to provide a short hint about the expected input format or content (e.g., `'Enter your email'`, `'MM/DD/YYYY'`). The placeholder text disappears as soon as the user begins typing. **Note:** Placeholder text is not a substitute for a `label` — always provide a descriptive label for accessibility.
|
|
8188
8299
|
* @vegaVersion 1.3.0
|
|
8189
8300
|
*/
|
|
8190
8301
|
"placeholder"?: string;
|
|
8191
8302
|
/**
|
|
8192
|
-
*
|
|
8303
|
+
* Displays a Vega icon at the leading (left) side of the input field, providing visual context about the expected input. Pass a valid Vega icon name (e.g., `'search'`, `'email'`, `'lock'`). The icon is rendered inside the input container and does not affect the input's value or validation.
|
|
8193
8304
|
* @vegaVersion 1.0.5
|
|
8194
8305
|
*/
|
|
8195
8306
|
"prefixIcon"?: string;
|
|
8196
8307
|
/**
|
|
8197
|
-
*
|
|
8308
|
+
* Marks the input field as required for form submission. When `true`, a required-field validation rule is automatically applied. If `autoValidation` is enabled, the field will display a validation error when the user leaves it empty. A visual required indicator (asterisk) is shown next to the label.
|
|
8309
|
+
* @default false
|
|
8198
8310
|
* @vegaVersion 1.0.5
|
|
8199
8311
|
*/
|
|
8200
8312
|
"required"?: boolean;
|
|
8201
8313
|
/**
|
|
8202
|
-
*
|
|
8314
|
+
* Controls whether a clear (✕) icon button is displayed inside the input when the field has a non-empty value. When `true`, clicking the clear icon resets the input value to an empty string and emits a `vegaChange` event. Set to `false` to hide the icon (e.g., for inputs where clearing is not desired, such as read-only displays).
|
|
8315
|
+
* @default true
|
|
8203
8316
|
* @vegaVersion 1.3.0
|
|
8204
8317
|
*/
|
|
8205
8318
|
"showClearIcon"?: boolean;
|
|
8206
8319
|
/**
|
|
8207
|
-
*
|
|
8320
|
+
* Sets the visual size variant of the input field, affecting its height and internal padding. - `'default'` — Standard height (40px), suitable for most form layouts. - `'small'` — Compact height (32px), useful in dense or inline layouts. Such as table cells or toolbars.
|
|
8321
|
+
* @default 'default'
|
|
8208
8322
|
* @vegaVersion 1.3.0
|
|
8209
8323
|
*/
|
|
8210
8324
|
"size"?: 'default' | 'small';
|
|
8211
8325
|
/**
|
|
8212
|
-
*
|
|
8326
|
+
* Provides the data source for the input's autocomplete suggestion dropdown. Pass an array of `VegaDropdownSourceItem` objects to enable the suggestions feature. The dropdown appears as the user types, filtering items that match the current input value. When the user selects a suggestion, the `vegaSuggestionItemClick` event is emitted. **Important:** You must set this property to at least an empty array (`[]`) to enable the suggestion dropdown. If left `undefined`, the feature is disabled.
|
|
8213
8327
|
* @vegaVersion 2.75.0
|
|
8214
8328
|
*/
|
|
8215
8329
|
"suggestionsDropdownSource"?: VegaDropdownSourceItem[];
|
|
8216
8330
|
/**
|
|
8217
|
-
*
|
|
8331
|
+
* Sets the HTML input type, which controls the browser's input behavior, on-screen keyboard layout, and built-in validation. - `'text'` — Standard single-line text input. - `'email'` — Optimized for email entry; triggers email validation automatically. - `'password'` — Masks the entered characters; displays a show/hide toggle icon. - `'number'` — Restricts input to numeric values; may show increment/decrement controls. - `'hidden'` — Renders the input as invisible (useful for programmatic form values).
|
|
8332
|
+
* @default 'text'
|
|
8218
8333
|
* @vegaVersion 1.0.9
|
|
8219
8334
|
*/
|
|
8220
8335
|
"type"?: InputType;
|
|
8221
8336
|
/**
|
|
8222
|
-
*
|
|
8337
|
+
* An array of custom validation rules applied to the input field in addition to the built-in rules derived from `required`, `min`, `max`, `minLength`, `maxLength`, and `email` props. Each rule is a `FormFieldValidationRule` object that defines a validation function and an associated error message. Rules are evaluated in order; the first failing rule's message is displayed.
|
|
8338
|
+
* @default []
|
|
8223
8339
|
* @vegaVersion 1.0.10
|
|
8224
8340
|
*/
|
|
8225
8341
|
"validationRules"?: FormFieldValidationRule<unknown>[];
|
|
8226
8342
|
/**
|
|
8227
|
-
*
|
|
8343
|
+
* The current value of the input field. Use this property to programmatically set or read the input's value. The value is two-way bound — it updates when the user types and can be set externally to pre-fill or reset the field. When a `maskConfig` is applied, the displayed value may differ from the raw value (e.g., formatted phone numbers). The `vegaChange` event emits the current value whenever it changes.
|
|
8344
|
+
* @default ''
|
|
8228
8345
|
* @vegaVersion 1.0.5
|
|
8229
8346
|
*/
|
|
8230
8347
|
"value"?: string;
|
|
8231
8348
|
/**
|
|
8232
|
-
*
|
|
8349
|
+
* Controls when the `vegaChange` event is emitted, allowing you to choose between real-time updates and committed-value updates. - `'input'` — Fires on every keystroke as the user types (real-time). - `'change'` — Fires only when the input loses focus or the user presses Enter, similar to the native HTML `change` event behavior. Use `'change'` for expensive operations (e.g., API calls) where you only need the final committed value. Use `'input'` for live search or filtering scenarios.
|
|
8350
|
+
* @default 'input'
|
|
8233
8351
|
* @vegaVersion 2.24.0
|
|
8234
8352
|
*/
|
|
8235
8353
|
"valueUpdateTrigger"?: InputValueUpdateTriggeredBy;
|
|
@@ -8326,286 +8444,336 @@ declare namespace LocalJSX {
|
|
|
8326
8444
|
}
|
|
8327
8445
|
interface VegaInputNumeric {
|
|
8328
8446
|
/**
|
|
8329
|
-
* Determines whether the input
|
|
8447
|
+
* Determines whether the numeric input should be validated automatically as the user interacts with it. When `true`, validation rules (including `required`, `min`, `max`, and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
8448
|
+
* @default true
|
|
8330
8449
|
* @vegaVersion 2.29.0
|
|
8331
8450
|
*/
|
|
8332
8451
|
"autoValidation"?: boolean;
|
|
8333
8452
|
/**
|
|
8334
|
-
*
|
|
8453
|
+
* Specifies whether the numeric input field is disabled. When `true`, the field is non-interactive — the user cannot type, focus, or use keyboard controls to change the value.
|
|
8454
|
+
* @default false
|
|
8335
8455
|
* @vegaVersion 2.29.0
|
|
8336
8456
|
*/
|
|
8337
8457
|
"disabled"?: boolean;
|
|
8338
8458
|
/**
|
|
8339
|
-
*
|
|
8459
|
+
* Supplementary helper message displayed below the input field that assists users in understanding the expected value or range. Visible at all times (not just on focus).
|
|
8460
|
+
* @default undefined
|
|
8340
8461
|
* @vegaVersion 2.29.0
|
|
8341
8462
|
*/
|
|
8342
8463
|
"hint"?: string;
|
|
8343
8464
|
/**
|
|
8344
|
-
*
|
|
8465
|
+
* When `true`, restricts user input to whole numbers only — decimal points and fractional digits are rejected. Useful for fields like quantity, count, or age.
|
|
8466
|
+
* @default false
|
|
8345
8467
|
* @vegaVersion 2.29.0
|
|
8346
8468
|
*/
|
|
8347
8469
|
"integerOnly"?: boolean;
|
|
8348
8470
|
/**
|
|
8349
|
-
*
|
|
8471
|
+
* Reflects the current validation status of the numeric input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
8472
|
+
* @default null
|
|
8350
8473
|
* @vegaVersion 2.29.0
|
|
8351
8474
|
*/
|
|
8352
8475
|
"isValid"?: boolean;
|
|
8353
8476
|
/**
|
|
8354
|
-
*
|
|
8477
|
+
* Specifies the visible label text rendered above the numeric input. The label identifies the purpose of the field and serves as the accessible name for screen readers.
|
|
8478
|
+
* @default ''
|
|
8355
8479
|
* @vegaVersion 2.29.0
|
|
8356
8480
|
*/
|
|
8357
8481
|
"label"?: string;
|
|
8358
8482
|
/**
|
|
8359
|
-
*
|
|
8483
|
+
* The step value used when the user presses `Shift` + `ArrowUp` or `Shift` + `ArrowDown` to increment or decrement the value by a larger amount. This enables quick coarse-grained adjustments. For smaller steps, see `minorIncrement`.
|
|
8484
|
+
* @default 10
|
|
8360
8485
|
* @vegaVersion 2.29.0
|
|
8361
8486
|
*/
|
|
8362
8487
|
"majorIncrement"?: number;
|
|
8363
8488
|
/**
|
|
8364
|
-
* Sets the maximum allowable value for the numeric input.
|
|
8489
|
+
* Sets the maximum allowable value for the numeric input. When set, the built-in `MaxNumberRule` is applied during validation. Values above this threshold will cause validation to fail. Set to `null` to remove the upper bound.
|
|
8490
|
+
* @default null
|
|
8365
8491
|
* @vegaVersion 2.63.0
|
|
8366
8492
|
*/
|
|
8367
8493
|
"max"?: number | null;
|
|
8368
8494
|
/**
|
|
8369
|
-
* Sets the minimum allowable value for the numeric input.
|
|
8495
|
+
* Sets the minimum allowable value for the numeric input. When set, the built-in `MinNumberRule` is applied during validation. Values below this threshold will cause validation to fail. Set to `null` to remove the lower bound.
|
|
8496
|
+
* @default null
|
|
8370
8497
|
* @vegaVersion 2.63.0
|
|
8371
8498
|
*/
|
|
8372
8499
|
"min"?: number | null;
|
|
8373
8500
|
/**
|
|
8374
|
-
*
|
|
8501
|
+
* The step value used when the user presses the `ArrowUp` or `ArrowDown` key to increment or decrement the value. This controls fine-grained adjustments to the numeric input. For larger jumps, see `majorIncrement` (activated with `Shift` + arrow keys).
|
|
8502
|
+
* @default 1
|
|
8375
8503
|
* @vegaVersion 2.29.0
|
|
8376
8504
|
*/
|
|
8377
8505
|
"minorIncrement"?: number;
|
|
8378
8506
|
/**
|
|
8379
|
-
*
|
|
8507
|
+
* Native-equivalent mirror of `vegaChange`. Fires with the same payload and at the same time, allowing consumers to listen using the standard `change` event name.
|
|
8508
|
+
* @eventDetail number
|
|
8380
8509
|
* @eventSemantics namespace:native
|
|
8381
8510
|
* @vegaVersion 2.29.0
|
|
8382
8511
|
*/
|
|
8383
8512
|
"onChange"?: (event: VegaInputNumericCustomEvent<number>) => void;
|
|
8384
8513
|
/**
|
|
8385
|
-
*
|
|
8514
|
+
* Fires whenever the numeric input's value changes — including typing, keyboard increment/decrement, clearing, and programmatic updates. The event detail contains the new numeric value (`number`), or `NaN` when the field is empty.
|
|
8515
|
+
* @eventDetail number
|
|
8386
8516
|
* @vegaVersion 2.29.0
|
|
8387
8517
|
*/
|
|
8388
8518
|
"onVegaChange"?: (event: VegaInputNumericCustomEvent<number>) => void;
|
|
8389
8519
|
/**
|
|
8390
|
-
* Specifies
|
|
8520
|
+
* Specifies placeholder text displayed inside the input field when it is empty. The placeholder disappears once the user begins typing and is typically used to indicate the expected format (e.g., `'0.00'`).
|
|
8521
|
+
* @default undefined
|
|
8391
8522
|
* @vegaVersion 2.29.0
|
|
8392
8523
|
*/
|
|
8393
8524
|
"placeholder"?: string;
|
|
8394
8525
|
/**
|
|
8395
|
-
*
|
|
8526
|
+
* Name of a Vega icon rendered before (to the left of) the input field, providing additional visual context. The icon is purely decorative and does not affect the input value.
|
|
8527
|
+
* @default undefined
|
|
8396
8528
|
* @vegaVersion 2.29.0
|
|
8397
8529
|
*/
|
|
8398
8530
|
"prefixIcon"?: string;
|
|
8399
8531
|
/**
|
|
8400
|
-
*
|
|
8532
|
+
* Text displayed before (to the left of) the numeric value inside the input field. Use this to provide contextual information such as a currency symbol (e.g., `'$'`) or unit prefix.
|
|
8533
|
+
* @default ''
|
|
8401
8534
|
* @vegaVersion 2.29.0
|
|
8402
8535
|
*/
|
|
8403
8536
|
"prefixText"?: string;
|
|
8404
8537
|
/**
|
|
8405
|
-
* Determines whether the input
|
|
8538
|
+
* Determines whether the numeric input field must have a value before the form can be submitted. When `true`, the built-in `RequiredFieldRule` is applied during validation and a required indicator is shown on the label.
|
|
8539
|
+
* @default undefined
|
|
8406
8540
|
* @vegaVersion 2.29.0
|
|
8407
8541
|
*/
|
|
8408
8542
|
"required"?: boolean;
|
|
8409
8543
|
/**
|
|
8410
|
-
*
|
|
8544
|
+
* Controls whether a clear (×) icon button is shown inside the input field when a value is present. Clicking the button resets the value to an empty string and triggers the `vegaChange` event.
|
|
8545
|
+
* @default true
|
|
8411
8546
|
* @vegaVersion 2.53.0
|
|
8412
8547
|
*/
|
|
8413
8548
|
"showClearIcon"?: boolean;
|
|
8414
8549
|
/**
|
|
8415
|
-
*
|
|
8550
|
+
* Controls the visual size of the numeric input field. - `'medium'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs or inline editing.
|
|
8551
|
+
* @default 'medium'
|
|
8416
8552
|
* @vegaVersion 2.29.0
|
|
8417
8553
|
*/
|
|
8418
8554
|
"size"?: 'medium' | 'small';
|
|
8419
8555
|
/**
|
|
8420
|
-
*
|
|
8556
|
+
* Text displayed after (to the right of) the numeric value inside the input field. Use this to provide contextual information such as a unit suffix (e.g., `'%'`, `'kg'`, `'USD'`).
|
|
8557
|
+
* @default undefined
|
|
8421
8558
|
* @vegaVersion 2.29.0
|
|
8422
8559
|
*/
|
|
8423
8560
|
"suffixText"?: string;
|
|
8424
8561
|
/**
|
|
8425
|
-
*
|
|
8562
|
+
* When `true`, the numeric input automatically formats the displayed value with thousand separators (commas) as the user types (e.g., `1,000,000`). The underlying `value` property remains an unformatted numeric string.
|
|
8563
|
+
* @default false
|
|
8426
8564
|
* @vegaVersion 2.29.0
|
|
8427
8565
|
*/
|
|
8428
8566
|
"thousandComma"?: boolean;
|
|
8429
8567
|
/**
|
|
8430
|
-
*
|
|
8568
|
+
* An array of custom validation rules applied to the numeric input in addition to the built-in rules (`RequiredFieldRule`, `MinNumberRule`, `MaxNumberRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
8569
|
+
* @default []
|
|
8431
8570
|
* @vegaVersion 2.29.0
|
|
8432
8571
|
*/
|
|
8433
8572
|
"validationRules"?: FormFieldValidationRule1<unknown>[];
|
|
8434
8573
|
/**
|
|
8435
|
-
*
|
|
8574
|
+
* The current value of the numeric input field, represented as a string. This property is mutable and will be updated when the user types or uses keyboard increment/decrement actions. It can also be set externally to pre-populate or reset the field. When `thousandComma` is enabled, the display is formatted with separators but the underlying value remains unformatted. Changes to this property trigger the `vegaChange` event.
|
|
8575
|
+
* @default ''
|
|
8436
8576
|
* @vegaVersion 2.29.0
|
|
8437
8577
|
*/
|
|
8438
8578
|
"value"?: string;
|
|
8439
8579
|
}
|
|
8440
8580
|
interface VegaInputPasscode {
|
|
8441
8581
|
/**
|
|
8442
|
-
* Determines whether the input
|
|
8582
|
+
* Determines whether the passcode input should be validated automatically as the user types. When `true`, validation rules (including `required` and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
8583
|
+
* @default true
|
|
8443
8584
|
* @vegaVersion 2.66.0
|
|
8444
8585
|
*/
|
|
8445
8586
|
"autoValidation"?: boolean;
|
|
8446
8587
|
/**
|
|
8447
|
-
*
|
|
8588
|
+
* Specifies whether the passcode input is disabled. When `true`, all individual input boxes become non-interactive — the user cannot type, paste, or focus any box.
|
|
8589
|
+
* @default false
|
|
8448
8590
|
* @vegaVersion 2.66.0
|
|
8449
8591
|
*/
|
|
8450
8592
|
"disabled"?: boolean;
|
|
8451
8593
|
/**
|
|
8452
|
-
*
|
|
8594
|
+
* Supplementary helper message displayed below the passcode input that assists users in understanding the expected input. For example, `'Enter the 4-digit code sent to your email'`.
|
|
8595
|
+
* @default ''
|
|
8453
8596
|
* @vegaVersion 2.66.0
|
|
8454
8597
|
*/
|
|
8455
8598
|
"hint"?: string;
|
|
8456
8599
|
/**
|
|
8457
|
-
* Specifies the
|
|
8600
|
+
* Specifies the type of characters accepted by each passcode box. - `'numeric'` — Only digits `0`–`9` are accepted. - `'text'` — Any non-space character is accepted. Spaces are always rejected regardless of the selected type.
|
|
8601
|
+
* @default 'numeric'
|
|
8458
8602
|
* @vegaVersion 2.66.0
|
|
8459
8603
|
*/
|
|
8460
8604
|
"inputType"?: 'numeric' | 'text';
|
|
8461
8605
|
/**
|
|
8462
|
-
*
|
|
8606
|
+
* Reflects the current validation status of the passcode input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
8607
|
+
* @default null
|
|
8463
8608
|
* @vegaVersion 2.66.0
|
|
8464
8609
|
*/
|
|
8465
8610
|
"isValid"?: boolean | null;
|
|
8466
8611
|
/**
|
|
8467
|
-
* Specifies the label
|
|
8612
|
+
* Specifies the visible label text rendered above the passcode input. The label identifies the purpose of the field (e.g., "Enter verification code") and serves as the accessible name for screen readers.
|
|
8613
|
+
* @default ''
|
|
8468
8614
|
* @vegaVersion 2.66.0
|
|
8469
8615
|
*/
|
|
8470
8616
|
"label"?: string;
|
|
8471
8617
|
/**
|
|
8472
|
-
* Specifies the number of input boxes
|
|
8618
|
+
* Specifies the number of individual input boxes rendered for the passcode. Each box accepts a single character. Common values are `4` for a PIN and `6` for a two-factor authentication code.
|
|
8619
|
+
* @default 4
|
|
8473
8620
|
* @vegaVersion 2.66.0
|
|
8474
8621
|
*/
|
|
8475
8622
|
"length"?: number;
|
|
8476
8623
|
/**
|
|
8477
|
-
*
|
|
8624
|
+
* Native-equivalent mirror of `vegaChange`. Fires with the same payload and at the same time, allowing consumers to listen using the standard `change` event name.
|
|
8625
|
+
* @eventDetail string
|
|
8478
8626
|
* @eventSemantics namespace:native
|
|
8479
8627
|
* @vegaVersion 2.66.0
|
|
8480
8628
|
*/
|
|
8481
8629
|
"onChange"?: (event: VegaInputPasscodeCustomEvent<string>) => void;
|
|
8482
8630
|
/**
|
|
8483
|
-
*
|
|
8631
|
+
* Native-equivalent mirror of `vegaComplete`. Fires with the same payload and at the same time, allowing consumers to listen using the standard `complete` event name.
|
|
8632
|
+
* @eventDetail string
|
|
8484
8633
|
* @eventSemantics namespace:native
|
|
8485
8634
|
* @vegaVersion 2.66.0
|
|
8486
8635
|
*/
|
|
8487
8636
|
"onComplete"?: (event: VegaInputPasscodeCustomEvent<string>) => void;
|
|
8488
8637
|
/**
|
|
8489
|
-
*
|
|
8638
|
+
* Fires whenever the passcode value changes — each time a character is entered, deleted, or pasted into any box. The event detail contains the concatenated string of all box values at the time of the change.
|
|
8639
|
+
* @eventDetail string
|
|
8490
8640
|
* @vegaVersion 2.66.0
|
|
8491
8641
|
*/
|
|
8492
8642
|
"onVegaChange"?: (event: VegaInputPasscodeCustomEvent<string>) => void;
|
|
8493
8643
|
/**
|
|
8494
|
-
*
|
|
8644
|
+
* Fires when all passcode boxes have been filled (i.e., the value length equals the configured `length`). The event detail contains the complete passcode string. Useful for triggering auto-submit or verification workflows.
|
|
8645
|
+
* @eventDetail string
|
|
8495
8646
|
* @vegaVersion 2.66.0
|
|
8496
8647
|
*/
|
|
8497
8648
|
"onVegaComplete"?: (event: VegaInputPasscodeCustomEvent<string>) => void;
|
|
8498
8649
|
/**
|
|
8499
|
-
* Determines whether the
|
|
8650
|
+
* Determines whether the passcode field must have a value before the form can be submitted. When `true`, the built-in `RequiredFieldRule` is applied during validation and a required indicator is shown on the label.
|
|
8651
|
+
* @default false
|
|
8500
8652
|
* @vegaVersion 2.66.0
|
|
8501
8653
|
*/
|
|
8502
8654
|
"required"?: boolean;
|
|
8503
8655
|
/**
|
|
8504
|
-
*
|
|
8656
|
+
* Controls the visual size of the passcode input boxes. - `'medium'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs.
|
|
8657
|
+
* @default 'medium'
|
|
8505
8658
|
* @vegaVersion 2.66.0
|
|
8506
8659
|
*/
|
|
8507
8660
|
"size"?: 'medium' | 'small';
|
|
8508
8661
|
/**
|
|
8509
|
-
*
|
|
8662
|
+
* An array of custom validation rules applied to the passcode input in addition to the built-in `RequiredFieldRule`. Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
8663
|
+
* @default []
|
|
8510
8664
|
* @vegaVersion 2.66.0
|
|
8511
8665
|
*/
|
|
8512
8666
|
"validationRules"?: FormFieldValidationRule<unknown>[];
|
|
8513
8667
|
/**
|
|
8514
|
-
*
|
|
8668
|
+
* The current value of the passcode input, represented as a concatenated string of all box values (e.g., `'1234'` for a 4-digit passcode). This property is mutable and reflected to the host element attribute. It updates as the user types into the boxes and can be set externally to pre-populate or reset the field.
|
|
8669
|
+
* @default ''
|
|
8515
8670
|
* @vegaVersion 2.66.0
|
|
8516
8671
|
*/
|
|
8517
8672
|
"value"?: string;
|
|
8518
8673
|
}
|
|
8519
8674
|
interface VegaInputPhoneNumber {
|
|
8520
8675
|
/**
|
|
8521
|
-
*
|
|
8676
|
+
* An array of country codes available for selection in the country dropdown. Each entry must be a two-letter uppercase ISO 3166-1 alpha-2 code. By default all 245 supported codes are loaded, but providing a smaller subset improves initial render performance.
|
|
8677
|
+
* @default VegaCountryCode[] (all 245 codes)
|
|
8522
8678
|
* @vegaVersion 2.18.0
|
|
8523
|
-
* @defaultValue ['US', 'CN', ...]{@link VegaCountryCode }
|
|
8524
8679
|
*/
|
|
8525
8680
|
"allowedCountryCodes"?: VegaCountryCode[];
|
|
8526
8681
|
/**
|
|
8527
|
-
* Determines whether the phone number input
|
|
8682
|
+
* Determines whether the phone number input should be validated automatically as the user interacts with it. When `true`, validation rules (including `required`, `ValidPhoneNumberRule`, and custom `validationRules`) are evaluated and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
8683
|
+
* @default true
|
|
8528
8684
|
* @vegaVersion 2.18.0
|
|
8529
8685
|
*/
|
|
8530
8686
|
"autoValidation"?: boolean;
|
|
8531
8687
|
/**
|
|
8532
|
-
* Specifies the
|
|
8688
|
+
* Specifies the currently selected country using a two-letter uppercase ISO 3166-1 alpha-2 code (e.g., `'US'`, `'GB'`, `'CN'`). The country code determines the flag icon and calling code prefix displayed in the country selector. Changing this value updates the phone number prefix accordingly.
|
|
8689
|
+
* @default 'US'
|
|
8533
8690
|
* @vegaVersion 2.18.0
|
|
8534
|
-
* @defaultValue US
|
|
8535
8691
|
*/
|
|
8536
8692
|
"countryCode"?: VegaCountryCode;
|
|
8537
8693
|
/**
|
|
8538
|
-
*
|
|
8694
|
+
* Specifies whether the phone number input field is disabled. When `true`, both the country selector and the phone number text field become non-interactive — the user cannot type, select a country, or focus any part of the component.
|
|
8695
|
+
* @default false
|
|
8539
8696
|
* @vegaVersion 2.18.0
|
|
8540
8697
|
*/
|
|
8541
8698
|
"disabled"?: boolean;
|
|
8542
8699
|
/**
|
|
8543
|
-
*
|
|
8700
|
+
* Controls whether the `value` property can be an empty string. - `true` — The `value` property is cleared to `''` when the user deletes all digits from the input field. - `false` — The `value` property always retains at least the country calling code prefix (e.g., `'+1'` for US) even when no phone number digits have been entered.
|
|
8701
|
+
* @default false
|
|
8544
8702
|
* @vegaVersion 2.35.0
|
|
8545
8703
|
*/
|
|
8546
8704
|
"emptyValueEnabled"?: boolean;
|
|
8547
8705
|
/**
|
|
8548
|
-
*
|
|
8706
|
+
* Supplementary helper message displayed below the phone number input that assists users in understanding the expected value or provides additional context (e.g., `'We will send a verification code to this number'`).
|
|
8707
|
+
* @default ''
|
|
8549
8708
|
* @vegaVersion 2.18.0
|
|
8550
8709
|
*/
|
|
8551
8710
|
"hint"?: string;
|
|
8552
8711
|
/**
|
|
8553
|
-
*
|
|
8712
|
+
* Reflects the current validation status of the phone number input. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state.
|
|
8713
|
+
* @default null
|
|
8554
8714
|
* @vegaVersion 2.18.0
|
|
8555
8715
|
*/
|
|
8556
8716
|
"isValid"?: boolean;
|
|
8557
8717
|
/**
|
|
8558
|
-
* Specifies the label
|
|
8718
|
+
* Specifies the visible label text rendered above the phone number input. The label identifies the purpose of the field and serves as the accessible name for screen readers.
|
|
8719
|
+
* @default ''
|
|
8559
8720
|
* @vegaVersion 2.18.0
|
|
8560
8721
|
*/
|
|
8561
8722
|
"label"?: string;
|
|
8562
8723
|
/**
|
|
8563
|
-
*
|
|
8724
|
+
* Native-equivalent mirror of `vegaChange`. Fires with the same payload and at the same time, allowing consumers to listen using the standard `change` event name.
|
|
8725
|
+
* @eventDetail string
|
|
8564
8726
|
* @eventSemantics namespace:native
|
|
8565
8727
|
* @vegaVersion 2.18.0
|
|
8566
8728
|
*/
|
|
8567
8729
|
"onChange"?: (event: VegaInputPhoneNumberCustomEvent<string>) => void;
|
|
8568
8730
|
/**
|
|
8569
|
-
*
|
|
8731
|
+
* Native-equivalent mirror of `vegaCountryChange`. Fires with the same payload and at the same time, allowing consumers to listen using the standard `countryChange` event name.
|
|
8732
|
+
* @eventDetail VegaCountryType
|
|
8570
8733
|
* @eventSemantics namespace:native
|
|
8571
8734
|
* @vegaVersion 2.18.0
|
|
8572
8735
|
*/
|
|
8573
8736
|
"onCountryChange"?: (event: VegaInputPhoneNumberCustomEvent<VegaCountryType>) => void;
|
|
8574
8737
|
/**
|
|
8575
|
-
*
|
|
8738
|
+
* Fires whenever the phone number value changes — including typing, pasting, or programmatic updates. The event detail contains the full phone number in E.164 format (e.g., `'+14155552671'`).
|
|
8739
|
+
* @eventDetail string
|
|
8576
8740
|
* @vegaVersion 2.18.0
|
|
8577
8741
|
*/
|
|
8578
8742
|
"onVegaChange"?: (event: VegaInputPhoneNumberCustomEvent<string>) => void;
|
|
8579
8743
|
/**
|
|
8580
|
-
*
|
|
8744
|
+
* Fires whenever the selected country changes via the country dropdown. The event detail contains a `VegaCountryType` object with the country code, calling code, and display name of the newly selected country.
|
|
8745
|
+
* @eventDetail VegaCountryType
|
|
8581
8746
|
* @vegaVersion 2.18.0
|
|
8582
8747
|
*/
|
|
8583
8748
|
"onVegaCountryChange"?: (event: VegaInputPhoneNumberCustomEvent<VegaCountryType>) => void;
|
|
8584
8749
|
/**
|
|
8585
|
-
* Specifies
|
|
8750
|
+
* Specifies placeholder text displayed inside the phone number text field when it is empty. The placeholder disappears once the user begins typing and is typically used to indicate the expected format (e.g., `'(555) 555-5555'`).
|
|
8751
|
+
* @default undefined
|
|
8586
8752
|
* @vegaVersion 2.18.0
|
|
8587
8753
|
*/
|
|
8588
8754
|
"placeholder"?: string;
|
|
8589
8755
|
/**
|
|
8590
|
-
* Determines whether the phone number input field is required.
|
|
8756
|
+
* Determines whether the phone number input field must have a value before the form can be submitted. When `true`, the built-in `InputPhoneNumberRequiredRule` is applied during validation and a required indicator is shown on the label.
|
|
8757
|
+
* @default false
|
|
8591
8758
|
* @vegaVersion 2.18.0
|
|
8592
8759
|
*/
|
|
8593
8760
|
"required"?: boolean;
|
|
8594
8761
|
/**
|
|
8595
|
-
*
|
|
8762
|
+
* Controls the visual size of the phone number input field. - `'default'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs.
|
|
8763
|
+
* @default 'default'
|
|
8596
8764
|
* @vegaVersion 2.18.0
|
|
8597
8765
|
*/
|
|
8598
8766
|
"size"?: 'default' | 'small';
|
|
8599
8767
|
/**
|
|
8600
|
-
*
|
|
8768
|
+
* An array of custom validation rules applied to the phone number input in addition to the built-in rules (`InputPhoneNumberRequiredRule`, `ValidPhoneNumberRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
8769
|
+
* @default []
|
|
8601
8770
|
* @vegaVersion 2.18.0
|
|
8602
8771
|
*/
|
|
8603
8772
|
"validationRules"?: FormFieldValidationRule<unknown>[];
|
|
8604
8773
|
/**
|
|
8605
|
-
*
|
|
8606
|
-
* @
|
|
8774
|
+
* The current value of the phone number input in [E.164](https://en.wikipedia.org/wiki/E.164) format (e.g., `'+14155552671'`). This property is mutable and reflected to the host element attribute. It updates as the user types and can be set externally to pre-populate or reset the field. When `emptyValueEnabled` is `false` and no digits have been entered, the value defaults to the country calling code prefix (e.g., `'+1'` for US).
|
|
8775
|
+
* @default '+1'
|
|
8607
8776
|
* @vegaVersion 2.18.0
|
|
8608
|
-
* @defaultValue +1
|
|
8609
8777
|
*/
|
|
8610
8778
|
"value"?: string;
|
|
8611
8779
|
}
|
|
@@ -8803,7 +8971,7 @@ declare namespace LocalJSX {
|
|
|
8803
8971
|
*/
|
|
8804
8972
|
"selectType"?: SelectType;
|
|
8805
8973
|
/**
|
|
8806
|
-
* Allows customization of the text displayed within the select field when single or multiple items are selected. The default format for the selected label is
|
|
8974
|
+
* Allows customization of the text displayed within the select field when single or multiple items are selected. The default format for the selected label is `{0} Selected` for multiple mode only. To enable all modes, use the `SelectedLabelTypeForAllModes` type. For single mode, the default format is the `displayName` of the selected item if not set For multiple mode, the default format is `{0} Selected` if not set
|
|
8807
8975
|
* @vegaVersion 1.35.0
|
|
8808
8976
|
*/
|
|
8809
8977
|
"selectedLabel"?: SelectedLabelType | SelectedLabelTypeForAllModes;
|
|
@@ -9640,6 +9808,12 @@ declare namespace LocalJSX {
|
|
|
9640
9808
|
* @vegaVersion 2.34.0
|
|
9641
9809
|
*/
|
|
9642
9810
|
"onImageInserted"?: (event: VegaRichTextEditorCustomEvent<VegaRichTextEditorImage>) => void;
|
|
9811
|
+
/**
|
|
9812
|
+
* An event emitter notifying a source code change event. It triggers when the editor loses focus in source edit mode.
|
|
9813
|
+
* @eventSemantics namespace:native
|
|
9814
|
+
* @vegaVersion 2.78.0
|
|
9815
|
+
*/
|
|
9816
|
+
"onSourceCodeChange"?: (event: VegaRichTextEditorCustomEvent<string>) => void;
|
|
9643
9817
|
/**
|
|
9644
9818
|
* An event emitter notifying a value change.
|
|
9645
9819
|
* @vegaVersion 2.34.0
|
|
@@ -9650,6 +9824,11 @@ declare namespace LocalJSX {
|
|
|
9650
9824
|
* @vegaVersion 2.34.0
|
|
9651
9825
|
*/
|
|
9652
9826
|
"onVegaImageInserted"?: (event: VegaRichTextEditorCustomEvent<VegaRichTextEditorImage>) => void;
|
|
9827
|
+
/**
|
|
9828
|
+
* An event emitter notifying a source code change event. It triggers when the editor loses focus in source edit mode.
|
|
9829
|
+
* @vegaVersion 2.78.0
|
|
9830
|
+
*/
|
|
9831
|
+
"onVegaSourceCodeChange"?: (event: VegaRichTextEditorCustomEvent<string>) => void;
|
|
9653
9832
|
/**
|
|
9654
9833
|
* Specifies a placeholder string that displays as a temporary hint or example within the rich text editor. It indicates the expected format or pattern of the input within the rich text editor.
|
|
9655
9834
|
* @vegaVersion 2.34.0
|
|
@@ -10703,110 +10882,131 @@ declare namespace LocalJSX {
|
|
|
10703
10882
|
}
|
|
10704
10883
|
interface VegaTextarea {
|
|
10705
10884
|
/**
|
|
10706
|
-
* Determines whether
|
|
10885
|
+
* Determines whether the text area should be validated automatically as the user types. When `true`, validation rules (including `required`, `minLength`, `maxLength`, and custom `validationRules`) are evaluated on blur and the `isValid` property is updated accordingly. Set to `false` to handle validation manually.
|
|
10886
|
+
* @default true
|
|
10707
10887
|
* @vegaVersion 1.11.0
|
|
10708
10888
|
*/
|
|
10709
10889
|
"autoValidation"?: boolean;
|
|
10710
10890
|
/**
|
|
10711
|
-
* Specifies whether the text area is disabled.
|
|
10891
|
+
* Specifies whether the text area is disabled. When `true`, the text area is non-interactive — the user cannot type, focus, or select the field. The disabled state is reflected as an HTML attribute for CSS styling.
|
|
10892
|
+
* @default false
|
|
10712
10893
|
* @vegaVersion 1.11.0
|
|
10713
10894
|
*/
|
|
10714
10895
|
"disabled"?: boolean;
|
|
10715
10896
|
/**
|
|
10716
|
-
* Provides a supplementary
|
|
10897
|
+
* Provides a supplementary helper message displayed below the text area that assists users in understanding the expected value or format. The hint is visible at all times (not just on focus) and is typically used for guidance such as character requirements or formatting rules.
|
|
10898
|
+
* @default ''
|
|
10717
10899
|
* @vegaVersion 1.11.0
|
|
10718
10900
|
*/
|
|
10719
10901
|
"hint"?: string;
|
|
10720
10902
|
/**
|
|
10721
|
-
*
|
|
10903
|
+
* Reflects the current validation status of the text area. - `true` — the field value passes all validation rules. - `false` — one or more validation rules have failed. - `null` — the field has not been validated yet (initial state). This property is mutable: it is updated automatically when `autoValidation` is enabled, but can also be set manually to override the validation state. The value is reflected as an HTML attribute.
|
|
10904
|
+
* @default null
|
|
10722
10905
|
* @vegaVersion 1.11.0
|
|
10723
10906
|
*/
|
|
10724
10907
|
"isValid"?: boolean;
|
|
10725
10908
|
/**
|
|
10726
|
-
* Specifies the label
|
|
10909
|
+
* Specifies the visible label text rendered above the text area. The label helps identify the purpose or content expected within the field and also serves as the accessible `aria-label` for screen readers when present. Clicking the label will focus the text area.
|
|
10910
|
+
* @default ''
|
|
10727
10911
|
* @vegaVersion 1.11.0
|
|
10728
10912
|
*/
|
|
10729
10913
|
"label"?: string;
|
|
10730
10914
|
/**
|
|
10731
|
-
*
|
|
10915
|
+
* Configuration object for an optional suffix button rendered beside the field label. Use this to provide an inline action (e.g., a help or info button) next to the label text. When the button is clicked, the `vegaLabelButtonClick` event is emitted. Set to `null` to hide the suffix button.
|
|
10916
|
+
* @default null
|
|
10732
10917
|
* @vegaVersion 2.68.0
|
|
10733
10918
|
*/
|
|
10734
10919
|
"labelSuffixButtonConfig"?: Nullable<LabelSuffixButtonConfig>;
|
|
10735
10920
|
/**
|
|
10736
|
-
* Specifies the maximum number of characters (UTF-16 code units)
|
|
10921
|
+
* Specifies the maximum number of characters (UTF-16 code units) that the user can enter in the text area. The native `maxlength` attribute is applied to the inner `<textarea>` element. When `showCounter` is `true`, the maximum value is displayed alongside the current character count (e.g., `42/200`). Exceeding this limit triggers a visual warning on the counter and fails the `MaxStringLengthRule` during validation. Set to `null` to allow unlimited input.
|
|
10922
|
+
* @default null
|
|
10737
10923
|
* @vegaVersion 1.11.0
|
|
10738
10924
|
*/
|
|
10739
10925
|
"maxLength"?: number;
|
|
10740
10926
|
/**
|
|
10741
|
-
* Specifies the minimum number of characters (UTF-16 code units)
|
|
10927
|
+
* Specifies the minimum number of characters (UTF-16 code units) that the user must enter in the text area for the value to be considered valid. The native `minlength` attribute is applied to the inner `<textarea>` element. When set, the `MinStringLengthRule` is applied during validation. Set to `null` to impose no minimum length.
|
|
10928
|
+
* @default null
|
|
10742
10929
|
* @vegaVersion 1.11.0
|
|
10743
10930
|
*/
|
|
10744
10931
|
"minLength"?: number;
|
|
10745
10932
|
/**
|
|
10746
|
-
*
|
|
10933
|
+
* Native-namespace mirror of `vegaBlur`. Fired when the inner `<textarea>` element loses focus. Provided for compatibility with standard DOM event listeners.
|
|
10934
|
+
* @eventDetail undefined — No payload; signals the blur occurrence only.
|
|
10747
10935
|
* @eventSemantics namespace:native
|
|
10748
10936
|
* @vegaVersion 2.0.0
|
|
10749
10937
|
*/
|
|
10750
10938
|
"onBlur"?: (event: VegaTextareaCustomEvent<undefined>) => void;
|
|
10751
10939
|
/**
|
|
10752
|
-
*
|
|
10940
|
+
* Native-namespace mirror of `vegaChange`. Fired whenever the text area value changes. Provided for compatibility with standard DOM event listeners.
|
|
10941
|
+
* @eventDetail string — The updated text area value.
|
|
10753
10942
|
* @eventSemantics namespace:native
|
|
10754
10943
|
* @vegaVersion 2.0.0
|
|
10755
10944
|
*/
|
|
10756
10945
|
"onChange"?: (event: VegaTextareaCustomEvent<string>) => void;
|
|
10757
10946
|
/**
|
|
10758
|
-
*
|
|
10947
|
+
* Native-namespace mirror of `vegaLabelButtonClick`. Fired when the label suffix button is clicked. Provided for compatibility with standard DOM event listeners.
|
|
10948
|
+
* @eventDetail void
|
|
10759
10949
|
* @eventSemantics namespace:native
|
|
10760
10950
|
* @vegaVersion 2.68.0
|
|
10761
10951
|
*/
|
|
10762
10952
|
"onLabelButtonClick"?: (event: VegaTextareaCustomEvent<any>) => void;
|
|
10763
10953
|
/**
|
|
10764
|
-
*
|
|
10954
|
+
* Fired when the inner `<textarea>` element loses focus (blur). Use this event to trigger validation or save actions when the user leaves the text area.
|
|
10955
|
+
* @eventDetail undefined — No payload; signals the blur occurrence only.
|
|
10765
10956
|
* @vegaVersion 1.11.0
|
|
10766
10957
|
*/
|
|
10767
10958
|
"onVegaBlur"?: (event: VegaTextareaCustomEvent<undefined>) => void;
|
|
10768
10959
|
/**
|
|
10769
|
-
*
|
|
10960
|
+
* Fired whenever the text area value changes, whether by user input or programmatic update of the `value` property. This is the primary event for reacting to content changes and implementing two-way binding.
|
|
10961
|
+
* @eventDetail string — The updated text area value.
|
|
10770
10962
|
* @vegaVersion 1.11.0
|
|
10771
10963
|
*/
|
|
10772
10964
|
"onVegaChange"?: (event: VegaTextareaCustomEvent<string>) => void;
|
|
10773
10965
|
/**
|
|
10774
|
-
*
|
|
10966
|
+
* Fired when the suffix button configured via `labelSuffixButtonConfig` is clicked. Listen for this event to handle inline label actions such as opening a help dialog or toggling additional information.
|
|
10967
|
+
* @eventDetail void
|
|
10775
10968
|
* @vegaVersion 2.68.0
|
|
10776
10969
|
*/
|
|
10777
10970
|
"onVegaLabelButtonClick"?: (event: VegaTextareaCustomEvent<any>) => void;
|
|
10778
10971
|
/**
|
|
10779
|
-
* Specifies a placeholder string that displays as a
|
|
10972
|
+
* Specifies a placeholder string that displays as a temporary hint or example within the text area. The placeholder text is shown when the field is empty and disappears once the user begins typing. Use this to indicate the expected format or content of the input, for example `'Enter your comments here...'`.
|
|
10973
|
+
* @default ''
|
|
10780
10974
|
* @vegaVersion 1.11.0
|
|
10781
10975
|
*/
|
|
10782
10976
|
"placeholder"?: string;
|
|
10783
10977
|
/**
|
|
10784
|
-
* Determines whether the
|
|
10978
|
+
* Determines whether the text area must have a non-empty value before the form can be submitted. When `true`, a required-field indicator is shown on the label and the built-in `RequiredFieldRule` is applied during validation.
|
|
10979
|
+
* @default false
|
|
10785
10980
|
* @vegaVersion 1.11.0
|
|
10786
10981
|
*/
|
|
10787
10982
|
"required"?: boolean;
|
|
10788
10983
|
/**
|
|
10789
|
-
* Determines whether the text area is
|
|
10984
|
+
* Determines whether the user can vertically resize the text area by dragging its bottom-right corner. When `false`, the resize handle is hidden via CSS and the text area height is fixed.
|
|
10985
|
+
* @default true
|
|
10790
10986
|
* @vegaVersion 2.19.0
|
|
10791
10987
|
*/
|
|
10792
10988
|
"resizable"?: boolean;
|
|
10793
10989
|
/**
|
|
10794
|
-
* Specifies the number of visible lines in the
|
|
10990
|
+
* Specifies the number of visible text lines in the text area, controlling its initial height. Accepts integers ≥ 2. For optimal display, values below 2 are internally adjusted to 4 rows.
|
|
10991
|
+
* @default 5
|
|
10795
10992
|
* @vegaVersion 2.63.0
|
|
10796
10993
|
*/
|
|
10797
10994
|
"rows"?: number;
|
|
10798
10995
|
/**
|
|
10799
|
-
* Determines whether to display a character counter
|
|
10996
|
+
* Determines whether to display a live character counter below the text area. When `true`, the counter shows the current character count. If `maxLength` is also set, the counter displays in the format `current/max` and visually highlights when the limit is exceeded.
|
|
10997
|
+
* @default false
|
|
10800
10998
|
* @vegaVersion 1.11.0
|
|
10801
10999
|
*/
|
|
10802
11000
|
"showCounter"?: boolean;
|
|
10803
11001
|
/**
|
|
10804
|
-
*
|
|
11002
|
+
* An array of custom validation rules applied to the text area in addition to the built-in rules (`RequiredFieldRule`, `MinStringLengthRule`, `MaxStringLengthRule`). Each rule must implement the `FormFieldValidationRule` interface. Rules are evaluated in order when `autoValidation` is enabled or when validation is triggered programmatically.
|
|
11003
|
+
* @default []
|
|
10805
11004
|
* @vegaVersion 1.11.0
|
|
10806
11005
|
*/
|
|
10807
11006
|
"validationRules"?: FormFieldValidationRule<unknown>[];
|
|
10808
11007
|
/**
|
|
10809
|
-
*
|
|
11008
|
+
* The current value (content) of the text area field. This property is mutable and will be updated programmatically when the user types into the text area. It can also be set externally to pre-populate or reset the field. Changes to this property trigger the `vegaChange` event and update the character counter if `showCounter` is enabled. Supports two-way binding in framework wrappers.
|
|
11009
|
+
* @default ''
|
|
10810
11010
|
* @vegaVersion 1.11.0
|
|
10811
11011
|
*/
|
|
10812
11012
|
"value"?: string;
|