wave-ui 3.10.1 → 3.11.0

package/dist/types/components/WOverlay.d.ts

@@ -0,0 +1,118 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveOverlayProps {
+    /**
+     * ``value` in Vue 2.`
+     * This prop controls the visibility of the overlay. Any truthy value will show the overlay whereas any falsy value will hide it.
+     * @property {any} modelValue
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    modelValue?: any;
+    /**
+     * Sets a custom opacity on the overlay.
+     * @property {number|string|boolean} opacity
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    opacity?: number | string | boolean;
+    /**
+     * Applies a color to the overlay's background. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} bgColor
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    bgColor?: string;
+    /**
+     * Sets the CSS position of the overlay to `absolute`. By default it is set to `fixed`.
+     * @property {boolean} absolute
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    absolute?: boolean;
+    /**
+     * Applies a z-index (positive or negative integer) to the overlay.
+     * @property {number|string|boolean} zIndex
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    zIndex?: number | string | boolean;
+    /**
+     * When set to true, clicking outside of the overlay or pressing the escape key will not close the overlay.
+     * A bounce animation will give the user a feedback that the overlay content needs attention and cannot be closed.
+     * @property {boolean} persistent
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    persistent?: boolean;
+    /**
+     * When this and the `persistent` props are set to true, clicking outside of the overlay or pressing the escape key will not trigger the default bounce animation (no feedback is given to the user).
+     * @property {boolean} persistentNoAnimation
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    persistentNoAnimation?: boolean;
+}
+export interface WaveOverlayEmits {
+    /**
+     * Emitted on overlay close (a click on overlay doesn't trigger this event if <code>persistent</code>).<br>Updates the v-model value in Vue 2.x only.
+     * @param {any} renameMe1 - Represents the open state of the overlay: false on overlay close.
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'onInput'?: (renameMe1: any) => void;
+    /**
+     * Emitted on overlay close (a click on overlay doesn't trigger this event if <code>persistent</code>).<br>Updates the v-model value in Vue 3 only.
+     * @param {any} renameMe1 - Represents the open state of the overlay: false on overlay close.
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'onUpdate:modelValue'?: (renameMe1: any) => void;
+    /**
+     * Emitted on every overlay click. Whether the <code>persistent</code> prop is set to true or false.
+     * @param {any} renameMe1 - The associated click DOM event.
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'onClick'?: (renameMe1: any) => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'onBeforeClose'?: () => void;
+    /**
+     * Emitted on overlay close (a click on overlay doesn't trigger this event if <code>persistent</code>).
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'onClose'?: () => void;
+}
+export interface WaveOverlayComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    backgroundColor: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    classes: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    styles: ComputedGetter<any>;
+}
+export interface WaveOverlayMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @param {any} e
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    onClick(e: any): void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    onClose(): void;
+}
+export type WaveOverlaySlots = SlotsType<{
+    /**
+     * The overlay content, if any.
+     * @see https://antoniandre.github.io/wave-ui/w-overlay
+     */
+    'default': () => any;
+}>;
+export type WOverlay = DefineComponent<WaveOverlayProps, {}, {}, WaveOverlayComputeds, WaveOverlayMethods, {}, {}, WaveOverlayEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveOverlayProps & WaveOverlayEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveOverlayProps>, WaveOverlaySlots>;

package/dist/types/components/WOverlay.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/components/WProgress.d.ts

