@propelinc/citrus-ui 0.6.0 → 1.0.0

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

@@ -0,0 +1,19 @@
+import { DefineComponent, ExtractPropTypes, Ref, ComputedRef, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: 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>;
+export default _default;

package/dist/components/CFadeTransition.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/CFileInput.vue.d.ts

@@ -0,0 +1,98 @@
+import { PropType, DefineComponent, ExtractPropTypes, Ref, ComputedRef, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** The input's label, both visual and screenreader-only */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Placholder text to display before a user has selected any files */
+    prompt: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** The input's value. Either one file or an array of files */
+    value: {
+        type: PropType<File[] | File | null>;
+        default: null;
+    };
+    /** A unique id for the input */
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Allow the user to upload multiple files */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the input is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the input is required */
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** A custom data-test string applied to the form field, text field and hide icon */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    idWithFallback: Ref<string, string>;
+    inputValue: Ref<File | File[] | null, File | File[] | null>;
+    hasValue: ComputedRef<boolean>;
+    onFileChange: (event: Event) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "input"[], "input", PublicProps, Readonly< ExtractPropTypes<{
+    /** The input's label, both visual and screenreader-only */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Placholder text to display before a user has selected any files */
+    prompt: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** The input's value. Either one file or an array of files */
+    value: {
+        type: PropType<File[] | File | null>;
+        default: null;
+    };
+    /** A unique id for the input */
+    id: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Allow the user to upload multiple files */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the input is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Controls whether the input is required */
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** A custom data-test string applied to the form field, text field and hide icon */
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onInput?: ((...args: any[]) => any) | undefined;
+}>, {
+    value: File | File[] | null;
+    dataTest: string;
+    disabled: boolean;
+    required: boolean;
+    multiple: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,106 @@
+import { DefineComponent, ExtractPropTypes, Ref, CreateComponentPublicInstanceWithMixins, ComponentOptionsMixin, PublicProps, GlobalComponents, GlobalDirectives, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** The HTML tag to render as. Avoid changing this if possible. */
+    tag: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    footer: Ref< CreateComponentPublicInstanceWithMixins<Readonly< ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>> & Readonly<{}>, void, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {
+        large: boolean;
+        tag: string;
+    }, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, any, ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly< ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, {
+        large: boolean;
+        tag: string;
+    }> | null, CreateComponentPublicInstanceWithMixins<Readonly< ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>> & Readonly<{}>, void, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {
+        large: boolean;
+        tag: string;
+    }, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, any, ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly< ExtractPropTypes<{
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        large: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, {
+        large: boolean;
+        tag: string;
+    }> | null>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "change:height"[], "change:height", PublicProps, Readonly< ExtractPropTypes<{
+    /** The HTML tag to render as. Avoid changing this if possible. */
+    tag: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    "onChange:height"?: ((...args: any[]) => any) | undefined;
+}>, {
+    tag: string;
+}, {}, {
+    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>;
+}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,29 @@
+import { DefineComponent, ExtractPropTypes, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    form: Ref<HTMLFormElement | null, HTMLFormElement | null>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("input" | "submit")[], "input" | "submit", PublicProps, Readonly< ExtractPropTypes<{
+    dataTest: {
+        type: StringConstructor;
+        default: string;
+    };
+    value: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onInput?: ((...args: any[]) => any) | undefined;
+    onSubmit?: ((...args: any[]) => any) | undefined;
+}>, {
+    value: boolean;
+    dataTest: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,42 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** Sets the denominator of the counter. */
+    counter: {
+        type: PropType<number | null>;
+        default: null;
+    };
+    /** Function or number that determines the numerator of the counter. */
+    counterValue: {
+        type: PropType<number | (() => number | null)>;
+        default: null;
+    };
+    /** Input value of the parent form field */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    numerator: ComputedRef<number | null>;
+    displayText: ComputedRef<string>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** Sets the denominator of the counter. */
+    counter: {
+        type: PropType<number | null>;
+        default: null;
+    };
+    /** Function or number that determines the numerator of the counter. */
+    counterValue: {
+        type: PropType<number | (() => number | null)>;
+        default: null;
+    };
+    /** Input value of the parent form field */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    value: string;
+    counter: number | null;
+    counterValue: number | (() => number | null);
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+export default _default;

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

@@ -0,0 +1,390 @@
+import { IconDefinition } from '@fortawesome/pro-light-svg-icons';
+import { PropType, DefineComponent, ExtractPropTypes, ComputedRef, Ref, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { RouteLocationRaw, RouteLocationAsRelativeGeneric, RouteLocationAsPathGeneric } from 'vue-router';
+import { ButtonLevel, ButtonSize, ButtonVariant, ButtonIconPosition, ButtonShoelaceVariant } from './CButton/types';
+import { FontAwesomeIconProps } from '@fortawesome/vue-fontawesome';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    /** ARIA label for the button. You must use either this or ariaLabelledby. */
+    ariaLabel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** ARIA labelledby for the button. You must use either this or ariaLabel. */
+    ariaLabelledby: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Controls whether button is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Designates the button as an anchor and applies the href attribute */
+    href: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Specifies a Font Awesome icon */
+    icon: {
+        type: PropType<string | string[] | IconDefinition>;
+        default: undefined;
+    };
+    /**
+     * Controls whether button uses the large variant
+     * @deprecated Use `size="large"` instead
+     */
+    large: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * Controls the level of the button
+     * @default 'normal'
+     */
+    level: {
+        type: PropType<ButtonLevel>;
+        default: string;
+    };
+    /** Controls whether button is loading */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Controls whether button uses the secondary variant
+     * @deprecated Use `variant="secondary"` instead
+     */
+    secondary: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * Controls the size of the button
+     * @default 'medium'
+     */
+    size: {
+        type: PropType<ButtonSize>;
+        default: string;
+    };
+    /** Spins the icon for loading states */
+    spinIcon: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Designates the target attribute. Only use with the href prop. */
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Controls whether button uses the tertiary variant
+     * @deprecated Use `variant="tertiary"` instead
+     */
+    tertiary: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /** Controls whether button functions as a router-link */
+    to: {
+        type: PropType<RouteLocationRaw>;
+        default: undefined;
+    };
+    /**
+     * Controls the variant of the button
+     * @default 'primary'
+     */
+    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<{
+    /** ARIA label for the button. You must use either this or ariaLabelledby. */
+    ariaLabel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** ARIA labelledby for the button. You must use either this or ariaLabel. */
+    ariaLabelledby: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Controls whether button is disabled */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Designates the button as an anchor and applies the href attribute */
+    href: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Specifies a Font Awesome icon */
+    icon: {
+        type: PropType<string | string[] | IconDefinition>;
+        default: undefined;
+    };
+    /**
+     * Controls whether button uses the large variant
+     * @deprecated Use `size="large"` instead
+     */
+    large: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * Controls the level of the button
+     * @default 'normal'
+     */
+    level: {
+        type: PropType<ButtonLevel>;
+        default: string;
+    };
+    /** Controls whether button is loading */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Controls whether button uses the secondary variant
+     * @deprecated Use `variant="secondary"` instead
+     */
+    secondary: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /**
+     * Controls the size of the button
+     * @default 'medium'
+     */
+    size: {
+        type: PropType<ButtonSize>;
+        default: string;
+    };
+    /** Spins the icon for loading states */
+    spinIcon: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Designates the target attribute. Only use with the href prop. */
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Controls whether button uses the tertiary variant
+     * @deprecated Use `variant="tertiary"` instead
+     */
+    tertiary: {
+        type: BooleanConstructor;
+        default: boolean;
+        deprecated: boolean;
+    };
+    /** Controls whether button functions as a router-link */
+    to: {
+        type: PropType<RouteLocationRaw>;
+        default: undefined;
+    };
+    /**
+     * Controls the variant of the button
+     * @default 'primary'
+     */
+    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>;
+export default _default;