@maltjoy/core-vue 3.17.2 → 3.18.0

package/dist/components/JoySnackbar/VJoySnackbar.vue.d.ts

@@ -0,0 +1,96 @@
+import { PropType } from 'vue';
+import { Emitter } from 'mitt';
+import { TJoySnackbarEvents, TJoySnackbarLevels } from './JoySnackbar.types';
+declare const _default: import("vue").DefineComponent<{
+    level: {
+        type: PropType<TJoySnackbarLevels>;
+        default: string;
+    };
+    closable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Default snackar display duration. Default to 5000ms */
+    duration: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** The title if you need to set one */
+    header: {
+        type: StringConstructor;
+    };
+    /** Main snackbar message. Mandatory */
+    message: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** If you need to trigger an action from the generated snackbar, use this field to create a CTA.
+     *
+     * Use `bus.on('snackbar:action-click')` to catch the event.
+     */
+    actionText: {
+        type: StringConstructor;
+    };
+    frozen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** You don't need to explicitely set the bus property as the snackbar service is already handling it. */
+    bus: {
+        type: PropType<Emitter<TJoySnackbarEvents>>;
+    };
+    /** @internal */
+    instanceNb: {
+        type: NumberConstructor;
+    };
+}, {
+    isOpen: import("vue").Ref<boolean>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    level: {
+        type: PropType<TJoySnackbarLevels>;
+        default: string;
+    };
+    closable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Default snackar display duration. Default to 5000ms */
+    duration: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** The title if you need to set one */
+    header: {
+        type: StringConstructor;
+    };
+    /** Main snackbar message. Mandatory */
+    message: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** If you need to trigger an action from the generated snackbar, use this field to create a CTA.
+     *
+     * Use `bus.on('snackbar:action-click')` to catch the event.
+     */
+    actionText: {
+        type: StringConstructor;
+    };
+    frozen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** You don't need to explicitely set the bus property as the snackbar service is already handling it. */
+    bus: {
+        type: PropType<Emitter<TJoySnackbarEvents>>;
+    };
+    /** @internal */
+    instanceNb: {
+        type: NumberConstructor;
+    };
+}>>, {
+    duration: number;
+    level: TJoySnackbarLevels;
+    closable: boolean;
+    frozen: boolean;
+}, {}>;
+export default _default;

package/dist/components/JoySnackbar/VJoySnackbarService.d.ts

@@ -0,0 +1,25 @@
+import { App } from 'vue';
+import { IJoynackbarServiceOptions, IJoynackbarServiceReturn } from './JoySnackbar.types';
+export declare let snackbarMountedInstances: App<Element>[];
+/**
+ * For testing purpose, it's called before test execution.
+ * @return {void}
+ */
+export declare function resetCount(): void;
+/**
+ *
+ * @param {Object} options - createAllSnackbarsContainer options
+ * @param {string } options.appendTo - where to injecte the snackbar shell
+ * @param {string } options.defaultMountSelector - where to injecte the snackbar shell
+ * @return {void}
+ */
+export declare function createAllSnackbarsContainer(options?: {
+    appendTo: string;
+    defaultMountSelector: string;
+}): void;
+/**
+ * @param {Object} options - pushVJoySnackbar options. Props are mandatory.
+ * @param {Object} options.props - VJoySnackbar properties. props.message is mandatory.
+ * @returns {Object} - Returns snackbarEventBus and snackbarApp instance
+ */
+export declare function pushVJoySnackbar(options: IJoynackbarServiceOptions): IJoynackbarServiceReturn;

package/dist/components/JoySnackbar/index.d.ts

@@ -0,0 +1 @@
+export * from './VJoySnackbarService';

package/dist/components/JoyTab/TabButton.vue.d.ts

