@vonage/vivid-vue 4.21.1 → 4.22.0

package/generated/components/VRangeSlider.types.d.ts

@@ -0,0 +1,238 @@
+import type { VwcRangeSliderElement } from '@vonage/vivid';
+export interface VRangeSliderEvents {
+    /**
+     * Fires when the element loses focus.
+     */
+    blur: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Event emitted when either the start or end value changes.
+     */
+    change: CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    click: MouseEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Fires when the element receives focus.
+     */
+    focus: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Event emitted when either the start or end value changes.
+     */
+    input: CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Event emitted when the end value changes
+     */
+    'input:end': CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Event emitted when the start value changes
+     */
+    'input:start': CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Fires when a key is pressed.
+     */
+    keydown: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Fires when a key is released.
+     */
+    keyup: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRangeSliderElement;
+        currentTarget: VwcRangeSliderElement;
+    };
+    /**
+     * Fires when the end value changes
+     */
+    'update:end': string;
+    /**
+     * Fires when the start value changes
+     */
+    'update:start': string;
+}
+export interface VRangeSliderProps {
+    /**
+     * Aria label for the end thumb
+     */
+    ariaEndLabel?: string;
+    /**
+     * Aria label for the start thumb
+     */
+    ariaStartLabel?: string;
+    /**
+     * The connotation of the component
+     */
+    connotation?: 'accent' | 'cta';
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled?: boolean;
+    /**
+     * The current end value of the element. This property serves as a mechanism
+     * to set the `end` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's value
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    end?: string;
+    /**
+     * The initial end value. This value sets the `end` property
+     * only when the `end` property has not been explicitly set.
+     */
+    initialEnd?: string;
+    /**
+     * The initial start value. This value sets the `start` property
+     * only when the `start` property has not been explicitly set.
+     */
+    initialStart?: string;
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    initialValue?: string;
+    /**
+     * The label for the form element.
+     */
+    label?: string;
+    /**
+     * Display markers on/off
+     */
+    markers?: boolean;
+    /**
+     * The maximum value of the range.
+     */
+    max?: number;
+    /**
+     * The minimum value of the range.
+     */
+    min?: number;
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name?: string;
+    /**
+     * The orientation of the slider.
+     */
+    orientation?: 'horizontal' | 'vertical';
+    /**
+     * Show current values on the thumbs.
+     */
+    pin?: boolean;
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required?: boolean;
+    /**
+     * The current start value of the element. This property serves as a mechanism
+     * to set the `start` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's value
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    start?: string;
+    /**
+     * Value to increment or decrement via arrow keys, mouse click or drag.
+     */
+    step?: number;
+    /**
+     * The current value of the element. This property serves as a mechanism
+     * to set the `value` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's value
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    value?: string;
+    /**
+     * Fires when the element loses focus.
+     */
+    onBlur?: (event: VRangeSliderEvents['blur']) => void;
+    /**
+     * Event emitted when either the start or end value changes.
+     */
+    onChange?: (event: VRangeSliderEvents['change']) => void;
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    onClick?: (event: VRangeSliderEvents['click']) => void;
+    /**
+     * Fires when the element receives focus.
+     */
+    onFocus?: (event: VRangeSliderEvents['focus']) => void;
+    /**
+     * Event emitted when either the start or end value changes.
+     */
+    onInput?: (event: VRangeSliderEvents['input']) => void;
+    /**
+     * Event emitted when the end value changes
+     */
+    'onInput:end'?: (event: VRangeSliderEvents['input:end']) => void;
+    /**
+     * Event emitted when the start value changes
+     */
+    'onInput:start'?: (event: VRangeSliderEvents['input:start']) => void;
+    /**
+     * Fires when a key is pressed.
+     */
+    onKeydown?: (event: VRangeSliderEvents['keydown']) => void;
+    /**
+     * Fires when a key is released.
+     */
+    onKeyup?: (event: VRangeSliderEvents['keyup']) => void;
+    /**
+     * Fires when the end value changes
+     */
+    'onUpdate:end'?: (event: VRangeSliderEvents['update:end']) => void;
+    /**
+     * Fires when the start value changes
+     */
+    'onUpdate:start'?: (event: VRangeSliderEvents['update:start']) => void;
+}

package/generated/components/VRichTextEditor.types.d.ts

@@ -0,0 +1,91 @@
+import type { VwcRichTextEditorElement } from '@vonage/vivid';
+export interface VRichTextEditorEvents {
+    /**
+     * Fires when the element loses focus.
+     */
+    blur: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    click: MouseEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+    /**
+     * Fires when the element receives focus.
+     */
+    focus: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+    /**
+     * Fires when the value of an element has been changed.
+     */
+    input: Event & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+    /**
+     * Fires when a key is pressed.
+     */
+    keydown: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+    /**
+     * Fires when a key is released.
+     */
+    keyup: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcRichTextEditorElement;
+        currentTarget: VwcRichTextEditorElement;
+    };
+}
+export interface VRichTextEditorProps {
+    selectionEnd?: number;
+    selectionStart?: number;
+    /**
+     * Fires when the element loses focus.
+     */
+    onBlur?: (event: VRichTextEditorEvents['blur']) => void;
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    onClick?: (event: VRichTextEditorEvents['click']) => void;
+    /**
+     * Fires when the element receives focus.
+     */
+    onFocus?: (event: VRichTextEditorEvents['focus']) => void;
+    /**
+     * Fires when the value of an element has been changed.
+     */
+    onInput?: (event: VRichTextEditorEvents['input']) => void;
+    /**
+     * Fires when a key is pressed.
+     */
+    onKeydown?: (event: VRichTextEditorEvents['keydown']) => void;
+    /**
+     * Fires when a key is released.
+     */
+    onKeyup?: (event: VRichTextEditorEvents['keyup']) => void;
+}