@@ -0,0 +1,177 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveProgressProps {
+    /**
+     * ``value` in Vue 2.`
+     * Accepts a percentage value (ranging from 0 to 100) as a number or a string.
+     * If the value is `undefined`, `-1` or not provided at all, it will be assumed indeterminate.
+     * @property {number|string|boolean} modelValue - Default: -1
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    modelValue?: number | string | boolean;
+    /**
+     * Shows or hides the label of the progress containing the current progress value.
+     * @property {boolean} label
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    label?: boolean;
+    /**
+     * Applies a round line-cap to the progress.
+     * @property {boolean} roundCap
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    roundCap?: boolean;
+    /**
+     * Applies a foreground color to the progress. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} color - Default: 'primary'
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a color to the progress' background. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} bgColor
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    bgColor?: string;
+    /**
+     * Applies a color to the progress label's text. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} labelColor
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    labelColor?: string;
+    /**
+     * Sets the size of the progress element: the width if circular, or the height if linear.
+     * Accepts a string made of a value and a unit (e.g. `2.5em`) or a number (e.g. `45`) that will be a pixel value.
+     * @property {number|string} size
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    size?: number | string;
+    /**
+     * Sets the progress style to circle.
+     * @property {boolean} circle
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    circle?: boolean;
+    /**
+     * Only applies to a circular progress.
+     * Sets the thickness of the circular progress.
+     * @property {number|string} stroke - Default: 4
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    stroke?: number | string;
+    /**
+     * Only applies to a linear progress.
+     * Applies a drop shadow to the progress bar.
+     * @property {boolean} shadow
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    shadow?: boolean;
+    /**
+     * Only applies to a linear progress.
+     * Removes the default border-radius and sets sharp edges on the progress bar.
+     * @property {boolean} tile
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    tile?: boolean;
+    /**
+     * Only applies to a linear progress.
+     * Sets a maximum border-radius on the corners of the progress, giving it a round look.
+     * @property {boolean} round
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    round?: boolean;
+    /**
+     * Only applies to a linear progress.
+     * When using the linear progress, the outline style applies the provided `color` (by default the `primary` color is used) to the progress, border and label and no background color is set.
+     * @property {boolean} outline
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    outline?: boolean;
+    /**
+     * Only applies to a linear progress.
+     * Applies an animated stripes background on the progress bar.
+     * @property {boolean} stripes
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    stripes?: boolean;
+    /**
+     * Sets the CSS position of the progress element to `absolute`.
+     * @property {boolean} absolute
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    absolute?: boolean;
+    /**
+     * Sets the CSS position of the progress element to `fixed`.
+     * @property {boolean} fixed
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    fixed?: boolean;
+    /**
+     * Places the progress element at the top of the screen when the `fixed` prop is set to true or at the top of its container when the `absolute` prop is set to true.
+     * @property {boolean} top
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    top?: boolean;
+    /**
+     * Places the progress element at the bottom of the screen when the `fixed` prop is set to true or at the bottom of its container when the `absolute` prop is set to true.
+     * @property {boolean} bottom
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    bottom?: boolean;
+    /**
+     * Applies a z-index (positive or negative integer) to the progress element.
+     * @property {number|string|boolean} zIndex
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    zIndex?: number | string | boolean;
+}
+export interface WaveProgressEmits {
+}
+export interface WaveProgressComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    progressValue: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    circleCenter: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    forcedSize: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    position: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    classes: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    styles: ComputedGetter<any>;
+}
+export interface WaveProgressMethods extends MethodOptions {
+}
+export type WaveProgressSlots = SlotsType<{
+    /**
+     * Provide a custom progress label.
+     * @see https://antoniandre.github.io/wave-ui/w-progress
+     */
+    'default': () => any;
+}>;
+export type WProgress = DefineComponent<WaveProgressProps, {}, {}, WaveProgressComputeds, WaveProgressMethods, {}, {}, WaveProgressEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveProgressProps & WaveProgressEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveProgressProps>, WaveProgressSlots>;

package/dist/types/components/WProgress.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/components/WRadio.d.ts