@@ -10,7 +10,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
      * Id of the tab, used for aria prop
      */
     tab: {
-        type: StringConstructor;
+        type: (StringConstructor | NumberConstructor)[];
         required: true;
     };
     /**
@@ -41,7 +41,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
      * Id of the tab, used for aria prop
      */
     tab: {
-        type: StringConstructor;
+        type: (StringConstructor | NumberConstructor)[];
         required: true;
     };
     /**

package/dist/components/JoyTag/VJoyTag.vue.d.ts

@@ -20,7 +20,6 @@ declare const _default: import("vue").DefineComponent<{
     /** Mandatory, especially if you deal with tags list and v-model */
     value: {
         type: StringConstructor;
-        required: true;
         default: string;
     };
     draggable: {
@@ -61,7 +60,6 @@ declare const _default: import("vue").DefineComponent<{
     /** Mandatory, especially if you deal with tags list and v-model */
     value: {
         type: StringConstructor;
-        required: true;
         default: string;
     };
     draggable: {

package/dist/components/JoyTagsList/VJoyTagsList.vue.d.ts

@@ -8,16 +8,26 @@ declare const _default: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<TJoyTagsListModel>;
     };
+    /** Tags list. Array of objects containing at least a label. "value" is mandatory if dealing with removable or selectable tags */
     tags: {
         type: PropType<TJoyTagsList>;
         default(): never[];
-        required: true;
     };
     /** You can either pass this property to make all generated tags removable, or pass the `removable: true` to each tag in "tags" prop. */
     removable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** Make all VJoyTag selectable. Can be overriden by setting selectable: false in specific tags property entry. */
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Apply variant for all VJoyTag. Can be overriden by setting a variant property in specific tags entry. */
+    variant: {
+        type: PropType<"primary" | "secondary" | "important" | "inactive" | "pending" | "pricing">;
+        default: string;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (tags: TJoyTagsListModel) => void;
     removeTag: (tagValue: string) => void;
@@ -29,21 +39,33 @@ declare const _default: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<TJoyTagsListModel>;
     };
+    /** Tags list. Array of objects containing at least a label. "value" is mandatory if dealing with removable or selectable tags */
     tags: {
         type: PropType<TJoyTagsList>;
         default(): never[];
-        required: true;
     };
     /** You can either pass this property to make all generated tags removable, or pass the `removable: true` to each tag in "tags" prop. */
     removable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** Make all VJoyTag selectable. Can be overriden by setting selectable: false in specific tags property entry. */
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Apply variant for all VJoyTag. Can be overriden by setting a variant property in specific tags entry. */
+    variant: {
+        type: PropType<"primary" | "secondary" | "important" | "inactive" | "pending" | "pricing">;
+        default: string;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((tags: TJoyTagsListModel) => any) | undefined;
     onRemoveTag?: ((tagValue: string) => any) | undefined;
 }, {
+    variant: "primary" | "secondary" | "important" | "inactive" | "pending" | "pricing";
     align: "left" | "right" | "center";
+    selectable: boolean;
     removable: boolean;
     tags: TJoyTagsList;
 }, {}>;

package/dist/components/JoyWrapper/VJoyWrapper.vue.d.ts

@@ -80,10 +80,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: string;
     };
 }>>, {
+    wrap: "nowrap" | "wrap";
+    justify: "center" | "space-between" | "flex-start" | "flex-end";
     align: "center" | "flex-start" | "flex-end" | "stretch";
     direction: "row" | "column";
-    justify: "center" | "space-between" | "flex-start" | "flex-end";
-    wrap: "nowrap" | "wrap";
     itemStretch: boolean;
     noMargin: boolean;
     columnGap: "0" | "1" | "2" | "3" | "12" | "10" | "4" | "5" | "6" | "7" | "8" | "9" | "11";

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

@@ -4,6 +4,7 @@ export * from './JoyBadge/JoyBadge.types';
 export * from './JoyBadgeLevel/JoyBadgeLevel.types';
 export * from './JoyButton/JoyButton.types';
 export * from './JoyCompanyAvatar/JoyCompanyAvatar.types';
+export * from './JoyDialog/JoyDialog.types';
 export * from './JoyDropdown/JoyDropdown.types';
 export * from './JoyDropdownList/JoyDropdownList.types';
 export * from './JoyFunnel/JoyFunnel.types';
@@ -23,6 +24,7 @@ export * from './JoyRadioGroup/JoyRadioGroup.types';
 export * from './JoyScreenLoader/VJoyScreenLoader.types';
 export * from './JoySelect/JoySelect.types';
 export * from './JoySeparator/JoySeparator.types';
+export * from './JoySnackbar/JoySnackbar.types';
 export * from './JoySpinner/JoySpinner.types';
 export * from './JoyTag/JoyTag.types';
 export * from './JoyTagsList/JoyTagsList.types';

package/dist/components/index.d.ts

@@ -7,6 +7,8 @@ import VJoyButton from '@/components/JoyButton/VJoyButton.vue';
 import VJoyCheckbox from '@/components/JoyCheckbox/VJoyCheckbox.vue';
 import VJoyCompanyAvatar from '@/components/JoyCompanyAvatar/VJoyCompanyAvatar.vue';
 import VJoyCounter from '@/components/JoyCounter/VJoyCounter.vue';
+import VJoyDialog from '@/components/JoyDialog/VJoyDialog.vue';
+import VJoyDialogTrigger from '@/components/JoyDialogTrigger/VJoyDialogTrigger.vue';
 import VJoyDividerCta from '@/components/JoyDividerCta/VJoyDividerCta.vue';
 import VJoyDropdown from '@/components/JoyDropdown/VJoyDropdown.vue';
 import VJoyDropdownList from '@/components/JoyDropdownList/VJoyDropdownList.vue';
@@ -38,6 +40,7 @@ import VJoySelect from '@/components/JoySelect/VJoySelect.vue';
 import VJoySelectableItem from '@/components/JoySelectableItem/VJoySelectableItem.vue';
 import VJoySelectableItemGroup from '@/components/JoySelectableItemGroup/VJoySelectableItemGroup.vue';
 import VJoySeparator from '@/components/JoySeparator/VJoySeparator.vue';
+import VJoySnackbar from '@/components/JoySnackbar/VJoySnackbar.vue';
 import VJoySpinner from '@/components/JoySpinner/VJoySpinner.vue';
 import VJoyStep from '@/components/JoyStep/VJoyStep.vue';
 import VJoyStepper from '@/components/JoyStepper/VJoyStepper.vue';
@@ -53,4 +56,4 @@ import VJoyToggle from '@/components/JoyToggle/VJoyToggle.vue';
 import VJoyTooltip from '@/components/JoyTooltip/VJoyTooltip.vue';
 import VJoyUserCard from '@/components/JoyUserCard/VJoyUserCard.vue';
 import VJoyWrapper from '@/components/JoyWrapper/VJoyWrapper.vue';
-export { VJoyAvailability, VJoyAvatar, VJoyAvatarsList, VJoyBadge, VJoyBadgeLevel, VJoyButton, VJoyCheckbox, VJoyCompanyAvatar, VJoyCounter, VJoyDividerCta, VJoyDropdown, VJoyDropdownList, VJoyFilterBar, VJoyFilterBarButton, VJoyFooter, VJoyFormError, VJoyFormFieldSkeleton, VJoyFunnel, VJoyHeader, VJoyHighlight, VJoyIcon, VJoyIndicator, VJoyIndicators, VJoyInput, VJoyLabel, VJoyLink, VJoyMenu, VJoyMultiCheckbox, VJoyPagination, VJoyPanel, VJoyPanelSection, VJoyProgressBar, VJoyRadio, VJoyRadioGroup, VJoyRatingStars, VJoyScreenLoader, VJoySelect, VJoySelectableItem, VJoySelectableItemGroup, VJoySeparator, VJoySpinner, VJoyStep, VJoyStepper, VJoyTab, VJoyTabs, VJoyTag, VJoyTagsList, VJoyTemplate, VJoyTemplateShape, VJoyText, VJoyTextarea, VJoyToggle, VJoyTooltip, VJoyUserCard, VJoyWrapper, };
+export { VJoyAvailability, VJoyAvatar, VJoyAvatarsList, VJoyBadge, VJoyBadgeLevel, VJoyButton, VJoyCheckbox, VJoyCompanyAvatar, VJoyCounter, VJoyDialog, VJoyDialogTrigger, VJoyDividerCta, VJoyDropdown, VJoyDropdownList, VJoyFilterBar, VJoyFilterBarButton, VJoyFooter, VJoyFormError, VJoyFormFieldSkeleton, VJoyFunnel, VJoyHeader, VJoyHighlight, VJoyIcon, VJoyIndicator, VJoyIndicators, VJoyInput, VJoyLabel, VJoyLink, VJoyMenu, VJoyMultiCheckbox, VJoyPagination, VJoyPanel, VJoyPanelSection, VJoyProgressBar, VJoyRadio, VJoyRadioGroup, VJoyRatingStars, VJoyScreenLoader, VJoySelect, VJoySelectableItem, VJoySelectableItemGroup, VJoySeparator, VJoySnackbar, VJoySpinner, VJoyStep, VJoyStepper, VJoyTab, VJoyTabs, VJoyTag, VJoyTagsList, VJoyTemplate, VJoyTemplateShape, VJoyText, VJoyTextarea, VJoyToggle, VJoyTooltip, VJoyUserCard, VJoyWrapper, };

package/dist/components/main.d.ts

@@ -1,6 +1,9 @@
 import type { App } from 'vue';
 import '../style.scss';
-export * from './';
 export declare const JoyVuePlugin: {
-    install: (app: App) => void;
+    install: (app: App, options?: {
+        env: 'client' | 'server';
+    }) => void;
 };
+export * from './';
+export * from './JoySnackbar';

package/dist/events/bus.d.ts

@@ -0,0 +1,3 @@
+import { Emitter } from 'mitt';
+declare function createEventBus<T extends Record<string, unknown>>(): Emitter<T>;
+export { createEventBus };

package/dist/events/index.d.ts

@@ -0,0 +1 @@
+export * from './bus';

package/dist/helpers/index.d.ts

@@ -1,6 +1,15 @@
 import { TJoyIconsNames } from '@/components/JoyIcon/JoyIcon.types';
 import { Ref } from 'vue';
 import { LEVELS } from '../types';
+/**
+ * Check if you are working on dev environment. Based on `getMode` util that returns import.meta.env.MODE,
+ */
+export declare const isDevMode: boolean;
 export declare function iconLevel(level: (typeof LEVELS)[number]): TJoyIconsNames;
 export declare function focusOnFirstFocusableFormField(root: Ref): any;
 export declare const generateRandomId: (length?: number) => string;
+/**
+ * @param {Boolean} prevent - If you want to prevent scrolling or enable it again. Used by dialog component
+ * @return {void}
+ */
+export declare function preventBodyScroll(prevent: boolean): void;