@propelinc/citrus-ui 0.6.0 → 1.0.0

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

@@ -0,0 +1,6 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+export type { default as SlMenuItem } from '@shoelace-style/shoelace/dist/components/menu-item/menu-item.js';
+declare const _default: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "select"[], "select", PublicProps, Readonly<{}> & Readonly<{
+    onSelect?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,170 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComponentOptionsMixin, PublicProps, Ref, ComputedRef, ComponentProvideOptions } from 'vue';
+import { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Controls whether the item has hover-state styles and responds to click events */
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether to enable and display a checked state */
+    checkable: {
+        type: BooleanConstructor;
+    };
+    /** Reflects the item's checked state */
+    checked: {
+        type: BooleanConstructor;
+    };
+    /** Controls what style of checking to apply, either a checkbox, or just a check icon */
+    checkType: {
+        type: PropType<"checkbox" | "icon">;
+        default: string;
+    };
+}>, {
+    faCheck: IconDefinition;
+    onClick: (e: Event) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** Controls whether the item has hover-state styles and responds to click events */
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether to enable and display a checked state */
+    checkable: {
+        type: BooleanConstructor;
+    };
+    /** Reflects the item's checked state */
+    checked: {
+        type: BooleanConstructor;
+    };
+    /** Controls what style of checking to apply, either a checkbox, or just a check icon */
+    checkType: {
+        type: PropType<"checkbox" | "icon">;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    checked: boolean;
+    selectable: boolean;
+    checkable: boolean;
+    checkType: "icon" | "checkbox";
+}, {}, {
+    CCheckbox: DefineComponent<ExtractPropTypes<{
+        id: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        label: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        value: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        rules: {
+            type: PropType<((value: boolean) => string | boolean)[]>;
+            default: () => never[];
+        };
+        hideDetails: {
+            type: PropType<boolean | "auto">;
+            default: boolean;
+        };
+        variant: {
+            type: PropType<"contained" | "minimal">;
+            default: string;
+        };
+    }>, {
+        checkbox: Ref<HTMLInputElement | null, HTMLInputElement | null>;
+        faCheck: IconDefinition;
+        idWithFallback: Ref<string, string>;
+        internalValue: Ref<boolean, boolean>;
+        onChange: (event: Event) => void;
+        validationMessage: Ref<string | null, string | null>;
+        isValidationValid: Ref<boolean | null, boolean | null>;
+        validationListeners: Record<string, (event: Event) => void>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "focus" | "blur")[], "change" | "focus" | "blur", PublicProps, Readonly< ExtractPropTypes<{
+        id: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        label: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        value: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        rules: {
+            type: PropType<((value: boolean) => string | boolean)[]>;
+            default: () => never[];
+        };
+        hideDetails: {
+            type: PropType<boolean | "auto">;
+            default: boolean;
+        };
+        variant: {
+            type: PropType<"contained" | "minimal">;
+            default: string;
+        };
+    }>> & Readonly<{
+        onChange?: ((...args: any[]) => any) | undefined;
+        onFocus?: ((...args: any[]) => any) | undefined;
+        onBlur?: ((...args: any[]) => any) | undefined;
+    }>, {
+        label: string;
+        id: string | null;
+        value: boolean;
+        dataTest: string;
+        variant: "contained" | "minimal";
+        rules: ((value: boolean) => string | boolean)[];
+        hideDetails: boolean | "auto";
+    }, {}, {
+        FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+        CValidationMessage: DefineComponent<ExtractPropTypes<{
+            dataTest: {
+                type: StringConstructor;
+                default: string;
+            };
+            validationMessage: {
+                type: PropType<string | null>;
+                default: null;
+            };
+            hide: {
+                type: PropType<boolean | "auto">;
+                default: boolean;
+            };
+        }>, {
+            isHidden: ComputedRef<boolean>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+            dataTest: {
+                type: StringConstructor;
+                default: string;
+            };
+            validationMessage: {
+                type: PropType<string | null>;
+                default: null;
+            };
+            hide: {
+                type: PropType<boolean | "auto">;
+                default: boolean;
+            };
+        }>> & Readonly<{}>, {
+            dataTest: string;
+            validationMessage: string | null;
+            hide: boolean | "auto";
+        }, {}, {
+            CFadeTransition: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+        }, {}, string, ComponentProvideOptions, true, {}, any>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+    FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,3 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,206 @@
+import { default as SlDialog } from '@shoelace-style/shoelace/dist/components/dialog/dialog.js';
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { HexColor, isValidColor, CssColor } from '../colors/colors';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Controls whether or not the modal is showing */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The title of the modal */
+    title: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Shows loading state and sets loading message if string */
+    loading: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /** Allows modal to be dismissed */
+    dismissible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Prefix for test selectors */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Toggles the open/close animation */
+    transition: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the modal displays fullscreen */
+    fullscreen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Aria label for the modal. This is required if title is hidden */
+    ariaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    dialogLabel: ComputedRef<string>;
+    loadingMessage: ComputedRef<string | null>;
+    isVisible: Ref<boolean, boolean>;
+    enableExpandTransition: ComputedRef<boolean>;
+    footerHasContent: Ref<boolean, boolean>;
+    onRequestClose: (event: Event) => void;
+    getDataTestAttr: (suffix?: string) => string;
+    modal: Ref<SlDialog | null, SlDialog | null>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "input"[], "input", PublicProps, Readonly< ExtractPropTypes<{
+    /** Controls whether or not the modal is showing */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The title of the modal */
+    title: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Shows loading state and sets loading message if string */
+    loading: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /** Allows modal to be dismissed */
+    dismissible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Prefix for test selectors */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Toggles the open/close animation */
+    transition: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the modal displays fullscreen */
+    fullscreen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Aria label for the modal. This is required if title is hidden */
+    ariaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onInput?: ((...args: any[]) => any) | undefined;
+}>, {
+    title: string | null;
+    value: boolean;
+    dataTest: string;
+    transition: boolean;
+    loading: string | boolean;
+    ariaLabel: string;
+    dismissible: boolean;
+    fullscreen: boolean;
+}, {}, {
+    CButtonStack: DefineComponent<ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>, void, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>> & Readonly<{}>, {
+        large: boolean;
+        tag: string;
+    }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    CLoader: DefineComponent<ExtractPropTypes<{
+        accessibleText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        color: {
+            type: PropType< HexColor | string>;
+            default: string;
+            validator: isValidColor;
+        };
+        small: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        size: {
+            type: PropType<"sm" | "lg" | "md">;
+            default: string;
+        };
+        trackColor: {
+            type: PropType< HexColor | string>;
+            default: string;
+            validator: isValidColor;
+        };
+    }>, {
+        computedSize: ComputedRef<"sm" | "lg" | "md">;
+        indicatorColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+        SIZE_TO_FONT_SIZE: Record<"sm" | "lg" | "md", `${number}px`>;
+        SIZE_TO_TRACK_WIDTH: Record<"sm" | "lg" | "md", `${number}px`>;
+        trackColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        accessibleText: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        color: {
+            type: PropType< HexColor | string>;
+            default: string;
+            validator: isValidColor;
+        };
+        small: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        size: {
+            type: PropType<"sm" | "lg" | "md">;
+            default: string;
+        };
+        trackColor: {
+            type: PropType< HexColor | string>;
+            default: string;
+            validator: isValidColor;
+        };
+    }>> & Readonly<{}>, {
+        small: boolean;
+        size: "sm" | "lg" | "md";
+        accessibleText: string;
+        color: string;
+        trackColor: string;
+    }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    CExpandTransition: DefineComponent<ExtractPropTypes<{
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>, {
+        content: Ref<HTMLElement | null, HTMLElement | null>;
+        height: Ref<string, string>;
+        isDisabled: ComputedRef<boolean>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        disabled: boolean;
+    }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,230 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComponentOptionsMixin, PublicProps, ComputedRef, Ref, ComponentProvideOptions } from 'vue';
+import { SlDialog } from '@shoelace-style/shoelace';
+import { HexColor, isValidColor, CssColor } from '../colors/colors';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Controls whether or not the modal is showing */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls the message shown below the Modal Loading icon */
+    message: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Prefix for test selectors */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "input"[], "input", PublicProps, Readonly< ExtractPropTypes<{
+    /** Controls whether or not the modal is showing */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls the message shown below the Modal Loading icon */
+    message: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    /** Prefix for test selectors */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onInput?: ((...args: any[]) => any) | undefined;
+}>, {
+    value: boolean;
+    dataTest: string;
+    message: string | null;
+}, {}, {
+    CModal: DefineComponent<ExtractPropTypes<{
+        value: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        title: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        loading: {
+            type: (BooleanConstructor | StringConstructor)[];
+            default: boolean;
+        };
+        dismissible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        transition: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        fullscreen: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, {
+        dialogLabel: ComputedRef<string>;
+        loadingMessage: ComputedRef<string | null>;
+        isVisible: Ref<boolean, boolean>;
+        enableExpandTransition: ComputedRef<boolean>;
+        footerHasContent: Ref<boolean, boolean>;
+        onRequestClose: (event: Event) => void;
+        getDataTestAttr: (suffix?: string) => string;
+        modal: Ref< SlDialog | null, SlDialog | null>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "input"[], "input", PublicProps, Readonly< ExtractPropTypes<{
+        value: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        title: {
+            type: PropType<string | null>;
+            default: null;
+        };
+        loading: {
+            type: (BooleanConstructor | StringConstructor)[];
+            default: boolean;
+        };
+        dismissible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        dataTest: {
+            type: StringConstructor;
+            default: string;
+        };
+        transition: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        fullscreen: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{
+        onInput?: ((...args: any[]) => any) | undefined;
+    }>, {
+        title: string | null;
+        value: boolean;
+        dataTest: string;
+        transition: boolean;
+        loading: string | boolean;
+        ariaLabel: string;
+        dismissible: boolean;
+        fullscreen: boolean;
+    }, {}, {
+        CButtonStack: DefineComponent<ExtractPropTypes<{
+            tag: {
+                type: StringConstructor;
+                default: string;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: null;
+            };
+        }>, void, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+            tag: {
+                type: StringConstructor;
+                default: string;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: null;
+            };
+        }>> & Readonly<{}>, {
+            large: boolean;
+            tag: string;
+        }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+        CLoader: DefineComponent<ExtractPropTypes<{
+            accessibleText: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            color: {
+                type: PropType< HexColor | string>;
+                default: string;
+                validator: isValidColor;
+            };
+            small: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            size: {
+                type: PropType<"sm" | "lg" | "md">;
+                default: string;
+            };
+            trackColor: {
+                type: PropType< HexColor | string>;
+                default: string;
+                validator: isValidColor;
+            };
+        }>, {
+            computedSize: ComputedRef<"sm" | "lg" | "md">;
+            indicatorColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+            SIZE_TO_FONT_SIZE: Record<"sm" | "lg" | "md", `${number}px`>;
+            SIZE_TO_TRACK_WIDTH: Record<"sm" | "lg" | "md", `${number}px`>;
+            trackColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+            accessibleText: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            color: {
+                type: PropType< HexColor | string>;
+                default: string;
+                validator: isValidColor;
+            };
+            small: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            size: {
+                type: PropType<"sm" | "lg" | "md">;
+                default: string;
+            };
+            trackColor: {
+                type: PropType< HexColor | string>;
+                default: string;
+                validator: isValidColor;
+            };
+        }>> & Readonly<{}>, {
+            small: boolean;
+            size: "sm" | "lg" | "md";
+            accessibleText: string;
+            color: string;
+            trackColor: string;
+        }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+        CExpandTransition: DefineComponent<ExtractPropTypes<{
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>, {
+            content: Ref<HTMLElement | null, HTMLElement | null>;
+            height: Ref<string, string>;
+            isDisabled: ComputedRef<boolean>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>> & Readonly<{}>, {
+            disabled: boolean;
+        }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;