wave-ui 3.10.0 → 3.11.0

package/dist/types/components/WCard.js

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

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

@@ -0,0 +1,132 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveCheckboxProps {
+    /**
+     * TODO: Add Description
+     * @property {any} wCheckboxes - Default: null
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    wCheckboxes?: any;
+    /**
+     * ``value` in Vue 2.`
+     * Provide a boolean to dictate the checked state the checkbox.
+     * This value gets updated when using a v-model.
+     * @property {any} modelValue - Default: false
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    modelValue?: any;
+    /**
+     * Since the native HTML checkbox element uses the `value` attribute to define the checked state, the `return-value` prop let you specify a value to return to the `v-model` when the checkbox is checked (instead of returning `true`).
+     * @property {any} returnValue
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    returnValue?: any;
+    /**
+     * Sets a visible label for the checkbox.
+     * @property {string} label
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    label?: string;
+    /**
+     * Moves the label to the left of the checkbox. By default the label is displayed on the right.
+     * @property {boolean} labelOnLeft
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    labelOnLeft?: boolean;
+    /**
+     * Applies a color to the checkbox 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-checkbox
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a specific color to the checkbox'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-checkbox
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    labelColor?: string;
+    /**
+     * Removes the ripple animation on check.
+     * @property {boolean} noRipple
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    noRipple?: boolean;
+    /**
+     * Applies an indeterminate state on the checkbox. E.g. when it represents the selected state of a collection of elements where some are checked and some not.
+     * @property {boolean} indeterminate
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    indeterminate?: boolean;
+    /**
+     * Displays a round checkbox instead of a square one.
+     * @property {boolean} round
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    round?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} dark
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    dark?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} light
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    light?: boolean;
+}
+export interface WaveCheckboxEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    'onFocus'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    'onBlur'?: () => void;
+}
+export interface WaveCheckboxComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    hasLabel: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    classes: ComputedGetter<any>;
+}
+export interface WaveCheckboxMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    onInput(): void;
+}
+export type WaveCheckboxSlots = SlotsType<{
+    /**
+     * The checkbox label content.
+     * @see https://antoniandre.github.io/wave-ui/w-checkbox
+     */
+    'default': () => any;
+}>;
+export type WCheckbox = DefineComponent<WaveCheckboxProps, {}, {}, WaveCheckboxComputeds, WaveCheckboxMethods, {}, {}, WaveCheckboxEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveCheckboxProps & WaveCheckboxEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveCheckboxProps>, WaveCheckboxSlots>;

package/dist/types/components/WCheckbox.js

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

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

@@ -0,0 +1,141 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveCheckboxesProps {
+    /**
+     * An array of checkbox 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-checkboxes
+     */
+    items: Array<any>;
+    /**
+     * ``value` in Vue 2.`
+     * Provide an array of values to dictate the checked state of all the checkboxes.
+     * This value gets updated when using a v-model.
+     * @property {Array<any>} modelValue
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    modelValue?: Array<any>;
+    /**
+     * Moves the label to the left of each checkbox.
+     * @property {boolean} labelOnLeft
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    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-checkboxes
+     */
+    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-checkboxes
+     */
+    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-checkboxes
+     */
+    itemColorKey?: string;
+    /**
+     * Displays all the checkboxes inline instead of in column.
+     * @property {boolean} inline
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    inline?: boolean;
+    /**
+     * Displays round checkboxes instead of square ones.
+     * @property {boolean} round
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    round?: boolean;
+    /**
+     * Applies a color to the active checkbox. 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-checkboxes
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a specific color to the checkboxes 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-checkboxes
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    labelColor?: string;
+}
+export interface WaveCheckboxesEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    'onFocus'?: () => void;
+}
+export interface WaveCheckboxesComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    checkboxItems: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    classes: ComputedGetter<any>;
+}
+export interface WaveCheckboxesMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    reset(): void;
+    /**
+     * TODO: Add Description
+     * @param {any} checkbox
+     * @param {any} isChecked
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    toggleCheck(checkbox: any, isChecked: any): void;
+    /**
+     * TODO: Add Description
+     * @param {any} item
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    getOriginalItem(item: any): void;
+}
+export type WaveCheckboxesSlots = SlotsType<{
+    /**
+     * TODO: Add Description
+     * @param {any} item TODO: Describe me!
+     * @param {any} checked TODO: Describe me!
+     * @param {any} index TODO: Describe me!
+     * @see https://antoniandre.github.io/wave-ui/w-checkboxes
+     */
+    'item.x': (_: {
+        item: any;
+        checked: any;
+        index: any;
+    }) => any;
+} & {
+    [k in `item'${number}`]: (_: {
+        item: any;
+        checked: any;
+        index: any;
+    }) => any;
+}>;
+export type WCheckboxes = DefineComponent<WaveCheckboxesProps, {}, {}, WaveCheckboxesComputeds, WaveCheckboxesMethods, {}, {}, WaveCheckboxesEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveCheckboxesProps & WaveCheckboxesEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveCheckboxesProps>, WaveCheckboxesSlots>;

package/dist/types/components/WCheckboxes.js

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

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

