@vonage/vivid-vue 3.2.3 → 3.4.0

package/dist/generated/components/VCheckbox.vue2.d.ts

@@ -0,0 +1,226 @@
+import { PropType } from 'vue';
+import type { Checkbox } from '@vonage/vivid/lib/checkbox/checkbox';
+/**
+ * Base class for checkbox
+ */
+declare const _default: import("vue/types/v3-define-component").DefineComponent<{
+    /**
+     * The success text for the form element.
+     */
+    successText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The error text for the form element.
+     */
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The helper text for the form element.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The label for the form element.
+     */
+    label: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Indicates the element that represents the current item within a container or set of related elements.
+     */
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+        default: undefined;
+    };
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * 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.
+     */
+    currentValue: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * Provides the default checkedness of the input element
+     */
+    checked: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The current checkedness of the element. This property serves as a mechanism
+     * to set the `checked` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's checkedness
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    modelValue: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     */
+    readonly: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+}, {
+    componentName: import("vue").Ref<string>;
+    element: import("vue").Ref<Checkbox | null>;
+}, import("vue").Data, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("click" | "focus" | "blur" | "keydown" | "keyup" | "input" | "update:modelValue")[], string, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The success text for the form element.
+     */
+    successText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The error text for the form element.
+     */
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The helper text for the form element.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The label for the form element.
+     */
+    label: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Indicates the element that represents the current item within a container or set of related elements.
+     */
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+        default: undefined;
+    };
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * 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.
+     */
+    currentValue: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * Provides the default checkedness of the input element
+     */
+    checked: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The current checkedness of the element. This property serves as a mechanism
+     * to set the `checked` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's checkedness
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    modelValue: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     */
+    readonly: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+}>>, {
+    name: string;
+    ariaCurrent: "page" | "step" | "location" | "date" | "time" | "true" | "false";
+    value: string;
+    disabled: boolean;
+    currentValue: string;
+    required: boolean;
+    label: string;
+    modelValue: boolean;
+    successText: string;
+    errorText: string;
+    helperText: string;
+    checked: boolean;
+    readonly: boolean;
+}>;
+export default _default;

package/dist/generated/components/VCheckbox.vue3.d.ts

@@ -0,0 +1,234 @@
+import { PropType } from 'vue';
+import type { Checkbox } from '@vonage/vivid/lib/checkbox/checkbox';
+/**
+ * Base class for checkbox
+ */
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The success text for the form element.
+     */
+    successText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The error text for the form element.
+     */
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The helper text for the form element.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The label for the form element.
+     */
+    label: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Indicates the element that represents the current item within a container or set of related elements.
+     */
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+        default: undefined;
+    };
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * 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.
+     */
+    currentValue: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * Provides the default checkedness of the input element
+     */
+    checked: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The current checkedness of the element. This property serves as a mechanism
+     * to set the `checked` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's checkedness
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    modelValue: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     */
+    readonly: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+}, {
+    componentName: import("vue").Ref<string>;
+    element: import("vue").Ref<Checkbox | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "focus" | "blur" | "keydown" | "keyup" | "input" | "update:modelValue")[], "click" | "focus" | "blur" | "keydown" | "keyup" | "input" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The success text for the form element.
+     */
+    successText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The error text for the form element.
+     */
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The helper text for the form element.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The label for the form element.
+     */
+    label: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Indicates the element that represents the current item within a container or set of related elements.
+     */
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+        default: undefined;
+    };
+    /**
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
+     */
+    disabled: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * 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.
+     */
+    currentValue: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     */
+    name: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * Require the field to be completed prior to form submission.
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * Provides the default checkedness of the input element
+     */
+    checked: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * The current checkedness of the element. This property serves as a mechanism
+     * to set the `checked` property through both property assignment and the
+     * .setAttribute() method. This is useful for setting the field's checkedness
+     * in UI libraries that bind data through the .setAttribute() API
+     * and don't support IDL attribute binding.
+     */
+    modelValue: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+    /**
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     */
+    readonly: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
+}>> & {
+    onKeydown?: ((...args: any[]) => any) | undefined;
+    onClick?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    onBlur?: ((...args: any[]) => any) | undefined;
+    onKeyup?: ((...args: any[]) => any) | undefined;
+    onInput?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    name: string;
+    ariaCurrent: "page" | "step" | "location" | "date" | "time" | "true" | "false";
+    value: string;
+    disabled: boolean;
+    currentValue: string;
+    required: boolean;
+    label: string;
+    modelValue: boolean;
+    successText: string;
+    errorText: string;
+    helperText: string;
+    checked: boolean;
+    readonly: boolean;
+}>;
+export default _default;