@vonage/vivid-vue 4.26.0 → 4.28.0

package/dist/generated/components/VMenu.types.d.ts

@@ -0,0 +1,51 @@
+import type { VwcMenuElement } from '@vonage/vivid';
+export interface VMenuEvents {
+    blur: FocusEvent & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    click: MouseEvent & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    close: CustomEvent<undefined> & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    focus: FocusEvent & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    input: Event & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    keydown: KeyboardEvent & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    keyup: KeyboardEvent & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+    open: CustomEvent<undefined> & {
+        target: VwcMenuElement;
+        currentTarget: VwcMenuElement;
+    };
+}
+export interface VMenuProps {
+    anchor?: string | HTMLElement;
+    autoDismiss?: boolean;
+    open?: boolean;
+    placement?: 'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end';
+    positionStrategy?: 'absolute' | 'fixed';
+    trigger?: 'auto' | 'legacy' | 'off';
+    onBlur?: (event: VMenuEvents['blur']) => void;
+    onClick?: (event: VMenuEvents['click']) => void;
+    onClose?: (event: VMenuEvents['close']) => void;
+    onFocus?: (event: VMenuEvents['focus']) => void;
+    onInput?: (event: VMenuEvents['input']) => void;
+    onKeydown?: (event: VMenuEvents['keydown']) => void;
+    onKeyup?: (event: VMenuEvents['keyup']) => void;
+    onOpen?: (event: VMenuEvents['open']) => void;
+}

package/{generated → dist/generated}/components/VMenu.vue2.d.ts

@@ -1,44 +1,26 @@
 import { PropType } from 'vue';
 import type { VwcMenuElement } from '@vonage/vivid';
