/* eslint-disable */ /* tslint:disable */ /** * This is an autogenerated file created by the Stencil compiler. * It contains typing information for all components that exist in this project. */ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime"; import { BorderStyleType, BoxDisplayType, CornersType, CssStatesType, ElementAppenderAlignmentType, ElementAppenderPlacementType, FlexAlignItemType, FlexDirectionType, FlexJustifyContentType, FlexWrapType, GapType, GridColumnsType, GridJustifyItemsType, GridRowsType, HeightType, IconAlignType, MarginType, MaxHeightType, MinHeightType, PaddingType, PlacementType, PositionAlignmentType, ResponsiveType, SizeType, StateVariantType, TextAlignType, TranslocationType, VegaComponentInterface, VegaEATriggerType, VegaFlexProps, WidthType } from "./types/ui.type"; import { LinkTargetType, VegaAppFooterLink } from "./components/vega-app-footer/types"; import { VegaAppHeaderAvatarConfig, VegaAppHeaderButtonDropdownConfig, VegaAppHeaderButtonSize, VegaAppHeaderLabelConfig } from "./components/vega-app-header-button/types"; import { VegaBannerActionButtonType, VegaBannerPropType } from "./components/vega-banner/types"; import { VegaBarChartOptionsType } from "./components/vega-chart/vega-bar-chart/types"; import { BackgroundColorsTokenType, BorderColorsTokenType, BordersTokenType, BreakpointsTokenType, ShadowsTokenType, SpacingTokenType, TextColorsTokenType, TypographyTokenType } from "./types/design-token.type"; import { AlignSelfType, FlexBasisType, FlexGrowType, FlexShrinkType, FlexType, GridAreaType, GridColumnType, GridRowType, JustifySelfType, OrderType } from "./components/vega-box/interface"; import { VegaBreadcrumbCollapsedThresholdType, VegaBreadcrumbItemType } from "./components/vega-breadcrumb/types"; import { VegaButtonIconAlign, VegaButtonSize, VegaButtonType, VegaButtonVariant } from "./components/vega-button/types"; import { VegaButtonCircleSize, VegaButtonCircleTooltip, VegaButtonCircleVariant } from "./components/vega-button-circle/types"; import { DropdownPropsForButtonGroup, VegaButtonGroupIconAlign, VegaButtonGroupSize, VegaButtonGroupVariant } from "./components/vega-button-group/types"; import { DropdownSourceGroup, DropdownSourceItem, VegaDropdownSearchTriggerByType, VegaDropdownSearchTriggerEventDetail, VegaDropdownSourceItem } from "./components/vega-dropdown/types"; import { VegaButtonLinkTarget } from "./components/vega-button-link/types"; import { DisabledDate, DropdownPropsForCalendar, VegaCalendarChangeEventType, VegaCalendarDateClickInfo, VegaCalendarEventClickInfo, VegaCalendarRawEvent, VegaCalendarViewModeType } from "./components/vega-calendar/types"; import { Nullable, TimeFormat } from "./types/general"; import { CalendarEvent } from "./helpers/calendar/calendar-event"; import { FormFieldValidationRule } from "./helpers/validator/rules/form-field-validation-rule"; import { VegaChipIconAlign, VegaChipSize, VegaChipType, VegaChipVariant } from "./components/vega-chip/types"; import { VegaCodeBlockValue } from "./components/vega-code-block/types"; import { VegaComboBoxSize, VegaDropdownPropsForComboBox } from "./components/vega-combo-box/types"; import { DatePickerCalendarIndicator, DatePickerCalendarRepickType, DatePickerCalendarSizeType, DatePickerModeType, DatePickerMonthYearTypes, DatePickerValueType, DropdownConfigForDatePicker, VegaDropdownPropsForDatePickerCalendar } from "./components/vega-date-picker/types"; import { VegaDialogAction, VegaDialogActionButtonProps } from "./components/vega-dialog/types"; import { VegaDividerDirectionType, VegaDividerVariantType } from "./components/vega-divider/interface"; import { VegaDropdownItemClickEvent } from "./components/vega-dropdown/vega-dropdown-item/types"; import { LabelSuffixButtonConfig, LabelSuffixButtonProps } from "./components/vega-field-label/types"; import { VegaFileUploaderFile, VegaFileUploaderFiles, VegaFileUploaderType } from "./components/vega-file-uploader/types"; import { VegaCountryCode } from "./types/flag.type"; import { VegaFontAs } from "./components/vega-font/types"; import { FormControlOption, FormValidateResult, VegaFormFieldValidationState } from "./components/vega-form/types"; import { VegaFile, VegaFileOptional, VegaImageUploaderStatus } from "./components/vega-image-uploader/types"; import { DataTransferType, InputAutocompleteTypes, InputEnterKeyHintTypes, InputType, InputValueUpdateTriggeredBy, MaskConfigType, VegaInputSuggestionsDropdownConfig } from "./components/vega-input/types"; import { FormFieldValidationRule as FormFieldValidationRule1 } from "./types/components.type"; import { VegaCountryType } from "./components/vega-input-phone-number/types"; import { InputRangeStackType, InputRangeValueType } from "./components/vega-input-range/types"; import { SelectedLabelType, SelectedLabelTypeForAllModes, SelectSourceItem, SelectType, SelectValueType, VegaDropdownPropsForSelect, VegaInputSelectSize, VegaInputSelectSourceLazyLoadCallback } from "./components/vega-input-select/types"; import { ItemToggleStatusMap } from "./components/vega-item-toggle/types"; import { autoCollapseGroupsType, LeftNavCounterBadgeConfig, LeftNavHeaderConfig, LeftNavSectionHeaderConfig, LeftNavSourceItem } from "./components/vega-nav/interface"; import { LineChartOptionsType } from "./helpers/chart/line-chart"; import { VegaLoadingIndicatorSize } from "./components/vega-loading-indicator/types"; import { VegaModalBackdrop, VegaModalBackdropColor } from "./components/vega-modal/types"; import { VegaPageNotificationActionButtonConfig, VegaPageNotificationTypes } from "./components/vega-page-notification/types"; import { DropdownPropsForPagination, VegaPaginationItemType, VegaPaginationLayoutType, VegaPaginationPageSizeOption } from "./components/vega-pagination/types"; import { PieChartOptions } from "./helpers/chart/pie-chart"; import { VegaProgressTrackerDirectionType, VegaProgressTrackerStepItem } from "./components/vega-progress-tracker/type"; import { VegaRTEContent } from "./components/vega-rich-text-editor/dto/content-state"; import { VegaRTEExtension } from "./components/vega-rich-text-editor/extensions/extension.abstract"; import { RTETablePropertiesType, TableCellStylePropertiesMap, VegaRichTextEditorImage, VegaRTEColorSchema, VegaRTESourceEditConfig, VegaRTEToolbarItem } from "./components/vega-rich-text-editor/interface"; import { VegaRichTextImageEditorChangeDetail, VegaRichTextImageEditorSizeType } from "./components/vega-rich-text-editor/vega-rich-text-image-editor/types"; import { VegaRichTextLinkEditorChangeDetail, VegaRichTextLinkEditorStatus, VegaRTELinkEditorRecord } from "./components/vega-rich-text-editor/vega-rich-text-link-editor/types"; import { RTETableCellBlock } from "./components/vega-rich-text-editor/extensions/table/dto/table-cell-block"; import { VegaSectionTitleSizeType } from "./components/vega-section-title/types"; import { VegaSegmentControlVariant, VegaSegmentProps } from "./components/vega-segment-control/types"; import { VegaSelectionChipSize, VegaSelectionChipTooltipProps, VegaSelectionChipVariant } from "./components/vega-selection-chip/interface"; import { VegaSelectionChipGroupSelectType } from "./components/vega-selection-chip/vega-selection-chip-group/interface"; import { OpenByDefaultType, SidebarHeaderConfig, SidebarTopLevelItem } from "./components/vega-sidenav/types"; import { VegaSignatureCaptureMode, VegaSignatureValue } from "./components/vega-signature-capture/types"; import { VegaSkeletonType } from "./components/vega-skeleton/interface"; import { TabConfig, TabGroupOverflowType, TabGroupVariant } from "./components/vega-tab-group/types"; import { VegaTableChangePropType, VegaTableColumnBreakpoint, VegaTableColumnConfig, VegaTableDataSourceItem, VegaTableDensityType, VegaTableGroupColumnConfig, VegaTableHeadCellClickEvent, VegaTablePagination, VegaTablePinnedType, VegaTableRowClickEvent, VegaTableRowClickPropType, VegaTableRowExpandEvent, VegaTableRowExpandEventDetail, VegaTableRowSelectAllEventDetail, VegaTableRowSelectEventDetail, VegaTableRowSelectionConfig, VegaTableRowSelectProp, VegaTableScrollConfig, VegaTableSelectAllProp, VegaTableSortConfig, VegaTableSorterConfig, VegaTableSortOrderType } from "./components/vega-table/interface"; import { VegaTextTooltipProps } from "./components/vega-text/types"; import { TimePickerModeType, TimePickerValueType } from "./components/vega-time-picker/types"; import { SourceItemType } from "./components/vega-virtual-scroll/types"; export namespace Components { interface VegaAccordion { /** * Specifies the title of the accordion. If the title exceeds the maximum width, it will be displayed on a new line to ensure visibility and readability. * @vegaVersion 1.3.0 */ "accordionTitle": string; /** * Determines whether the accordion block should be displayed with its default background color `bg-primary` and padding of `size-24`. * @vegaVersion 1.3.0 */ "drawsBackground": boolean; /** * Controls whether the accordion is expanded. * @vegaVersion 1.0.4 */ "expand": boolean; /** * Specifies the placement of the expand icon in the accordion. * @vegaVersion 1.3.0 */ "expandIconAlign": 'left' | 'right'; /** * Specifies the unique group ID for enabling accordion functionality. Use this parameter to assign a specific group ID to the accordions that should be grouped together, ensuring that only one accordion can be expanded at a time within the same group. * @vegaVersion 1.3.0 */ "groupId": string; /** * Specifies the vertical placement of the prefix icon and expand icon within the accordion. * @vegaVersion 1.8.1 */ "iconPosition": 'top' | 'center'; /** * Specifies an optional icon to be displayed alongside the accordion's title. * @vegaVersion 1.3.0 */ "prefixIcon": string; /** * Specifies whether to display or hide the expand icon in the accordion. It can be provided as a ResponsiveType or boolean value. * @vegaVersion 1.3.0 */ "showExpandIcon": ResponsiveType; } interface VegaAppFooter { /** * Specifies additional links that can be included in the app footer. * @vegaVersion 1.15.0 */ "additionalLinks": VegaAppFooterLink[]; /** * Specifies the content to be displayed in the app footer. By default, it includes Heartland's official copyright message with a reference to the current year. * @vegaVersion 1.15.0 * @defaultValue © {{currentYear}} Global Payments Inc. All rights reserved. */ "content": string; /** * Specifies the target window or tab when the user clicks on the Disclaimer link in the app footer. * @vegaVersion 1.27.3 */ "disclaimerUrlTarget": LinkTargetType; /** * Specifies whether to hide the default Term of Use and Privacy Policy links. * @vegaVersion 1.35.1 */ "hideDefaultLinks": boolean; /** * Specifies the label or text to be displayed for the Privacy Policy link in the app footer. * @vegaVersion 1.15.0 */ "privacyPolicyLabel": string; /** * Specifies the URL or web address that the Privacy Policy link in the app footer should navigate to when clicked. * @vegaVersion 1.15.0 * @defaultValue https://www.globalpayments.com/privacy-statement */ "privacyPolicyUrl": string; /** * Specifies the unique identifier for the Privacy Policy Link. * @vegaVersion 2.54.0 */ "privacyPolicyUrlId": string; /** * Specifies the target window or browsing context in which the Privacy Policy URL should be opened when the user clicks on the link. * @vegaVersion 1.27.3 */ "privacyPolicyUrlTarget": LinkTargetType; /** * Specifies whether the app footer should display a predetermined disclaimer message and link to indicate that the site uses Google reCAPTCHA. * @vegaVersion 1.3.0 */ "showDisclaimer": boolean; /** * Specifies the label or text to be displayed for the Terms of Use link in the app footer. * @vegaVersion 1.15.0 */ "termOfUseLabel": string; /** * Specifies the URL or web address that the Terms of Use link in the app footer should navigate to when clicked. * @vegaVersion 1.15.0 * @defaultValue https://www.globalpayments.com/terms-of-use */ "termOfUseUrl": string; /** * Specifies the unique identifier for the Terms of Use Link. * @vegaVersion 2.54.0 */ "termOfUseUrlId": string; /** * Specifies the target window or browsing context in which the Terms of Use URL should be opened when the user clicks on the link. * @vegaVersion 1.27.3 */ "termOfUseUrlTarget": LinkTargetType; } interface VegaAppHeaderButton { /** * Specifies the configuration for the avatar image or icon displayed in the app header button. * @vegaVersion 1.11.0 */ "avatar": VegaAppHeaderAvatarConfig; /** * Specifies the position of the avatar in relation to the label within the app header button. * @vegaVersion 1.11.0 */ "avatarPosition": 'right' | 'left'; /** * Specifies the configuration for the dropdown functionality of the app header button. * @vegaVersion 1.11.0 */ "dropdown": VegaAppHeaderButtonDropdownConfig; /** * Specifies the label or text content of the app header button. * @vegaVersion 1.11.0 */ "label": string; /** * Specifies the display configuration of the app header button label. * @vegaVersion 2.77.1 */ "labelConfig": VegaAppHeaderLabelConfig; /** * Specifies whether the app header button is displayed in a selected state. * @vegaVersion 1.15.0 */ "selected": boolean; /** * Specifies whether to show a border around the app header button. * @vegaVersion 1.11.0 */ "showBorder": boolean; /** * Determines whether to display the label of the app header button directly on the button itself or in a tooltip when the user hovers over the button. * @vegaVersion 1.11.0 */ "showLabel": boolean; /** * Specifies whether to display a menu arrow icon in the app header button. * @vegaVersion 1.11.0 */ "showMenuArrowIcon": boolean; /** * Specifies the size of the app header button. * @vegaVersion 1.11.0 */ "size": ResponsiveType; } interface VegaBackdrop { /** * Defines the color of the backdrop element. * @vegaVersion 2.0.0 */ "color": 'bg-backdrop-modal' | 'bg-backdrop-popover' | 'bg-transparent'; /** * The duration of the animation in milliseconds. * @vegaVersion 2.0.0 */ "duration": number; /** * Whether to show or hide the backdrop * @vegaVersion 2.0.0 */ "visible": boolean; } interface VegaBanner { /** * Specifies the action buttons available within the banner. These buttons enable users to perform specific actions, enhancing user interaction within the banner. * @vegaVersion 2.8.0 */ "actionButtons": VegaBannerActionButtonType[]; /** * Specifies the label or title for the banner. * @vegaVersion 2.8.0 */ "bannerTitle": string; /** * Specifies the content displayed within the banner. * @vegaVersion 2.8.0 */ "content": string; /** * Invoke this method to close the banner. * @vegaVersion 2.8.0 */ "doClose": () => Promise; /** * Determines whether the banner is displayed. * @vegaVersion 2.13.0 */ "isOpen": boolean; /** * Determines whether the close icon is displayed. * @vegaVersion 1.13.0 */ "showCloseButton": boolean; /** * Specifies the type of the banner. * @vegaVersion 2.8.0 */ "type": VegaBannerPropType; } interface VegaBarChart { /** * Specifies the rendering options for the bar chart. * @vegaVersion 1.33.0 */ "options": VegaBarChartOptionsType; } interface VegaBox { /** * Specifies how the box aligns itself within its container. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/align-self */ "alignSelf": ResponsiveType; /** * Defines the background color of the box. It accepts a string value representing a valid background color token. * @vegaVersion 2.0.0 */ "backgroundColor": StateVariantType; /** * Defines the border of the box. It accepts a string value representing a valid border token. * @vegaVersion 2.0.0 */ "border": StateVariantType; /** * Defines the border color of the box. It accepts a string value representing a valid border color token. * @vegaVersion 2.0.0 */ "borderColor": StateVariantType; /** * Specifies the line style of the box border. * * @vegaVersion 2.7.0 */ "borderStyle": BorderStyleType; /** * Defines the corner of the box. It accepts a string value representing a valid border radius token. * @vegaVersion 2.0.0 */ "corners": ResponsiveType; /** * Defines the display behavior of the box, allowing you to choose from standard display options like `block`, `inline-block` and `none`. * @vegaVersion 1.38.0 */ "display": ResponsiveType; /** * Specifies how the box adjusts its size, growth, and alignment within a flex container. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex */ "flex": ResponsiveType; /** * Specifies the base size of the box. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis */ "flexBasis": ResponsiveType; /** * Specifies how the box is grow. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow */ "flexGrow": ResponsiveType; /** * Specifies how much the box shrinks. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink */ "flexShrink": ResponsiveType; /** * Defines the area within the grid occupied by the item. It accepts CSS values and can be set as ResponsiveType. * @vegaVersion 2.5.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area */ "gridArea": ResponsiveType; /** * Determines the placement of the item within the grid along the horizontal axis. * @vegaVersion 2.5.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column */ "gridColumn": ResponsiveType; /** * Determines the placement of the item within the grid along the vertical axis. * @vegaVersion 2.5.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row */ "gridRow": ResponsiveType; /** * Specifies the height of the box. It accepts values in numeric, string and spacing token formats. For numeric values, use a number to indicate the height in pixels, e.g., 100 will be translated to 100px. For string values, you can use CSS units like '%' or 'calc' expressions. For example, '100%' and 'calc(100vh - 20px)' which allows for more complex calculations to determine the height. For spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.globalpayments.com/tokens/spacing to check the full list of spacing tokens. * @vegaVersion 2.0.0 */ "height": ResponsiveType; /** * Specifies how a single box justifies its content along the main axis within its container. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self */ "justifySelf": ResponsiveType; /** * Defines the spacing around the box. You can set it as a single spacing value, such as `size-16` or `size-24`, which will apply the same margin on all sides of the box. Alternatively, you can set the padding as a responsive map, allowing you to define different margin values for different breakpoints. The responsive map should follow the structure `{default: 'size-12', L: { top: 'size-24', bottom: 'size-24'}}`. Note that the `default` value is required when using a responsive map to provide a fallback margin value for breakpoints that are not explicitly defined. * @vegaVersion 1.27.0 */ "margin": ResponsiveType; /** * Specifies the maximum height of the box. It accepts values in numeric, string and spacing token formats. Numeric values represent maximum heights in pixels (e.g., 100 translates to 100px). String values allow the use of CSS units such as '%' or keyword values like 'min-content' (e.g., '100%' or 'min-content'). Spacing tokens like 'size-2' or 'size-16' can also be used. Please refer to https://vega.globalpayments.com/tokens/spacing to check the full list of spacing tokens. * @vegaVersion 2.7.0 */ "maxHeight": ResponsiveType; /** * Specifies the minimum height of the box. It accepts values in numeric, string and spacing token formats. Numeric values represent minimum heights in pixels (e.g., 100 translates to 100px). String values allow the use of CSS units such as '%' or keyword values like 'max-content' (e.g., '100%' or 'max-content'). Spacing tokens like 'size-2' or 'size-16' can also be used. Please refer to https://vega.globalpayments.com/tokens/spacing to check the full list of spacing tokens. * @vegaVersion 2.7.0 */ "minHeight": ResponsiveType; /** * Specifies the display order of the box. * @vegaVersion 2.3.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/order */ "order": ResponsiveType; /** * Determines the spacing between the content and the edges of the box. It can be set as a spacing value, such as `size-16` or `size-24`, to apply the same padding on all sides. Alternatively, you can set the padding as a responsive map, allowing you to define different padding values for different breakpoints. The responsive map should follow the structure `{default: 'size-12', L: { top: 'size-24', bottom: 'size-24'}}`. Note that the `default` value is required when using a responsive map to provide a fallback padding value for breakpoints that are not explicitly defined. * @vegaVersion 1.27.0 */ "padding": ResponsiveType; /** * Defines the custom class name of the box. * @vegaVersion 2.0.0 */ "responsiveClass": ResponsiveType; /** * Defines the box shadow of the box. It accepts a string value representing a valid box shadow token. * @vegaVersion 2.0.0 */ "shadow": StateVariantType; /** * Specifies the width of the box. It accepts values in numeric, string and spacing token formats. For numeric values, use a number to indicate the width in pixels, e.g., 100 will be translated to 100px. For string values, you can use CSS units like '%' or 'calc' expressions. For example, '100%' and 'calc(100vw - 20px)' which allows for more complex calculations to determine the width. For spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.globalpayments.com/tokens/spacing to check the full list of spacing tokens. * @vegaVersion 2.0.0 */ "width": ResponsiveType; } interface VegaBrandLogo { /** * Specifies the name of the brand logo. * @vegaVersion 2.47.0 */ "name": 'global-payments' | 'genius' | 'g-symbol'; /** * Specifies the size of the brand logo. * @vegaVersion 2.47.0 */ "size": 'small' | 'medium' | 'large'; /** * Specifies the display theme of the brand logo. Available options include: - `auto`: Displays the logo in light mode by default; switches to dark mode if the page theme changes. - `light`: Always displays the logo in light mode, regardless of the page theme. - `dark`: Always displays the logo in dark mode, regardless of the page theme. * @vegaVersion 2.47.0 */ "theme": 'auto' | 'light' | 'dark'; } interface VegaBreadcrumb { /** * Compact mode toggle for mobile viewport. When `true` (default), the breadcrumb displays only the last clickable item on mobile devices to save horizontal space. When `false`, the full multi-item layout is shown on mobile, identical to desktop behavior (still subject to collapsing based on `maxItems`). * @vegaVersion 2.66.0 */ "compactOnMobile": boolean; /** * Represents the individual elements within the `vega-breadcrumb` component. * @vegaVersion 1.41.0 */ "items": VegaBreadcrumbItemType[]; /** * Determines whether the last breadcrumb item is clickable. When `false` (default), the last item is rendered as plain text. When `true`, the last item becomes a clickable link, styled the same as the other breadcrumb items. * @vegaVersion 2.81.0 */ "lastItemClickable": boolean; /** * Determines the maximum number of visible items in the `vega-breadcrumb` component, primarily in desktop mode. When the number of items exceeds this limit, the component automatically collapses the center items, rendering only the first and last items visible. If you set this value to `none`, all items will remain expanded. The minimum allowed value for this property is 4. * @vegaVersion 1.41.0 */ "maxItems": VegaBreadcrumbCollapsedThresholdType; } interface VegaButton { /** * Specifies whether the button should span the full width of its parent element. * @vegaVersion 1.3.0 */ "block": ResponsiveType; /** * Indicates the danger status of the button, typically used for destructive actions. * @vegaVersion 1.3.0 */ "danger": boolean; /** * Specifies whether the button element is disabled. * @vegaVersion 1.0.3 */ "disabled": boolean; /** * Specifies the icon to be displayed on the button, which can be selected from a list of predefined icon tokens or specified using a Font Awesome class. * @vegaVersion 1.0.3 */ "icon": string; /** * Specifies the placement of the icon in relation to the button's label. * @vegaVersion 1.3.0 */ "iconAlign": VegaButtonIconAlign; /** * Specifies the text displayed on the button. * @vegaVersion 1.0.3 */ "label": string; /** * Specifies whether the button is in a loading state. When `true`, the button is disabled and an indeterminate loading indicator is displayed within the button. * @vegaVersion 2.17.0 */ "loading": boolean; /** * Specifies the size of the button. * @vegaVersion 1.0.0 */ "size": ResponsiveType; /** * Specifies the type of button and its behavior in relation to form submission and data reset. * @vegaVersion 1.0.3 */ "type": VegaButtonType; /** * Specifies the visual style and prominence of the button. It determines how the button will be presented to the user. * @vegaVersion 1.0.0 */ "variant": VegaButtonVariant; } interface VegaButtonCircle { /** * Indicates the danger status of the circular button, typically used for destructive actions. * @vegaVersion 1.3.0 */ "danger": boolean; /** * Specifies whether the circular button element is disabled. * @vegaVersion 1.0.4 */ "disabled": boolean; /** * Specifies the icon to be displayed on the circular button, which can be selected from a list of predefined icon tokens or specified using a Font Awesome class. * @vegaVersion 1.0.4 */ "icon": string; /** * Specifies the color of the icon displayed on the circular button. * @vegaVersion 1.24.0 */ "iconColor": TextColorsTokenType; /** * Specifies the text to be displayed in the tooltip for the circular button and sets it as the `aria-label` for accessibility. * @vegaVersion 1.0.4 */ "label": string; /** * Indicates whether to use a tooltip to display the label for the button circle. * @vegaVersion 2.0.0 */ "showTooltip": boolean; /** * Specifies the size of the circular button. * @vegaVersion 1.0.2 */ "size": VegaButtonCircleSize; /** * Specifies the properties of the `vega-tooltip` displayed for the button circle. * @vegaVersion 1.52.0 */ "tooltip": VegaButtonCircleTooltip; /** * Specifies the type of button and its behavior in relation to form submission and data reset. * @vegaVersion 1.16.0 */ "type": VegaButtonType; /** * Specifies the variant and prominence of the circular button. The following options are available for the `variant` parameter: - `primary`: The circular button is rendered with the `bg-action` background color, which typically signifies a primary or important action. - `secondary`: The circular button is rendered with a transparent background and an `action` border color. This variant is often used for secondary or less prominent actions. - `icon-only`: The circular button is rendered with an icon displayed in the default state, and the circle background appears when hovering over the button. * @vegaVersion 1.0.2 */ "variant": VegaButtonCircleVariant; } interface VegaButtonGroup { /** * Specifies whether the button elements are disabled. * @vegaVersion 2.72.0 */ "disabled": boolean; /** * Specifies the placement of the icon in relation to the button's label. * @vegaVersion 2.5.0 */ "iconAlign": VegaButtonGroupIconAlign; /** * Specifies the size of the button group. * @vegaVersion 2.5.0 */ "size": VegaButtonGroupSize; /** * Specifies the visual style and prominence of the button group. It determines how the button group will be presented to the user. * @vegaVersion 2.5.0 */ "variant": VegaButtonGroupVariant; } interface VegaButtonGroupItem { /** * Specifies whether the button group item is disabled. * @vegaVersion 2.72.0 */ "disabled": boolean; /** * Specifies the properties for the dropdown menu that appears when the button group contains more than one button item. * @vegaVersion 2.5.0 */ "dropdownProps": DropdownPropsForButtonGroup; /** * Defines the data source used to populate the dropdown menu when the button group contains more than one button item. * @vegaVersion 2.5.0 */ "dropdownSource": (DropdownSourceGroup | DropdownSourceItem)[]; /** * Specifies the icon to be displayed on the button item, which can be selected from a list of predefined icon tokens or specified using a Font Awesome class. * @vegaVersion 2.5.0 */ "icon": string; /** * Specifies whether to display the icon only. * @vegaVersion 2.5.0 */ "iconOnly": boolean; /** * Specifies the unique key for the button item. * @vegaVersion 2.5.0 */ "itemKey": string; /** * Specifies the text displayed on the button item. * @vegaVersion 2.5.0 */ "label": string; } interface VegaButtonLink { /** * Indicates the danger status of the button link, typically used for destructive actions. * @vegaVersion 1.3.0 */ "danger": boolean; /** * Specifies whether the button link element is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Specifies whether the button link will emit a vegaClick event when clicked. When set to true, the component behaves as a link but also triggers the click event when clicked, allowing both navigation and custom click handling. * @vegaVersion 1.3.0 */ "eventful": boolean; /** * Specifies the icon to be displayed on the button link, which can be selected from a list of predefined icon tokens or specified using a Font Awesome class. * @vegaVersion 1.0.4 */ "icon": string; /** * Specifies the placement of the icon in relation to the button link's label. * @vegaVersion 1.3.0 */ "iconAlign": 'left' | 'right'; /** * Specifies the type of icon used in the button link. The following options are available for the `iconType` parameter: - `icon`: The icon is rendered as a regular icon without any additional styling or background. - `button`: The icon is rendered with a circular background, providing additional emphasis and visual prominence to the icon in the button link. * @vegaVersion 1.0.5 */ "iconType": 'icon' | 'button'; /** * Specifies the text displayed on the button link. * @vegaVersion 1.0.4 */ "label": string; /** * Specifies the URL associated with the button link. If no URL is set, the component behaves as a button and triggers the click event. If a URL is provided, it behaves as a link and the click event is not emitted. * @vegaVersion 1.0.4 * @defaultValue javascript:void(0); */ "link": string; /** * Specifies the size of the button link. * @vegaVersion 1.0.2 */ "size": 'default' | 'large' | 'small'; /** * Specifies the location where the linked document will be opened, helping users understand how the link will behave when activated. * @vegaVersion 2.33.0 */ "target": VegaButtonLinkTarget; } interface VegaCalendar { /** * Controls whether clicking on a calendar date triggers the `vegaDateClick` event. When enabled, it disables the `vegaDateDblClick` event to prevent conflicts. * @vegaVersion 2.61.0 */ "enableDateClick": boolean; /** * Controls the visibility of the event preview popover while click event. * @vegaVersion 2.59.0 */ "enabledEventPreview": boolean; /** * Specifies the events of the calendar. * @vegaVersion 2.14.0 */ "events": VegaCalendarRawEvent[]; /** * Specifies a predicate function that determines whether a given date in the calendar should be disabled (non-interactive). The function is called for each date cell before rendering. Return `true` to disable the cell, or false to keep it selectable. Default behavior: always returns `false` (no cells are disabled). * @param date - The `Date` object for the cell being evaluated. * @returns `true` if the cell should be disabled; otherwise `false`. * @vegaVersion 2.56.0 */ "isDateDisabled": DisabledDate; /** * Defines the configuration options for the more action button's dropdown menu. * @vegaVersion 2.20.0 */ "moreActionDropdownProps": DropdownPropsForCalendar; /** * Controls the visibility of the calendar's event color bar. * @vegaVersion 2.21.0 */ "showEventColorBar": boolean; /** * Controls whether the switch view is displayed. * @vegaVersion 2.58.0 */ "showSwitchView": boolean; /** * Controls the visibility of the weekend columns in the calendar. * @vegaVersion 2.28.0 */ "showWeekends": boolean; /** * Specifies the time format of the calendar. * @vegaVersion 2.14.0 */ "timeFormat": TimeFormat; /** * Specifies the IANA time zone or Etc/GMT±n format. It accepts values such as "America/New_York" or "Etc/GMT+12". If not set, the component defaults to the system's time zone. For a complete list of IANA time zones, see Time Zone DB(https://timezonedb.com/time-zones). * @vegaVersion 2.65.0 */ "timezone": string; /** * Specifies the current view mode of the calendar. * @vegaVersion 2.14.0 */ "viewMode": VegaCalendarViewModeType; } interface VegaCalendarEvent { /** * Specifies the calendar event. * @vegaVersion 2.14.0 */ "calendarEvent": CalendarEvent; } interface VegaCalendarEventPreview { } interface VegaCalendarEventSlot { /** * Specifies the event key. * @vegaVersion 2.19.0 */ "eventKey": string; } interface VegaCard { /** * Defines the background color of the card element. It accepts a string value representing a valid background color token. * @vegaVersion 1.3.0 */ "backgroundColor": BackgroundColorsTokenType; /** * Specifies the margin for the card. It can be set as ResponsiveType or any sizing token. * @vegaVersion 1.3.0 */ "margin": ResponsiveType; /** * Specifies the padding within the card. It can be set as ResponsiveType or any sizing token. * @vegaVersion 1.0.4 */ "padding": ResponsiveType; /** * Determines whether the card is rendered with a shadow or a border. By default, cards are rendered without a shadow or border. * @vegaVersion 1.26.0 */ "variant": 'shadow' | 'border'; } interface VegaCarousel { /** * Indicates whether the carousel can be swiped to navigate between pages on a mobile device. * @vegaVersion 1.18.0 */ "canSwipe": boolean; /** * Invoke this method to navigate the carousel to the specified page number. * @param nextPage * @returns * @vegaVersion 1.0.6 */ "goToPage": (nextPage: number) => Promise; /** * Specifies the number of items displayed per page in the carousel. * @vegaVersion 2.1.0 */ "itemsPerPage": ResponsiveType; /** * Invoke this method to transition the carousel to the next available page, if it exists. * @vegaVersion 1.0.2 */ "nextPage": () => Promise; /** * Specifies the number of elements displayed per page in the carousel. * @deprecated This property will be removed soon and replaced by prop itemsPerPage * @vegaVersion 1.0.2 */ "perPage": ResponsiveType; /** * Invoke this method to transition the carousel to the previous page, if it exists. * @vegaVersion 1.0.2 */ "prevPage": () => Promise; /** * Specifies whether to show the navigational buttons at the bottom of the carousel. * @vegaVersion 1.0.2 */ "showSlider": boolean; /** * Controls the amount of space between the elements in the carousel when more than one element is displayed on each page using the `itemsPerPage` property. * @vegaVersion 1.0.2 */ "spacing": SpacingTokenType; } interface VegaCheckbox { /** * Specifies whether the checkbox should be pre-checked. Use the `value` property to retrieve the current status of the checkbox. * @vegaVersion 1.0.7 */ "checked": boolean; /** * Specifies whether the checkbox element is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Sets a unique identifier for the checkbox. Refer to the `value` property for detailed information on how to use this property during form validation. * @vegaVersion 1.10.0 */ "identifier": string; /** * Specifies the validation status of the checkbox component. * @vegaVersion 1.10.0 */ "isValid": boolean; /** * Specifies whether the checkbox must be checked to pass form validation. * @vegaVersion 1.3.0 */ "required": boolean; /** * Invoke this method to set the value of the checkbox. It is recommended to use this method instead of directly modifying the `value` property. * @vegaVersion 1.16.0 */ "setValue": (value: string | boolean) => Promise; /** * Specifies the size of the checkbox. * @vegaVersion 1.3.0 */ "size": 'default' | 'small'; /** * Determines the value that is associated with the checkbox when it is checked or unchecked. When the `identifier` property is set, the `value` property will return the value of the `identifier` when the checkbox is checked. When the checkbox is unchecked, the `value` property will return an empty string ''. If the `identifier` property is not set, the `value` property behaves as a boolean and returns `true` when the checkbox is checked, and `false` when it is unchecked. * @vegaVersion 1.0.7 */ "value": string | boolean; } interface VegaCheckboxGroup { /** * Determines whether automatic validation should be implemented for the checkbox group upon selection. * @vegaVersion 2.6.0 */ "autoValidation": boolean; /** * Indicates if the checkbox group is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that assists users in selecting the appropriate value for the checkbox group. * @vegaVersion 1.3.0 */ "hint": string; /** * Specifies the validation status of the checkbox group component. * @vegaVersion 1.3.0 */ "isValid": boolean; /** * Specifies the label or title for the checkbox group. It provides descriptive text that helps identify the purpose of the checkbox group. * @vegaVersion 1.3.0 */ "label": string; /** * Indicates whether at least one checkbox in the checkbox group must be checked to pass form validation. * @vegaVersion 1.3.0 */ "required": boolean; /** * Defines custom validation rules for the checkbox group. * @vegaVersion 2.6.0 */ "validationRules": FormFieldValidationRule[]; /** * Stores the selected values of the nested checkboxes within the checkbox group. * @vegaVersion 1.0.7 */ "value": string[]; /** * Specifies all properties of a `vega-flex` component, accessible as an object. * @vegaVersion 1.3.0 */ "vegaFlexProp": VegaFlexProps; } interface VegaChip { /** * Specifies the background color of the chip. This property is only applicable when using the `filled-background` variant, which is a specific style option for the chip. * @vegaVersion 1.11.0 */ "bgColor": BackgroundColorsTokenType; /** * Specifies the type of the chip, determining its visual appearance and behavior. There are two available options: `status` and `label`: - When `chipType` is set to `status`, the chip will display a dot as a prefix. This style is commonly used to indicate a specific status or state associated with the chip. The `icon` and `iconAlign` properties are disabled in this mode. - On the other hand, when `chipType` is set to `label`, the chip allows for more flexibility in positioning the icon. You can choose to have the icon as a prefix or a suffix to the label text. This type is commonly used when the chip represents a label or category. * @vegaVersion 1.11.0 */ "chipType": VegaChipType; /** * Specifies whether the chip is clickable. * @vegaVersion 1.11.0 */ "clickable": boolean; /** * Displays an icon in the chip. This property is applicable only when the chip's type is set to `label`. * @vegaVersion 1.11.0 */ "icon": string; /** * Specifies the placement or alignment of the icon within the chip in relation to the chip's text. * @vegaVersion 1.11.0 */ "iconAlign": VegaChipIconAlign; /** * Specifies the color of the icon displayed within the chip. This property is applicable only when the chip's type is set to `label` and an `icon` is provided. * @vegaVersion 2.81.0 */ "iconColor": TextColorsTokenType; /** * Controls the visibility of a close button within the chip. * @vegaVersion 1.11.0 */ "showCloseIcon": boolean; /** * Specifies the size of the chip. * @vegaVersion 1.11.0 */ "size": ResponsiveType; /** * Specifies the color of the status dot when the chip's type is set to `status`. * @vegaVersion 1.11.0 */ "statusColor": BackgroundColorsTokenType; /** * Specifies the label or title for the chip. It provides descriptive text that helps identify the purpose or category of the chip. * @vegaVersion 1.11.0 */ "text": string; /** * Specifies the color of the text displayed within the chip. * @vegaVersion 1.11.0 */ "textColor": TextColorsTokenType; /** * Determines the rendering style for the chip. * @vegaVersion 1.11.0 */ "variant": VegaChipVariant; } interface VegaCodeBlock { /** * Specifies whether the code block editor is disabled. * @vegaVersion 2.50.0 */ "disabled": boolean; /** * Invoke this method to focus the current code block. * @vegaVersion 2.50.0 */ "doFocus": () => Promise; /** * Specifies whether the code block editor is in read-only mode. * @vegaVersion 2.50.0 */ "readOnly": boolean; /** * Specifies whether to display the copy button in the code block. * @vegaVersion 2.50.0 */ "showCopyButton": boolean; /** * Specifies whether to display the code line number in the code block. * @vegaVersion 2.50.0 */ "showLineNumber": boolean; /** * Specifies the content or value to be displayed in the code block. * @vegaVersion 2.50.0 */ "value": VegaCodeBlockValue; } interface VegaColorPicker { /** * Determines whether automatic validation should be implemented for the color picker when a color is selected. * @vegaVersion 1.13.0 */ "autoValidation": boolean; /** * Defines custom color options for the color picker. It should be an array of hexadecimal strings representing different colors. * @vegaVersion 1.13.0 */ "colors": string[]; /** * Specifies whether the color picker element is disabled. * @vegaVersion 1.13.0 */ "disabled": boolean; /** * Displays a supplementary prompt message that assists users in understanding the expected value for the color picker. * @vegaVersion 1.13.0 */ "hint": string; /** * Specifies whether the color picker is inline with container styles, including a border, background color, and padding. * @vegaVersion 2.30.0 */ "isInline": boolean; /** * Specifies the validation status of the color picker component. * @vegaVersion 1.13.0 */ "isValid": boolean; /** * Specifies the label or title for the color picker. It provides descriptive text that helps identify the purpose or content expected in the color picker. * @vegaVersion 1.13.0 */ "label": string; /** * Specifies whether a color must be selected for the color picker to pass form validation. * @vegaVersion 1.13.0 */ "required": boolean; /** * Specifies custom validation rules for the color picker. * @vegaVersion 1.13.0 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the initial or preset color value of the color picker. It is represented as a hexadecimal string. * @vegaVersion 1.13.0 */ "value": string; } interface VegaComboBox { /** * Determines whether automatic validation should be implemented when a value is edited in the combo box. * @vegaVersion 1.11.0 */ "autoValidation": boolean; /** * Invoke this method to close the dropdown menu associated with the combo box. * @vegaVersion 1.11.0 */ "close": () => Promise; /** * Specifies whether the combo box element is disabled. * @vegaVersion 1.11.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that is displayed alongside the combo box input field. * @vegaVersion 1.11.0 */ "hint": string; /** * Specifies the validation status of the combo box component. * @vegaVersion 1.11.0 */ "isValid": boolean; /** * Specifies the label or title for the combo box. It provides descriptive text that helps identify the purpose or content expected in the combo box. * @vegaVersion 1.11.0 */ "label": string; /** * Invoke this method to open the dropdown menu associated with the combo box. * @vegaVersion 1.11.0 */ "open": () => Promise; /** * Sets a placeholder string that provides a temporary hint or example inside the combo box input field. It indicates the expected format or pattern of the input. * @vegaVersion 1.11.0 */ "placeholder": string; /** * Specifies whether a value must be entered for the combo box to pass form validation. * @vegaVersion 1.11.0 */ "required": boolean; /** * Specifies the size of the combo box. * @vegaVersion 1.11.0 */ "size": VegaComboBoxSize; /** * Specifies the source data used to populate the dropdown menu associated with the combo box. * @vegaVersion 1.11.0 */ "source": DropdownSourceItem[]; /** * Determines whether to display the associated dropdown menu and filter its options based on the text entered into the combo box. Setting this property to `false` enables custom text input handling by listening for the `vegaSearch` event. * @vegaVersion 1.24.0 */ "useDefaultFilter": boolean; /** * Specifies custom validation rules for the combo box. * @vegaVersion 1.11.0 */ "validationRules": FormFieldValidationRule[]; /** * Sets the initial or preset values of the combo box. It should be an array of strings representing the selected values. * @vegaVersion 1.11.0 */ "value": string[]; /** * Specifies partial properties of the `vega-dropdown` component that are used to configure the dropdown menu associated with the combo box. * @vegaVersion 1.11.0 */ "vegaDropdownProps": VegaDropdownPropsForComboBox; } interface VegaCounterBadge { /** * Specifies the background color token to indicate prominence. - Use 'bg-danger' to represent critical information that demands the user's attention. - Use 'bg-action' to represent a mere count of items. * @vegaVersion 1.15.0 */ "color": 'bg-danger' | 'bg-action'; /** * Represents the number that will be displayed on the badge. * @vegaVersion 1.15.0 */ "count": number; /** * Determines whether the badge is displayed without a specific count. If set to `true`, the count is hidden, and the badge is rendered as a smaller dot. * @vegaVersion 1.15.0 */ "dot": boolean; /** * Specifies the offset of the badge `[left, top]` from its default position at the top right corner. * @vegaVersion 1.15.0 */ "offset": number[]; } interface VegaDatePicker { /** * Specifies whether the user is allowed to change either the start date or end date of an already selected date range without completely resetting the selected range. * @vegaVersion 1.3.0 */ "allowRepick": boolean; /** * Determines whether automatic validation should be implemented when a date or range is selected. * @vegaVersion 1.3.0 */ "autoValidation": boolean; /** * Specifies whether to display the clear button when the calendar is shown. * @vegaVersion 1.3.0 */ "clearButton": boolean; /** * Specifies whether the date picker field is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Invoke this method to close the calendar dropdown associated with the date picker. * @see {module :vega-date-picker-click-call-do-open-close} * @vegaVersion 1.3.0 */ "doClose": () => Promise; /** * Invoke this method to open the calendar dropdown associated with the date picker. * @see {module :vega-date-picker-click-call-do-open-close} * @vegaVersion 1.3.0 */ "doOpen": () => Promise; /** * Specifies the configuration for the calendar dropdown associated with the date picker. * @vegaVersion 1.5.0 */ "dropdownConfig": DropdownConfigForDatePicker; /** * Specifies the desired date format. * @vegaVersion 1.3.0 */ "format": string; /** * Specifies a predicate function that determines whether a given date in the date picker should be disabled (non-interactive). The function is called for each date cell before rendering. Return `true` to disable the cell, or false to keep it selectable. Default behavior: always returns `false` (no cells are disabled). * @param date - The `Date` object for the cell being evaluated. * @returns `true` if the cell should be disabled; otherwise `false`. * @vegaVersion 2.60.0 */ "isDateDisabled": DisabledDate; /** * Specifies the validation status of the date picker component. * @vegaVersion 1.3.0 */ "isValid": boolean | null; /** * Specifies the label or title for the date picker field. It provides descriptive text that helps identify the purpose or content expected in the date picker field. * @vegaVersion 1.3.0 */ "label": string; /** * Specifies the maximum selectable date in the date picker. * @vegaVersion 1.3.0 */ "maxDate": string; /** * Specifies the minimum selectable date in the date picker. * @vegaVersion 1.3.0 */ "minDate": string; /** * Specifies the selection mode of the date picker. - Use `single` to allow selecting a single date. - Use `range` to allow selecting a date range. * @vegaVersion 1.3.0 */ "mode": DatePickerModeType; /** * Specifies a placeholder string that displays as a temporary hint or example inside the date picker field. It indicates the expected format or pattern of the date picker field. * @vegaVersion 1.3.0 */ "placeholder": string | string[]; /** * Specifies whether the date picker field is set to read-only. If set to `true`, keyboards and touch devices will skip interacting with this element. * @vegaVersion 1.3.0 */ "readOnly": boolean; /** * Determines whether the date picker field is required. Specifies whether a date or range must be selected for the date picker to pass form validation. * @vegaVersion 1.3.0 */ "required": boolean; /** * Determines whether the clear icon should be displayed or hidden. * @vegaVersion 2.33.0 */ "showClearIcon": boolean; /** * Determines whether to show months and years dropdown in date picker If set to true, date picker calendar will have months and years dropdown * @vegaVersion 2.36.0 */ "showYearMonthDropdowns": boolean; /** * Specifies the size of the date picker field. * @vegaVersion 1.3.0 */ "size": 'default' | 'small'; /** * Specifies the IANA time zone or Etc/GMT±n format. It accepts values such as "America/New_York" or "Etc/GMT+12". For a complete list of IANA time zones, refer to Time Zone DB(https://timezonedb.com/time-zones). If not configured, the time zone will default to the system's time zone. * @vegaVersion 2.35.0 */ "timezone": string; /** * Specifies custom validation rules for the date picker field. * @vegaVersion 1.3.0 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the selected date or date range in the date picker. * @vegaVersion 1.3.0 */ "value": DatePickerValueType; } interface VegaDatePickerCalendar { /** * Specifies whether to display the clear button when the calendar is shown. * @vegaVersion 2.72.0 */ "clearButton": boolean; /** * Specifies a function that returns the properties for the date indicator tooltip for a given date in the date picker. The function is called for each date cell before rendering. * @vegaVersion 2.77.0 */ "dateIndicator": DatePickerCalendarIndicator; /** * Determines whether to show two months in date picker calendar. It will be ignored when the device is mobile, that means the calendar will always show single month on mobile device regardless of the value of this prop. * @vegaVersion 2.81.0 */ "dualMonths": boolean; /** * Specifies the desired date format. * @vegaVersion 2.72.0 */ "format": string; /** * Specifies a predicate function that determines whether a given date in the date picker should be disabled (non-interactive). The function is called for each date cell before rendering. Return `true` to disable the cell, or false to keep it selectable. Default behavior: always returns `false` (no cells are disabled). * @param date - The `Date` object for the cell being evaluated. * @returns `true` if the cell should be disabled; otherwise `false`. * @vegaVersion 2.72.0 */ "isDateDisabled": DisabledDate; /** * Specifies the maximum selectable date in the date picker calendar. * @vegaVersion 2.72.0 */ "maxDate": string; /** * Specifies the minimum selectable date in the date picker calendar. * @vegaVersion 2.72.0 */ "minDate": string; /** * Specifies the selection mode of the date picker calendar. - Use `single` to allow selecting a single date. - Use `range` to allow selecting a date range. * @vegaVersion 2.72.0 */ "mode": DatePickerModeType; /** * Invoke this method to reset calendar to its initial state, it include reset to current value and reset the current period. * @vegaVersion 2.72.0 */ "reset": () => Promise; /** * Specifies the selected date or date range in the date picker calendar. * @vegaVersion 2.72.0 */ "selection": DatePickerValueType; /** * Determines whether to show months and years dropdown in date picker calendar If set to true, date picker calendar will have months and years dropdown * @vegaVersion 2.72.0 */ "showYearMonthDropdowns": boolean; /** * Renders the calendar picker in different sizes. Defaults to regular size * @vegaVersion 2.72.0 */ "size": DatePickerCalendarSizeType; /** * Specifies the calendar is static height. * @vegaVersion 2.72.0 */ "staticHeight": boolean; /** * Specifies the IANA time zone or Etc/GMT±n format. It accepts values such as "America/New_York" or "Etc/GMT+12". For a complete list of IANA time zones, refer to Time Zone DB(https://timezonedb.com/time-zones). If not configured, the time zone will default to the system's time zone. * @vegaVersion 2.72.0 */ "timezone": string; /** * Invoke this method to trigger repick. The param `type` is distinguishing the start date or end date can be repick. * @vegaVersion 2.72.0 */ "triggerRepick": (type: DatePickerCalendarRepickType) => Promise; /** * Determines whether the year or month dropdown position is calculated relative to the screen. * @vegaVersion 2.72.0 */ "yearMonthDropdownProps": VegaDropdownPropsForDatePickerCalendar; } interface VegaDialog { /** * Represents a dictionary that contains the configuration options for the cancel button in the dialog. * @vegaVersion 1.24.0 */ "cancelButton"?: VegaDialogActionButtonProps; /** * Specifies the text content of the dialog. * @vegaVersion 1.24.0 */ "content"?: string; /** * Specifies the title of the dialog. * @vegaVersion 1.24.0 */ "dialogTitle"?: string; /** * Represents the function that will be executed when the user clicks the cancel button in the dialog. * @vegaVersion 1.24.0 */ "handleCancel"?: VegaDialogAction; /** * Represents the function that will be executed when the user clicks the action button in the dialog. * @vegaVersion 1.24.0 */ "handleOk"?: VegaDialogAction; /** * Represents a dictionary that contains the configuration options for the modal component used to display the dialog. * @vegaVersion 1.24.0 */ "modalProps": Partial>; /** * Represents a dictionary that contains the configuration options for the action button in the dialog. * @vegaVersion 1.24.0 */ "okButton"?: VegaDialogActionButtonProps; /** * Determines whether the cancel button should be displayed. * @vegaVersion 1.24.0 */ "showCancel": boolean; /** * Specifies the type of the dialog. Use the value `danger` when the dialog's primary action is destructive. * @vegaVersion 1.24.0 */ "type"?: 'default' | 'danger'; } interface VegaDivider { /** * Specifies the direction of the divider. It can be set to either horizontal or vertical, determining the orientation of the separation. * @vegaVersion 2.10.0 */ "direction": ResponsiveType; /** * Specifies the margin within the divider, offering flexibility in adjusting spacing. It can be set as ResponsiveType or any sizing token for precise control over layout and appearance. * @vegaVersion 2.10.0 */ "margin": ResponsiveType; /** * Determines the rendering style for the divider. * @vegaVersion 2.10.0 */ "variant": VegaDividerVariantType; } interface VegaDropdown { /** * Determines the horizontal positioning of the dropdown within its container or relative to a reference point. * @vegaVersion 1.41.0 */ "alignment": ElementAppenderAlignmentType; /** * Specifies whether the search source list is case-sensitive. Note that the default filter rules are fuzzy matching and case-insensitive. This parameter only takes effect when `searchable` is set to `true`. * @vegaVersion 1.4.0 */ "caseSensitive": boolean; /** * Invoke this method to clear the selected items keys, removing any current selection. * @vegaVersion 1.47.0 */ "clearSelection": () => Promise; /** * Controls whether the dropdown can add a new item when no proper item is available. It becomes active only when `searchable` is set to `true`. * @vegaVersion 1.16.0 */ "dynamicOption": boolean; /** * Invoke this method to retrieve the selected items keys, providing an key or list of the keys representing the currently selected items. * @vegaVersion 1.47.0 */ "getSelection": () => Promise; /** * Invoke this method to programmatically dismiss the dropdown menu. * @vegaVersion 1.3.0 */ "hide": () => Promise; /** * Determines whether the dropdown displays a lazy loading status. * @vegaVersion 2.3.0 */ "isLazyLoading": boolean; /** * Determines whether the dropdown displays a loading status. * @vegaVersion 1.24.0 */ "isLoading": boolean; /** * Determines whether the dropdown position is calculated relative to the screen. * @VegaWarning - It will overrides the positionRelativeTo and matchContainerHeight properties, rendering them ineffective. - Currently, when set to true, the position calculation may be inaccurate if the popover is placed inside a scrollable container within a shadowRoot (e.g., inside a vega-modal with scrollable content). * @vegaVersion 2.36.0 */ "isScreenPosition": boolean; /** * Specifies the display rule for items in the dropdown. * @VegaWarning Specifies the display rule for items in the dropdown, only be active if matchTargetWidth is true or maxWidth has value. * @vegaVersion 1.13.0 */ "itemDisplayRule": 'ellipsis' | 'newline'; /** * Determines if the dropdown height should be automatically adjusted to fit its container height. If set to `true`, the dropdown will always be positioned at the bottom of the available space. * @vegaVersion 1.3.0 */ "matchContainerHeight": boolean; /** * Determines whether the dropdown should have the same width as the target element. * @vegaVersion 1.3.0 */ "matchTargetWidth": boolean; /** * Specifies the maximum height for the dropdown. * @vegaVersion 1.3.0 */ "maxHeight": number; /** * Specifies the maximum width of the dropdown. It can be provided as a number or a ResponsiveType. * @vegaVersion 1.13.0 */ "maxWidth": ResponsiveType; /** * Specifies the minimum width of the dropdown. It can be provided as a number or a ResponsiveType. * @vegaVersion 1.13.0 */ "minWidth": ResponsiveType; /** * Specifies the vertical positioning of the dropdown within its container or relative to a reference point. * @vegaVersion 1.41.0 */ "placement": ElementAppenderPlacementType; /** * Specifies the relative positioning of the dropdown menu in relation to its container. If not specified, the dropdown will be appended to the menu by default. Adjust this property when facing scrolling positioning problems. * @VegaWarning The value of this property should be an element that is the parent of this component or an ancestor of the parent element. Using any other element may lead to unexpected behavior. * @vegaVersion 1.3.0 */ "positionRelativeTo": string; /** * Controls whether the prefix icon occupy a position, even if prefix has no value. * @vegaVersion 1.47.0 */ "prefixIconSlot": boolean; /** * Controls whether the value of selectedSourceKey is preserved when it does not exist in the source. * @vegaVersion 2.69.0 */ "preserveValueIfNotInSource": boolean; /** * Specifies whether the selected option in the dropdown can be cleared. It allows users to reset the selectedSourceKey when a selection has already been made. * @vegaVersion 2.46.0 */ "resettable": boolean; /** * Invoke this method to set the search input value and filter the list of items in the dropdown. This method is applicable only when the dropdown is searchable. * @vegaVersion 1.11.0 */ "search": (input: string) => Promise; /** * Specifies the no search results text for the dropdown. * @vegaVersion 2.74.0 */ "searchNoResultsText": string; /** * Determines whether the dropdown search is triggered by input or pressing the Enter key. * @vegaVersion 2.26.0 */ "searchTriggerBy": VegaDropdownSearchTriggerByType; /** * Controls whether the dropdown list can be searched. * @vegaVersion 1.3.0 */ "searchable": boolean; /** * Controls the dropdown menu's selection. It accepts three values: - `none`: After an item is selected, this option not only triggers the `vegaDropdownClick` event but also conceals the dropdown menu immediately. - `single`: Upon selection of an item whose key matches the `selectedSourceKey` property, this setting both dispatches the `vegaDropdownClick` event and hides the dropdown menu. - `multiple`: When an item with a key found in the `selectedSourceKey` array is selected, this mode releases the `vegaDropdownClick` event. Unlike the others, however, Determines the selection mode for multiple item selection. * @vegaVersion 1.3.0 */ "selectType": 'none' | 'single' | 'multiple'; /** * Represents the key corresponding to the selected item in the dropdown menu. It becomes active only when `selectType` is set to `single` or `multiple`. * @vegaVersion 1.3.0 */ "selectedSourceKey": string | string[]; /** * Invoke this method to set the selected items keys, specifying an array or list of keys to represent the desired selected items. * @param keys - Row keys to be set as selected. * @vegaVersion 1.47.0 */ "setSelection": (keys: string[] | string) => Promise; /** * Invoke this method to programmatically display the dropdown menu. * @vegaVersion 1.3.0 */ "show": () => Promise; /** * Specifies the size of the dropdown. It can be provided as a number or a ResponsiveType. If no size is set, the dropdown will default to fitting the item content width. * @vegaVersion 1.3.0 */ "size": ResponsiveType; /** * Sets the source array of items for the dropdown, where each item must have a `key` and `label` property. * @vegaVersion 1.3.0 */ "source": VegaDropdownSourceItem[]; /** * Specifies the position adjustment for the dropdown relative to the target element. By default, the dropdown is displayed on the left-bottom of the target. * @vegaVersion 1.3.0 */ "translocation": ResponsiveType; /** * Specifies the trigger mode for the dropdown. hover: The dropdown is shown/hidden on hover, and listens for global area clicks. click: The dropdown is shown/hidden on click, and listens for global area clicks. none: The dropdown does not listen for any events; you must control its visibility within the component. custom: Custom trigger strategy, more information can refer to https://gethired.atlassian.net/wiki/spaces/VKB/pages/657031171/Trigger+strategy. * @vegaVersion 1.3.0 */ "trigger": VegaEATriggerType; /** * Determines whether to enable source filtering based on input words. When set to 'false', the component will emit a `vegaSearch` event when input words are provided. In this case, you are responsible for managing the source, including adding, deleting, and updating the source. Note that the `dynamicOption` property will not work when this property is set to `false`. * @VegaWarning Set `preserveValueIfNotInSource` to 'true' to get custom filter fully supported when set to 'false'. * @vegaVersion 1.24.0 */ "useDefaultFilter": boolean; /** * The count of the source that will be used as the threshold for determining whether to use virtual scrolling. If the count of source exceeds this threshold, we employ virtual scrolling. Otherwise, normal item rendering is used If the value is 0, it means we will disable the virtualization all the time. * @vegaVersion 2.54.0 */ "virtualizationThreshold": number; } interface VegaDropdownContentBox { } interface VegaDropdownGroup { /** * Determines whether to include a dividing line at the bottom of the dropdown group. * @vegaVersion 1.47.0 */ "divide": boolean; /** * Specifies the label for the dropdown group's level. * @vegaVersion 1.47.0 */ "label": string; } interface VegaDropdownItem { /** * Specifies the dropdown item's count. * @vegaVersion 1.47.0 */ "count": number; /** * Specifies whether the dropdown item represents a danger action. It highlights actions that may have critical consequences when the select type is set to none. * @vegaVersion 2.25.0 */ "danger": boolean; /** * Specifies the disabled status of the dropdown item. * @vegaVersion 1.47.0 */ "disabled": boolean; /** * Specifies the height of the dropdown item. * @vegaVersion 1.47.0 */ "height": number; /** * Specifies the key for the dropdown item. * @vegaVersion 1.47.0 */ "itemKey": string; /** * Specifies the label for the dropdown item. * @vegaVersion 1.47.0 */ "label": string; /** * Specifies the prefix icon for the dropdown item. * @vegaVersion 1.47.0 */ "prefixIcon": string; } interface VegaFieldError { /** * Specifies the error message when the input field should display an error. The input field will clear the error status when the message is empty. * @vegaVersion 1.45.0 */ "message": string; } interface VegaFieldLabel { /** * Specifies whether the field is disabled. * @vegaVersion 1.10.0 */ "disabled": boolean; /** * Determines whether the input field is required. Specifies whether the field must be filled in to pass form validation. * @vegaVersion 1.10.0 */ "isFieldRequired": boolean; /** * Specifies the label or title for the field. It provides descriptive text that helps identify the purpose or content expected in the field. * @vegaVersion 1.10.0 */ "label": string; /** * Specifies the properties for the suffix button associated with the input. It provides essential information and functionality related to the suffix button's role and behavior. * @vegaVersion 2.68.0 */ "suffixButtonConfig": Nullable; /** * @deprecated Please use `suffixButtonConfig` instead Specifies the properties for the suffix button associated with the input. It provides essential information and functionality related to the suffix button's role and behavior. * @vegaVersion 2.25.0 */ "suffixButtonProps": LabelSuffixButtonProps; } interface VegaFileUploader { /** * Specifies the allowed file types for upload. * @vegaVersion 2.25.0 * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept */ "accept": string; /** * Determines whether the input field should undergo automatic validation during the user's input. * @vegaVersion 2.25.0 */ "autoValidation": boolean; /** * Specifies whether the File Uploader field is disabled. * @vegaVersion 2.25.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that assists users in understanding the expected value for the file uploader field. * @vegaVersion 2.25.0 */ "hint": string; /** * Specifies the validation status of the file uploader component. * @vegaVersion 2.25.0 */ "isValid": boolean | null; /** * Specifies the label or title for the field. It provides descriptive text that helps identify the purpose or content expected in the field. * @vegaVersion 2.25.0 */ "label": string; /** * Specifies the maximum number of files that can be uploaded using the File Uploader. The value must be a positive integer. * @vegaVersion 2.36.0 */ "maxCount": number | null; /** * Specifies whether uploading a file is mandatory. * @vegaVersion 2.25.0 */ "required": boolean; /** * Defines custom validation rules for the File Uploader field. * @vegaVersion 2.25.0 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the initial file content to display, enabling a preview of the uploaded file or a default placeholder. * @vegaVersion 2.25.0 */ "value": VegaFileUploaderFile[] | null; /** * Specifies the uploader type that activates when clicked or when a file is dragged, determining how users interact with the file uploader. * @vegaVersion 2.25.0 */ "variant": VegaFileUploaderType; } interface VegaFlagIcon { /** * Specifies the country code using the two-letter uppercase country code. * @vegaVersion 2.46.0 */ "country": VegaCountryCode; /** * Specifies the width and height of the icon. * @vegaVersion 2.46.0 */ "size": SpacingTokenType; } interface VegaFlex { /** * Controls the alignment of items within the flex container. * @vegaVersion 1.49.0 */ "alignItems": ResponsiveType; /** * Determines the breakpoint at which the flex direction transitions from row-based layout to column-based layout, or vice versa. * @deprecated Please use the `direction` property instead. * @vegaVersion 1.0.4 */ "breakpoint": BreakpointsTokenType | 'None'; /** * Specifies the flex direction. * @vegaVersion 1.3.0 */ "direction": ResponsiveType; /** * Specifies how the box adjusts its size, growth, and alignment within a flex container. * @vegaVersion 2.26.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex */ "flex": ResponsiveType; /** * Specifies the box's base size, defining its initial width or height in a flex container. * @vegaVersion 2.26.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis */ "flexBasis": ResponsiveType; /** * Specifies how the box grows to fill available space in a flex container. * @vegaVersion 2.26.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow */ "flexGrow": ResponsiveType; /** * Specifies how much the box shrinks to fit within a flex container. * @vegaVersion 2.26.0 * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink */ "flexShrink": ResponsiveType; /** * Determines whether flex items are confined to a single line or can wrap onto multiple lines based on available space. * @vegaVersion 2.6.0 */ "flexWrap": ResponsiveType; /** * Determines the gap (spacing) within the flex container. It can be provided as a spacing value, such as `size-12` or `size-24`. Alternatively, it can be set as a responsive map using key-value pairs to define different gaps for various breakpoints, where the `default` key is required. * @vegaVersion 1.0.4 */ "gap": ResponsiveType; /** * Controls the alignment of content items and the distribution of space between and around them within the flex container. * @vegaVersion 1.3.0 */ "justifyContent": ResponsiveType; /** * Determines the margin (spacing) around the flex container. It can be provided as a spacing value, such as `size-16` or `size-24`. Alternatively, it can be set as a responsive map using key-value pairs to define different margins for various breakpoints. When using a responsive map, the `default` key is required. * @vegaVersion 1.3.0 */ "margin": ResponsiveType; /** * Specifies whether to use the native flex layout. * @deprecated This property will be removed soon and vega-flex will only support native-based flex behaviors. * @vegaVersion 1.10.0 */ "useNativeFlex": boolean; } interface VegaFont { /** * Indicates the rendering of an additional node with a value that is an HTML tag name. It can be set as `ResponsiveType`. * @vegaVersion 1.46.0 */ "as": ResponsiveType; /** * Specifies the font color represented by a valid text color token. * @vegaVersion 1.46.0 */ "color": TextColorsTokenType; /** * Specifies the capability to enable or disable the font's responsiveness from native code. * @vegaVersion 1.46.0 */ "disableResponsive": boolean; /** * Specifies the horizontal alignment of the vega-font content. This property determines how the text is aligned within its container, and it is effective only when the vega-font is styled as a block-level element. * @vegaVersion 2.9.0 */ "textAlign": ResponsiveType; /** * Specifies the typography token used for styling the text within this component. A typography token includes values for font size and line height. * @vegaVersion 1.46.0 */ "variant": ResponsiveType; } interface VegaForm { /** * Specifies the HTTP URL for form submission. This property takes effect only when {@link useNativeForm} is set to `true`. * @vegaVersion 2.64.0 */ "action": string; /** * Specifies whether form validation should be disabled on blur events of form elements. - This helps prevent validation on blur when clicking Submit inside an input, avoiding error messages that shift the button and block the click. - For nested forms, the parent form will override this property to ensure consistent validation behavior. * @vegaVersion 2.47.0 */ "disableBlurValidation": boolean; /** * Invoke this method asynchronously to retrieve the values for all the available vega field elements nested within the `vega-form`. * @param option form control option to skip disabled/invisible components * @return object with key and field value as key-value pair * @vegaVersion 1.3.0 */ "getValue": (option?: FormControlOption) => Promise; /** * Indicates whether the value of any current form-controlled elements has been changed. 1. When the value of any form-controlled element is changed, this parameter is set to `true`. 2. When resetting the form, this parameter is set to `false`. 3. When invoking the `setValue` method, this parameter is set to `false`. * @vegaVersion 1.3.0 */ "isTouched": boolean; /** * Indicates whether the current form-controlled elements are valid. Form-controlled elements are considered for validation if they have the `data-vega-form` property. Disabled and invisible elements are excluded from validation. If the value is `undefined`, it means there are no form-controlled elements that can be validated. **Additional Notes:** 1. When depending on `isValid` for form validation, it is advised not to modify the following properties of the monitored DOM: - `disabled` property - Element visibility style 2. As this property relies heavily on the `VegaValidate` event emitted, it is highly recommended to enable auto-validation for all form-controlled elements to ensure that the value reflects the most up-to-date form validation status. * @vegaVersion 1.3.0 */ "isValid": boolean | null; /** * Specifies the HTTP method used for form submission. This property takes effect only when {@link useNativeForm} is set to `true`. * @vegaVersion 2.64.0 */ "method": 'post' | 'get'; /** * Invoke this method to reset the vega field elements in the form to the default value provided, or an empty string if no default value is found. * @param defaultValueMap map of the vega form field name to default value * @param option form control option to skip disabled/invisible components * @vegaVersion 1.3.0 */ "reset": (defaultValueMap?: unknown, option?: FormControlOption) => Promise; /** * Invoke this method to set validation states on specific form fields. * @param states - An array of validation error objects. * @vegaVersion 2.59.0 */ "setValidationStates": (states: VegaFormFieldValidationState[]) => Promise; /** * Invoke this method to prefill the `vega-form` with the given value. This action will also set the `isTouched` property to `false`. * @param value to prefill into the vega-form * @param option form control option to skip disabled/invisible components * @vegaVersion 1.3.0 */ "setValue": (value: T, option?: FormControlOption) => Promise; /** * Determines whether the `vega-form` content is wrapped in a native HTML
element. * @vegaVersion 2.64.0 */ "useNativeForm": boolean; /** * Invoke this method asynchronously to retrieve the validation result for all the vega field elements nested within the `vega-form`. If an element is a `vega-form` itself, it will recursively invoke its `valid()` method. * @param showError determine whether the validation result should be reflected in UI * @return validation result * @vegaVersion 1.3.0 */ "valid": (showError?: boolean | 'rule') => Promise; } interface VegaGrid { /** * Determines the configuration of the grid columns. It can be provided as an integer, string, or a responsive map using key-value pairs. If provided as an integer from 1 to 12, each column will have the same width. The CSS for this configuration is `grid-template-columns: repeat(number, minmax(0, 1fr))`. If provided as a string in the format of n-auto (e.g., `1-auto`, `2-auto`, ..., `12-auto`), each column will have auto width. The CSS for this configuration is `grid-template-columns: repeat(number, auto)`. Alternatively, you can use a responsive map to define different column configurations for various breakpoints. The keys in the map should represent the breakpoints, such as `default` or `L`, and the values can be integers or strings following the same patterns mentioned above. * @vegaVersion 1.3.0 */ "column": ResponsiveType; /** * Determines the spacing between grid cells. It can be provided as a spacing value, such as `size-16` or `size-24`. Alternatively, you can use a responsive map to define different gap values for various breakpoints. The keys in the map should represent the breakpoints, such as `default` or `L`, and the values should be spacing values. * @vegaVersion 1.3.0 */ "gap": ResponsiveType; /** * Specifies how grid items are aligned along the inline (row) axis. It can be provided as one of: `start`, `center`, `end`, or `stretch`. Alternatively, you can use a responsive map to define different values for various breakpoints. The keys in the map should represent the breakpoints, such as `default` or `L`. * @vegaVersion 2.79.0 */ "justifyItems": ResponsiveType; /** * Determines the configuration of the grid rows. It can be provided as an integer, string, or a responsive map using key-value pairs. If provided as an integer from 1 to 6, each row will have the same height. The CSS for this configuration is `grid-template-rows: repeat(number, minmax(0, 1fr))`. If provided as a string in the format of n-auto (e.g., `1-auto`, `2-auto`, ..., `6-auto`), each row will have auto height. The CSS for this configuration is `grid-template-rows: repeat(number, auto)`. Alternatively, you can use a responsive map to define different row configurations for various breakpoints. The keys in the map should represent the breakpoints, such as `default` or `L`, and the values can be integers or strings following the same patterns mentioned above. * @vegaVersion 1.3.0 */ "row": ResponsiveType; } interface VegaHint { } interface VegaIcon { /** * Specifies the color of the icon. If the color prop is `undefined`, it defaults to `currentColor`. * @vegaVersion 1.26.0 */ "color"?: TextColorsTokenType; /** * Specifies the required icon design token for the icon. * @vegaVersion 1.0.4 */ "icon": string; /** * Specifies the width and height of the icon. For Third Party Icons (e.g., Font Awesome), it sets the icon's font-size. * @vegaVersion 1.0.4 */ "size": SpacingTokenType; } interface VegaImageUploader { /** * Specifies the allowed file types for upload. * @vegaVersion 1.14.0 * @defaultValue .jpg,.png,.jpeg */ "accept": string; /** * Specifies the action sub-title for the image uploader. This property provides descriptive text that identifies the intended action or function of the image uploader. * @vegaVersion 2.9.0 */ "actionSubTitle": string; /** * Specifies the action title for the image uploader. This property provides descriptive text that identifies the intended action or function of the image uploader. * @vegaVersion 2.9.0 */ "actionTitle": string; /** * Determines whether automatic validation should be implemented for image uploads. * @vegaVersion 1.14.0 */ "autoValidation": boolean; /** * Specifies whether the Image Uploader field is disabled. * @vegaVersion 1.14.0 */ "disabled": boolean; /** * Invoke this method to retrieve the image preview URL for the current selection in the `vega-image-uploader` component. * @vegaVersion 1.45.0 */ "getContentURL": (file?: VegaFile) => Promise>; /** * Defines the height of the image uploader field. * @vegaVersion 2.9.0 */ "height": ResponsiveType; /** * Provides a supplementary prompt message that assists users in understanding the expected value for the image uploader field. * @vegaVersion 2.9.0 */ "hint": string; /** * Specifies the validation status. * @vegaVersion 1.14.0 */ "isValid": boolean | null; /** * Specifies the label or title for the image uploader. It provides descriptive text that helps identify the purpose of the image uploader. * @vegaVersion 2.5.0 */ "label": string; /** * Specifies whether uploading an image is mandatory. * @vegaVersion 1.14.0 */ "required": boolean; /** * Determines whether to show the preview button. * @vegaVersion 1.14.0 */ "showPreviewButton": boolean; /** * Determines whether to show the remove button. * @vegaVersion 1.14.0 */ "showRemoveButton": boolean; /** * Determines whether to show the replace button. * @vegaVersion 1.39.2 */ "showReplaceButton": boolean; /** * Controls the display of the upload status (`uploading`, `done`). If not set, the status remains invisible. * @vegaVersion 1.14.0 */ "status": VegaImageUploaderStatus | undefined; /** * Specifies custom validation rules for image uploads. * @vegaVersion 1.14.0 */ "validationRules": FormFieldValidationRule[]; /** * Determines the visual content that is initially displayed in the image uploader component, thereby providing a preview of the uploaded image or a default placeholder. * @vegaVersion 1.14.0 */ "value": VegaFile | null; /** * Defines the width of the image uploader field. * @vegaVersion 2.9.0 */ "width": ResponsiveType; } interface VegaInput { /** * 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). * @default true * @vegaVersion 1.0.10 */ "autoValidation": boolean; /** * 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 * @default 'off' * @vegaVersion 1.0.5 */ "autocomplete": InputAutocompleteTypes; /** * 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. * @default false * @vegaVersion 2.1.0 */ "disableCopyPaste": boolean; /** * 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. * @default false * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Programmatically removes focus from the underlying native `` 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. * @returns A promise that resolves once blur has been applied. * @vegaVersion 1.12.0 */ "doBlur": () => Promise; /** * Programmatically sets focus on the underlying native `` 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. * @returns A promise that resolves once focus has been applied. * @vegaVersion 1.12.0 */ "doFocus": () => Promise; /** * 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. * @deprecated Please use `type='email'` instead, which provides the same validation along with optimized mobile keyboard and browser autofill support. * @default false * @vegaVersion 1.0.5 */ "email": boolean; /** * Configures the action label (or icon) to present for the enter key on virtual keyboards. - `'enter'` — Insert a new line. - `'done'` — Nothing more to input, close the virtual keyboard. - `'go'` — Navigate to the target of the typed text. - `'next'` — Move to the next field that will accept text. - `'previous'` — Move to the previous field that will accept text. - `'search'` — Execute a search query. - `'send'` — Deliver the content (e.g. a message). See https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/enterkeyhint for more details. * @vegaVersion 2.81.0 */ "enterkeyhint": InputEnterKeyHintTypes; /** * 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). * @returns A promise that resolves once the dropdown is hidden. * @vegaVersion 2.75.0 */ "hideSuggestionsDropdown": () => Promise; /** * 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 `` sub-component and is replaced by an error message when validation fails. * @default '' * @vegaVersion 1.3.0 */ "hint": string; /** * 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. * @vegaVersion 2.71.0 */ "inputmode": 'text' | 'numeric'; /** * 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). * @default null * @vegaVersion 1.3.0 */ "isValid": boolean; /** * 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 `` element and is associated with the native `` for accessibility (screen readers, click-to-focus). When set to an empty string, no label is rendered. * @default '' * @vegaVersion 1.0.5 */ "label": string; /** * 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. * @default null * @vegaVersion 2.68.0 */ "labelSuffixButtonConfig": Nullable; /** * @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. * @default null * @vegaVersion 2.25.0 */ "labelSuffixButtonProps": Nullable; /** * 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. * @vegaVersion 1.3.0 */ "maskConfig": MaskConfigType | MaskConfigType[]; /** * 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. * @default null * @vegaVersion 1.0.5 */ "max": number | null; /** * 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. * @default null * @vegaVersion 1.0.5 */ "maxLength": number; /** * 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. * @default null * @vegaVersion 1.0.5 */ "min": number | null; /** * 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. * @default null * @vegaVersion 1.0.5 */ "minLength": number; /** * Sets the `name` attribute on the underlying native `` 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. * @default '' * @vegaVersion 1.0.5 */ "name": string; /** * 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. * @vegaVersion 1.3.0 */ "placeholder": string; /** * 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. * @vegaVersion 1.0.5 */ "prefixIcon": string; /** * Sets the input field as read-only, preventing direct keyboard input. When set to `true`, prevents manual keyboard text entry in the input field on all platforms. On touch devices, this typically suppresses the virtual keyboard. * @default false * @vegaVersion 2.79.0 */ "readOnly": boolean; /** * 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. * @default false * @vegaVersion 1.0.5 */ "required": boolean; /** * 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). * @default true * @vegaVersion 1.3.0 */ "showClearIcon": boolean; /** * 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. * @param dropdownConfig - Optional configuration to customize the dropdown behavior (e.g., itemDisplayRule, caseSensitive). * @returns A promise that resolves once the dropdown is displayed. * @vegaVersion 2.75.0 */ "showSuggestionsDropdown": (dropdownConfig?: VegaInputSuggestionsDropdownConfig) => Promise; /** * 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. * @default 'default' * @vegaVersion 1.3.0 */ "size": 'default' | 'small'; /** * 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. * @vegaVersion 2.75.0 */ "suggestionsDropdownSource": VegaDropdownSourceItem[]; /** * 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). * @default 'text' * @vegaVersion 1.0.9 */ "type": InputType; /** * 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. * @default [] * @vegaVersion 1.0.10 */ "validationRules": FormFieldValidationRule[]; /** * 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. * @default '' * @vegaVersion 1.0.5 */ "value": string; /** * 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. * @default 'input' * @vegaVersion 2.24.0 */ "valueUpdateTrigger": InputValueUpdateTriggeredBy; } interface VegaInputCreditCard { /** * Determines whether the user's input in the credit card field should be automatically validated. * @vegaVersion 1.26.0 */ "autoValidation": boolean; /** * Determines whether the credit card input field is disabled. * @vegaVersion 1.26.0 */ "disabled": boolean; /** * Specifies whether to hide the credit card number when users focus out of the input field. When set to `true`, the credit card number is partially masked, with the first three fields displayed as "x" and the last field remaining visible during blur and upon initial loading. * @vegaVersion 1.26.0 */ "hideCardNumberOnBlur": boolean; /** * Provides a supplementary prompt message that assists users in understanding the expected value for the input field. * @vegaVersion 1.26.0 */ "hint": string; /** * Indicates whether the current value in the field is considered valid based on the defined validation rules. * @vegaVersion 1.26.0 */ "isValid": boolean; /** * Defines the label or title for the credit card input field. * @vegaVersion 1.26.0 */ "label": string; /** * Specifies a placeholder string that displays as a temporary hint or example inside the credit card input field. It indicates the expected format or pattern of the credit card input. * @vegaVersion 1.26.0 */ "placeholder": string; /** * Specifies whether a card number must be entered for this component to pass form validation. * @vegaVersion 1.26.0 */ "required": boolean; /** * Specifies the size of the credit card input field. * @vegaVersion 1.26.0 */ "size": 'default' | 'small'; /** * Specifies custom validation rules for the credit card input field. * @vegaVersion 1.26.0 */ "validationRules": FormFieldValidationRule[]; /** * Represents a pre-set value for the credit card input field. It allows you to initialize the field with a specific value, which is displayed to the user when the input is initially rendered. * @vegaVersion 1.26.0 */ "value": string; } interface VegaInputNumeric { /** * 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. * @default true * @vegaVersion 2.29.0 */ "autoValidation": boolean; /** * 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. * @default false * @vegaVersion 2.29.0 */ "disabled": boolean; /** * 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). * @default undefined * @vegaVersion 2.29.0 */ "hint": string; /** * When `true`, restricts user input to whole numbers only — decimal points and fractional digits are rejected. Useful for fields like quantity, count, or age. * @default false * @vegaVersion 2.29.0 */ "integerOnly": boolean; /** * 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. * @default null * @vegaVersion 2.29.0 */ "isValid": boolean; /** * 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. * @default '' * @vegaVersion 2.29.0 */ "label": string; /** * 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`. * @default 10 * @vegaVersion 2.29.0 */ "majorIncrement": number; /** * 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. * @default null * @vegaVersion 2.63.0 */ "max": number | null; /** * 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. * @default null * @vegaVersion 2.63.0 */ "min": number | null; /** * 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). * @default 1 * @vegaVersion 2.29.0 */ "minorIncrement": number; /** * 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'`). * @default undefined * @vegaVersion 2.29.0 */ "placeholder": string; /** * 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. * @default undefined * @vegaVersion 2.29.0 */ "prefixIcon": string; /** * 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. * @default '' * @vegaVersion 2.29.0 */ "prefixText": string; /** * 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. * @default undefined * @vegaVersion 2.29.0 */ "required": boolean; /** * 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. * @default true * @vegaVersion 2.53.0 */ "showClearIcon": boolean; /** * 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. * @default 'medium' * @vegaVersion 2.29.0 */ "size": 'medium' | 'small'; /** * 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'`). * @default undefined * @vegaVersion 2.29.0 */ "suffixText": string; /** * 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. * @default false * @vegaVersion 2.29.0 */ "thousandComma": boolean; /** * 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. * @default [] * @vegaVersion 2.29.0 */ "validationRules": FormFieldValidationRule1[]; /** * 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. * @default '' * @vegaVersion 2.29.0 */ "value": string; } interface VegaInputPasscode { /** * 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. * @default true * @vegaVersion 2.66.0 */ "autoValidation": boolean; /** * 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. * @default false * @vegaVersion 2.66.0 */ "disabled": boolean; /** * 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'`. * @default '' * @vegaVersion 2.66.0 */ "hint": string; /** * 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. * @default 'numeric' * @vegaVersion 2.66.0 */ "inputType": 'numeric' | 'text'; /** * 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. * @default null * @vegaVersion 2.66.0 */ "isValid": boolean | null; /** * 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. * @default '' * @vegaVersion 2.66.0 */ "label": string; /** * 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. * @default 4 * @vegaVersion 2.66.0 */ "length": number; /** * 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. * @default false * @vegaVersion 2.66.0 */ "required": boolean; /** * Controls the visual size of the passcode input boxes. - `'medium'` — Standard height, suitable for most form layouts. - `'small'` — Compact height, useful for dense UIs. * @default 'medium' * @vegaVersion 2.66.0 */ "size": 'medium' | 'small'; /** * 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. * @default [] * @vegaVersion 2.66.0 */ "validationRules": FormFieldValidationRule[]; /** * 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. * @default '' * @vegaVersion 2.66.0 */ "value": string; } interface VegaInputPhoneNumber { /** * 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. * @default VegaCountryCode[] (all 245 codes) * @vegaVersion 2.18.0 */ "allowedCountryCodes": VegaCountryCode[]; /** * 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. * @default true * @vegaVersion 2.18.0 */ "autoValidation": boolean; /** * 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. * @default 'US' * @vegaVersion 2.18.0 */ "countryCode": VegaCountryCode; /** * 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. * @default false * @vegaVersion 2.18.0 */ "disabled": boolean; /** * 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. * @default false * @vegaVersion 2.35.0 */ "emptyValueEnabled": boolean; /** * 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'`). * @default '' * @vegaVersion 2.18.0 */ "hint": string; /** * 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. * @default null * @vegaVersion 2.18.0 */ "isValid": boolean; /** * 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. * @default '' * @vegaVersion 2.18.0 */ "label": string; /** * 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'`). * @default undefined * @vegaVersion 2.18.0 */ "placeholder": string; /** * 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. * @default false * @vegaVersion 2.18.0 */ "required": boolean; /** * 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. * @default 'default' * @vegaVersion 2.18.0 */ "size": 'default' | 'small'; /** * 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. * @default [] * @vegaVersion 2.18.0 */ "validationRules": FormFieldValidationRule[]; /** * 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). * @default '+1' * @vegaVersion 2.18.0 */ "value": string; } interface VegaInputRange { /** * Determines whether the input field should undergo automatic validation during the user's input. * @vegaVersion 2.2.0 */ "autoValidation": boolean; /** * Determines whether the input range is disabled. * @vegaVersion 2.2.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that assists users in understanding the expected value for the input field. * @vegaVersion 2.2.0 */ "hint": string; /** * Indicates whether the current value in the field is considered valid based on the defined validation rules. * @vegaVersion 2.2.0 */ "isValid": boolean; /** * Specifies the label or title for the input range. It provides descriptive text that helps identify the purpose or content expected in the input field. * @vegaVersion 2.2.0 */ "label": string; /** * Sets the maximum allowable numeric value for the input value. * @vegaVersion 2.2.0 */ "max": number; /** * Sets the minimum allowable numeric value for the input value. * @vegaVersion 2.2.0 */ "min": number; /** * Specifies a placeholder string that displays as a temporary hint or example inside the input field. It indicates the expected format or pattern of the input. * @vegaVersion 2.2.0 */ "placeholder": [string, string]; /** * Specifies an icon or symbol that appears before the input range, providing visual context or enhancing the aesthetic appearance of the input. * @vegaVersion 2.2.0 */ "prefixIcon": string; /** * Determines whether the input range is required. * @vegaVersion 2.2.0 */ "required": boolean; /** * Determines whether the clear icon should be displayed. * @vegaVersion 2.2.0 */ "showClearIcon": boolean; /** * Defines the size of the input range, specifying its width or length. * @vegaVersion 2.2.0 */ "size": 'default' | 'small'; /** * Determines the arrangement and appearance of the label and input areas. * @vegaVersion 2.2.0 */ "stack": InputRangeStackType; /** * Defines custom validation rules for the input field. * @vegaVersion 2.2.0 */ "validationRules": FormFieldValidationRule[]; /** * Represents a pre-set or default value for the input field. It allows you to initialize the field with a specific value, which is displayed to the user when the input is initially rendered. If the value is too long, it may be truncated with an ellipsis for visual presentation. * @vegaVersion 2.2.0 */ "value": InputRangeValueType; } interface VegaInputSelect { /** * Specifies whether the system should automatically carry out validation checks on the user's selection in real-time, ensuring that the input adheres to predefined criteria before submission or proceeding further. * @vegaVersion 1.0.11 */ "autoValidation": boolean; /** * Specifies whether the input select field is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Invoke this method to change the ID of the select source item. * @vegaVersion 1.0.7 */ "doChange": (value: SelectValueType) => Promise; /** * Invoke this method to close the select dropdown and clear the dropdown element reference. * @vegaVersion 1.0.7 */ "doClose": () => Promise; /** * Invoke this method to open the select dropdown. * @vegaVersion 1.0.7 */ "doOpen": () => Promise; /** * Provides a supplementary prompt message that assists users in understanding the expected value for the input select field. * @vegaVersion 1.3.0 */ "hint": string; /** * Indicates the current validation status of the user's selection from the dropdown menu. * @vegaVersion 1.3.0 */ "isValid": boolean | null; /** * Specifies the label or title for the input field. It provides descriptive text that helps identify the purpose or content expected in the input select field. * @vegaVersion 1.3.0 */ "label": string; /** * Specifies the properties for the suffix button associated with the input. It provides essential information and functionality related to the suffix button's role and behavior. * @vegaVersion 2.68.0 */ "labelSuffixButtonConfig": Nullable; /** * Specifies a placeholder string that displays as a temporary hint or example inside the input select field. It indicates the expected format or pattern of the input. * @vegaVersion 1.0.7 */ "placeholder": string; /** * Specifies a prefix icon for visual context or aesthetic enhancement. * @vegaVersion 1.3.0 */ "prefixIcon": string; /** * Determines whether the input select field is required. * @vegaVersion 1.0.7 */ "required": boolean; /** * Controls the selection capabilities of the associated dropdown menu. * @vegaVersion 1.35.0 */ "selectType": SelectType; /** * 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 * @vegaVersion 1.35.0 */ "selectedLabel": SelectedLabelType | SelectedLabelTypeForAllModes; /** * Defines the size of the input select field. * @vegaVersion 1.18.0 */ "size": ResponsiveType; /** * Specifies the dataset used to populate the options available in the select input dropdown menu. * @vegaVersion 1.0.7 */ "source": SelectSourceItem[]; /** * Specifies the callback function for source lazy loading, which returns new data to load. When the dropdown reaches the bottom, this function is triggered and receives the current end index as a parameter. * @vegaVersion 2.3.0 */ "sourceLazyLoadCallback": VegaInputSelectSourceLazyLoadCallback; /** * Allows setting custom criteria or constraints that the user's selection in the dropdown menu must comply with. * @vegaVersion 1.0.11 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the ID of the item selected from the source data in the dropdown menu. The ID should be unique within the source collection to correctly associate the chosen option with its corresponding data entry. * @vegaVersion 1.0.7 */ "value": SelectValueType; /** * Provides partial properties for the `vega-dropdown` component used in the input select element. You can specify custom properties and their corresponding values as needed. * @vegaVersion 1.3.0 */ "vegaDropdownProps": VegaDropdownPropsForSelect; } interface VegaItemToggle { /** * Determines whether the item is toggled on. * @vegaVersion 1.3.0 */ "isToggled": boolean; /** * Defines the labels and icons associated with the toggle states. * @deprecated This property will be removed soon and replaced by prop statusMap * @vegaVersion 1.3.0 * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'} */ "itemToggleStatusMap": ItemToggleStatusMap; /** * Defines the labels and icons associated with the toggle states. * @vegaVersion 2.2.0 * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'} */ "statusMap": ItemToggleStatusMap; } interface VegaLeftNav { /** * Determines how the left navigation groups behave when clicked, controlling the automatic collapsing of open groups. Available options: - `true`: Collapses the group when clicking either a group or a link. - `false`: Collapses the group only when clicking a link; clicking a group does not collapse it. - `always`: Always collapses the group when clicking a group or link (equivalent to true). - `on-group-click`: Collapses the group only when clicking a group; clicking a link does not collapse it. - `on-link-click`: Collapses the group only when clicking a link; clicking a group does not collapse it. - `never`: Never collapses groups when clicking a group or link. * @vegaVersion 2.48.0 * @VegaWarning - Boolean types are deprecated, please use "on-group-click" | "on-link-click" | "never" | "always" instead. */ "autoCollapseGroups": autoCollapseGroupsType; /** * Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. * * @vegaVersion 2.7.0 */ "autoCollapseOnOverlay": boolean; /** * Provides additional information or context in the form of a footnote in the left-nav footer. * @vegaVersion 1.31.0 */ "footnote": string; /** * Specifies the configuration options for the header within the left-nav. You can use this property to define a custom title and subtitle. * @vegaVersion 1.31.0 */ "headerConfig": LeftNavHeaderConfig; /** * Determines whether the left navigation is expanded or collapsed. * @vegaVersion 1.39.2 */ "open": boolean; /** * Determines whether the left-nav should appear as an overlay, accompanied by a backdrop that darkens the content on the page. This property has no effect on breakpoints smaller than the desktop size. Note: To use the backdrop-free feature when the left navigation is open, ensure the `show-as-overlay` property is set to `false` within the `vega-left-nav` component. Additionally, enclose all content within an element possessing the class `vega-left-nav-content` immediately following the `vega-left-nav` component. * @vegaVersion 1.33.0 */ "showAsOverlay": boolean; /** * Specifies source data used to generate the links and groups structure in the left-nav. * @vegaVersion 1.31.0 */ "source": LeftNavSourceItem[]; /** * Invoke this method to toggle the left-nav's open state. * @vegaVersion 1.31.0 */ "toggle": () => Promise; } interface VegaLeftNavGroup { /** * icon attached to the left nav group items ** * @vegaVersion 1.31.0 */ "icon": string; /** * Defines a unique key for the left nav group item. * @vegaVersion 2.45.0 */ "itemKey": string; /** * label attached to the left nav group items ** * @vegaVersion 1.31.0 */ "label": string; /** * Specifies whether the navigation group is expanded by default ** * @vegaVersion 2.44.0 */ "openByDefault": boolean; } interface VegaLeftNavLink { /** * config the counter badge for left nav link items * @deprecatedAttribute [counter] The 'counter' attribute is deprecated and will be removed soon. Please use 'count' instead. * @vegaVersion 1.31.0 */ "counterBadge": LeftNavCounterBadgeConfig; /** * Specifies whether the link's selected state can be customized. When enabled, it prevents the default automatic selection on click, allowing users to manually control the link’s selection behavior. * @vegaVersion 2.37.0 */ "customSelectionEnabled": boolean; /** * icon attached to the left nav link items ** * @vegaVersion 1.31.0 */ "icon": string; /** * Defines a unique key for the left nav link item. * @vegaVersion 2.45.0 */ "itemKey": string; /** * A boolean that indicates whether the current link item is selected. * @VegaWarning Note: Ensure that the `custom-selection-enabled` property is set to `true` before modifying this value, as modifying it without this setting may lead to unexpected behavior. * @vegaVersion 1.31.0 */ "selected": boolean; /** * Specifies where to open the URL linked in the left navigation item. Common values include _self (default) to open in the same tab, or _blank to open in a new tab. * @vegaVersion 2.53.0 */ "target": '_blank' | '_self'; /** * url attached to the left nav link item ** * @vegaVersion 1.31.0 */ "url": string; } interface VegaLeftNavSection { /** * Defines a unique key for the left nav nav section item. * @vegaVersion 2.45.0 */ "itemKey": string; /** * sectionHeader attached to the left nav section ** * @vegaVersion 1.31.0 */ "sectionHeader": LeftNavSectionHeaderConfig; } interface VegaLineChart { /** * Specifies the rendering options for the line chart. * @vegaVersion 1.32.0 */ "options": LineChartOptionsType; /** * Invoke this method to render the chart using the existing options. If the chart is displayed incorrectly within a modal or tab, ensure that this method is invoked after the chart is shown to ensure proper rendering. * @vegaVersion 1.32.0 */ "reRender": () => Promise; } interface VegaLoaderWrapper { } interface VegaLoadingIndicator { /** * Provides a supplementary prompt message that assists users in understanding the ongoing loading process. * @vegaVersion 1.16.0 */ "hint": string; /** * Provides a descriptive text or message that indicates the status or progress of the process. * @vegaVersion 1.16.0 */ "label": string; /** * Specifies the mode of the loading indicator. When the mode is set to `determinate`, there will be no animation. * @vegaVersion 1.16.0 */ "mode": 'indeterminate' | 'determinate'; /** * Specifies the completion percentage when the mode is set to `determinate`. * @vegaVersion 1.16.0 */ "percent": number; /** * Specifies the shape of the loading indicator. * @vegaVersion 1.16.0 */ "shape": 'circle' | 'bar'; /** * Specifies the size of the loading indicator. It is provided as a ResponsiveType. * @vegaVersion 1.16.0 */ "size": ResponsiveType; /** * Indicates the current status or state of the loading process. * @vegaVersion 1.16.0 */ "status": 'default' | 'success' | 'error'; } interface VegaModal { /** * Specifies whether the modal uses an animated transition when it appears. * @vegaVersion 1.0.11 */ "animation": boolean; /** * Provides options for controlling the behavior of the backdrop. - `default`: indicates that the user can close the modal by clicking on the backdrop. - `static`: means that the user cannot close the modal by clicking on the backdrop. - `none`: specifies that the backdrop will not be rendered. _Note_: When changing this value, a page refresh is required for the changes to take effect. * @vegaVersion 1.0.6 */ "backdrop": VegaModalBackdrop; /** * Specifies the background color of the modal's backdrop. * @vegaVersion 1.3.0 */ "backdropColor": VegaModalBackdropColor; /** * Defines the maximum height of the content within the modal element. It accepts values in numeric, string and ResponsiveType. Numeric values represent maximum height of the content in pixels (e.g., 100 translates to 100px). String values allow the use of CSS units like 'vh' or 'calc' expressions. (e.g., '100vh' or 'calc(100vh - 20px)'). * @vegaVersion 1.4.0 */ "contentMaxHeight": ResponsiveType; /** * Provides a callback function that is triggered when a user clicks the close button located in the top right corner of the modal. If the callback function returns `true`, the modal will be closed. If the callback function returns `false` or does not return any value, the modal will remain open. * @vegaVersion 1.22.0 */ "handleClose": (() => boolean) | undefined; /** * Determines the height of the modal. It accepts numeric values (interpreted as pixels), string values (e.g., "100%", "100vh"), or ResponsiveType for responsive configurations. * @vegaVersion 2.81.0 */ "height": ResponsiveType; /** * Determines whether the modal is vertically centered on the screen. * @deprecated This property will be removed soon and replaced by prop isVerticallyCentered * @vegaVersion 1.3.0 */ "isVerticallyCenter": boolean; /** * Determines whether the modal is vertically centered on the screen. * @vegaVersion 2.2.0 */ "isVerticallyCentered": boolean; /** * Specifies the margin around the modal dialog. It accepts a ResponsiveType or size values. Set `x` to `auto` to horizontally center the modal. * @vegaVersion 2.81.0 */ "margin": ResponsiveType; /** * Invoke this method to show or hide the modal. * @vegaVersion 1.0.6 */ "modal": (option: 'show' | 'hide') => Promise; /** * Represents the title displayed within the modal. * @vegaVersion 1.3.0 */ "modalTitle": string; /** * Determines whether the modal is initially open. * @vegaVersion 1.0.6 */ "open": boolean; /** * Specifies the amount of space or padding within the modal. It can be set as a ResponsiveType or any size value. * @vegaVersion 1.0.10 */ "padding": ResponsiveType; /** * Determines whether the modal displays a close button to allow hiding or closing of the modal. * @vegaVersion 1.3.0 */ "showCloseButton": boolean; /** * Determines the size of the modal. It can be specified as a number, a percentage string ending with "%", or a ResponsiveType. It is important to note that there are different maximum widths for modal windows based on the viewport size. If the specified size exceeds the maximum width, the maximum modal width will be used instead. * @vegaVersion 1.0.6 */ "size": ResponsiveType; } interface VegaNavCard { /** * Specifies the maximum height for the scrollable list within the `vega-nav-card` component. It accepts values in both numeric and string formats. For numeric values, use a number to indicate the height in pixels, e.g., 100 will be translated to 100px. For string values, you can use CSS units like 'vh' or 'calc' expressions. For example, '100vh' sets the height to 100% of the viewport height, and 'calc(100vh - 20px)' allows for more complex calculations to determine the height. * @vegaVersion 1.44.0 */ "maxHeight": ResponsiveType; /** * Specifies the source data used to populate the list within the `vega-nav-card` component. * @vegaVersion 1.42.0 */ "source": LeftNavSourceItem[]; } interface VegaPageNotification { /** * Specifies the configuration array for the action buttons of the page notification. The action buttons provide interactive options for users to perform specific actions or operations related to the notification. * @vegaVersion 1.17.0 */ "actionButtons": VegaPageNotificationActionButtonConfig[]; /** * Invoke this method to close the page notification. * @vegaVersion 1.17.0 */ "close": () => Promise; /** * Specifies the duration, in milliseconds, before the page notification automatically closes. If the duration is set to `0`, the notification will not close automatically. * @vegaVersion 1.17.0 */ "duration": number; /** * Specifies the content text for the page notification. It provides a detailed message or information that further explains the purpose or context of the notification. * @vegaVersion 1.17.0 */ "message": string; /** * Specifies the title text for the page notification. It provides users with a concise and informative message that communicates the purpose or nature of the notification. * @vegaVersion 1.17.0 */ "notificationTitle": string; /** * Specifies whether to display the close button for the page notification. * @vegaVersion 1.17.0 */ "showCloseButton": boolean; /** * Specifies the type of page notification, indicating the visual style or category of the notification. * @vegaVersion 1.17.0 */ "type": VegaPageNotificationTypes; } interface VegaPageNotificationList { } interface VegaPagination { /** * Specifies the current page number for the pagination component. * @vegaVersion 1.3.0 */ "current": number; /** * Specifies the properties of the `vega-dropdown` component used to configure the dropdown for the page size selector in pagination. * @vegaVersion 2.36.0 */ "dropdownProps": DropdownPropsForPagination; /** * Specifies the extensions associated with the pagination items in the pagination component. It refers to additional elements or components that can be added to enhance the functionality or appearance of each pagination item. * @VegaWarning - Note: The default value is controlled by feature flag `VEGA_PAGINATION.ENABLE_EXTENSIONS_RESPONSIVE_DEFAULT_VALUE`, which is disabled by default. - To enable the new responsive default value `{ default: [['pageSizeSelectorMobile_currentPageLabel'], ['pageSelectorMobile_goTo']], M: [['pageSelector']], }`, please enable the feature flag. * @vegaVersion 1.25.0 * @defaultValue [['pageSelector']] */ "extensions": ResponsiveType; /** * Specifies the layout of the elements. It determines how the pagination elements are arranged, with options such as 'horizontal' for a horizontal layout or other defined layouts. * @vegaVersion 2.42.0 */ "layout": ResponsiveType; /** * Specifies the number of data items to be displayed per page in the pagination component. * @vegaVersion 1.3.0 */ "pageSize": number; /** * Specifies the options available for the page size selector in the pagination component. Each option can be a number or an object with `value` and `label`. Use `{ value: -1, label: 'All' }` to show all items on a single page. * @vegaVersion 1.25.0 */ "pageSizeSelectorOptions": VegaPaginationPageSizeOption[]; /** * Specifies the total number of data items for the pagination component. * @vegaVersion 1.3.0 */ "total": number; } interface VegaPaginationPageSelectorMobile { /** * Specifies the current page number * @vegaVersion 2.42.0 */ "current": number; /** * Total number of pages. * @vegaVersion 2.42.0 */ "pageCount": number; /** * Specifies the total number of data items * @vegaVersion 2.42.0 */ "total": number; /** * Specifies the type of the pagination elements. * @vegaVersion 2.42.0 */ "type": 'pageSelectorMobile' | 'pageSelectorMobile_goTo'; } interface VegaPaginationPageSizeSelectorMobile { /** * Specifies the current page number * @vegaVersion 2.42.0 */ "current": number; /** * Specifies the properties of the `vega-dropdown` component used to configure the dropdown for the page size selector mobile in pagination. * @vegaVersion 2.42.0 */ "dropdownProps": DropdownPropsForPagination; /** * @vegaVersion 2.81.0 */ "isAllActive": boolean; /** * Specifies the number of data items to be displayed per page * @vegaVersion 2.42.0 */ "pageSize": number; /** * Specifies the options available for the page size selector * @vegaVersion 2.42.0 */ "pageSizeSelectorOptions": VegaPaginationPageSizeOption[]; /** * Specifies the total number of data items * @vegaVersion 2.42.0 */ "total": number; /** * Specifies the type of the pagination elements. * @vegaVersion 2.42.0 */ "type": 'pageSizeSelectorMobile' | 'pageSizeSelectorMobile_currentPageLabel'; } interface VegaPieChart { /** * Specifies the rendering options for the pie chart. * @vegaVersion 1.35.0 */ "options": PieChartOptions; /** * Invoke this method to render the chart using the existing options. If the chart is displayed incorrectly within a modal or tab, ensure that this method is invoked after the chart is shown to ensure proper rendering. * @vegaVersion 1.35.0 */ "reRender": () => Promise; } interface VegaPopover { /** * Controls how the popover aligns horizontally and vertically, ensuring it is displayed in the desired position. * @vegaVersion 1.19.0 */ "alignment": PositionAlignmentType; /** * Invoke this method to close the popover. * @vegaVersion 1.22.0 */ "hide": () => Promise; /** * Determines whether the popover's position is calculated relative to the screen. * @VegaWarning - It will overrides the positionRelativeTo and matchContainerHeight properties, rendering them ineffective. - Currently, when set to true, the position calculation may be inaccurate if the popover is placed inside a scrollable container within a shadowRoot (e.g., inside a vega-modal with scrollable content). * @vegaVersion 2.39.0 */ "isScreenPosition": boolean; /** * Determines the spacing between the content and the edges of the popover content box. * @vegaVersion 2.59.0 */ "padding": ResponsiveType; /** * Specifies the placement or position of the popover in relation to its parent element. If there is insufficient space to display the popover in the default position, it will automatically adjust its placement based on the following order: `top`, `left`, `bottom`, `right`. * @vegaVersion 1.19.0 */ "placement": PlacementType; /** * Specifies the selector for the element that will contain the popover. If this parameter is not provided, the popover will be appended to the body element of the page. However, if you encounter any issues with the positioning of the popover, especially when scrolling occurs, you can modify this property to specify a different element as the container for the popover. * @VegaWarning The value of this property should be an element that is the parent of this component or an ancestor of the parent element. Using any other element may lead to unexpected behavior. * @vegaVersion 1.19.0 */ "positionRelativeTo": string; /** * Invoke this method to show the popover. * @vegaVersion 1.22.0 * @param refresh - Determines whether the popover should be refreshed even when it is already visible. This is useful for updating the popover‘s styles (such as width, height, or position). The default value is false. Added in 2.73.0. */ "show": (refresh?: boolean) => Promise; /** * Controls whether the arrow is display. * @vegaVersion 2.8.0 */ "showArrow": boolean; /** * Specifies the size of the popover component. It is provided as a number or ResponsiveType. * @vegaVersion 1.19.0 */ "size": ResponsiveType; /** * Specifies the trigger mode for the popover. * @vegaVersion 2.1.0 */ "trigger": 'hover' | 'click'; } interface VegaPopoverContentBox { /** * Determines the spacing between the content and the edges of the popover content box. * @vegaVersion 2.59.0 */ "padding": ResponsiveType; /** * Controls whether the arrow is display. * @vegaVersion 2.8.0 */ "showArrow": boolean; } interface VegaProgressTracker { /** * Enables the ability to click on the steps in the Progress Tracker component. * @vegaVersion 1.5.0 */ "canClickStep": boolean; /** * Specifies an array of completed step titles for the Progress Tracker component. Each completed step title represents a step that has been successfully completed in the workflow or process. * @deprecated This property will be removed soon and replaced by prop completedSteps * @vegaVersion 1.5.0 */ "completedStepArray": string[]; /** * Specifies an array of titles representing completed steps in the progress tracker, indicating successful completion within the workflow or process. * @vegaVersion 2.2.0 */ "completedSteps": string[]; /** * Indicates the current step or stage in a sequential process or workflow, starting from 0. * @vegaVersion 1.0.7 */ "current": number; /** * Specifies the direction of the Progress Tracker component. It can be set to either horizontal or vertical. In the horizontal direction, the tracker is divided into panes with navigable arrows. In the vertical direction, it is displayed as a single pane. It also can be set as ResponsiveType for responsive direction. * @vegaVersion 1.0.7 */ "direction": ResponsiveType; /** * Invoke this method to retrieve the tracker's current step. * @vegaVersion 1.3.0 */ "getCurrent": () => Promise; /** * Invoke this method to change the tracker's current step to the next step, if available. * @vegaVersion 1.5.0 */ "nextStep": () => Promise; /** * Invoke this method to change the tracker's current step to the previous step, if available. * @vegaVersion 1.5.0 */ "prevStep": () => Promise; /** * Invoke this method to set the current step of the tracker. * @vegaVersion 1.0.7 */ "setCurrent": (step: number) => Promise; /** * Specifies an array of step subtitles for the Progress Tracker component. Each subtitle corresponds to a step in the progression of the workflow or process. * @vegaVersion 1.3.0 */ "steps": string[] | VegaProgressTrackerStepItem[]; } interface VegaProgressTrackerStep { /** * If step is clickable. * @vegaVersion 2.76.0 */ "clickable": boolean; /** * The unique key for the step. * @vegaVersion 2.73.0 */ "stepKey": string; } interface VegaRadio { /** * Determines if the radio button is selected or checked. * @vegaVersion 1.0.7 */ "checked": boolean; /** * Determines if the radio button is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Assigns a common name to the input element of the radio button, to differentiate it from other buttons in a radio group. * @vegaVersion 1.3.0 */ "name": string; /** * Specifies the size of the Radio Button component. The size should be selected based on the context and design requirements of the specific form. * @vegaVersion 1.9.2 */ "size": 'default' | 'small'; /** * Represents the value associated with the radio button that is currently selected or checked. * @vegaVersion 1.0.7 */ "value": string; } interface VegaRadioGroup { /** * Determines whether automatic validation should be implemented for the radio group upon selection. * @vegaVersion 2.6.0 */ "autoValidation": boolean; /** * Determines whether the radio group is disabled. * @vegaVersion 1.8.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that assists users in selecting the appropriate value for the radio group. * @vegaVersion 1.3.0 */ "hint": string; /** * Sets the validation status for the radio group. * @vegaVersion 1.3.0 */ "isValid": boolean; /** * Specifies the label or title of the radio group. * @vegaVersion 1.3.0 */ "label": string; /** * Specifies the name attribute for each radio button in the radio group. * @vegaVersion 1.3.0 */ "name": string; /** * Specifies whether the radio button within the radio group must be checked to pass form validation. * @vegaVersion 1.3.0 */ "required": boolean; /** * Defines custom validation rules for the radio group. * @vegaVersion 2.6.0 */ "validationRules": FormFieldValidationRule[]; /** * Represents the value associated with the radio button. * @vegaVersion 1.0.7 */ "value": string; /** * Specifies all the properties of the `vega-flex` component in the radio group. * @vegaVersion 1.3.0 */ "vegaFlexProp": VegaFlexProps; } interface VegaRichTextContent { /** * Specifies the text or formatted information displayed by the rich text content, which can be either VegaRTEContent or VegaRTEContentBlock. It is recommended to use the VegaRTEContent type. Only in exceptional cases should the original data in the VegaRTEContentBlock type be used. * @vegaVersion 2.34.0 */ "content": VegaRTEContent; /** * Defines the configuration for rich text content extensions. It enables support for custom nodes, ensuring that extended content is rendered correctly. * @vegaVersion 2.62.0 */ "extensions": VegaRTEExtension[]; /** * Invoke this method to focus on rich text content editable div * @vegaVersion 2.34.0 */ "vegaFocus": () => Promise; } interface VegaRichTextEditor { /** * Determines whether to allow source edit mode in the rich text editor. * @vegaVersion 2.59.0 */ "allowSourceEdit": boolean; /** * Determines whether automatic validation should be implemented for the rich text editor. * @vegaVersion 2.34.0 */ "autoValidation": boolean; /** * Specifies whether the rich text editor is disabled. * @vegaVersion 2.34.0 */ "disabled": boolean; /** * Specifies the configuration for the rich text editor extensions. * @vegaVersion 2.62.0 */ "extensions": VegaRTEExtension[]; /** * Provides a supplementary prompt message that assists users in understanding the expected value within the rich text editor. * @vegaVersion 2.34.0 */ "hint": string; /** * Specifies the validation status of the rich text editor component. * @vegaVersion 2.34.0 */ "isValid": boolean | null; /** * Specifies the label for the rich text editor. It provides descriptive text that helps identify the purpose or content expected in the rich text editor. * @vegaVersion 2.34.0 */ "label": string; /** * 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. * @vegaVersion 2.34.0 */ "placeholder": string; /** * Determines whether the rich text editor field is required. * @vegaVersion 2.34.0 */ "required": boolean; /** * Specifies editable section rows for the rich text editor * @vegaVersion 2.34.0 */ "rows": number; /** * Specifies the configuration options for source edit mode. It includes settings such as autoMatchFormat, which controls whether the editor automatically matches formatting when switching to source edit mode. * @vegaVersion 2.59.0 */ "sourceEditConfig": VegaRTESourceEditConfig; /** * Specifies the built-in toolbar items available in the rich-text editor. * @vegaVersion 2.34.0 */ "toolbarItems": VegaRTEToolbarItem[][]; /** * Defines custom validation rules for the rich text editor. * @vegaVersion 2.34.0 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the value of the rich text editor, which can be either VegaRTEContent or VegaRTEContentBlock. It is recommended to use the VegaRTEContent type. Only in exceptional cases should the original data in the VegaRTEContentBlock type be used. * @vegaVersion 2.34.0 * @defaultValue [{id:'UUID', type:'paragraph', nodes:[{id: 'UUID',type: 'text',text:''}]}] */ "value": VegaRTEContent; } interface VegaRichTextEditorToolbarButton { /** * Specifies whether the rich text editor toolbar button element is disabled. * @vegaVersion 2.34.0 */ "disabled": boolean; /** * Specifies whether the rich text editor toolbar button element is hidden. * @vegaVersion 2.59.0 */ "hidden": boolean; /** * Specifies whether the toolbar button in the rich text editor is represented by an icon. * @vegaVersion 2.34.0 */ "icon": string; /** * Specifies the color of the toolbar button icon in the rich text editor. * @vegaVersion 2.34.0 */ "iconColor": TextColorsTokenType; /** * Specifies whether the rich text editor toolbar button element is selected. * @vegaVersion 2.34.0 */ "selected": boolean; /** * Specifies whether the rich text editor toolbar button element is showArrowIcon. * @vegaVersion 2.34.0 */ "showArrowIcon": boolean; } interface VegaRichTextImageEditor { /** * Specifies the value of image alt * @vegaVersion 2.34.0 */ "alt": string; /** * Specifies the size of the image to the container * @vegaVersion 2.34.0 */ "size": VegaRichTextImageEditorSizeType; } interface VegaRichTextLinkEditor { /** * Specifies the hyperlink editor record * @vegaVersion 2.34.0 */ "record": VegaRTELinkEditorRecord; /** * Specifies whether the status will be reset after hide the popover * @vegaVersion 2.34.0 */ "resetStatusAfterHide": boolean; /** * Provide a method to show the link editor popover * @vegaVersion 2.34.0 */ "show": () => Promise; /** * Specifies the status of the link editor * @vegaVersion 2.34.0 */ "status": VegaRichTextLinkEditorStatus; /** * Specifies the target element for the popover. * @vegaVersion 2.34.0 */ "target": HTMLElement; } interface VegaRichTextTableProperties { /** * @vegaVersion 2.79.0 */ "colors": VegaRTEColorSchema[]; /** * @vegaVersion 2.79.0 */ "defaultValue": RTETablePropertiesType; /** * The origin style map for multiple selected blocks. The key is the block ID, and the value is the style object for that block. * @vegaVersion 2.79.0 */ "styleMap": TableCellStylePropertiesMap; /** * @vegaVersion 2.79.0 */ "type": 'TABLE' | 'CELL'; } interface VegaRichTextTableSelectionWidget { } interface VegaRichTextTableSetting { /** * Indicates whether the current table already has a caption. * @vegaVersion 2.79.0 */ "hasCaption"?: boolean; /** * The selected cells in the table. * @vegaVersion 2.79.0 */ "selectedCells": RTETableCellBlock[]; /** * Specifies the target table element for the table setting. * @vegaVersion 2.79.0 */ "target": HTMLElement; } interface VegaSectionTitle { /** * Specifies the text content of the description displayed within the section title. * @vegaVersion 2.1.0 */ "description": string; /** * Specifies the icon displayed within the section title. * @vegaVersion 2.1.0 */ "icon": string; /** * Specifies the alignment of the icon relative to the title within the section title. * @vegaVersion 2.1.0 */ "iconAlign": IconAlignType; /** * Specifies the color of the icon displayed within the section title. * @vegaVersion 2.81.0 */ "iconColor": TextColorsTokenType; /** * Specifies the size of the section title. * @vegaVersion 2.81.0 */ "size": VegaSectionTitleSizeType; /** * Specifies the text content of the title displayed within the section title. * @vegaVersion 2.1.0 */ "titleText": string; } interface VegaSegmentControl { /** * Specifies whether the segment control spans the full width of its parent element. * @vegaVersion 2.3.0 */ "block": boolean; /** * Specifies the options available within the segment control. Please note that we advise against having more than four segments in a segment control. * @vegaVersion 2.3.0 */ "segments": VegaSegmentProps[]; /** * Specifies the key of the currently selected segment within the segment control. * @vegaVersion 2.3.0 */ "selected": string; /** * Specifies the size of the segment control. * @vegaVersion 2.3.0 */ "size": 'medium' | 'small'; /** * Specifies the variant of the segment control. The following options are available for the `variant` property: - `default`: The segment control is rendered with both icon and text if configured, - `text-only`: The segment control is rendered with text only regardless of the configuration of icon. - `icon-only`: The segment control is rendered with icon only, text will be showed as the icon's tooltip if configured. * @vegaVersion 2.3.0 */ "variant": VegaSegmentControlVariant; } interface VegaSelectionChip { /** * Defines the display behavior of the selection chip. This property controls how the chip is presented in relation to surrounding elements. * @vegaVersion 2.22.0 */ "block": boolean; /** * Determines if the selection chip is checked. * @vegaVersion 2.22.0 */ "checked": boolean; /** * Indicates if the selection chip is disabled. * @vegaVersion 2.22.0 */ "disabled": boolean; /** * Specifies the `vega-tooltip` displayed for the selection chip when it is in a disabled state. This provides additional context or information about the chip's functionality or reason for being disabled. * @vegaVersion 2.22.0 */ "disabledTooltip": VegaSelectionChipTooltipProps; /** * Specifies the label or title for the selection chip. It provides descriptive text that helps identify the purpose of the selection chip. * @vegaVersion 2.22.0 */ "label": string; /** * Specifies the size of the selection chip. * @vegaVersion 2.22.0 */ "size": ResponsiveType; /** * Defines the background color of the swatch. It accepts a string value representing a valid background color token, which customizes the chip appearance. * @vegaVersion 2.22.0 */ "swatchColor": BackgroundColorsTokenType; /** * Stores the value associated with the selection chip when it is checked or unchecked. * @vegaVersion 2.22.0 */ "value": string; /** * Determines the rendering style for the selection chip. * @vegaVersion 2.22.0 */ "variant": VegaSelectionChipVariant; } interface VegaSelectionChipGroup { /** * Indicates if the selection chip group is disabled. * @vegaVersion 2.22.0 */ "disabled": boolean; /** * Provides a supplementary prompt message that assists users in selecting the appropriate value for the selection chip group. * @vegaVersion 2.22.0 */ "hint": string; /** * Sets the validation status for the selection chip group. * @vegaVersion 2.22.0 */ "isValid": boolean; /** * Specifies the label or title for the selection chip group. It provides descriptive text that helps identify the purpose of the selection chip group. * @vegaVersion 2.22.0 */ "label": string; /** * Indicates whether at least one selection chip in the selection chip group must be checked to pass form validation. * @vegaVersion 2.22.0 */ "required": boolean; /** * Determines the selection method for the chip group. * @vegaVersion 2.22.0 */ "selectType": VegaSelectionChipGroupSelectType; /** * Defines custom validation rules for the selection chip group field. * @vegaVersion 2.22.0 */ "validationRules": FormFieldValidationRule[]; /** * Stores the selected values of the nested selection chips within the selection chip group. * @vegaVersion 2.22.0 */ "value": string | string[]; } interface VegaSelectionTile { /** * Determines if the selection tile is checked. * @vegaVersion 2.7.0 */ "checked": boolean; /** * Determines if the selection tile is disabled. * @vegaVersion 2.7.0 */ "disabled": boolean; /** * Specifies the text content of the note displayed within the selection tile. * @vegaVersion 2.7.0 */ "note": string; /** * Specifies the prefix icon displayed within the selection tile. * @vegaVersion 2.7.0 */ "prefixIcon": string; /** * Determines the selection method for the tile. Options are: - `radio`: Displays a radio button for selection. - `checkbox`: Displays a checkbox for selection. * @vegaVersion 2.7.0 */ "selectType": 'radio' | 'checkbox'; /** * Specifies the text content of the title displayed within the selection tile. * @vegaVersion 2.7.0 */ "titleText": string; /** * Determines the value that is associated with the selection-tile when it is checked or unchecked. * @vegaVersion 2.7.0 */ "value": string; } interface VegaSelectionTileGroup { /** * Indicates if the selection tile group is disabled. * @vegaVersion 2.7.0 */ "disabled": boolean; /** * Distribute vega-selection-tile components evenly to always cover the entire available width of the vega-selection-tile-group * @vegaVersion 2.58.0 */ "distributeEvenly": boolean; /** * Provides a supplementary prompt message that assists users in selecting the appropriate value for the selection tile group. * @vegaVersion 2.7.0 */ "hint": string; /** * Sets the validation status for the selection tile group. * @vegaVersion 2.7.0 */ "isValid": boolean; /** * Specifies the label or title for the selection tile group. It provides descriptive text that helps identify the purpose of the selection tile group. * @vegaVersion 2.7.0 */ "label": string; /** * Controls the layout of the nested selection tiles within the selection tile group. * @vegaVersion 2.7.0 */ "layout": 'vertical' | 'horizontal'; /** * Indicates whether at least one selection tile in the selection tile group must be checked to pass form validation. * @vegaVersion 2.7.0 */ "required": boolean; /** * Determines the selection method for the tile group. Options are: - `radio`: Displays a radio button for selection. - `checkbox`: Displays a checkbox for selection. * @vegaVersion 2.7.0 */ "selectType": 'radio' | 'checkbox'; /** * Defines custom validation rules for the selection tile group field. * @vegaVersion 2.7.0 */ "validationRules": FormFieldValidationRule[]; /** * Stores the selected values of the nested selection tiles within the selection tile group. * @vegaVersion 2.7.0 */ "value": string | string[]; } interface VegaSidenav { /** * Provides additional information or context in the form of a footnote in the side nav footer. * @vegaVersion 1, v2.29.0 */ "footnote": string; /** * Specifies the configuration for the header of the side nav, allowing customization of the logo and headline. * @vegaVersion 1, v2.29.0 */ "headerConfig": SidebarHeaderConfig; /** * Specifies the default open behavior for the side nav across different screen sizes and disables collapse for large screens. * @vegaVersion 1, v2.29.0 */ "openByDefault": ResponsiveType; /** * Defines the data that is used to generate the items in the side nav list. * @vegaVersion 1, v2.29.0 */ "source": SidebarTopLevelItem[]; /** * Invoke this method to toggle the side navigation menu. * @vegaVersion 1, v2.29.0 */ "toggle": () => Promise; } interface VegaSidenavGroup { /** * Represents the icon attached to the side navigation group header link. * @vegaVersion 1, v2.29.0 */ "icon": string; /** * Specifies the text that serves as the label or title for the side navigation group in the sidebar. * @vegaVersion 1, v2.29.0 */ "label": string; } interface VegaSidenavLink { /** * Specifies the icon displayed for the side navigation link. Icons are only displayed for top-level links. * @vegaVersion 1, v2.29.0 */ "icon": string; /** * Indicates whether the link item is selected. * @vegaVersion 1, v2.29.0 */ "selected": boolean; /** * Determines if the side nav should stay open when the sidenav-link element is clicked. * @vegaVersion 1, v2.29.0 */ "showSideBarOnClickLink": boolean; /** * Specifies the destination URL to which the side navigation link navigates when clicked. * @vegaVersion 1, v2.29.0 */ "url": string; } interface VegaSignatureCapture { /** * Determines whether the signature capture field should undergo automatic validation during the user's sign. * @vegaVersion 2.19.0 */ "autoValidation": boolean; /** * Invoke this method to clear the signature * @vegaVersion 2.19.0 */ "clear": () => Promise; /** * Specifies whether the signature capture is disabled. * @vegaVersion 2.19.0 */ "disabled": boolean; /** * Defines the height of the signature capture field. * @vegaVersion 2.20.0 */ "height": ResponsiveType; /** * Indicates whether the current value in the field is considered valid or invalid based on the defined validation rules. * @vegaVersion 2.19.0 */ "isValid": boolean | null; /** * Specifies the label or title for the signature capture. It provides descriptive text that helps identify the purpose or content expected in the signature capture. * @vegaVersion 2.19.0 */ "label": string; /** * Specifies the mode of the signature capture * @vegaVersion 2.19.0 */ "mode": VegaSignatureCaptureMode; /** * Specifies a placeholder string that displays as a temporary hint or example inside the signature capture. It indicates the expected format or pattern of the signature capture. * @vegaVersion 2.19.0 */ "placeholder": string; /** * Specifies an icon or symbol that appears before the placeholder, providing visual context or enhancing the aesthetic appearance of the signature capture. * @vegaVersion 2.19.0 * @defaultValue v-internal-icon signature */ "placeholderIcon": string; /** * Determines whether the signature capture field is required. * @vegaVersion 2.19.0 */ "required": boolean; /** * Determines whether the clear button is displayed. * @vegaVersion 2.19.0 */ "showClearBtn": boolean; /** * Defines custom validation rules for the signature capture field. * @vegaVersion 2.19.0 */ "validationRules": FormFieldValidationRule[]; /** * Specifies the value of the signature capture * @vegaVersion 2.19.0 */ "value": VegaSignatureValue | null; } interface VegaSkeleton { /** * Indicates whether the skeleton displays an animation effect. * @vegaVersion 2.15.0 */ "animated": boolean; /** * Defines the corner of the skeleton. It accepts a string value representing a valid border radius token. * @VegaHint This property is only valid for image types. * @vegaVersion 2.45.0 */ "corners": CornersType; /** * Specifies the height of the skeleton. - This property is applicable only when {@link type} is set to is `image` or `ellipse`. * @vegaVersion 2.15.0 */ "height": HeightType; /** * Specifies the type of the skeleton. * @vegaVersion 2.15.0 */ "type": VegaSkeletonType; /** * Specifies the width of the skeleton. * @vegaVersion 2.15.0 */ "width": WidthType; } interface VegaSlotContainer { } interface VegaStepper { /** * Determines whether automatic validation should be implemented for the stepper component. * @vegaVersion 1.18.0 */ "autoValidation": boolean; /** * Specifies the style variant for the stepper buttons. * @vegaVersion 1.19.0 */ "buttonVariant": 'primary' | 'secondary'; /** * Specifies whether the stepper component is disabled. * @vegaVersion 1.3.0 */ "disabled": boolean; /** * Specifies whether the input field of the stepper component is disabled. The increment and decrement buttons are unaffected by this setting. * @vegaVersion 1.31.0 */ "inputDisabled": boolean; /** * Specifies the validation status of the stepper component. * @vegaVersion 1.3.0 */ "isValid": boolean; /** * Provides a descriptive text or string that serves as the label or title for the stepper component. * @vegaVersion 1.0.5 */ "label": string; /** * Defines the upper limit or maximum value that can be incremented within the stepper component. * @vegaVersion 1.0.5 */ "max": number; /** * Defines the lower limit or minimum value that can be decremented within the stepper component. * @vegaVersion 1.0.5 */ "min": number; /** * Specifies the unique identifier for the stepper component. * @vegaVersion 1.3.0 */ "stepperId": string; /** * Defines the initial or current value of the stepper component. * @vegaVersion 1.0.5 */ "value": number; } interface VegaTabGroup { /** * Defines the spacing between the tabs in the tab group. * @vegaVersion 1.3.0 */ "gap": SpacingTokenType; /** * Specifies the overflow navigation for many tab items within the tab group. * @vegaVersion 2.49.0 */ "overflow": TabGroupOverflowType; /** * Defines the selector of the element that will contain the tab group popup. - If provided, the popup will be positioned relative to this element. - If not provided, the popup will be appended to the body element by default. * @VegaWarning The value of this property should be an element that is the parent of this component or an ancestor of the parent element. Using any other element may lead to unexpected behavior. * @vegaVersion 1.3.0 */ "positionRelativeTo": string; /** * Defines the data target for the selected tab within the tab group. * @vegaVersion 1.3.0 */ "selectedTabDataTarget": string; /** * Specifies whether the tabs in the tab group include a close button for closing the tab. * @vegaVersion 1.3.0 */ "showCloseButton": boolean; /** * Defines the tab items that appear within the tab group. The `tabItems` property can only be set once during initialization and cannot be overridden or modified dynamically. * @vegaVersion 1.3.0 */ "tabItems": TabConfig[]; /** * Specifies the visual style and prominence of the tab group. * @vegaVersion 1.39.0 */ "variant": TabGroupVariant; } interface VegaTabGroupPanel { /** * Controls the visibility of the tab panel within the tab group. * @vegaVersion 1.26.0 */ "isActive": boolean; } interface VegaTable { /** * Invoke this method to add a new row to the editable table. * @param record the default record of the new row * @returns the rowKey of the new row * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "addNewRow": (record?: VegaTableDataSourceItem) => Promise; /** * Invoke this method to clear the selected row keys, removing any current selection. * @vegaVersion 1.3.0 */ "clearSelection": () => Promise; /** * Invoke this method to close all expanded rows. * @vegaVersion 1.3.0 */ "closeAllExpandRow": () => Promise; /** * Invoke this method to close the expanded row with the specified `rowKey`. * @param rowKey * @vegaVersion 1.3.0 */ "closeExpandRow": (rowKey: string) => Promise; /** * Specifies whether dividers should be displayed between columns in the table. * @vegaVersion 1.3.0 */ "columnDivider": boolean; /** * Defines the columns of the table. * @vegaVersion 1.3.0 */ "columns": VegaTableColumnConfig[]; /** * Contains the data records to be rendered and displayed within the table. * @vegaVersion 1.3.0 */ "dataSource": VegaTableDataSourceItem[]; /** * Specifies the negative space within the table's cells. * @vegaVersion 1.3.0 */ "density": ResponsiveType; /** * Provides a customized message or description that is shown when the table's data source is empty. * @vegaVersion 1.7.0 */ "emptyDescription": string; /** * Invoke this method to obtain the keys of the rows currently in the editing mode in the table. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "getEditingRowsKey": () => Promise; /** * Invoke this method to retrieve the table row reference based on the provided `rowKey`. If the `rowKey` is empty, this method will return the reference to the table form. * @param optional rowKey * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "getFormRef": (rowKey?: string) => Promise; /** * Invoke this method to retrieve the data of the row with the specified `rowKey`, obtaining the complete set of information associated with that row. * @param rowKey The row's unique key. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "getRowData": (rowKey: string) => Promise; /** * Invoke this method to retrieve all rows of data, obtaining the complete set of information associated with each row. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "getRowsData": () => Promise; /** * Invoke this method to retrieve the selected row keys, provided an array or list of the keys representing the currently selected rows. * @vegaVersion 1.3.0 */ "getSelection": () => Promise; /** * Defines how columns can be grouped. * @vegaVersion 2.57.0 */ "groupColumns": VegaTableGroupColumnConfig[]; /** * Invoke this method to expand the row with the specified `rowKey`, revealing additional content. * @param rowKey * @vegaVersion 1.3.0 */ "openExpandRow": (rowKey: string) => Promise; /** * Controls the amount of horizontal padding applied to the table. * @vegaVersion 1.3.0 */ "paddingX": [string, string]; /** * Specifies the pagination configuration. * @vegaVersion 1.5.0 */ "pagination": VegaTablePagination; /** * Invoke this method to remove a row from the `currentData` based on the specified `rowKey` in the table. * @param rowKey The rowKey of the row to remove. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "removeRow": (rowKey: string) => Promise; /** * Specifies whether rows in the table can be clicked. If enabled, a `vegaRowClick` event will be dispatched when a row is clicked. * @vegaVersion 1.3.0 */ "rowClickable": boolean; /** * Specifies whether dividers should be displayed between rows in the table. * @vegaVersion 1.3.0 */ "rowDivider": boolean; /** * Indicates whether the row is expandable. * @vegaVersion 1.3.0 */ "rowExpandable": boolean; /** * Defines a unique key for each row in the table. * @vegaVersion 1.9.2 */ "rowKey": string; /** * Defines the behavior and options related to row selection in the table. It allows users to select one or more rows in the table for further actions or processing. * @vegaVersion 1.3.0 */ "rowSelection": VegaTableRowSelectionConfig; /** * Invoke this method to save the data of all edited rows to the `currentData` and stop the edit mode for all rows in the table. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "saveAllEditRows": () => Promise; /** * Invoke this method to save the edited row data to the `currentData` and stop the edit mode for that row. This action will not affect the editing mode of other rows. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "saveEditRow": (rowKey: string) => Promise; /** * Customizes the behavior and appearance of the scrollable container that wraps the table. * @vegaVersion 1.29.0 */ "scrollConfig"?: VegaTableScrollConfig; /** * Invoke this method to set the selected row keys, specifying an array or list of keys to represent the desired selected rows. * @param keys - Row keys to be set as selected. * @vegaVersion 1.3.0 */ "setSelection": (keys: string[]) => Promise; /** * Specifies whether the table header should be displayed. * @vegaVersion 1.3.0 */ "showHeader": boolean; /** * Defines the column sorting options Has optional property type: single | multiple If not specified, it defaults to multiple column sorting * @vegaVersion 2.22.0 */ "sortConfig"?: VegaTableSortConfig; /** * Invoke this method to start the edit mode for the row with the specified `rowKey`. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "startRowEditMode": (rowKey: string) => Promise; /** * Invoke this method to stop the edit mode for all rows, exiting the edit mode for each row currently in the editing state. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "stopAllRowEditMode": () => Promise; /** * Invoke this method to stop the edit mode for the row with the specified `rowKey`. * @VegaWarning Note: This method only works with editable tables. * @vegaVersion 1.19.0 */ "stopRowEditMode": (rowKey: string) => Promise; /** * Specifies whether alternate colors should be applied to the rows of the table. * @vegaVersion 1.3.0 */ "striped": boolean; /** * Invoke this method to toggle the expandable row with the specified `rowKey`, expanding it if it is currently collapsed and collapsing it if it is currently expanded. * @param rowKey * @vegaVersion 1.3.0 */ "toggleExpandRow": (rowKey: string) => Promise; } interface VegaTableBody { } interface VegaTableCell { /** * Defines the screen width at which the column becomes hidden. If not set, the column remains visible at all times. * @vegaVersion 1.44.0 */ "breakpoint"?: VegaTableColumnBreakpoint; /** * Determines the text overflow behavior within cells. `ellipsis`: Replaces overflowed text with ellipsis. `scroll`: Enables cell scrolling; scroll bars are displayed only when the content overflows, remaining hidden by default. * @vegaVersion 1.44.0 */ "overflow"?: 'ellipsis' | 'scroll'; /** * Determines the alignment of text within the cell. * @vegaVersion 1.44.0 */ "textAlign"?: 'left' | 'right' | 'center'; /** * Specifies the width of the cell. * @vegaVersion 1.44.0 */ "width"?: string; } interface VegaTableExpandRow { /** * Defines a unique key for the expandable row within the table. * @vegaVersion 1.44.0 */ "rowKey": string; /** * Specifies whether alternate colors should be applied to the expand row. * @vegaVersion 2.61.0 */ "striped": boolean; } interface VegaTableFoot { } interface VegaTableFootCell { /** * Defines the screen width at which the column becomes hidden. If not set, the column remains visible at all times. * @vegaVersion 2.68.1 */ "breakpoint"?: VegaTableColumnBreakpoint; /** * Determines the alignment of text within the foot cell. * @vegaVersion 2.68.1 */ "textAlign"?: 'left' | 'right' | 'center'; /** * Specifies the width of the foot cell. * @vegaVersion 2.68.1 */ "width"?: string; } interface VegaTableFootRow { } interface VegaTableHead { } interface VegaTableHeadCell { /** * Defines the screen width at which the column becomes hidden. If not set, the column remains visible at all times. * @vegaVersion 1.44.0 */ "breakpoint"?: VegaTableColumnBreakpoint; /** * Specifies the pinned type of the head cell. * @vegaVersion 2.57.0 */ "pinned"?: VegaTablePinnedType; /** * Specifies the sorting configuration for the table header cell. * @vegaVersion 2.42.0 */ "sortConfig"?: VegaTableSortConfig; /** * Defines the column's sorting order. * @vegaVersion 2.8.0 */ "sortOrder"?: VegaTableSortOrderType; /** * Defines the column's sorting configuration. * @vegaVersion 1.44.0 */ "sorter"?: VegaTableSorterConfig; /** * Determines the alignment of text within the head cell. * @vegaVersion 1.44.0 */ "textAlign"?: 'left' | 'right' | 'center'; /** * Specifies the width of the head cell. * @vegaVersion 1.44.0 */ "width"?: string; } interface VegaTableHeadRow { /** * Determines whether to hide the select all checkbox. * @vegaVersion 1.44.0 */ "hideSelectAll"?: boolean; /** * Indicates whether the checkbox is disabled. * @vegaVersion 1.44.0 */ "selectAllDisabled"?: boolean; } interface VegaTableRow { /** * Specifies whether dividers should be displayed in the row. * @vegaVersion 2.61.0 */ "rowDivider": boolean; /** * Defines a unique key for the row. * @vegaVersion 1.44.0 */ "rowKey": string; /** * Specifies whether alternate colors should be applied to the row. * @vegaVersion 2.61.0 */ "striped": boolean; } interface VegaText { /** * Specifies the behavior of text when it exceeds the available space within its container. * @vegaVersion 1.18.0 */ "overflow": 'ellipsis' | 'newline'; /** * Specifies the properties of the vega-tooltip in vega-text. * @vegaVersion 2.0.0 */ "tooltip": VegaTextTooltipProps; } interface VegaTextarea { /** * 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. * @default true * @vegaVersion 1.11.0 */ "autoValidation": boolean; /** * 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. * @default false * @vegaVersion 1.11.0 */ "disabled": boolean; /** * 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. * @default '' * @vegaVersion 1.11.0 */ "hint": string; /** * 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. * @default null * @vegaVersion 1.11.0 */ "isValid": boolean; /** * 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. * @default '' * @vegaVersion 1.11.0 */ "label": string; /** * 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. * @default null * @vegaVersion 2.68.0 */ "labelSuffixButtonConfig": Nullable; /** * 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 `