@globalpayments/vega 2.87.0-beta.1 → 2.88.0

package/dist/types/components.d.ts

@@ -5,12 +5,12 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { BackgroundColorsTokenType, BorderColorsTokenType, BordersTokenType, BreakpointsTokenType, ShadowsTokenType, SpacingTokenType, TextColorsTokenType, TypographyTokenType } from "./types/design-token.type";
 import { BorderStyleType, BoxDisplayType, CornersType, CssStatesType, DragDropEventPayload, 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";
@@ -56,6 +56,7 @@ import { VegaRTEExtension } from "./components/vega-rich-text-editor/extensions/
 import { RTETablePropertiesType, TableCellStylePropertiesMap, VegaRichTextEditorImage, VegaRTEColorSchema, VegaRTESourceEditConfig, VegaRTETextStyleItem, 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 { VegaRTESpecialCharacterCategory } from "./components/vega-rich-text-editor/extensions/special-characters/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";
@@ -111,6 +112,12 @@ export namespace Components {
           * @vegaVersion 1.3.0
          */
         "showExpandIcon": ResponsiveType<boolean>;
+        /**
+          * Specifies the background color of the accordion header row    (prefix icon, title and expand icon).  When unset, the header has no background of its own.
+          * @VegaWarning Note: To ensure sufficient visual contrast and maintain accessibility standards, avoid choosing a background color that closely matches the expand icon color (such as `bg-action`), as it may make the icon difficult to perceive.
+          * @vegaVersion 2.88.0
+         */
+        "titleBackgroundColor": BackgroundColorsTokenType;
     }
     interface VegaAppFooter {
         /**
@@ -695,7 +702,7 @@ export namespace Components {
         "enabledEventPreview": boolean;
         /**
           * Controls whether the calendar is editable, allowing users to interact with events and dates. When set to `false`, all interactive features such as clicking on events or dates will be disabled, making the calendar view-only.
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "eventEditable": boolean;
         /**
@@ -705,7 +712,7 @@ export namespace Components {
         "events": VegaCalendarRawEvent[];
         /**
           * A callback function that determines the visibility of action buttons in the event preview popover for each calendar event. It receives the raw event data and the associated date, and should return an object indicating which action buttons should be visible in the popover. This allows for dynamic customization of the event preview based on the specific event being clicked.
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "getEventPreviewActions": CalendarEventActionsCallback;
         /**
@@ -1008,6 +1015,7 @@ export namespace Components {
         "readOnly": boolean;
         /**
           * Specifies whether to display the copy button in the code block.
+          * @VegaWarning Only has effect when `readOnly` is `true`.
           * @vegaVersion 2.50.0
          */
         "showCopyButton": boolean;
@@ -1226,6 +1234,12 @@ export namespace Components {
           * @vegaVersion 1.11.0
          */
         "open": () => Promise<void>;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -1474,10 +1488,10 @@ export namespace Components {
          */
         "showYearMonthDropdowns": boolean;
         /**
-          * Renders the calendar picker in different sizes. Defaults to regular size
+          * Renders the calendar picker in different sizes. Defaults to regular size.    Responsive sizing is supported starting with version 2.88.0.
           * @vegaVersion 2.72.0
          */
-        "size": DatePickerCalendarSizeType;
+        "size": ResponsiveType<DatePickerCalendarSizeType>;
         /**
           * Specifies the calendar is static height.    It means the height of calendar will not change according to the number of weeks in the month.
           * @vegaVersion 2.72.0
@@ -1819,6 +1833,12 @@ export namespace Components {
           * @vegaVersion 1.10.0
          */
         "label": string;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `isFieldRequired` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -1867,6 +1887,12 @@ export namespace Components {
           * @vegaVersion 2.36.0
          */
         "maxCount": number | null;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * Specifies whether uploading a file is mandatory.
           * @vegaVersion 2.25.0
@@ -2320,6 +2346,12 @@ export namespace Components {
           * @vegaVersion 1.0.5
          */
         "name": string;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -2613,6 +2645,12 @@ export namespace Components {
           * @vegaVersion 2.66.0
          */
         "length": number;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -2687,6 +2725,12 @@ export namespace Components {
           * @vegaVersion 2.18.0
          */
         "label": string;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -3602,6 +3646,12 @@ export namespace Components {
           * @vegaVersion 2.34.0
          */
         "label": string;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * 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
@@ -3716,6 +3766,18 @@ export namespace Components {
          */
         "target": HTMLElement;
     }
+    interface VegaRichTextSpecialCharactersPanel {
+        /**
+          * The special character categories to display.
+          * @vegaVersion 2.88.0
+         */
+        "categories": VegaRTESpecialCharacterCategory[];
+        /**
+          * Resets the panel to its initial state (all categories, no hovered item) and moves focus to the category select. Called whenever the popover opens.
+          * @vegaVersion 2.88.0
+         */
+        "resetPanel": () => Promise<void>;
+    }
     interface VegaRichTextTableProperties {
         /**
           * @vegaVersion 2.79.0
@@ -4409,6 +4471,11 @@ export namespace Components {
           * @vegaVersion 1.3.0
          */
         "setSelection": (keys: string[]) => Promise<void>;
+        /**
+          * Indicates whether to show the form field error message in editing state.   When set to true, the error message will be shown below the form field, otherwise the error message will be hidden.
+          * @vegaVersion 2.87.0
+         */
+        "showEditError"?: boolean;
         /**
           * Specifies whether the table header should be displayed.
           * @vegaVersion 1.3.0
@@ -4635,6 +4702,12 @@ export namespace Components {
           * @vegaVersion 1.11.0
          */
         "minLength": number;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional": boolean;
         /**
           * Specifies a placeholder string that displays as a temporary hint or example within the text area. The placeholder text is shown when the field is empty and disappears once the user begins typing.  Use this to indicate the expected format or content of the input, for example `'Enter your comments here...'`.
           * @default ''
@@ -5107,6 +5180,10 @@ export interface VegaRichTextLinkEditorCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVegaRichTextLinkEditorElement;
 }
+export interface VegaRichTextSpecialCharactersPanelCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLVegaRichTextSpecialCharactersPanelElement;
+}
 export interface VegaRichTextTablePropertiesCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVegaRichTextTablePropertiesElement;
@@ -5676,6 +5753,12 @@ declare global {
         prototype: HTMLVegaRichTextLinkEditorElement;
         new (): HTMLVegaRichTextLinkEditorElement;
     };
+    interface HTMLVegaRichTextSpecialCharactersPanelElement extends Components.VegaRichTextSpecialCharactersPanel, HTMLStencilElement {
+    }
+    var HTMLVegaRichTextSpecialCharactersPanelElement: {
+        prototype: HTMLVegaRichTextSpecialCharactersPanelElement;
+        new (): HTMLVegaRichTextSpecialCharactersPanelElement;
+    };
     interface HTMLVegaRichTextTablePropertiesElement extends Components.VegaRichTextTableProperties, HTMLStencilElement {
     }
     var HTMLVegaRichTextTablePropertiesElement: {
@@ -5981,6 +6064,7 @@ declare global {
         "vega-rich-text-editor-toolbar-button": HTMLVegaRichTextEditorToolbarButtonElement;
         "vega-rich-text-image-editor": HTMLVegaRichTextImageEditorElement;
         "vega-rich-text-link-editor": HTMLVegaRichTextLinkEditorElement;
+        "vega-rich-text-special-characters-panel": HTMLVegaRichTextSpecialCharactersPanelElement;
         "vega-rich-text-table-properties": HTMLVegaRichTextTablePropertiesElement;
         "vega-rich-text-table-selection-widget": HTMLVegaRichTextTableSelectionWidgetElement;
         "vega-rich-text-table-setting": HTMLVegaRichTextTableSettingElement;
@@ -6073,6 +6157,12 @@ declare namespace LocalJSX {
           * @vegaVersion 1.3.0
          */
         "showExpandIcon"?: ResponsiveType<boolean>;
+        /**
+          * Specifies the background color of the accordion header row    (prefix icon, title and expand icon).  When unset, the header has no background of its own.
+          * @VegaWarning Note: To ensure sufficient visual contrast and maintain accessibility standards, avoid choosing a background color that closely matches the expand icon color (such as `bg-action`), as it may make the icon difficult to perceive.
+          * @vegaVersion 2.88.0
+         */
+        "titleBackgroundColor"?: BackgroundColorsTokenType;
     }
     interface VegaAppFooter {
         /**
@@ -6778,7 +6868,7 @@ declare namespace LocalJSX {
         "enabledEventPreview"?: boolean;
         /**
           * Controls whether the calendar is editable, allowing users to interact with events and dates. When set to `false`, all interactive features such as clicking on events or dates will be disabled, making the calendar view-only.
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "eventEditable"?: boolean;
         /**
@@ -6788,7 +6878,7 @@ declare namespace LocalJSX {
         "events"?: VegaCalendarRawEvent[];
         /**
           * A callback function that determines the visibility of action buttons in the event preview popover for each calendar event. It receives the raw event data and the associated date, and should return an object indicating which action buttons should be visible in the popover. This allows for dynamic customization of the event preview based on the specific event being clicked.
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "getEventPreviewActions"?: CalendarEventActionsCallback;
         /**
@@ -6830,7 +6920,7 @@ declare namespace LocalJSX {
         /**
           * An event emitter notifying that a calendar event edit action is triggered from the event preview popover.
           * @eventSemantics namespace:native
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "onEventEdit"?: (event: VegaCalendarCustomEvent<VegaCalendarEventEditInfo>) => void;
         /**
@@ -6861,7 +6951,7 @@ declare namespace LocalJSX {
         "onVegaEventClick"?: (event: VegaCalendarCustomEvent<VegaCalendarEventClickInfo>) => void;
         /**
           * An event emitter notifying that a calendar event edit action is triggered from the event preview popover.
-          * @vegaVersion 2.87.0-beta.1
+          * @vegaVersion 2.87.0
          */
         "onVegaEventEdit"?: (event: VegaCalendarCustomEvent<VegaCalendarEventEditInfo>) => void;
         /**
@@ -7207,6 +7297,7 @@ declare namespace LocalJSX {
         "readOnly"?: boolean;
         /**
           * Specifies whether to display the copy button in the code block.
+          * @VegaWarning Only has effect when `readOnly` is `true`.
           * @vegaVersion 2.50.0
          */
         "showCopyButton"?: boolean;
@@ -7481,6 +7572,12 @@ declare namespace LocalJSX {
           * @vegaVersion 1.24.0
          */
         "onVegaSearch"?: (event: VegaComboBoxCustomEvent<string>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -7741,6 +7838,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.72.0
          */
         "onSelectionChange"?: (event: VegaDatePickerCalendarCustomEvent<string | string[]>) => void;
+        /**
+          * An event emitter notifying the today button is clicked in the date picker.
+          * @eventSemantics namespace:native
+          * @vegaVersion 2.88.0
+         */
+        "onTodayClick"?: (event: VegaDatePickerCalendarCustomEvent<string>) => void;
         /**
           * An event emitter notifying the change of the value in the date picker,    whether triggered programmatically or through user interaction.
           * @vegaVersion 2.72.0
@@ -7756,6 +7859,11 @@ declare namespace LocalJSX {
           * @vegaVersion 2.72.0
          */
         "onVegaSelectionChange"?: (event: VegaDatePickerCalendarCustomEvent<string | string[]>) => void;
+        /**
+          * An event emitter notifying the today button is clicked in the date picker.
+          * @vegaVersion 2.88.0
+         */
+        "onVegaTodayClick"?: (event: VegaDatePickerCalendarCustomEvent<string>) => void;
         /**
           * Specifies the selected date or date range in the date picker calendar.
           * @vegaVersion 2.72.0
@@ -7767,10 +7875,10 @@ declare namespace LocalJSX {
          */
         "showYearMonthDropdowns"?: boolean;
         /**
-          * Renders the calendar picker in different sizes. Defaults to regular size
+          * Renders the calendar picker in different sizes. Defaults to regular size.    Responsive sizing is supported starting with version 2.88.0.
           * @vegaVersion 2.72.0
          */
-        "size"?: DatePickerCalendarSizeType;
+        "size"?: ResponsiveType<DatePickerCalendarSizeType>;
         /**
           * Specifies the calendar is static height.    It means the height of calendar will not change according to the number of weeks in the month.
           * @vegaVersion 2.72.0
@@ -8180,6 +8288,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.25.0
          */
         "onVegaLabelButtonClick"?: (event: VegaFieldLabelCustomEvent<any>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `isFieldRequired` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -8283,6 +8397,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.25.0
          */
         "onVegaSelectedFileChange"?: (event: VegaFileUploaderCustomEvent<VegaFileUploaderFiles>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * Specifies whether uploading a file is mandatory.
           * @vegaVersion 2.25.0
@@ -8836,6 +8956,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.75.0
          */
         "onVegaSuggestionItemClick"?: (event: VegaInputCustomEvent<VegaDropdownSourceItem>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -9194,6 +9320,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.66.0
          */
         "onVegaComplete"?: (event: VegaInputPasscodeCustomEvent<string>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -9294,6 +9426,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.18.0
          */
         "onVegaCountryChange"?: (event: VegaInputPhoneNumberCustomEvent<VegaCountryType>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -10403,6 +10541,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.78.0
          */
         "onVegaSourceCodeChange"?: (event: VegaRichTextEditorCustomEvent<string>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * 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
@@ -10543,6 +10687,23 @@ declare namespace LocalJSX {
          */
         "target"?: HTMLElement;
     }
+    interface VegaRichTextSpecialCharactersPanel {
+        /**
+          * The special character categories to display.
+          * @vegaVersion 2.88.0
+         */
+        "categories"?: VegaRTESpecialCharacterCategory[];
+        /**
+          * Emitted when a character cell is clicked. The payload is the Unicode character string.
+          * @vegaVersion 2.88.0
+         */
+        "onClick"?: (event: VegaRichTextSpecialCharactersPanelCustomEvent<string>) => void;
+        /**
+          * Emitted when a character cell is clicked. The payload is the Unicode character string.
+          * @vegaVersion 2.88.0
+         */
+        "onVegaClick"?: (event: VegaRichTextSpecialCharactersPanelCustomEvent<string>) => void;
+    }
     interface VegaRichTextTableProperties {
         /**
           * @vegaVersion 2.79.0
@@ -11359,6 +11520,11 @@ declare namespace LocalJSX {
           * @vegaVersion 1.29.0
          */
         "scrollConfig"?: VegaTableScrollConfig;
+        /**
+          * Indicates whether to show the form field error message in editing state.   When set to true, the error message will be shown below the form field, otherwise the error message will be hidden.
+          * @vegaVersion 2.87.0
+         */
+        "showEditError"?: boolean;
         /**
           * Specifies whether the table header should be displayed.
           * @vegaVersion 1.3.0
@@ -11633,6 +11799,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.68.0
          */
         "onVegaLabelButtonClick"?: (event: VegaTextareaCustomEvent<any>) => void;
+        /**
+          * Indicates whether the field should be presented as optional.  This property only takes effect when `required` is `false`. When `true`, an "optional" label is displayed next to the field label.
+          * @default false
+          * @vegaVersion 2.88.0
+         */
+        "optional"?: boolean;
         /**
           * Specifies a placeholder string that displays as a temporary hint or example within the text area. The placeholder text is shown when the field is empty and disappears once the user begins typing.  Use this to indicate the expected format or content of the input, for example `'Enter your comments here...'`.
           * @default ''
@@ -12008,6 +12180,7 @@ declare namespace LocalJSX {
         "vega-rich-text-editor-toolbar-button": VegaRichTextEditorToolbarButton;
         "vega-rich-text-image-editor": VegaRichTextImageEditor;
         "vega-rich-text-link-editor": VegaRichTextLinkEditor;
+        "vega-rich-text-special-characters-panel": VegaRichTextSpecialCharactersPanel;
         "vega-rich-text-table-properties": VegaRichTextTableProperties;
         "vega-rich-text-table-selection-widget": VegaRichTextTableSelectionWidget;
         "vega-rich-text-table-setting": VegaRichTextTableSetting;
@@ -12133,6 +12306,7 @@ declare module "@stencil/core" {
             "vega-rich-text-editor-toolbar-button": LocalJSX.VegaRichTextEditorToolbarButton & JSXBase.HTMLAttributes<HTMLVegaRichTextEditorToolbarButtonElement>;
             "vega-rich-text-image-editor": LocalJSX.VegaRichTextImageEditor & JSXBase.HTMLAttributes<HTMLVegaRichTextImageEditorElement>;
             "vega-rich-text-link-editor": LocalJSX.VegaRichTextLinkEditor & JSXBase.HTMLAttributes<HTMLVegaRichTextLinkEditorElement>;
+            "vega-rich-text-special-characters-panel": LocalJSX.VegaRichTextSpecialCharactersPanel & JSXBase.HTMLAttributes<HTMLVegaRichTextSpecialCharactersPanelElement>;
             "vega-rich-text-table-properties": LocalJSX.VegaRichTextTableProperties & JSXBase.HTMLAttributes<HTMLVegaRichTextTablePropertiesElement>;
             "vega-rich-text-table-selection-widget": LocalJSX.VegaRichTextTableSelectionWidget & JSXBase.HTMLAttributes<HTMLVegaRichTextTableSelectionWidgetElement>;
             "vega-rich-text-table-setting": LocalJSX.VegaRichTextTableSetting & JSXBase.HTMLAttributes<HTMLVegaRichTextTableSettingElement>;

package/dist/types/constants/ui.d.ts

@@ -13,5 +13,5 @@ export declare const FlexWrap: readonly ["nowrap", "wrap", "wrap-reverse"];
 export declare const BoxDisplay: readonly ["block", "inline-block", "none"];
 export declare const BorderStyle: readonly ["solid", "dashed", "dotted", "double", "none"];
 export declare const TextAlign: readonly ["start", "end", "left", "right", "center", "justify"];
-export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "rowExpand", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "searchTrigger", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateDblClick", "dateClick", "countryChange", "actionButtonClick", "moreActionClick", "expand", "rowSelect", "rowSelectAll", "retry", "selectedFileChange", "preview", "labelButtonClick", "imageInserted", "reset", "eventPreviewShow", "monthYearChange", "complete", "paste", "clear", "periodChange", "selectionChange", "suggestionItemClick", "nativeInputChange", "sourceCodeChange", "rowDragDrop", "eventEdit"];
+export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "rowExpand", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "searchTrigger", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateDblClick", "dateClick", "countryChange", "actionButtonClick", "moreActionClick", "expand", "rowSelect", "rowSelectAll", "retry", "selectedFileChange", "preview", "labelButtonClick", "imageInserted", "reset", "eventPreviewShow", "monthYearChange", "complete", "paste", "clear", "periodChange", "selectionChange", "suggestionItemClick", "nativeInputChange", "sourceCodeChange", "rowDragDrop", "eventEdit", "todayClick"];
 export declare const CssStates: readonly ["default", "hover", "active", "focus-visible"];

package/dist/types/helpers/event-manager/event-id/vega-event-id.d.ts

@@ -100,6 +100,7 @@ export declare const VegaPaste: VegaEventID;
 export declare const HTMLNativeEventIds: VegaEventID[];
 export declare const VegaMonthYearChange: VegaEventID;
 export declare const VegaSelectionChange: VegaEventID;
+export declare const VegaTodayClick: VegaEventID;
 export declare const VegaSuggestionItemClick: VegaEventID;
 export declare const VegaNativeInputChange: VegaEventID;
 export declare const VegaSourceCodeChange: VegaEventID;

package/dist/types/helpers/slimmers/component-value-history-controller-slimmer.abstract.d.ts

@@ -5,6 +5,7 @@ import { KeyboardManagerSlimmer } from './keyboard-manager-slimmer';
 export declare abstract class ComponentValueHistoryControllerSlimmer<T> extends KeyboardManagerSlimmer {
   protected redoStack: T[];
   protected undoStack: T[];
+  protected hasPendingHistory: boolean;
   private readonly registerHistoryDelay;
   private readonly registerHistoryDebounced;
   constructor();
@@ -16,6 +17,18 @@ export declare abstract class ComponentValueHistoryControllerSlimmer<T> extends
    * @param {boolean} [isForce] - If true, the history will be registered immediately without debounce.
    */
   registerHistory(editorState: T, isForce?: boolean): void;
+  /**
+   * Checks whether the undo stack has a previous state to restore.
+   *
+   * @returns {boolean} - True if undo is available.
+   */
+  canUndo(): boolean;
+  /**
+   * Checks whether the redo stack has a state to restore.
+   *
+   * @returns {boolean} - True if redo is available.
+   */
+  canRedo(): boolean;
   /**
    * Internal function to register history immediately.
    *

package/dist/types/helpers/theme/controllers/action-color-accessibility-validator.d.ts

@@ -0,0 +1,10 @@
+import { VegaColorTokenContrastChecker } from '../../../vega-color-token-contrast-checker/src/index';
+import { VegaThemeOverrideColors } from '../theme';
+export type { ColorContrastDetail, ContrastCheckResult as ActionColorAccessibilityResult, } from '../../../vega-color-token-contrast-checker/src/index';
+/**
+ * Process-lifetime singleton: a {@link VegaColorTokenContrastChecker} pre-bound
+ * to vega-stencil's design-token table and override-themes generator. Consumers
+ * call `.validate(overrideColors)` and `.computeContrastCapPatches(overrideColors)`
+ * directly — no per-call configuration needed.
+ */
+export declare const vegaAccessibilityValidator: VegaColorTokenContrastChecker<VegaThemeOverrideColors>;

package/dist/types/helpers/theme/internal-theme-manager.d.ts

@@ -1,4 +1,5 @@
 import { BrandOptions, VegaThemeOverrideColors } from './theme';
+import type { ActionColorAccessibilityResult } from './controllers/action-color-accessibility-validator';
 import './controllers/dark-mode-style-controller';
 import './controllers/brand-style-controller';
 /**
@@ -7,7 +8,11 @@ import './controllers/brand-style-controller';
 declare class InternalThemeManager {
   private currentBranding;
   /**
-   * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme
+   * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme.
+   *
+   * When `overrideColors.overrideTokenMap` is provided (typically the `contrastCapPatches`
+   * returned by `validateColorAccessibility()`), matching tokens in the generated theme are replaced
+   * with the patched values before applying.
    *
    * @param {VegaThemeOverrideColors} overrideColors - OverrideColors - This is the object that you pass to the function.
    */
@@ -43,6 +48,28 @@ declare class InternalThemeManager {
    * @param {BrandOptions} options - The options includes 'gp', 'genius' and 'heartland' options
    */
   applyBranding(options: BrandOptions): void;
+  /**
+   * Validate a full `VegaThemeOverrideColors` payload against WCAG 2.1 AA thresholds
+   * without applying any theme changes.
+   *
+   * Reports each failing token (those fixable by choosing a different `actionColor`) with
+   * its actual and required contrast ratios. Also returns `contrastCapPatches` — a map of
+   * token-level repairs for tokens whose formula hard-caps contrast below the threshold.
+   * Pass the patches back via `overrideColors({ ..., overrideTokenMap: result.contrastCapPatches })`
+   * to apply them at override time.
+   *
+   * @param {VegaThemeOverrideColors} overrideColors The same input accepted by `overrideColors()`
+   * @returns {Promise<ActionColorAccessibilityResult>} Per-token contrast report with patches
+   */
+  validateColorAccessibility(overrideColors: VegaThemeOverrideColors): Promise<ActionColorAccessibilityResult>;
+  /**
+   * Replace tokens in the generated theme array with values from the provided patch map.
+   *
+   * @param {OverrideColor[]} themes - Generated override theme entries.
+   * @param {Record<string, string>} patchMap - Token name → patched CSS value map.
+   * @returns {OverrideColor[]} Theme array with matching tokens patched.
+   */
+  private applyTokenMapPatches;
 }
 export declare const VegaInternalThemeManager: InternalThemeManager;
 export {};

package/dist/types/helpers/theme/theme-manager.d.ts

@@ -1,4 +1,5 @@
 import { BrandOptions, VegaThemeOverrideColors } from './theme';
+import type { ActionColorAccessibilityResult } from './controllers/action-color-accessibility-validator';
 import './controllers/dark-mode-style-controller';
 import { VegaPublicAPIRuntimeMetricsSlimmerBase } from '../slimmers/runtime-metrics/public-api-runtime-metrics-slimmer-base';
 /**
@@ -7,7 +8,11 @@ import { VegaPublicAPIRuntimeMetricsSlimmerBase } from '../slimmers/runtime-metr
 declare class ThemeManager {
   protected vegaPublicAPIRuntimeMetricsSlimmer: VegaPublicAPIRuntimeMetricsSlimmerBase;
   /**
-   * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme
+   * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme.
+   *
+   * When `overrideColors.overrideTokenMap` is provided (typically the `contrastCapPatches`
+   * returned by `validateColorAccessibility()`), matching tokens in the generated theme are replaced
+   * with the patched values before applying.
    *
    * @param {VegaThemeOverrideColors} overrideColors - OverrideColors - This is the object that you pass to the function.
    * @vegaVersion 1.20.0
@@ -43,6 +48,24 @@ declare class ThemeManager {
    * @vegaVersion 2.47.0
    */
   applyBranding(options: BrandOptions): void;
+  /**
+   * Validate a full override-color payload against WCAG 2.1 AA thresholds (light mode only)
+   * without applying any theme changes.
+   *
+   * Returns per-token contrast details, a suggested accessible `actionColor`, and
+   * `contrastCapPatches` — token-level repairs for tokens whose formula hard-caps contrast
+   * below the threshold. Pass the patches back via
+   * `overrideColors({ ..., overrideTokenMap: result.contrastCapPatches })` to apply them.
+   *
+   * Note: Only `actionColor`-driven tokens are validated. `sidebarColor` tokens are not
+   * evaluated by this method. The `actionColor` value must be a 3- or 6-digit hex string
+   * (with optional leading `#`).
+   *
+   * @param {VegaThemeOverrideColors} overrideColors The same payload passed to `overrideColors()`
+   * @returns {Promise<ActionColorAccessibilityResult>} Per-token contrast report with patches
+   * @vegaVersion 2.88.0
+   */
+  validateColorAccessibility(overrideColors: VegaThemeOverrideColors): Promise<ActionColorAccessibilityResult>;
 }
 export declare const VegaThemeManager: ThemeManager;
 export {};

package/dist/types/helpers/theme/theme.d.ts

@@ -10,6 +10,14 @@ type OverrideRgbaValue = {
 export type VegaThemeOverrideColors = {
 	actionColor?: string;
 	sidebarColor?: string;
+	/**
+	 * Optional token-level overrides returned by `validateColorAccessibility()` as `contrastCapPatches`.
+	 * When provided, these CSS values are applied on top of the generated theme, replacing
+	 * tokens whose formula hard-caps contrast below the WCAG threshold.
+	 *
+	 * Keys are token names (e.g. `"ring-input-focus"`), values are CSS `r g b / a` strings.
+	 */
+	overrideTokenMap?: Record<string, string>;
 };
 
 export type OverrideColor = {