@@ -0,0 +1,250 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveConfirmProps {
+    /**
+     * Applies a color to the main button's background.
+     * If no `color` and no `bg-color` are set, and if neither `outline` nor `text` are set to true, the `primary` color will be applied.
+     * 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-confirm
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    bgColor?: string;
+    /**
+     * Applies a color to the main button's text.
+     * If no `color` and no `bg-color` are set, and if either `outline` or `text` is set to true, the `primary` color will be applied.
+     * 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
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Sets the button to a round icon style, containing only an icon.
+     * Accepts a string: e.g. `mdi mdi-home`.
+     * @property {string} icon
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    icon?: string;
+    /**
+     * TODO: Add Description
+     * @property {boolean} disablePrompt
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    disablePrompt?: boolean;
+    /**
+     * For more customization, this prop accepts an object of props to pass down to the main button (all the options that the `w-button` component can handle).
+     * @property {{}} mainButton
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    mainButton?: {};
+    /**
+     * TODO: Add Description
+     * @property {string} question - Default: 'Are you sure?'
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    question?: string;
+    /**
+     * Accept either `false` to remove the button, a `String` for the button label, or an `Object` in order to define `w-button` props to further customize it (all the options that the `w-button` component can handle).
+     * In addition to all the `w-button` props, the object also accepts a `label` key to customize the button label.
+     * The default button label is "Cancel".
+     * @property {boolean|{}|string} cancel - Default: undefined
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    cancel?: boolean | {} | string;
+    /**
+     * Accept either a `String` for the button label, or an `Object` in order to define `w-button` props to further customize it (all the options that the `w-button` component can handle).
+     * In addition to all the `w-button` props, the object also accepts a `label` key to customize the button label.
+     * The default button label is "Confirm".
+     * @property {{}|string} confirm
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    confirm?: {} | string;
+    /**
+     * Displays the question inline with the buttons, inside the menu.
+     * @property {boolean} inline
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    inline?: boolean;
+    /**
+     * For more customization, this prop accepts an object of props to pass down to the menu (all the options that the `w-menu` component can handle).
+     * @property {{}} menu - Default: () => ({})
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    menu?: {};
+    /**
+     * Accept either `false` for no tooltip (by default), a `String` to display as a tooltip on the main button, or an `Object` in order to define `w-tooltip` props to further customize the tooltip (all the options that the `w-tooltip` component can handle).
+     * In addition to all the `w-tooltip` props, the object also accepts a `label` key to provide the tooltip string in the object.
+     * By default, the tooltip shows on hover, and at the bottom.
+     * @property {boolean|{}|string} tooltip
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    tooltip?: boolean | {} | string;
+    /**
+     * By default the confirmation menu displays an arrow pointing toward the main button.
+     * The arrow can simply be removed with this prop.
+     * @property {boolean} noArrow
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    noArrow?: boolean;
+    /**
+     * Places the menu above the main button.
+     * @property {boolean} top
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    top?: boolean;
+    /**
+     * Places the below the main button.
+     * @property {boolean} bottom
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    bottom?: boolean;
+    /**
+     * Places the menu on the left of the main button.
+     * @property {boolean} left
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    left?: boolean;
+    /**
+     * Places the menu at the right of the main button.
+     * @property {boolean} right
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    right?: boolean;
+    /**
+     * Aligns the top of the menu with the top of the main button.
+     * @property {boolean} alignTop
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    alignTop?: boolean;
+    /**
+     * Aligns the bottom of the menu with the bottom of the main button.
+     * @property {boolean} alignBottom
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    alignBottom?: boolean;
+    /**
+     * Aligns the left side of the menu with the left side of the main button.
+     * @property {boolean} alignLeft
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    alignLeft?: boolean;
+    /**
+     * Aligns the right side of the menu with the right side of the main button.
+     * @property {boolean} alignRight
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    alignRight?: boolean;
+    /**
+     * When set to `true`, clicking outside of the menu will not close the menu.
+     * @property {boolean} persistent
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    persistent?: boolean;
+    /**
+     * Applies a particular transition to the menu element when showing and hiding.
+     * Accepts all the transitions listed in the `transitions` knowledge base page. You can also disable the transition by setting this prop to an empty string.
+     * @property {string} transition
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     * @see https://antoniandre.github.io/wave-ui//transitions
+     */
+    transition?: string;
+    /**
+     * TODO: Add Description
+     * @property {boolean} dark
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    dark?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} light
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    light?: boolean;
+}
+export interface WaveConfirmEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'onCancel'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'onConfirm'?: () => void;
+}
+export interface WaveConfirmComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    cancelButton: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    cancelButtonProps: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    confirmButton: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    confirmButtonProps: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    wMenuProps: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    tooltipObject: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    buttonProps: ComputedGetter<any>;
+}
+export interface WaveConfirmMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    onCancel(): void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    onConfirm(): void;
+}
+export type WaveConfirmSlots = SlotsType<{
+    /**
+     * The main button contents.
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'default': () => any;
+    /**
+     * The question to ask for confirmation in the menu.
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'question': () => any;
+    /**
+     * The cancel button contents, in the menu.
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'cancel': () => any;
+    /**
+     * The confirm button contents, in the menu.
+     * @see https://antoniandre.github.io/wave-ui/w-confirm
+     */
+    'confirm': () => any;
+}>;
+export type WConfirm = DefineComponent<WaveConfirmProps, {}, {}, WaveConfirmComputeds, WaveConfirmMethods, {}, {}, WaveConfirmEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveConfirmProps & WaveConfirmEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveConfirmProps>, WaveConfirmSlots>;

package/dist/types/components/WConfirm.js

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