@maltjoy/core-vue 1.0.0-alpha.5 → 1.0.0-alpha.7

package/dist/components/JoyButton/JoyButton.vue.d.ts

@@ -18,7 +18,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     /** Button or Link color variant */
     variant: {
-        type: PropType<"main" | "secondary" | "primary" | "admin" | "ghost">;
+        type: PropType<"main" | "primary" | "secondary" | "admin" | "ghost">;
         default: string;
         validator(variant: ButtonVariants): boolean;
     };
@@ -52,7 +52,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     /** Button or Link color variant */
     variant: {
-        type: PropType<"main" | "secondary" | "primary" | "admin" | "ghost">;
+        type: PropType<"main" | "primary" | "secondary" | "admin" | "ghost">;
         default: string;
         validator(variant: ButtonVariants): boolean;
     };
@@ -71,7 +71,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }>>, {
     circle: boolean;
     loading: boolean;
-    variant: "main" | "secondary" | "primary" | "admin" | "ghost";
+    variant: "main" | "primary" | "secondary" | "admin" | "ghost";
     size: ButtonSizes;
     iconSize: "small" | "xsmall" | "xxsmall";
 }>, {

package/dist/components/JoyCheckbox/JoyCheckbox.vue.d.ts

@@ -1,51 +1,30 @@
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    disabled: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    id: {
-        type: StringConstructor;
-    }; /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
-    invalid: {
+    /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
+    indeterminate: {
         type: BooleanConstructor;
         default: boolean;
     };
-    name: {
+    /** Use it to replace the default slot */
+    label: {
         type: StringConstructor;
     };
-    required: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    modelValue: {
+    /** Checked state of the component */
+    checked: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** The value is used in multiselection context in order to build array of values. */
     value: {
         type: StringConstructor;
         default: string;
     };
-    /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
-    indeterminate: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    label: {
-        type: StringConstructor;
-    };
-}, {
-    isIndeterminate: import("vue").Ref<boolean>;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Removes any interactivity if disabled */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
     id: {
         type: StringConstructor;
-    }; /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
-    invalid: {
-        type: BooleanConstructor;
-        default: boolean;
     };
     name: {
         type: StringConstructor;
@@ -54,31 +33,53 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-    modelValue: {
+}, {
+    isIndeterminate: import("vue").Ref<boolean>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:checked": (value: boolean) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
+    indeterminate: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** Use it to replace the default slot */
+    label: {
+        type: StringConstructor;
+    };
+    /** Checked state of the component */
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The value is used in multiselection context in order to build array of values. */
     value: {
         type: StringConstructor;
         default: string;
     };
-    /** Can't be used in addition of v-model. See usage : https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes */
-    indeterminate: {
+    /** Removes any interactivity if disabled */
+    disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
-    label: {
+    id: {
+        type: StringConstructor;
+    };
+    name: {
         type: StringConstructor;
     };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>> & {
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:checked"?: ((value: boolean) => any) | undefined;
 }, {
     disabled: boolean;
     indeterminate: boolean;
-    invalid: boolean;
-    required: boolean;
-    modelValue: boolean;
+    checked: boolean;
     value: string;
+    required: boolean;
 }>, {
     default: (_: {}) => any;
     'checkbox-content': (_: {}) => any;

package/dist/components/JoyCounter/JoyCounter.vue.d.ts

@@ -0,0 +1,211 @@
+import { PropType } from 'vue';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** Removes any interactivity */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    id: {
+        type: StringConstructor;
+    };
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: StringConstructor;
+    };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Display a label on top of the element. */
+    label: StringConstructor;
+    /** Overrides the default label size. See JoyLabel stories */
+    labelSize: {
+        type: PropType<"small" | "large" | "medium">;
+        default: string;
+    };
+    /** If your component is not required, we can add a label to explicitely tell that it's not mandatory */
+    optionalLabel: StringConstructor;
+    /** Depending on context, we can add a "*" after the label to specify it's mandatory. */
+    requiredMark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Used for aria-label. */
+    labelDecrement: {
+        type: StringConstructor;
+    };
+    /** Used for aria-label. */
+    labelIncrement: {
+        type: StringConstructor;
+    };
+    max: {
+        type: NumberConstructor;
+    };
+    min: {
+        type: NumberConstructor;
+        default: number;
+    };
+    modelValue: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** In order to increment or decrement by given steps. For non-integer values, don't use comma */
+    step: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** When given, it renders a JoyFormError element */
+    errorMessage: {
+        type: StringConstructor;
+    };
+}, {
+    props: Readonly<import("vue").ExtractPropTypes<{
+        /** Removes any interactivity */
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        id: {
+            type: StringConstructor;
+        };
+        invalid: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        name: {
+            type: StringConstructor;
+        };
+        required: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        /** Display a label on top of the element. */
+        label: StringConstructor;
+        /** Overrides the default label size. See JoyLabel stories */
+        labelSize: {
+            type: PropType<"small" | "large" | "medium">;
+            default: string;
+        };
+        /** If your component is not required, we can add a label to explicitely tell that it's not mandatory */
+        optionalLabel: StringConstructor;
+        /** Depending on context, we can add a "*" after the label to specify it's mandatory. */
+        requiredMark: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        /** Used for aria-label. */
+        labelDecrement: {
+            type: StringConstructor;
+        };
+        /** Used for aria-label. */
+        labelIncrement: {
+            type: StringConstructor;
+        };
+        max: {
+            type: NumberConstructor;
+        };
+        min: {
+            type: NumberConstructor;
+            default: number;
+        };
+        modelValue: {
+            type: NumberConstructor;
+            default: number;
+        };
+        /** In order to increment or decrement by given steps. For non-integer values, don't use comma */
+        step: {
+            type: NumberConstructor;
+            default: number;
+        };
+        /** When given, it renders a JoyFormError element */
+        errorMessage: {
+            type: StringConstructor;
+        };
+    }>>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: number) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Removes any interactivity */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    id: {
+        type: StringConstructor;
+    };
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: StringConstructor;
+    };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Display a label on top of the element. */
+    label: StringConstructor;
+    /** Overrides the default label size. See JoyLabel stories */
+    labelSize: {
+        type: PropType<"small" | "large" | "medium">;
+        default: string;
+    };
+    /** If your component is not required, we can add a label to explicitely tell that it's not mandatory */
+    optionalLabel: StringConstructor;
+    /** Depending on context, we can add a "*" after the label to specify it's mandatory. */
+    requiredMark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Used for aria-label. */
+    labelDecrement: {
+        type: StringConstructor;
+    };
+    /** Used for aria-label. */
+    labelIncrement: {
+        type: StringConstructor;
+    };
+    max: {
+        type: NumberConstructor;
+    };
+    min: {
+        type: NumberConstructor;
+        default: number;
+    };
+    modelValue: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** In order to increment or decrement by given steps. For non-integer values, don't use comma */
+    step: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** When given, it renders a JoyFormError element */
+    errorMessage: {
+        type: StringConstructor;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: number) => any) | undefined;
+}, {
+    disabled: boolean;
+    required: boolean;
+    invalid: boolean;
+    labelSize: "small" | "large" | "medium";
+    requiredMark: boolean;
+    min: number;
+    modelValue: number;
+    step: number;
+}>, {
+    default: (_: {}) => any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/JoyFormError/JoyFormError.vue.d.ts

@@ -1,14 +1,18 @@
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** In some cases you'll need to inject the error in the DOM but hide it. Visible by default */
     visible: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** Error message to display. If you need a list of errors, use the slot instead */
     noHtmlErrorText: StringConstructor;
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** In some cases you'll need to inject the error in the DOM but hide it. Visible by default */
     visible: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /** Error message to display. If you need a list of errors, use the slot instead */
     noHtmlErrorText: StringConstructor;
 }>>, {
     visible: boolean;

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

@@ -1,3 +1,3 @@
 import { LEVELS } from '@/types';
 export type HighlightLevels = (typeof LEVELS)[number];
-export declare const HIGHLIGHT_LEVELS: ("error" | "neutral" | "success" | "info" | "warning")[];
+export declare const HIGHLIGHT_LEVELS: ("neutral" | "success" | "info" | "warning" | "error")[];

package/dist/components/JoyHighlight/JoyHighlight.vue.d.ts

@@ -11,7 +11,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     icon: StringConstructor;
     level: {
-        type: PropType<"error" | "neutral" | "success" | "info" | "warning">;
+        type: PropType<"neutral" | "success" | "info" | "warning" | "error">;
         default: string;
         validator(level: HighlightLevels): boolean;
     };
@@ -28,14 +28,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     icon: StringConstructor;
     level: {
-        type: PropType<"error" | "neutral" | "success" | "info" | "warning">;
+        type: PropType<"neutral" | "success" | "info" | "warning" | "error">;
         default: string;
         validator(level: HighlightLevels): boolean;
     };
 }>>, {
     accent: boolean;
     displayIcon: boolean;
-    level: "error" | "neutral" | "success" | "info" | "warning";
+    level: "neutral" | "success" | "info" | "warning" | "error";
 }>, {
     'highlight-title': (_: {}) => any;
     default: (_: {}) => any;

package/dist/components/JoyInput/JoyInput.vue.d.ts

@@ -1,32 +1,60 @@
 import { PropType } from 'vue';
 import { InputSizes } from './JoyInput.types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    clearable: {
+    disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
-    icon: StringConstructor;
-    size: {
-        type: PropType<InputSizes>;
-        default: string;
-        validator(size: InputSizes): boolean;
+    id: {
+        type: StringConstructor;
     };
-    type: StringConstructor;
-    unit: StringConstructor;
-    modelValue: {
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
         type: StringConstructor;
-        default: string;
     };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Display a label on top of the element. */
     label: StringConstructor;
+    /** Overrides the default label size. See JoyLabel stories */
     labelSize: {
         type: PropType<"small" | "large" | "medium">;
         default: string;
     };
+    /** If your component is not required, we can add a label to explicitely tell that it's not mandatory */
     optionalLabel: StringConstructor;
+    /** Depending on context, we can add a "*" after the label to specify it's mandatory. */
     requiredMark: {
         type: BooleanConstructor;
         default: boolean;
     };
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Display a cross icon on the right that enables to clear the field */
+    clearable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Add a JoyIcon / joy-icon with given name on left-side. */
+    icon: StringConstructor;
+    size: {
+        type: PropType<InputSizes>;
+        default: string;
+        validator(size: InputSizes): boolean;
+    };
+    type: StringConstructor;
+    /** Adds a legend like symbol on the right of the component. Made for number based values */
+    unit: StringConstructor;
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     disabled: {
         type: BooleanConstructor;
         default: boolean;
@@ -45,62 +73,50 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    clearable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    icon: StringConstructor;
-    size: {
-        type: PropType<InputSizes>;
-        default: string;
-        validator(size: InputSizes): boolean;
-    };
-    type: StringConstructor;
-    unit: StringConstructor;
-    modelValue: {
-        type: StringConstructor;
-        default: string;
-    };
+    /** Display a label on top of the element. */
     label: StringConstructor;
+    /** Overrides the default label size. See JoyLabel stories */
     labelSize: {
         type: PropType<"small" | "large" | "medium">;
         default: string;
     };
+    /** If your component is not required, we can add a label to explicitely tell that it's not mandatory */
     optionalLabel: StringConstructor;
+    /** Depending on context, we can add a "*" after the label to specify it's mandatory. */
     requiredMark: {
         type: BooleanConstructor;
         default: boolean;
     };
-    disabled: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    id: {
+    modelValue: {
         type: StringConstructor;
+        default: string;
     };
-    invalid: {
+    /** Display a cross icon on the right that enables to clear the field */
+    clearable: {
         type: BooleanConstructor;
         default: boolean;
     };
-    name: {
-        type: StringConstructor;
-    };
-    required: {
-        type: BooleanConstructor;
-        default: boolean;
+    /** Add a JoyIcon / joy-icon with given name on left-side. */
+    icon: StringConstructor;
+    size: {
+        type: PropType<InputSizes>;
+        default: string;
+        validator(size: InputSizes): boolean;
     };
+    type: StringConstructor;
+    /** Adds a legend like symbol on the right of the component. Made for number based values */
+    unit: StringConstructor;
 }>> & {
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
     size: InputSizes;
     disabled: boolean;
-    invalid: boolean;
     required: boolean;
-    modelValue: string;
-    clearable: boolean;
+    invalid: boolean;
     labelSize: "small" | "large" | "medium";
     requiredMark: boolean;
+    modelValue: string;
+    clearable: boolean;
 }>, {
     default: (_: {}) => any;
 }>;

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

@@ -0,0 +1,84 @@
+import { PropType } from 'vue';
+export interface Option {
+    id: string;
+    name?: string;
+    value: string;
+    label: string;
+    subLabel?: string;
+    /**
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * @default false
+     */
+    required?: boolean;
+}
+declare const _default: import("vue").DefineComponent<{
+    options: {
+        type: PropType<Option[]>;
+        required: true;
+        validator(value: Array<Option>): boolean;
+    };
+    id: StringConstructor;
+    value: {
+        type: PropType<any[]>;
+        default(): never[];
+    };
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    label: StringConstructor;
+    labelSize: {
+        type: PropType<"small" | "large" | "medium">;
+        default: string;
+    };
+    optionalLabel: StringConstructor;
+    requiredMark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:value"[], "update:value", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    options: {
+        type: PropType<Option[]>;
+        required: true;
+        validator(value: Array<Option>): boolean;
+    };
+    id: StringConstructor;
+    value: {
+        type: PropType<any[]>;
+        default(): never[];
+    };
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    label: StringConstructor;
+    labelSize: {
+        type: PropType<"small" | "large" | "medium">;
+        default: string;
+    };
+    optionalLabel: StringConstructor;
+    requiredMark: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:value"?: ((...args: any[]) => any) | undefined;
+}, {
+    value: any[];
+    required: boolean;
+    labelSize: "small" | "large" | "medium";
+    requiredMark: boolean;
+    fullWidth: boolean;
+}>;
+export default _default;