@@ -0,0 +1,121 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveRadioProps {
+    /**
+     * TODO: Add Description
+     * @property {any} wRadios - Default: null }
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    wRadios?: any;
+    /**
+     * ``value` in Vue 2.`
+     * Provide a boolean to dictate the selected state of the radio button.
+     * This value gets updated when using a v-model.
+     * @property {any} modelValue - Default: false
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    modelValue?: any;
+    /**
+     * Since the native HTML radio uses the `value` attribute to define the selected state, the `return-value` prop let you specify a value to return to the `v-model` when the radio is selected (instead of returning `true`).
+     * @property {any} returnValue
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    returnValue?: any;
+    /**
+     * Sets a visible label for the radio button.
+     * @property {string} label
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    label?: string;
+    /**
+     * Moves the label to the left of the radio button. By default the label is displayed on the right.
+     * @property {boolean} labelOnLeft
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    labelOnLeft?: boolean;
+    /**
+     * Applies a color to the radio button when active. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} color - Default: 'primary'
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a specific color to the radio button's label. Note that on validation failure, the validation-color takes precedence.
+     * Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} labelColor - Default: 'primary'
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    labelColor?: string;
+    /**
+     * Removes the ripple animation on select.
+     * @property {boolean} noRipple
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    noRipple?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} dark
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    dark?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} light
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    light?: boolean;
+}
+export interface WaveRadioEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    'onFocus'?: () => void;
+}
+export interface WaveRadioComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    hasLabel: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    classes: ComputedGetter<any>;
+}
+export interface WaveRadioMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    toggleFromOutside(): void;
+    /**
+     * TODO: Add Description
+     * @param {any} e
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    onInput(e: any): void;
+}
+export type WaveRadioSlots = SlotsType<{
+    /**
+     * The radio button label content.
+     * @see https://antoniandre.github.io/wave-ui/w-radio
+     */
+    'default': () => any;
+}>;
+export type WRadio = DefineComponent<WaveRadioProps, {}, {}, WaveRadioComputeds, WaveRadioMethods, {}, {}, WaveRadioEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveRadioProps & WaveRadioEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveRadioProps>, WaveRadioSlots>;

package/dist/types/components/WRadio.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/components/WRadios.d.ts

@@ -0,0 +1,129 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveRadiosProps {
+    /**
+     * An array of radio button items to display. Each item object should contain at least a `label` or a `value` attribute.
+     * @property {Array<any>} [items]
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    items: Array<any>;
+    /**
+     * ``value` in Vue 2.`
+     * Provide a value (of one of the `items` objects) to dictate the selected choice.
+     * This value gets updated when using a v-model.
+     * @property {string|number|boolean} modelValue
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    modelValue?: string | number | boolean;
+    /**
+     * Moves the label to the left of each radio button. By default the label is displayed on the right.
+     * @property {boolean} labelOnLeft
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    labelOnLeft?: boolean;
+    /**
+     * The property name (aka "key") in each item object where to find the label of the item (if any).
+     * @property {string} itemLabelKey - Default: 'label'
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    itemLabelKey?: string;
+    /**
+     * The property name (aka "key") in each item object where to find the value of the item (if any).
+     * @property {string} itemValueKey - Default: 'value'
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    itemValueKey?: string;
+    /**
+     * The property name (aka "key") in each item object where to find the color of the item (if any).
+     * @property {string} itemColorKey - Default: 'color'
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    itemColorKey?: string;
+    /**
+     * Displays all the radio buttons inline instead of in column.
+     * @property {boolean} inline
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    inline?: boolean;
+    /**
+     * Applies a color to the active radio buttons. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} color - Default: 'primary'
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a specific color to the radio buttons' labels. Note that on validation failure, the validation-color takes precedence.
+     * Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
+     * Providing a color hex, rgb(a) or hsl(a) will not work.
+     * @property {string} labelColor - Default: 'primary'
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    labelColor?: string;
+}
+export interface WaveRadiosEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    'onFocus'?: () => void;
+}
+export interface WaveRadiosComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    radioItems: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    classes: ComputedGetter<any>;
+}
+export interface WaveRadiosMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @param {any} item
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    onInput(item: any): void;
+    /**
+     * TODO: Add Description
+     * @param {any} item
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    getOriginalItem(item: any): void;
+}
+export type WaveRadiosSlots = SlotsType<{
+    /**
+     * TODO: Add Description
+     * @param {any} item TODO: Describe me!
+     * @param {any} index TODO: Describe me!
+     * @param {any} checked TODO: Describe me!
+     * @see https://antoniandre.github.io/wave-ui/w-radios
+     */
+    'item.x': (_: {
+        item: any;
+        index: any;
+        checked: any;
+    }) => any;
+} & {
+    [k in `item'${number}`]: (_: {
+        item: any;
+        index: any;
+        checked: any;
+    }) => any;
+}>;
+export type WRadios = DefineComponent<WaveRadiosProps, {}, {}, WaveRadiosComputeds, WaveRadiosMethods, {}, {}, WaveRadiosEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveRadiosProps & WaveRadiosEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveRadiosProps>, WaveRadiosSlots>;

package/dist/types/components/WRadios.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });