wave-ui 3.10.0 → 3.11.0

package/dist/types/components/WMenu.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 WaveMenuProps {
+    /**
+     * ``value` in Vue 2.`
+     * This prop controls the visibility of the menu. Any truthy value will show the menu whereas any falsy value will hide it.
+     * @property {any} modelValue
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    modelValue?: any;
+    /**
+     * Triggers the menu apparition on activator hover instead of click by default. A mouseleave on the activator will hide the menu.
+     * @property {boolean} showOnHover
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    showOnHover?: boolean;
+    /**
+     * Hides the menu when a click is made inside the menu. For instance when selecting a list item inside a menu.
+     * @property {boolean} hideOnMenuClick
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    hideOnMenuClick?: boolean;
+    /**
+     * Applies a color to the menu'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} color
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a color to the menu'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-menu
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    bgColor?: string;
+    /**
+     * Applies a drop shadow to the menu element.
+     * @property {boolean} shadow
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    shadow?: boolean;
+    /**
+     * By default, the menu layout is a `w-card`. To have more flexibility, you can set this option to `true`.
+     * @property {boolean} custom
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    custom?: boolean;
+    /**
+     * Removes the default border-radius and sets sharp edges on the menu.
+     * @property {boolean} tile
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    tile?: boolean;
+    /**
+     * Sets a maximum border-radius on the corners of the menu, giving it a round look.
+     * @property {boolean} round
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    round?: boolean;
+    /**
+     * Removes the default border from the menu element.
+     * @property {boolean} noBorder
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    noBorder?: 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-menu
+     * @see https://antoniandre.github.io/wave-ui/transitions
+     */
+    transition?: string;
+    /**
+     * Provide custom CSS classes for the menu element.
+     * @property {string|{}|Array<any>} menuClass
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    menuClass?: string | {} | Array<any>;
+    /**
+     * Provide custom CSS classes for the menu's title when using the default card layout (when not using the `custom` prop).
+     * @property {string|{}|Array<any>} titleClass
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    titleClass?: string | {} | Array<any>;
+    /**
+     * Provide custom CSS classes for the menu's content when using the default card layout (when not using the `custom` prop).
+     * @property {string|{}|Array<any>} contentClass
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    contentClass?: string | {} | Array<any>;
+    /**
+     * Adds a small triangle on the edge of the menu, pointing toward the activator.
+     * @property {boolean} arrow
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    arrow?: boolean;
+    /**
+     * Sets a min-width on the menu.
+     * 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} minWidth
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    minWidth?: number | string;
+    /**
+     * Displays a full screen overlay underneath the menu (uses the `w-overlay` component).
+     * @property {boolean} overlay
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    overlay?: boolean;
+    /**
+     * Provide custom CSS classes for the `w-overlay` component.
+     * @property {string|{}|Array<any>} overlayClass
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    overlayClass?: string | {} | Array<any>;
+    /**
+     * An object of props to pass down to the `w-overlay` component for more control.
+     * @property {{}} overlayProps
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    overlayProps?: {};
+    /**
+     * 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-menu
+     */
+    persistent?: boolean;
+    /**
+     * A delay - in milliseconds - before opening the menu.
+     * A small delay may help the menu position computing if the menu content changes at the moment the activator is activated. For instance, when defining multiple activators opening the same menu with different content.
+     * @property {number} delay
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    delay?: number;
+    /**
+     * TODO: Add Description
+     * @property {boolean} dark
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    dark?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} light
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    light?: boolean;
+}
+export interface WaveMenuEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'onOpen'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'onClose'?: () => void;
+}
+export interface WaveMenuComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    transitionName: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    menuMinWidth: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    menuClasses: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    titleClasses: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    contentClasses: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    overlayClasses: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    classes: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    styles: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    activatorEventHandlers: ComputedGetter<any>;
+}
+export interface WaveMenuMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @param {any} e
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    toggle(e: any): void;
+}
+export type WaveMenuSlots = SlotsType<{
+    /**
+     * `This slot is required and must have the `v-on="on"` directive set on it for the menu to toggle correctly.`
+     * The activator can be any visible DOM element or mounted component.
+     * @param {any} on TODO: Describe me!
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'activator': (_: {
+        on: any;
+    }) => any;
+    /**
+     * The menu content.
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'default': () => any;
+    /**
+     * By default (when `custom` is set to false), the menu uses a `w-card`. This slot allows a custom title for the `w-card`.
+     * @see https://antoniandre.github.io/wave-ui/w-menu
+     */
+    'title': () => any;
+}>;
+export type WMenu = DefineComponent<WaveMenuProps, {}, {}, WaveMenuComputeds, WaveMenuMethods, {}, {}, WaveMenuEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveMenuProps & WaveMenuEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveMenuProps>, WaveMenuSlots>;

