@propelinc/citrus-ui 0.6.0 → 1.0.0

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

@@ -0,0 +1,128 @@
+import { PropType, 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';
+type Size = 'medium' | 'large';
+type ImageState = 'loading' | 'loaded' | 'failed';
+/**
+ * A component that displays a third party logo with a fallback icon.
+ *
+ * The fallback icon is displayed while the image is loading or if the image fails to load.
+ *
+ * The image is rendered, but hidden, while loading, and displayed when loaded.
+ */
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /**
+     * The alt text for the logo.
+     */
+    alt: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The color of the fallback icon logo
+     */
+    color: any;
+    /**
+     * The Font Awesome icon to display as a fallback
+     */
+    icon: any;
+    /**
+     * The size of the logo. Defaults to `medium`.
+     */
+    size: {
+        type: PropType<Size>;
+        required: false;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * The URL of the logo image
+     */
+    src: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+}>, {
+    handleImageError: () => void;
+    handleImageLoad: () => void;
+    imageState: Ref<ImageState, ImageState>;
+    SIZE_TO_VALUE: Record<Size, `${number}px`>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /**
+     * The alt text for the logo.
+     */
+    alt: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The color of the fallback icon logo
+     */
+    color: any;
+    /**
+     * The Font Awesome icon to display as a fallback
+     */
+    icon: any;
+    /**
+     * The size of the logo. Defaults to `medium`.
+     */
+    size: {
+        type: PropType<Size>;
+        required: false;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * The URL of the logo image
+     */
+    src: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    size: Size;
+    icon: any;
+    color: any;
+    src: string;
+}, {}, {
+    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/CTimeago.vue.d.ts

@@ -0,0 +1,12 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Props = {
+    datetime: string | number | Date;
+    converter: (datetime: string | number | Date, locale: string, count?: number) => string;
+    locale?: string;
+    autoUpdate?: number | false;
+};
+declare const _default: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    locale: string;
+    autoUpdate: number | false;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLTimeElement>;
+export default _default;

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

@@ -0,0 +1,458 @@
+import { default as SlAlert } from '@shoelace-style/shoelace/dist/components/alert/alert.js';
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { ToastVariant } from '../types';
+import { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+import { ButtonLevel, ButtonSize, ButtonVariant, ButtonIconPosition, ButtonShoelaceVariant } from './CButton/types';
+import { RouteLocationRaw, RouteLocationAsRelativeGeneric, RouteLocationAsPathGeneric } from 'vue-router';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Show/hides the toast */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The message rendered in the toast, using the default slot overrides this value */
+    message: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the error state
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the success state
+     */
+    success: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the warning state
+     */
+    warning: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /** The variant of the toast */
+    variant: {
+        type: PropType<ToastVariant>;
+        default: string;
+    };
+    /** Controls (overrides) whether the toast is dismissible. */
+    dismissible: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /** The data-test attribute for the toast. */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    duration: ComputedRef<number>;
+    alert: Ref<SlAlert | null, SlAlert | null>;
+    icon: ComputedRef<IconDefinition>;
+    faXmark: IconDefinition;
+    isOpen: Ref<boolean, boolean>;
+    computedVariant: ComputedRef<ToastVariant>;
+    close: () => Promise<void>;
+    onHide: () => void;
+    transform: ComputedRef<string>;
+    resetAnimation: () => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("input" | "hide")[], "input" | "hide", PublicProps, Readonly< ExtractPropTypes<{
+    /** Show/hides the toast */
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** The message rendered in the toast, using the default slot overrides this value */
+    message: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the error state
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the success state
+     */
+    success: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the warning state
+     */
+    warning: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /** The variant of the toast */
+    variant: {
+        type: PropType<ToastVariant>;
+        default: string;
+    };
+    /** Controls (overrides) whether the toast is dismissible. */
+    dismissible: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /** The data-test attribute for the toast. */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onInput?: ((...args: any[]) => any) | undefined;
+    onHide?: ((...args: any[]) => any) | undefined;
+}>, {
+    value: boolean;
+    dataTest: string;
+    error: boolean;
+    message: string;
+    variant: ToastVariant;
+    warning: boolean;
+    dismissible: boolean | undefined;
+    success: boolean;
+}, {}, {
+    FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+    CIconButton: DefineComponent<ExtractPropTypes<{
+        ariaLabel: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        ariaLabelledby: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        href: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        icon: {
+            type: PropType<string | string[] | IconDefinition>;
+            default: undefined;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        level: {
+            type: PropType< ButtonLevel>;
+            default: string;
+        };
+        loading: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        secondary: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        size: {
+            type: PropType< ButtonSize>;
+            default: string;
+        };
+        spinIcon: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        target: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        tertiary: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        to: {
+            type: PropType< RouteLocationRaw>;
+            default: undefined;
+        };
+        variant: {
+            type: PropType< ButtonVariant>;
+            default: string;
+        };
+    }>, {
+        computedSize: ComputedRef<ButtonSize>;
+        computedVariant: ComputedRef<ButtonVariant>;
+        inheritColor: Ref<boolean, boolean> | undefined;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("focus" | "blur" | "click")[], "focus" | "blur" | "click", PublicProps, Readonly< ExtractPropTypes<{
+        ariaLabel: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        ariaLabelledby: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        href: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        icon: {
+            type: PropType<string | string[] | IconDefinition>;
+            default: undefined;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        level: {
+            type: PropType< ButtonLevel>;
+            default: string;
+        };
+        loading: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        secondary: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        size: {
+            type: PropType< ButtonSize>;
+            default: string;
+        };
+        spinIcon: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        target: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        tertiary: {
+            type: BooleanConstructor;
+            default: boolean;
+            deprecated: boolean;
+        };
+        to: {
+            type: PropType< RouteLocationRaw>;
+            default: undefined;
+        };
+        variant: {
+            type: PropType< ButtonVariant>;
+            default: string;
+        };
+    }>> & Readonly<{
+        onFocus?: ((...args: any[]) => any) | undefined;
+        onBlur?: ((...args: any[]) => any) | undefined;
+        onClick?: ((...args: any[]) => any) | undefined;
+    }>, {
+        to: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+        size: ButtonSize;
+        icon: string | string[] | IconDefinition;
+        target: string;
+        tertiary: boolean;
+        loading: boolean;
+        large: boolean;
+        disabled: boolean;
+        ariaLabel: string;
+        secondary: boolean;
+        href: string;
+        level: ButtonLevel;
+        variant: ButtonVariant;
+        ariaLabelledby: string;
+        spinIcon: boolean;
+    }, {}, {
+        FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+        CButton: DefineComponent<ExtractPropTypes<{
+            block: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            href: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            icon: {
+                type: PropType<string | string[] | IconDefinition>;
+                default: undefined;
+            };
+            iconPosition: {
+                type: PropType< ButtonIconPosition>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            level: {
+                type: PropType< ButtonLevel>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            loading: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            secondary: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            size: {
+                type: PropType< ButtonSize>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            target: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            tertiary: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            to: {
+                type: PropType< RouteLocationRaw>;
+                default: undefined;
+            };
+            variant: {
+                type: PropType< ButtonVariant>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+        }>, {
+            animationListeners: Record<string, () => void>;
+            button: Ref<HTMLElement | null, HTMLElement | null>;
+            computedSize: ComputedRef<ButtonSize>;
+            computedVariant: ComputedRef<ButtonVariant>;
+            dataBlock: ComputedRef<true | undefined>;
+            dataLoading: ComputedRef<true | undefined>;
+            hasIcon: ComputedRef<boolean>;
+            injectedOrPropBlock: ComputedRef<boolean>;
+            injectedOrPropsLarge: ComputedRef<boolean>;
+            onClick: (event: MouseEvent) => void;
+            routerDestinationOrHref: ComputedRef<string | undefined>;
+            shoelaceVariant: ComputedRef<ButtonShoelaceVariant>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("focus" | "blur" | "click")[], "focus" | "blur" | "click", PublicProps, Readonly< ExtractPropTypes<{
+            block: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            href: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            icon: {
+                type: PropType<string | string[] | IconDefinition>;
+                default: undefined;
+            };
+            iconPosition: {
+                type: PropType< ButtonIconPosition>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            large: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            level: {
+                type: PropType< ButtonLevel>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            loading: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            secondary: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            size: {
+                type: PropType< ButtonSize>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+            target: {
+                type: StringConstructor;
+                default: undefined;
+            };
+            tertiary: {
+                type: BooleanConstructor;
+                default: boolean;
+                deprecated: boolean;
+            };
+            to: {
+                type: PropType< RouteLocationRaw>;
+                default: undefined;
+            };
+            variant: {
+                type: PropType< ButtonVariant>;
+                default: string;
+                validator: (value: string) => boolean;
+            };
+        }>> & Readonly<{
+            onFocus?: ((...args: any[]) => any) | undefined;
+            onBlur?: ((...args: any[]) => any) | undefined;
+            onClick?: ((...args: any[]) => any) | undefined;
+        }>, {
+            to: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+            size: ButtonSize;
+            icon: string | string[] | IconDefinition;
+            target: string;
+            tertiary: boolean;
+            loading: boolean;
+            block: boolean;
+            large: boolean;
+            disabled: boolean;
+            secondary: boolean;
+            href: string;
+            iconPosition: ButtonIconPosition;
+            level: ButtonLevel;
+            variant: ButtonVariant;
+        }, {}, {
+            FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>;
+        }, {}, string, ComponentProvideOptions, true, {}, any>;
+    }, {}, string, ComponentProvideOptions, true, {}, any>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;