-declare const _default: import("vue/types/v3-define-component").DefineComponent<{
-    /**
-     * ID or direct reference to the component's anchor element.
-     */
+declare const _default: import("vue/types/v3-define-component.js").DefineComponent<{
     anchor: {
         type: PropType<string | HTMLElement>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu will automatically close when focus moves away from it.
-     */
     autoDismiss: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu is open
-     */
     open: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * placement of the menu
-     */
     placement: {
         type: PropType<"top" | "right" | "bottom" | "left" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end">;
         default: undefined;
     };
-    /**
-     * The strategy-absolute attribute.
-     */
     positionStrategy: {
         type: PropType<"absolute" | "fixed">;
         default: undefined;
     };
-    /**
-     * Controls how the menu opens and closes itself.
-     */
     trigger: {
         type: PropType<"auto" | "legacy" | "off">;
         default: undefined;
@@ -47,55 +29,30 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcMenuElement | null>;
 }, import("vue").Data, {}, {
-    /**
-     * Collapses any expanded Menu Items.
-     */
     collapseExpandedItem(): void;
-    /**
-     * Moves focus into the menu. If there is a child with the `autofocus` attribute, it will be focused.
-     * Otherwise, the first focusable child will be focused.
-     */
     focus(): void;
     openChanged(_: boolean, newValue: boolean): void;
-}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "click" | "focus" | "input" | "keydown" | "keyup" | "open" | "close")[], string, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * ID or direct reference to the component's anchor element.
-     */
+}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, ("blur" | "click" | "focus" | "input" | "keydown" | "keyup" | "open" | "close")[], string, Readonly<import("vue").ExtractPropTypes<{
     anchor: {
         type: PropType<string | HTMLElement>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu will automatically close when focus moves away from it.
-     */
     autoDismiss: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu is open
-     */
     open: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * placement of the menu
-     */
     placement: {
         type: PropType<"top" | "right" | "bottom" | "left" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end">;
         default: undefined;
     };
-    /**
-     * The strategy-absolute attribute.
-     */
     positionStrategy: {
         type: PropType<"absolute" | "fixed">;
         default: undefined;
     };
-    /**
-     * Controls how the menu opens and closes itself.
-     */
     trigger: {
         type: PropType<"auto" | "legacy" | "off">;
         default: undefined;

package/{generated → dist/generated}/components/VMenu.vue3.d.ts

@@ -2,44 +2,26 @@ import { PropType } from 'vue';
 import type { VwcMenuElement } from '@vonage/vivid';
 import type { SlotsType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
-    /**
-     * ID or direct reference to the component's anchor element.
-     */
     anchor: {
         type: PropType<string | HTMLElement>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu will automatically close when focus moves away from it.
-     */
     autoDismiss: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu is open
-     */
     open: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * placement of the menu
-     */
     placement: {
         type: PropType<"top" | "right" | "bottom" | "left" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end">;
         default: undefined;
     };
-    /**
-     * The strategy-absolute attribute.
-     */
     positionStrategy: {
         type: PropType<"absolute" | "fixed">;
         default: undefined;
     };
-    /**
-     * Controls how the menu opens and closes itself.
-     */
     trigger: {
         type: PropType<"auto" | "legacy" | "off">;
         default: undefined;
@@ -48,202 +30,97 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcMenuElement | null>;
 }, unknown, {}, {
-    /**
-     * Collapses any expanded Menu Items.
-     */
     collapseExpandedItem(): void;
-    /**
-     * Moves focus into the menu. If there is a child with the `autofocus` attribute, it will be focused.
-     * Otherwise, the first focusable child will be focused.
-     */
     focus(): void;
     openChanged(_: boolean, newValue: boolean): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    /**
-     * Fires when the element loses focus.
-     * @type {FocusEvent}
-     */
     blur(event: FocusEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * 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.
-     * @type {MouseEvent}
-     */
     click(event: MouseEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fired when the menu is closed
-     * @type {CustomEvent<undefined>}
-     */
     close(event: CustomEvent<undefined> & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fires when the element receives focus.
-     * @type {FocusEvent}
-     */
     focus(event: FocusEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fires when the value of an element has been changed.
-     * @type {Event}
-     */
     input(event: Event & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fires when a key is pressed.
-     * @type {KeyboardEvent}
-     */
     keydown(event: KeyboardEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fires when a key is released.
-     * @type {KeyboardEvent}
-     */
     keyup(event: KeyboardEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
-    /**
-     * Fired when the menu is opened
-     * @type {CustomEvent<undefined>}
-     */
     open(event: CustomEvent<undefined> & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }): true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * ID or direct reference to the component's anchor element.
-     */
     anchor: {
         type: PropType<string | HTMLElement>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu will automatically close when focus moves away from it.
-     */
     autoDismiss: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * indicates whether the menu is open
-     */
     open: {
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * placement of the menu
-     */
     placement: {
         type: PropType<"top" | "right" | "bottom" | "left" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end">;
         default: undefined;
     };
-    /**
-     * The strategy-absolute attribute.
-     */
     positionStrategy: {
         type: PropType<"absolute" | "fixed">;
         default: undefined;
     };
-    /**
-     * Controls how the menu opens and closes itself.
-     */
     trigger: {
         type: PropType<"auto" | "legacy" | "off">;
         default: undefined;
     };
 }>> & {
     onKeydown?: ((event: KeyboardEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onBlur?: ((event: FocusEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onClick?: ((event: MouseEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onFocus?: ((event: FocusEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onInput?: ((event: Event & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onKeyup?: ((event: KeyboardEvent & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onOpen?: ((event: CustomEvent<undefined> & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
     onClose?: ((event: CustomEvent<undefined> & {
-        /**
-         * @deprecated Target may not refer to component in some cases. Use currentTarget instead.
-         */
         target: VwcMenuElement;
         currentTarget: VwcMenuElement;
     }) => any) | undefined;
@@ -255,21 +132,9 @@ declare const _default: import("vue").DefineComponent<{
     positionStrategy: "fixed" | "absolute";
     trigger: "auto" | "legacy" | "off";
 }, SlotsType<{
-    /**
-     * Used to add action items to the bottom of the menu.
-     */
     'action-items': Record<string, never>;
-    /**
-     * Used to set the anchor element for the menu.
-     */
     anchor: Record<string, never>;
-    /**
-     * Default slot.
-     */
     default: Record<string, never>;
-    /**
-     * Used to add additional content to the top of the menu.
-     */
     header: Record<string, never>;
 }>>;
 export default _default;

package/dist/generated/components/VMenuItem.types.d.ts

@@ -0,0 +1,60 @@
+import type { VwcMenuItemElement } from '@vonage/vivid';
+import type { IconId } from '../icons';
+export interface VMenuItemEvents {
+    blur: FocusEvent & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    change: CustomEvent<undefined> & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    click: MouseEvent & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    'expanded-change': CustomEvent<HTMLElement> & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    focus: FocusEvent & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    input: Event & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    keydown: KeyboardEvent & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    keyup: KeyboardEvent & {
+        target: VwcMenuItemElement;
+        currentTarget: VwcMenuItemElement;
+    };
+    'update:modelValue': boolean;
+}
+export interface VMenuItemProps {
+    checkAppearance?: 'normal' | 'tick-only';
+    checkTrailing?: boolean;
+    checked?: boolean;
+    modelValue?: boolean;
+    connotation?: 'cta' | 'accent';
+    controlType?: 'checkbox' | 'radio';
+    disabled?: boolean;
+    expanded?: boolean;
+    icon?: IconId;
+    role?: 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'presentation';
+    text?: string;
+    textSecondary?: string;
+    onBlur?: (event: VMenuItemEvents['blur']) => void;
+    onChange?: (event: VMenuItemEvents['change']) => void;
+    onClick?: (event: VMenuItemEvents['click']) => void;
+    onExpandedChange?: (event: VMenuItemEvents['expanded-change']) => void;
+    onFocus?: (event: VMenuItemEvents['focus']) => void;
+    onInput?: (event: VMenuItemEvents['input']) => void;
+    onKeydown?: (event: VMenuItemEvents['keydown']) => void;
+    onKeyup?: (event: VMenuItemEvents['keyup']) => void;
+    'onUpdate:modelValue'?: (event: VMenuItemEvents['update:modelValue']) => void;
+}