package/dist/types/components/WMenu.js

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

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

@@ -0,0 +1,283 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveNotificationProps {
+    /**
+     * ``value` in Vue 2.`
+     * This prop controls the visibility of the notification. Any truthy value will show the notification whereas any falsy value will hide it.
+     * @property {any} modelValue - Default: true
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    modelValue?: any;
+    /**
+     * Applies a particular transition to the notification when showing and hiding.
+     * Check all the transitions that apply to the notification in the `Transitions` example.
+     * @property {string|boolean} transition - Default: ''
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     * @see https://antoniandre.github.io/wave-ui/#transitions
+     */
+    transition?: string | boolean;
+    /**
+     * Sets a timer to hide a visible notification after a certain amount of milliseconds. E.g. `2000` will hide the notification after 2 seconds. A value of `0` or empty string will keep the notification persistent (no timeout).
+     * @property {number|string} timeout - Default: 0
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    timeout?: number | string;
+    /**
+     * Sets the CSS position of the notification to `absolute` (fixed by default).
+     * @property {boolean} absolute
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    absolute?: boolean;
+    /**
+     * Places the notification at the top of the screen or at the top of its container if the `absolute` prop is set to true.
+     * @property {boolean} top
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    top?: boolean;
+    /**
+     * Places the notification at the bottom of the screen or at the bottom of its container if the `absolute` prop is set to true.
+     * @property {boolean} bottom
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    bottom?: boolean;
+    /**
+     * Places the notification at the left of the screen or at the left of its container if the `absolute` prop is set to true.
+     * @property {boolean} left
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    left?: boolean;
+    /**
+     * Places the notification at the right of the screen or at the right of its container if the `absolute` prop is set to true.
+     * @property {boolean} right
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    right?: boolean;
+    /**
+     * Applies a z-index (positive or negative integer) to the notification.
+     * @property {number|string|boolean} zIndex
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    zIndex?: number | string | boolean;
+    /**
+     * Sets the type of the notification, applying the `success` class (green color) and adding a success icon on the left in the notification.
+     * @property {boolean} success
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    success?: boolean;
+    /**
+     * Sets the type of the notification, applying the `info` class (blue color) and adding an info icon on the left in the notification.
+     * @property {boolean} info
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    info?: boolean;
+    /**
+     * Sets the type of the notification, applying the `warning` class (orange color) and adding a warning icon on the left in the notification.
+     * @property {boolean} warning
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    warning?: boolean;
+    /**
+     * Sets the type of the notification, applying the `error` class (red color) and adding an error icon on the left in the notification.
+     * @property {boolean} error
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    error?: boolean;
+    /**
+     * Applies a color to the notification'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} color
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    color?: string;
+    /**
+     * Applies a color to the notification'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-notification
+     * @see https://antoniandre.github.io/wave-ui/colors
+     */
+    bgColor?: string;
+    /**
+     * Applies a drop shadow to the notification.
+     * @property {boolean} shadow
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    shadow?: boolean;
+    /**
+     * Removes the default border-radius and sets sharp edges on the notification.
+     * @property {boolean} tile
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    tile?: boolean;
+    /**
+     * Sets a maximum border-radius on the corners of the notification, giving it a round look.
+     * @property {boolean} round
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    round?: boolean;
+    /**
+     * Emphasizes a "typed" notification (one of `success`, `info`, `warning`, `error`) by applying a white text color and a full opacity background of the chosen type color.
+     * @property {boolean} plain
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    plain?: boolean;
+    /**
+     * Removes the default border from the notification container.
+     * @property {boolean} noBorder
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    noBorder?: boolean;
+    /**
+     * Adds a left border on the notification. Only one side-border can be applied at the same time.
+     * @property {boolean} borderLeft
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    borderLeft?: boolean;
+    /**
+     * Adds a right border on the notification. Only one side-border can be applied at the same time.
+     * @property {boolean} borderRight
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    borderRight?: boolean;
+    /**
+     * Adds a top border on the notification. Only one side-border can be applied at the same time.
+     * @property {boolean} borderTop
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    borderTop?: boolean;
+    /**
+     * Adds a bottom border on the notification. Only one side-border can be applied at the same time.
+     * @property {boolean} borderBottom
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    borderBottom?: boolean;
+    /**
+     * The outline style applies the provided `color` (by default the color is inherited) to the text and border and no background color is set.
+     * @property {boolean} outline
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    outline?: boolean;
+    /**
+     * Adds a close button (cross icon) on the right in the notification. Clicking on this button hides the notification.
+     * @property {boolean} dismiss
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    dismiss?: boolean;
+    /**
+     * Sets the size of the notification.
+     * @property {boolean} xs
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    xs?: boolean;
+    /**
+     * Sets the size of the notification.
+     * @property {boolean} sm
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    sm?: boolean;
+    /**
+     * Sets the size of the notification.
+     * @property {boolean} md
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    md?: boolean;
+    /**
+     * Sets the size of the notification.
+     * @property {boolean} lg
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    lg?: boolean;
+    /**
+     * Sets the size of the notification.
+     * @property {boolean} xl
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    xl?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} dark
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    dark?: boolean;
+    /**
+     * TODO: Add Description
+     * @property {boolean} light
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    light?: boolean;
+}
+export interface WaveNotificationEmits {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    'onInput'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    'onUpdate:modelValue'?: () => void;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    'onClose'?: () => void;
+}
+export interface WaveNotificationComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    transitionName: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    position: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    hasType: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    alertProps: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    classes: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    alertClasses: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    styles: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    timeoutVal: ComputedGetter<any>;
+}
+export interface WaveNotificationMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    countdown(): void;
+}
+export type WaveNotificationSlots = SlotsType<{
+    /**
+     * The notification content.
+     * @see https://antoniandre.github.io/wave-ui/w-notification
+     */
+    'default': () => any;
+}>;
+export type WNotification = DefineComponent<WaveNotificationProps, {}, {}, WaveNotificationComputeds, WaveNotificationMethods, {}, {}, WaveNotificationEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveNotificationProps & WaveNotificationEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveNotificationProps>, WaveNotificationSlots>;

