@propelinc/citrus-ui 0.6.0 → 1.0.0

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

@@ -0,0 +1,32 @@
+import { IconDefinition } from '@fortawesome/fontawesome-svg-core';
+import { PropType, DefineComponent, ExtractPropTypes, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Specifies the label's icon, overwritten if icon slot is used */
+    icon: {
+        type: PropType<string | string[] | IconDefinition>;
+        default: null;
+    };
+    /** A custom data test string */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** Specifies the label's icon, overwritten if icon slot is used */
+    icon: {
+        type: PropType<string | string[] | IconDefinition>;
+        default: null;
+    };
+    /** A custom data test string */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    icon: string | string[] | IconDefinition;
+    dataTest: string;
+}, {}, {
+    FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,208 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { RouteLocationRaw, RouteLocationAsRelativeGeneric, RouteLocationAsPathGeneric } from 'vue-router';
+import { FaPropType, FaIcon } from '../types/font-awesome';
+import { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+import { CssColor } from '../colors/colors';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** The Font Awesome icon to display */
+    icon: {
+        type: FaPropType;
+        default: null;
+    };
+    /** The icon to display on the right side for clickable items, defaulting to right arrow */
+    actionIcon: {
+        type: FaPropType;
+        default: null;
+    };
+    /** Color of the icon background */
+    iconColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Emphasized text above body text. Overridden by the default slot. */
+    title: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Plain body copy. Overridden by the default slot. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Router location for links within the app */
+    to: {
+        type: PropType<RouteLocationRaw>;
+        default: undefined;
+    };
+    /** HTML target attribute for links to outside the app */
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Location for links to outside the app */
+    href: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Changes alignment of icon and action icon */
+    align: {
+        type: PropType<"top" | "center">;
+        default: string;
+    };
+    /** Overrides default behavior to display a chevron in the action slot */
+    hideAction: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    allAttrs: ComputedRef<{
+        [x: string]: unknown;
+    }>;
+    faChevronRight: IconDefinition;
+    iconSlotHasContent: Ref<boolean, boolean>;
+    isTappable: ComputedRef<boolean>;
+    navigate: (event: MouseEvent) => Promise<void>;
+    renderActionSlot: ComputedRef<boolean>;
+    routerDestinationOrHref: ComputedRef<string | undefined>;
+    tag: ComputedRef<"div" | "button" | "a">;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** The Font Awesome icon to display */
+    icon: {
+        type: FaPropType;
+        default: null;
+    };
+    /** The icon to display on the right side for clickable items, defaulting to right arrow */
+    actionIcon: {
+        type: FaPropType;
+        default: null;
+    };
+    /** Color of the icon background */
+    iconColor: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Emphasized text above body text. Overridden by the default slot. */
+    title: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Plain body copy. Overridden by the default slot. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Router location for links within the app */
+    to: {
+        type: PropType<RouteLocationRaw>;
+        default: undefined;
+    };
+    /** HTML target attribute for links to outside the app */
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Location for links to outside the app */
+    href: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Changes alignment of icon and action icon */
+    align: {
+        type: PropType<"top" | "center">;
+        default: string;
+    };
+    /** Overrides default behavior to display a chevron in the action slot */
+    hideAction: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    label: string;
+    title: string;
+    to: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+    icon: FaIcon;
+    target: string;
+    href: string;
+    iconColor: string;
+    actionIcon: FaIcon;
+    align: "center" | "top";
+    hideAction: boolean;
+}, {}, {
+    FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+    CListItemIcon: DefineComponent<ExtractPropTypes<{
+        icon: any;
+        iconColor: any;
+    }>, {
+        iconSlotHasContent: Ref<boolean, boolean>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        icon: any;
+        iconColor: any;
+    }>> & Readonly<{}>, {
+        icon: any;
+        iconColor: any;
+    }, {}, {
+        CSquaredIcon: DefineComponent<ExtractPropTypes<{
+            icon: {
+                type: FaPropType;
+                default: null;
+            };
+            color: {
+                type: StringConstructor;
+                default: string;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>, {
+            cssColor: Ref< CssColor | undefined, CssColor | undefined>;
+            useWhiteIcon: ComputedRef<boolean>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+            icon: {
+                type: FaPropType;
+                default: null;
+            };
+            color: {
+                type: StringConstructor;
+                default: string;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>> & Readonly<{}>, {
+            icon: FaIcon;
+            color: string;
+            large: boolean;
+        }, {}, {
+            FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+        }, {}, string, ComponentProvideOptions, true, {}, any>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+    CListItemContent: DefineComponent<ExtractPropTypes<{
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+        label: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, {
+        titleSlotHasContent: Ref<boolean, boolean>;
+        labelSlotHasContent: Ref<boolean, boolean>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+        label: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        label: string;
+        title: string;
+    }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,27 @@
+import { DefineComponent, ExtractPropTypes, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    titleSlotHasContent: Ref<boolean, boolean>;
+    labelSlotHasContent: Ref<boolean, boolean>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    label: string;
+    title: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,54 @@
+import { DefineComponent, ExtractPropTypes, Ref, ComponentOptionsMixin, PublicProps, ComputedRef, ComponentProvideOptions } from 'vue';
+import { FaPropType, FaIcon } from '../types/font-awesome';
+import { CssColor } from '../colors/colors';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    icon: any;
+    iconColor: any;
+}>, {
+    iconSlotHasContent: Ref<boolean, boolean>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    icon: any;
+    iconColor: any;
+}>> & Readonly<{}>, {
+    icon: any;
+    iconColor: any;
+}, {}, {
+    CSquaredIcon: DefineComponent<ExtractPropTypes<{
+        icon: {
+            type: FaPropType;
+            default: null;
+        };
+        color: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>, {
+        cssColor: Ref< CssColor | undefined, CssColor | undefined>;
+        useWhiteIcon: ComputedRef<boolean>;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+        icon: {
+            type: FaPropType;
+            default: null;
+        };
+        color: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        icon: FaIcon;
+        color: string;
+        large: boolean;
+    }, {}, {
+        FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,73 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { default as Colors, HexColor, isValidColor, CssColor } from '../colors/colors';
+type Size = 'sm' | 'md' | 'lg';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Customizes screen reader only text alternative, should be translated */
+    accessibleText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Sets the color of the indicator of the loader */
+    color: {
+        type: PropType<HexColor | keyof typeof Colors>;
+        default: string;
+        validator: typeof isValidColor;
+    };
+    /** @deprecated Shows a smaller version of the loading icon */
+    small: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Sets the size of the loader */
+    size: {
+        type: PropType<Size>;
+        default: string;
+    };
+    /** Sets the color of the track of the loader */
+    trackColor: {
+        type: PropType<HexColor | keyof typeof Colors>;
+        default: string;
+        validator: typeof isValidColor;
+    };
+}>, {
+    computedSize: ComputedRef<Size>;
+    indicatorColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+    SIZE_TO_FONT_SIZE: Record<Size, `${number}px`>;
+    SIZE_TO_TRACK_WIDTH: Record<Size, `${number}px`>;
+    trackColorCode: Ref< CssColor | undefined, CssColor | undefined>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** Customizes screen reader only text alternative, should be translated */
+    accessibleText: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Sets the color of the indicator of the loader */
+    color: {
+        type: PropType<HexColor | keyof typeof Colors>;
+        default: string;
+        validator: typeof isValidColor;
+    };
+    /** @deprecated Shows a smaller version of the loading icon */
+    small: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Sets the size of the loader */
+    size: {
+        type: PropType<Size>;
+        default: string;
+    };
+    /** Sets the color of the track of the loader */
+    trackColor: {
+        type: PropType<HexColor | keyof typeof Colors>;
+        default: string;
+        validator: typeof isValidColor;
+    };
+}>> & Readonly<{}>, {
+    small: boolean;
+    size: Size;
+    accessibleText: string;
+    color: string;
+    trackColor: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,19 @@
+import { DefineComponent, ExtractPropTypes, ComputedRef, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Show just the orange icon */
+    icon: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    src: ComputedRef<string>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** Show just the orange icon */
+    icon: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    icon: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;