@feedmepos/ui-library 0.0.22 → 0.0.24

package/dist/components/button/FmButton.stories.d.ts

@@ -3,7 +3,7 @@ declare const meta: {
     title: string;
     component: import("vue").DefineComponent<{
         variant: {
-            type: import("vue").PropType<"primary" | "secondary" | "tertiary" | "destructive" | "fab">;
+            type: import("vue").PropType<"primary" | "secondary" | "tertiary" | "destructive" | "plain" | "fab">;
             default: string;
         };
         type: {
@@ -26,10 +26,6 @@ declare const meta: {
             type: import("vue").PropType<string>;
             default: string;
         };
-        autofocus: {
-            type: import("vue").PropType<boolean>;
-            default: boolean;
-        };
         iconColor: {
             type: import("vue").PropType<string>;
             default: string;
@@ -38,9 +34,21 @@ declare const meta: {
             type: import("vue").PropType<"prepend" | "append">;
             default: string;
         };
+        prependIcon: {
+            type: import("vue").PropType<string>;
+            default: string;
+        };
+        appendIcon: {
+            type: import("vue").PropType<string>;
+            default: string;
+        };
+        loading: {
+            type: import("vue").PropType<boolean>;
+            default: boolean;
+        };
     }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
         variant: {
-            type: import("vue").PropType<"primary" | "secondary" | "tertiary" | "destructive" | "fab">;
+            type: import("vue").PropType<"primary" | "secondary" | "tertiary" | "destructive" | "plain" | "fab">;
             default: string;
         };
         type: {
@@ -63,10 +71,6 @@ declare const meta: {
             type: import("vue").PropType<string>;
             default: string;
         };
-        autofocus: {
-            type: import("vue").PropType<boolean>;
-            default: boolean;
-        };
         iconColor: {
             type: import("vue").PropType<string>;
             default: string;
@@ -75,16 +79,30 @@ declare const meta: {
             type: import("vue").PropType<"prepend" | "append">;
             default: string;
         };
+        prependIcon: {
+            type: import("vue").PropType<string>;
+            default: string;
+        };
+        appendIcon: {
+            type: import("vue").PropType<string>;
+            default: string;
+        };
+        loading: {
+            type: import("vue").PropType<boolean>;
+            default: boolean;
+        };
     }>>, {
-        variant: "primary" | "secondary" | "tertiary" | "destructive" | "fab";
+        variant: "primary" | "secondary" | "tertiary" | "destructive" | "plain" | "fab";
         type: "button" | "submit" | "reset";
         label: string;
         disabled: boolean;
         size: "md" | "lg";
         icon: string;
-        autofocus: boolean;
         iconColor: string;
         iconPosition: "prepend" | "append";
+        prependIcon: string;
+        appendIcon: string;
+        loading: boolean;
     }, {}>;
     tags: string[];
     argTypes: {
@@ -96,19 +114,13 @@ declare const meta: {
                     summary: string;
                 };
             };
-            description: string;
         };
         label: {
             control: string;
-            description: string;
         };
         size: {
             control: string;
             options: string[];
-            if: {
-                arg: string;
-                neq: string;
-            };
             table: {
                 defaultValue: {
                     summary: string;
@@ -117,7 +129,6 @@ declare const meta: {
                     summary: string;
                 };
             };
-            description: string;
         };
         disabled: {
             control: string;
@@ -126,40 +137,57 @@ declare const meta: {
                     summary: boolean;
                 };
             };
+        };
+        type: {
+            control: string;
+            options: string[];
             description: string;
+            table: {
+                defaultValue: {
+                    summary: string;
+                };
+                type: {
+                    summary: string;
+                };
+            };
         };
-        icon: {
+        prependIcon: {
             control: string;
             table: {
                 defaultValue: {
                     summary: boolean;
                 };
             };
-            description: string;
         };
-        type: {
+        appendIcon: {
             control: string;
-            options: string[];
-            description: string;
             table: {
                 defaultValue: {
-                    summary: string;
-                };
-                type: {
-                    summary: string;
+                    summary: boolean;
                 };
             };
         };
+        icon: {
+            control: string;
+            description: string;
+        };
+        iconPosition: {
+            control: string;
+            description: string;
+        };
+        iconColor: {
+            control: string;
+            description: string;
+        };
     };
     args: {
         variant: "primary";
         label: string;
-        icon: string;
-        iconColor: string;
         size: "md";
         disabled: false;
-        autofocus: true;
         type: "button";
+        prependIcon: string;
+        appendIcon: string;
     };
 };
 export default meta;
@@ -168,4 +196,5 @@ export declare const Primary: Story;
 export declare const Secondary: Story;
 export declare const Tertiary: Story;
 export declare const Destructive: Story;
+export declare const Plain: Story;
 export declare const Fab: Story;

package/dist/components/button/FmButton.vue.d.ts

@@ -1,14 +1,46 @@
-type ButtonVariant = 'primary' | 'secondary' | 'tertiary' | 'destructive' | 'fab';
+type ButtonVariant = 'primary' | 'secondary' | 'tertiary' | 'destructive' | 'plain' | 'fab';
 export interface FmButtonProps {
+    /** Variant of the button. */
     variant?: ButtonVariant;
+    /** Label of the button. */
     label?: string;
+    /**
+     * @deprecated
+     * Please use `prependIcon` and `appendIcon` from now on.
+     */
     icon?: string;
+    /**
+     * Size of the button.
+     *
+     * `FAB` will be size `lg` always.
+     */
     size?: 'md' | 'lg';
+    /** Specify if button is disabled. */
     disabled?: boolean;
-    autofocus?: boolean;
+    /**
+     * @deprecated
+     * Design is strict on color, with icon color to be locked in by variant type.
+     */
     iconColor?: string;
+    /**
+     * The type of the button.
+     *
+     * Default: `button`
+     */
     type?: 'submit' | 'reset' | 'button';
+    /**
+     * @deprecated
+     * Please use `prependIcon` and `appendIcon` from now on.
+     *
+     * This option was originally to be used with `icon`.
+     */
     iconPosition?: 'prepend' | 'append';
+    /** To add icon at the front. */
+    prependIcon?: string;
+    /** To add icon at the back. */
+    appendIcon?: string;
+    /** Loading state */
+    loading?: boolean;
 }
 declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmButtonProps>, {
     variant: string;
@@ -16,20 +48,24 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     icon: string;
     size: string;
     disabled: boolean;
-    autofocus: boolean;
     iconColor: string;
     type: string;
     iconPosition: string;
+    prependIcon: string;
+    appendIcon: string;
+    loading: boolean;
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmButtonProps>, {
     variant: string;
     label: string;
     icon: string;
     size: string;
     disabled: boolean;
-    autofocus: boolean;
     iconColor: string;
     type: string;
     iconPosition: string;
+    prependIcon: string;
+    appendIcon: string;
+    loading: boolean;
 }>>>, {
     variant: ButtonVariant;
     type: "button" | "submit" | "reset";
@@ -37,9 +73,11 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     disabled: boolean;
     size: "md" | "lg";
     icon: string;
-    autofocus: boolean;
     iconColor: string;
     iconPosition: "prepend" | "append";
+    prependIcon: string;
+    appendIcon: string;
+    loading: boolean;
 }, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/dist/components/form/field/FmField.vue.d.ts

@@ -25,11 +25,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     focused: boolean;
 }>>>, {
     disabled: boolean;
+    prependIcon: string;
+    appendIcon: string;
     invalid: boolean;
     focused: boolean;
     tag: string;
-    prependIcon: string;
-    appendIcon: string;
     showValidBorder: boolean;
 }, {}>, {
     prepend?(_: {}): any;

package/dist/components/form/stepper-field/FmStepperField.vue.d.ts

@@ -65,6 +65,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     "onUpdate:modelValue"?: ((value: number) => any) | undefined;
 }, {
     label: string;
+    prependIcon: string;
+    appendIcon: string;
     min: number;
     max: number;
     rules: import("../../../composables/useValidation").ValidationRule[];
@@ -74,8 +76,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     labelInfo: string;
     placeholder: string;
     step: number;
-    prependIcon: string;
-    appendIcon: string;
     showValidBorder: boolean;
     inputmode: "numeric" | "decimal";
     useGrouping: boolean;

package/dist/components/form/text-field/FmTextField.vue.d.ts

@@ -63,6 +63,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
 }, {
     label: string;
     disabled: boolean;
+    prependIcon: string;
+    appendIcon: string;
     rules: import("../../../composables/useValidation").ValidationRule[];
     helperText: string;
     helperState: "success" | "warning" | "none" | "error";
@@ -71,8 +73,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     maxLength: number;
     minLength: number;
     placeholder: string;
-    prependIcon: string;
-    appendIcon: string;
     showValidBorder: boolean;
     inputmode: "numeric" | "text" | "search" | "none" | "email" | "tel" | "url" | "decimal";
     readonly: boolean;

package/dist/components/menu/{menu-list/FmMenuList.vue.d.ts → menu-component/FmMenu.vue.d.ts}

@@ -1,19 +1,16 @@
 import { type ComputedRef, type Ref } from 'vue';
 import { type Placement } from '@floating-ui/vue';
-interface FmMenuItem {
-    label?: string;
-    sublabel?: string;
-    icon?: string;
-    expandable?: boolean;
-    hasCheckbox?: boolean;
-    disabled?: boolean;
-    dividerPlacement?: 'up' | 'down' | 'both' | null;
-}
 interface FmMenu {
-    items?: FmMenuItem[];
+    /** Placement for the dropdown content relative to the button */
     placement?: Placement;
-    level?: number;
+    /** Trigger for the main menu button only (does not affect submenu(s)) */
     trigger?: 'click' | 'hover';
+    /** When set to `true`, menu will close on item clicks */
+    closeOnClick?: boolean;
+    /** Set the width of the content box */
+    width?: number | undefined;
+    /** Set the max height of the content box */
+    maxHeight?: number;
 }
 export interface MenuProvider {
     register: ({ injectProps, }: {
@@ -27,36 +24,35 @@ export interface MenuProvider {
     trigger: 'click' | 'hover';
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmMenu>, {
-    items: () => never[];
     showMenu: boolean;
     placement: string;
     disabled: boolean;
-    level: number;
     trigger: string;
+    closeOnClick: boolean;
+    width: undefined;
+    maxHeight: number;
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "menu-changed": (opened: boolean) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmMenu>, {
-    items: () => never[];
     showMenu: boolean;
     placement: string;
     disabled: boolean;
-    level: number;
     trigger: string;
+    closeOnClick: boolean;
+    width: undefined;
+    maxHeight: number;
 }>>> & {
     "onMenu-changed"?: ((opened: boolean) => any) | undefined;
 }, {
-    items: FmMenuItem[];
+    maxHeight: number;
     placement: Placement;
-    level: number;
     trigger: "click" | "hover";
+    closeOnClick: boolean;
+    width: number;
 }, {}>, {
     "menu-button"?(_: {}): any;
-    "menu-wrapper"?(_: {
-        forceHide: () => boolean;
-    }): any;
-    default?(_: {
-        forceHide: () => boolean;
-    }): any;
+    "menu-wrapper"?(_: {}): any;
+    default?(_: {}): any;
 }>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/dist/components/menu/{menu-container → menu-container-deprecated}/FmMenu.stories.d.ts

@@ -1,6 +1,6 @@
 import type { Meta, StoryObj } from '@storybook/vue3';
-import FmMenu from './FmMenu.vue';
-declare const meta: Meta<typeof FmMenu>;
+import FmMenuDeprecated from './FmMenuDeprecated.vue';
+declare const meta: Meta<typeof FmMenuDeprecated>;
 export default meta;
 type Story = StoryObj<typeof meta>;
 export declare const Primary: Story;

package/dist/components/menu/menu-divider/FmMenuDivider.vue.d.ts

@@ -0,0 +1,37 @@
+export interface FmDividerProps {
+    /** To enable Vertical divider */
+    vertical?: boolean;
+    /**
+     * Will be influenced by menu padding of 4px to align with items
+     * Setting `false` will make sure line is 100% width across
+     * */
+    inset?: boolean;
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmDividerProps>, {
+    vertical: boolean;
+    inset: boolean;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmDividerProps>, {
+    vertical: boolean;
+    inset: boolean;
+}>>>, {
+    vertical: boolean;
+    inset: boolean;
+}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/menu/menu-header/FmMenuHeader.vue.d.ts

@@ -0,0 +1,14 @@
+export interface FmMenuHeaderProps {
+    label: string;
+}
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<FmMenuHeaderProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<FmMenuHeaderProps>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/menu/menu-item/FmMenuItem.vue.d.ts

@@ -1,42 +1,54 @@
 export interface FmMenuItemProps {
-    modelValue: boolean;
+    /** Specify when item is in a selectable state */
+    modelValue?: boolean;
+    /** Specify if item is selectable */
+    selectable?: boolean;
+    /** Specify the label of the item */
     label?: string;
+    /** Specify the sublabel of the item */
     sublabel?: string;
+    /** Specify the prepend icon of the item */
     icon?: string;
+    /** Specify if item has submenu, this will add an appending expand icon */
     expandable?: boolean;
+    /** Specify if item uses checkbox to show selected state */
     hasCheckbox?: boolean;
+    /** Specify if item is disabled */
     disabled?: boolean;
-    dividerPlacement?: 'up' | 'down' | 'both' | null;
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmMenuItemProps>, {
+    modelValue: boolean;
     label: string;
     sublabel: string;
     icon: string;
     expandable: boolean;
     hasCheckbox: boolean;
     disabled: boolean;
-    dividerPlacement: null;
+    selectable: boolean;
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: boolean) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmMenuItemProps>, {
+    modelValue: boolean;
     label: string;
     sublabel: string;
     icon: string;
     expandable: boolean;
     hasCheckbox: boolean;
     disabled: boolean;
-    dividerPlacement: null;
+    selectable: boolean;
 }>>> & {
     "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
 }, {
     label: string;
     disabled: boolean;
     icon: string;
+    modelValue: boolean;
+    selectable: boolean;
     sublabel: string;
     expandable: boolean;
     hasCheckbox: boolean;
-    dividerPlacement: "up" | "down" | "both" | null;
 }, {}>, {
+    prepend?(_: {}): any;
     label?(_: {}): any;
     append?(_: {}): any;
 }>;

package/dist/components/progress-indicator/FmProgress.vue.d.ts

@@ -0,0 +1,32 @@
+export interface FmProgressProps {
+    size?: 'md' | 'lg' | 'xl';
+    color?: string;
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmProgressProps>, {
+    size: string;
+    color: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmProgressProps>, {
+    size: string;
+    color: string;
+}>>>, {
+    color: string;
+    size: "md" | "lg" | "xl";
+}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/table/FmTable.vue.d.ts

@@ -12,6 +12,8 @@ export interface FmTableProps {
     fetchFn?: ({ pageSize, pageIndex }: PaginationState) => void;
     /** Default is 10 */
     pageSize?: number;
+    /** Pin the headers row */
+    pinHeaderRow?: boolean;
 }
 export interface FmTableColumnDefs {
     minWidth?: number;
@@ -26,6 +28,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     pageCount: number;
     pageSize: number;
     fetchFn: undefined;
+    pinHeaderRow: boolean;
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FmTableProps>, {
     modelValue: {};
     selection: undefined;
@@ -35,6 +38,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     pageCount: number;
     pageSize: number;
     fetchFn: undefined;
+    pinHeaderRow: boolean;
 }>>>, {
     modelValue: any;
     pageSize: number;
@@ -44,6 +48,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     searchValue: string;
     pageCount: number;
     fetchFn: ({ pageSize, pageIndex }: PaginationState) => void;
+    pinHeaderRow: boolean;
 }, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;