package/dist/types/components/WNotification.js

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

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

@@ -0,0 +1,33 @@
+import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
+import { PublicProps, ResolveProps } from '../extra-vue-types';
+export interface WaveNotificationManagerProps {
+}
+export interface WaveNotificationManagerEmits {
+}
+export interface WaveNotificationManagerComputeds extends ComputedOptions {
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification-manager
+     */
+    conf: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification-manager
+     */
+    notifications: ComputedGetter<any>;
+    /**
+     * TODO: Add Description
+     * @see https://antoniandre.github.io/wave-ui/w-notification-manager
+     */
+    transition: ComputedGetter<any>;
+}
+export interface WaveNotificationManagerMethods extends MethodOptions {
+    /**
+     * TODO: Add Description
+     * @param {any} notif
+     * @see https://antoniandre.github.io/wave-ui/w-notification-manager
+     */
+    notifProps(notif: any): void;
+}
+export type WaveNotificationManagerSlots = SlotsType<{}>;
+export type WNotificationManager = DefineComponent<WaveNotificationManagerProps, {}, {}, WaveNotificationManagerComputeds, WaveNotificationManagerMethods, {}, {}, WaveNotificationManagerEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveNotificationManagerProps & WaveNotificationManagerEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveNotificationManagerProps>, WaveNotificationManagerSlots>;

package/dist/types/components/WNotificationManager.js

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