@maltjoy/core-vue 3.26.0 → 3.27.1

package/dist/components/JoyLink/VJoyLink.vue.d.ts

@@ -1,13 +1,13 @@
 import { PropType } from 'vue';
+import { TJoyLinkColors } from './JoyLink.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     href: {
         type: StringConstructor;
         required: true;
     };
     color: {
-        type: PropType<"white" | "teal">;
+        type: PropType<TJoyLinkColors>;
         default: string;
-        validator(color: "white" | "teal"): boolean;
     };
     icon: PropType<import("@maltjoy/icons").JoyIconsId>;
     text: PropType<string | null>;
@@ -17,16 +17,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         required: true;
     };
     color: {
-        type: PropType<"white" | "teal">;
+        type: PropType<TJoyLinkColors>;
         default: string;
-        validator(color: "white" | "teal"): boolean;
     };
     icon: PropType<import("@maltjoy/icons").JoyIconsId>;
     text: PropType<string | null>;
 }>>, {
-    color: "white" | "teal";
-}, {}>, {
-    default?(_: {}): any;
+    color: TJoyLinkColors;
+}, {}>, Readonly<{
+    default(): any;
+}> & {
+    default(): any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

package/dist/components/JoyMenu/VJoyMenu.vue.d.ts

@@ -42,16 +42,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     onSelectItem?: ((value: IJoyMenuItem) => any) | undefined;
 }, {
     items: IJoyMenuItem[];
-}, {}>, {
-    "menu-item"?(_: {
-        [x: string]: any;
-        id?: string | undefined;
-        label: string;
-        href?: string | undefined;
-        icon?: import("@maltjoy/icons").JoyIconsId | undefined;
-        current?: boolean | undefined;
-        disabled?: boolean | undefined;
-    }): any;
+}, {}>, Readonly<{
+    /** Customize the inner content of each menu item */
+    'menu-item': () => any;
+}> & {
+    /** Customize the inner content of each menu item */
+    'menu-item': () => any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

package/dist/components/JoyMultiCheckbox/VJoyMultiCheckbox.vue.d.ts

@@ -1,4 +1,5 @@
 import { PropType } from 'vue';
+import { TJoyLabelSizes } from '../JoyLabel/JoyLabel.types';
 export interface Option {
     id: string;
     name?: string;
@@ -15,12 +16,14 @@ export interface Option {
     required?: boolean;
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** To render the list of checkboxes you have to use this property. See "Controls" for object model */
     options: {
         type: PropType<Option[]>;
         required: true;
         validator(value: Option[]): boolean;
     };
     id: StringConstructor;
+    /** Use it with `v-model:value` */
     value: {
         type: PropType<any[]>;
         default(): never[];
@@ -31,10 +34,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: StringConstructor;
     labelSize: {
-        type: PropType<"small" | "large" | "medium">;
+        type: PropType<TJoyLabelSizes>;
         default: string;
     };
     optionalLabel: StringConstructor;
+    /** Display the "*" next to the label */
     requiredMark: {
         type: BooleanConstructor;
         default: boolean;
@@ -42,12 +46,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:value": (value: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** To render the list of checkboxes you have to use this property. See "Controls" for object model */
     options: {
         type: PropType<Option[]>;
         required: true;
         validator(value: Option[]): boolean;
     };
     id: StringConstructor;
+    /** Use it with `v-model:value` */
     value: {
         type: PropType<any[]>;
         default(): never[];
@@ -58,10 +64,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: StringConstructor;
     labelSize: {
-        type: PropType<"small" | "large" | "medium">;
+        type: PropType<TJoyLabelSizes>;
         default: string;
     };
     optionalLabel: StringConstructor;
+    /** Display the "*" next to the label */
     requiredMark: {
         type: BooleanConstructor;
         default: boolean;
@@ -71,24 +78,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     required: boolean;
     value: any[];
-    labelSize: "small" | "large" | "medium";
+    labelSize: TJoyLabelSizes;
     requiredMark: boolean;
-}, {}>, {
-    checkbox?(_: {
-        id: string;
-        name?: string | undefined;
-        value: string;
-        label: string;
-        subLabel?: string | undefined;
-        /**
-         * @default false
-         */
-        disabled?: boolean | undefined;
-        /**
-         * @default false
-         */
-        required?: boolean | undefined;
-    }): any;
+}, {}>, Readonly<{
+    /** Customize the inner content of each checkboxes */
+    checkbox?: (() => any) | undefined;
+}> & {
+    /** Customize the inner content of each checkboxes */
+    checkbox?: (() => any) | undefined;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

package/dist/components/JoyPagination/VJoyPagination.vue.d.ts

@@ -57,12 +57,20 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     currentPage: number;
     totalPages: number;
-}, {}>, {
-    "pagination-prev"?(_: {}): any;
-    page?(_: {
-        page: number;
-    }): any;
-    "pagination-next"?(_: {}): any;
+}, {}>, Readonly<{
+    /** Customize the content of the left arrow */
+    'pagination-prev'?: (() => any) | undefined;
+    /** Customize the content of the right arrow */
+    'pagination-next'?: (() => any) | undefined;
+    /** Customize the content of each pagination item */
+    page?: (() => any) | undefined;
+}> & {
+    /** Customize the content of the left arrow */
+    'pagination-prev'?: (() => any) | undefined;
+    /** Customize the content of the right arrow */
+    'pagination-next'?: (() => any) | undefined;
+    /** Customize the content of each pagination item */
+    page?: (() => any) | undefined;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,5 +1,3 @@
-import { SIZES } from '../../types';
-export type TJoyPanelSizes = Extract<(typeof SIZES)[number], 'small' | 'medium' | 'large'>;
-export declare const PANEL_SIZES: TJoyPanelSizes[];
-export type TJoyPanelTitleSizes = Extract<(typeof SIZES)[number], 'small' | 'large'>;
-export declare const PANEL_TITLE_SIZES: TJoyPanelTitleSizes[];
+import { TSizes } from '../../types';
+export type TJoyPanelSizes = Extract<TSizes, 'small' | 'medium' | 'large'>;
+export type TJoyPanelTitleSizes = Extract<TSizes, 'small' | 'large'>;

package/dist/components/JoyPanel/VJoyPanel.vue.d.ts

@@ -1,5 +1,6 @@
 import { PropType } from 'vue';
 import { TJoyPanelSizes, TJoyPanelTitleSizes } from './JoyPanel.types';
+import { TJoyScreenLoaderColors } from '../JoyScreenLoader/VJoyScreenLoader.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     flex: {
         type: StringConstructor;
@@ -11,19 +12,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     padding: {
         type: PropType<TJoyPanelSizes>;
         default: string;
-        validator(size: TJoyPanelSizes): boolean;
     };
     titleSize: {
         type: PropType<TJoyPanelTitleSizes>;
         default: string;
-        validator(size: TJoyPanelTitleSizes): boolean;
     };
     loading: {
         type: BooleanConstructor;
         default: boolean;
     };
     loadingColor: {
-        type: PropType<"light" | "dark">;
+        type: PropType<TJoyScreenLoaderColors>;
         default: string;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -37,19 +36,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     padding: {
         type: PropType<TJoyPanelSizes>;
         default: string;
-        validator(size: TJoyPanelSizes): boolean;
     };
     titleSize: {
         type: PropType<TJoyPanelTitleSizes>;
         default: string;
-        validator(size: TJoyPanelTitleSizes): boolean;
     };
     loading: {
         type: BooleanConstructor;
         default: boolean;
     };
     loadingColor: {
-        type: PropType<"light" | "dark">;
+        type: PropType<TJoyScreenLoaderColors>;
         default: string;
     };
 }>>, {
@@ -57,14 +54,33 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     noMargin: boolean;
     padding: TJoyPanelSizes;
     titleSize: TJoyPanelTitleSizes;
-    loadingColor: "light" | "dark";
-}, {}>, {
-    "panel-title"?(_: {}): any;
-    "panel-title-action"?(_: {}): any;
-    "panel-subtitle"?(_: {}): any;
-    "panel-body"?(_: {}): any;
-    "panel-action"?(_: {}): any;
-    "panel-loader-content"?(_: {}): any;
+    loadingColor: TJoyScreenLoaderColors;
+}, {}>, Readonly<{
+    /** Main title of the panel */
+    'panel-title'(): any;
+    /** Subtitle, not mandatory */
+    'panel-subtitle'?(): any;
+    /** Top right corner actions. Put whatever you want */
+    'panel-title-action'?(): any;
+    /** Main content */
+    'panel-body'?(): any;
+    /** Mostly for CTA */
+    'panel-action'?(): any;
+    /** Customize the loading state content */
+    'panel-loader-content'?(): any;
+}> & {
+    /** Main title of the panel */
+    'panel-title'(): any;
+    /** Subtitle, not mandatory */
+    'panel-subtitle'?(): any;
+    /** Top right corner actions. Put whatever you want */
+    'panel-title-action'?(): any;
+    /** Main content */
+    'panel-body'?(): any;
+    /** Mostly for CTA */
+    'panel-action'?(): any;
+    /** Customize the loading state content */
+    'panel-loader-content'?(): any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,3 +1,2 @@
-import { GENERIC_VARIANTS } from '../../types';
-export type TJoyProgressBarColors = (typeof GENERIC_VARIANTS)[number];
-export declare const PROGRESSBAR_VARIANT: string[];
+import { TGenericVariants } from '../../types';
+export type TJoyProgressBarColors = TGenericVariants;

package/dist/components/JoyProgressBar/VJoyProgressBar.vue.d.ts

@@ -1,7 +1,8 @@
 import { PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
+    /** import TJoyProgressBarColors */
     color: {
-        type: PropType<"primary" | "secondary">;
+        type: PropType<import("../../types").TGenericVariants>;
         default: string;
     };
     /**
@@ -26,8 +27,9 @@ declare const _default: import("vue").DefineComponent<{
     computeInnerWidth: import("vue").ComputedRef<string>;
     computedPercentage: import("vue").Ref<number>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** import TJoyProgressBarColors */
     color: {
-        type: PropType<"primary" | "secondary">;
+        type: PropType<import("../../types").TGenericVariants>;
         default: string;
     };
     /**
@@ -49,6 +51,6 @@ declare const _default: import("vue").DefineComponent<{
         type: NumberConstructor;
     };
 }>>, {
-    color: "primary" | "secondary";
+    color: import("../../types").TGenericVariants;
 }, {}>;
 export default _default;

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

@@ -1,2 +1 @@
-export declare const RADIO_THEMES: readonly ["default", "outline"];
-export type RadioThemes = (typeof RADIO_THEMES)[number];
+export type RadioThemes = 'default' | 'outline';

package/dist/components/JoyRadio/VJoyRadio.vue.d.ts

@@ -1,4 +1,5 @@
 import { PropType } from 'vue';
+import { RadioThemes } from './JoyRadio.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     disabled: {
         type: BooleanConstructor;
@@ -21,8 +22,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     modelValue: {
         type: (StringConstructor | NumberConstructor)[];
     };
+    /** Change the layout by using this property */
     theme: {
-        type: PropType<"default" | "outline">;
+        type: PropType<RadioThemes>;
         default: string;
     };
     value: {
@@ -56,8 +58,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     modelValue: {
         type: (StringConstructor | NumberConstructor)[];
     };
+    /** Change the layout by using this property */
     theme: {
-        type: PropType<"default" | "outline">;
+        type: PropType<RadioThemes>;
         default: string;
     };
     value: {
@@ -70,11 +73,21 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     required: boolean;
     disabled: boolean;
     invalid: boolean;
-    theme: "default" | "outline";
-}, {}>, {
-    default?(_: {}): any;
-    "radio-content"?(_: {}): any;
-    "expandable-content"?(_: {}): any;
+    theme: RadioThemes;
+}, {}>, Readonly<{
+    /** Default label of the radio */
+    default(): any;
+    /** Sub-content, pre-styled. */
+    'radio-content': () => any;
+    /** When using the theme outline, use this slot to inject hidden content */
+    'expandable-content': () => any;
+}> & {
+    /** Default label of the radio */
+    default(): any;
+    /** Sub-content, pre-styled. */
+    'radio-content': () => any;
+    /** When using the theme outline, use this slot to inject hidden content */
+    'expandable-content': () => any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,2 +1 @@
-export declare const RADIO_GROUP_DIRECTION: readonly ["vertical", "horizontal"];
-export type RadioGroupDirection = (typeof RADIO_GROUP_DIRECTION)[number];
+export type RadioGroupDirection = 'vertical' | 'horizontal';

package/dist/components/JoyRadioGroup/VJoyRadioGroup.vue.d.ts

@@ -1,10 +1,11 @@
 import { PropType } from 'vue';
+import { RadioGroupDirection } from './JoyRadioGroup.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     /**
      * Change the layout
      */
     direction: {
-        type: PropType<"vertical" | "horizontal">;
+        type: PropType<RadioGroupDirection>;
         default: string;
     };
     /**
@@ -21,7 +22,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
      * Change the layout
      */
     direction: {
-        type: PropType<"vertical" | "horizontal">;
+        type: PropType<RadioGroupDirection>;
         default: string;
     };
     /**
@@ -34,10 +35,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: StringConstructor;
     };
 }>>, {
-    direction: "vertical" | "horizontal";
-}, {}>, {
-    "radio-group-legend"?(_: {}): any;
-    default?(_: {}): any;
+    direction: RadioGroupDirection;
+}, {}>, Readonly<{
+    /** Label of the radio group */
+    'radio-group-legend': () => any;
+    /** Use it to render the VJoyRadio */
+    default(): any;
+}> & {
+    /** Label of the radio group */
+    'radio-group-legend': () => any;
+    /** Use it to render the VJoyRadio */
+    default(): any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,3 +1,2 @@
-import { SIZES } from '../../types';
-export type TJoyRatingStarsSizes = Extract<(typeof SIZES)[number], 'small' | 'medium' | 'large'>;
-export declare const RATING_STARS_SIZES: TJoyRatingStarsSizes[];
+import { TSizes } from '../../types';
+export type TJoyRatingStarsSizes = Extract<TSizes, 'small' | 'medium' | 'large'>;

package/dist/components/JoyRatingStars/VJoyRatingStars.vue.d.ts

@@ -1,10 +1,12 @@
 import { PropType } from 'vue';
 import { TJoyRatingStarsSizes } from './JoyRatingStars.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** Between 0 and 5 */
     ratingValue: {
         type: NumberConstructor;
         default: number;
     };
+    /** Display the amount of review leading to the rating value */
     reviewCount: {
         type: NumberConstructor;
         default: number;
@@ -16,10 +18,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     setStars: import("vue").ComputedRef<string[]>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Between 0 and 5 */
     ratingValue: {
         type: NumberConstructor;
         default: number;
     };
+    /** Display the amount of review leading to the rating value */
     reviewCount: {
         type: NumberConstructor;
         default: number;
@@ -32,8 +36,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     size: TJoyRatingStarsSizes;
     ratingValue: number;
     reviewCount: number;
-}, {}>, {
-    "rating-stars-content"?(_: {}): any;
+}, {}>, Readonly<{
+    /** Use this to inject some basic text */
+    'rating-stars-content': () => any;
+}> & {
+    /** Use this to inject some basic text */
+    'rating-stars-content': () => any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,2 +1 @@
-export declare const COLORS: readonly ["dark", "light"];
-export type TJoyScreenLoaderColors = (typeof COLORS)[number];
+export type TJoyScreenLoaderColors = 'dark' | 'light';

package/dist/components/JoyScreenLoader/VJoyScreenLoader.vue.d.ts

@@ -1,8 +1,9 @@
 import { PropType } from 'vue';
+import { TJoyScreenLoaderColors } from './VJoyScreenLoader.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     /** Light or dark. Changes the spinner and background color */
     color: {
-        type: PropType<"light" | "dark">;
+        type: PropType<TJoyScreenLoaderColors>;
         default: string;
     };
     /** The overlay mode set the component in an absolute position, and covers all the parent's area. */
@@ -13,7 +14,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** Light or dark. Changes the spinner and background color */
     color: {
-        type: PropType<"light" | "dark">;
+        type: PropType<TJoyScreenLoaderColors>;
         default: string;
     };
     /** The overlay mode set the component in an absolute position, and covers all the parent's area. */
@@ -22,11 +23,18 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: boolean;
     };
 }>>, {
-    color: "light" | "dark";
+    color: TJoyScreenLoaderColors;
     overlay: boolean;
-}, {}>, {
-    spinner?(_: {}): any;
-    content?(_: {}): any;
+}, {}>, Readonly<{
+    /** Override the spinner */
+    spinner?: (() => any) | undefined;
+    /** Inject text or whatever you want below the spinner */
+    content?: (() => any) | undefined;
+}> & {
+    /** Override the spinner */
+    spinner?: (() => any) | undefined;
+    /** Inject text or whatever you want below the spinner */
+    content?: (() => any) | undefined;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

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

@@ -1,3 +1,2 @@
-import { SIZES } from '../../types';
-export type TJoySelectSizes = Extract<(typeof SIZES)[number], 'xsmall' | 'small' | 'medium'>;
-export declare const SELECT_SIZES: TJoySelectSizes[];
+import { TSizes } from '../../types';
+export type TJoySelectSizes = Extract<TSizes, 'xsmall' | 'small' | 'medium'>;

package/dist/components/JoySelect/VJoySelect.vue.d.ts

@@ -1,5 +1,6 @@
 import { PropType, VNode } from 'vue';
 import { TJoySelectSizes } from './JoySelect.types';
+import { TJoyLabelSizes } from '../JoyLabel/JoyLabel.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     disabled: {
         type: BooleanConstructor;
@@ -21,7 +22,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: StringConstructor;
     labelSize: {
-        type: PropType<"small" | "large" | "medium">;
+        type: PropType<TJoyLabelSizes>;
     };
     optionalLabel: StringConstructor;
     requiredMark: {
@@ -62,7 +63,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     label: StringConstructor;
     labelSize: {
-        type: PropType<"small" | "large" | "medium">;
+        type: PropType<TJoyLabelSizes>;
     };
     optionalLabel: StringConstructor;
     requiredMark: {
@@ -88,14 +89,18 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     modelValue: string | number | null;
     requiredMark: boolean;
 }, {}>, Readonly<{
-    default: () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    /** Use native <option> tags here */
+    default(): VNode<import("vue").RendererNode, import("vue").RendererElement, {
         [key: string]: any;
     }>[];
+    /** Label above the select */
     'select-label'?: (() => any) | undefined;
 }> & {
-    default: () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    /** Use native <option> tags here */
+    default(): VNode<import("vue").RendererNode, import("vue").RendererElement, {
         [key: string]: any;
     }>[];
+    /** Label above the select */
     'select-label'?: (() => any) | undefined;
 }>;
 export default _default;