package/generated/components/VRichTextEditor.vue2.d.ts

@@ -13,10 +13,11 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRichTextEditorElement | null>;
 }, import("vue").Data, {}, {
+    focus(): unknown;
     selectionEndChanged(): unknown;
     selectionStartChanged(): unknown;
     setSelectionDecoration(decoration: string): unknown;
-    setTextSize(size: "title" | "subtitle" | "body"): unknown;
+    setTextBlock(blockType: "title" | "subtitle" | "body"): unknown;
 }, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "click" | "focus" | "input" | "keydown" | "keyup")[], string, Readonly<import("vue").ExtractPropTypes<{
     selectionEnd: {
         type: PropType<number>;

package/generated/components/VRichTextEditor.vue3.d.ts

@@ -14,10 +14,11 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRichTextEditorElement | null>;
 }, unknown, {}, {
+    focus(): unknown;
     selectionEndChanged(): unknown;
     selectionStartChanged(): unknown;
     setSelectionDecoration(decoration: string): unknown;
-    setTextSize(size: "title" | "subtitle" | "body"): unknown;
+    setTextBlock(blockType: "title" | "subtitle" | "body"): unknown;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     /**
      * Fires when the element loses focus.

package/generated/components/VSearchableSelect.types.d.ts

@@ -0,0 +1,216 @@
+import type { VwcSearchableSelectElement } from '@vonage/vivid';
+import type { IconId } from '../icons';
+export interface VSearchableSelectEvents {
+    /**
+     * Fires when the element loses focus.
+     */
+    blur: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fired when the selected options change
+     */
+    change: CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    click: MouseEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fires when the element receives focus.
+     */
+    focus: FocusEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fired when the selected options change
+     */
+    input: CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fires when a key is pressed.
+     */
+    keydown: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fires when a key is released.
+     */
+    keyup: KeyboardEvent & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fired when the search text changes
+     */
+    'search-text-change': CustomEvent<undefined> & {
+        /**
+         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
+         */
+        target: VwcSearchableSelectElement;
+        currentTarget: VwcSearchableSelectElement;
+    };
+    /**
+     * Fires when the modelValue value changes
+     */
+    'update:modelValue': string;
+    /**
+     * Fires when the values value changes
+     */
+    'update:values': string[];
+}
+export interface VSearchableSelectProps {
+    appearance?: 'fieldset' | 'ghost';
+    /**
+     * Adds a clear button to the input field that clears the selected values.
+     */
+    clearable?: boolean;
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled?: boolean;
+    /**
+     * The error text for the form element.
+     */
+    errorText?: string;
+    externalTags?: boolean;
+    fixedDropdown?: boolean;
+    /**
+     * The helper text for the form element.
+     */
+    helperText?: string;
+    /**
+     * A decorative icon the custom element should have.
+     * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
+     */
+    icon?: IconId;
+    /**
+     * Indicates the icon affix alignment.
+     */
+    iconTrailing?: boolean;
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    initialValue?: string;
+    /**
+     * The label for the form element.
+     */
+    label?: string;
+    /**
+     * Whether the component is in a loading state.
+     */
+    loading?: boolean;
+    maxLines?: number;
+    multiple?: boolean;
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name?: string;
+    open?: boolean;
+    /**
+     * Function to filter the options to display.
+     */
+    optionFilter?: any;
+    placeholder?: string;
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required?: boolean;
+    shape?: 'rounded' | 'pill';
+    /**
+     * The success text for the form element.
+     */
+    successText?: string;
+    /**
+     * The current value of the element. This property serves as a mechanism
+     * to set the `value` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's value
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    value?: string;
+    /**
+     * The current value of the element. This property serves as a mechanism
+     * to set the `value` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's value
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    modelValue?: string;
+    /**
+     * List of selected option values.
+     */
+    values?: string[];
+    /**
+     * Fires when the element loses focus.
+     */
+    onBlur?: (event: VSearchableSelectEvents['blur']) => void;
+    /**
+     * Fired when the selected options change
+     */
+    onChange?: (event: VSearchableSelectEvents['change']) => void;
+    /**
+     * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
+     */
+    onClick?: (event: VSearchableSelectEvents['click']) => void;
+    /**
+     * Fires when the element receives focus.
+     */
+    onFocus?: (event: VSearchableSelectEvents['focus']) => void;
+    /**
+     * Fired when the selected options change
+     */
+    onInput?: (event: VSearchableSelectEvents['input']) => void;
+    /**
+     * Fires when a key is pressed.
+     */
+    onKeydown?: (event: VSearchableSelectEvents['keydown']) => void;
+    /**
+     * Fires when a key is released.
+     */
+    onKeyup?: (event: VSearchableSelectEvents['keyup']) => void;
+    /**
+     * Fired when the search text changes
+     */
+    onSearchTextChange?: (event: VSearchableSelectEvents['search-text-change']) => void;
+    /**
+     * Fires when the modelValue value changes
+     */
+    'onUpdate:modelValue'?: (event: VSearchableSelectEvents['update:modelValue']) => void;
+    /**
+     * Fires when the values value changes
+     */
+    'onUpdate:values'?: (event: VSearchableSelectEvents['update:values']) => void;
+}