@propelinc/citrus-ui 1.0.4 → 1.3.0

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

@@ -0,0 +1,10 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Props = {
+    count?: number | null;
+    bordered?: boolean;
+};
+declare const _default: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    count: number | null;
+    bordered: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

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

@@ -0,0 +1,39 @@
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Props = {
+    /** Label for screen-readers. This hides and overrides the normal label. */
+    ariaLabel?: string;
+    /** Prevents the user from interacting with the switch */
+    disabled?: boolean;
+    /** When true, the slot label is visually rendered before the control (label left, switch right) */
+    labelFirst?: boolean;
+    /** Whether the switch is in an "on" or "off" state */
+    value?: boolean;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        default?: () => VNode[];
+    }> & {
+        default?: () => VNode[];
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+    input: (value: boolean) => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onInput?: ((value: boolean) => any) | undefined;
+}>, {
+    value: boolean;
+    disabled: boolean;
+    ariaLabel: string;
+    labelFirst: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,48 @@
+import { IconDefinition } from '@fortawesome/fontawesome-svg-core';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Props = {
+    /** Alignment of the content */
+    align?: 'top' | 'center';
+    /** Prevents the user from interacting with the switch */
+    disabled?: boolean;
+    /** Font Awesome icon to render on the left side of the component */
+    icon?: string | string[] | IconDefinition | null;
+    /** Color of the icon background */
+    iconColor?: string;
+    /** Plain body copy. Overridden by the default slot. */
+    label?: string;
+    /** Emphasized text above body text. Overridden by the default slot. */
+    title?: string;
+    /** Whether the switch is in an "on" or "off" state */
+    value?: boolean;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Partial<Record<string, (_: {}) => any>> & {
+        prepend?(_: {}): any;
+        icon?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+    input: (value: boolean) => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onInput?: ((value: boolean) => any) | undefined;
+}>, {
+    label: string;
+    title: string;
+    align: "top" | "center";
+    value: boolean;
+    icon: string | string[] | IconDefinition | null;
+    disabled: boolean;
+    iconColor: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,96 @@
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { Rules } from '../composables/validations';
+type __VLS_Props = {
+    /** Shows a character counter and sets its denominator. */
+    counter?: number | null;
+    /**
+     * Function or number that determines the numerator of the counter. If not
+     * set, the counter will be the length of the input value.
+     */
+    counterValue?: number | (() => number | null) | null;
+    /** Adds a custom data test string to the form field and textarea elements */
+    dataTest?: string;
+    /** Controls whether the input is disabled */
+    disabled?: boolean;
+    /**
+     * Overrides the default validation message. If provided, this error message will always
+     * be shown, regardless of any other failing validation rules.
+     */
+    errorMessage?: string | null;
+    /** Hides the label and instead labels the field with `aria-label` */
+    hideLabel?: boolean;
+    /**
+     * Hides the validation message area. Defaults to `false` (show message area even when valid),
+     * so validations transition in gracefully.
+     */
+    hideDetails?: boolean | 'auto';
+    /** The textarea element's id */
+    id?: string | null;
+    /** The textarea's label, both visual and screenreader-only */
+    label?: string | null;
+    /** Sets the maxlength attribute of the textarea */
+    maxlength?: number;
+    /** The textarea's placeholder */
+    placeholder?: string;
+    /** If true, the field is required */
+    required?: boolean;
+    /**
+     * Accepts a mixed array of types function, boolean and string.
+     * Functions pass an input value as an argument and must return either true / false or
+     * a string containing an error message. The input field will enter an error state if a
+     * function returns (or any value in the array contains) false or is a string
+     */
+    rules?: Rules<string>;
+    /** The textarea's value */
+    value?: string;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        label?: () => VNode[];
+        message?: () => VNode[];
+    }> & {
+        label?: () => VNode[];
+        message?: () => VNode[];
+    };
+    refs: {
+        textarea: HTMLTextAreaElement;
+    };
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    change: (value: string) => any;
+    blur: () => any;
+    focus: () => any;
+    input: (value: string) => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onChange?: ((value: string) => any) | undefined;
+    onBlur?: (() => any) | undefined;
+    onFocus?: (() => any) | undefined;
+    onInput?: ((value: string) => any) | undefined;
+}>, {
+    label: string | null;
+    id: string | null;
+    value: string;
+    dataTest: string;
+    placeholder: string;
+    disabled: boolean;
+    rules: Rules<string>;
+    required: boolean;
+    hideDetails: boolean | "auto";
+    counter: number | null;
+    counterValue: number | (() => number | null) | null;
+    maxlength: number;
+    hideLabel: boolean;
+    errorMessage: string | null;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {
+    textarea: HTMLTextAreaElement;
+}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,129 @@
+import { VNode, Ref, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { Rules } from '../composables/validations';
+export interface CTextFieldExposed {
+    input: Ref<HTMLInputElement | null>;
+    focus: () => void;
+    blur: () => void;
+    startValidating: () => void;
+}
+declare const _default: __VLS_WithTemplateSlots< DefineComponent<{
+    id?: string | null;
+    label?: string | null;
+    ariaLabel?: string | null;
+    placeholder?: string;
+    type?: "text" | "password" | "email" | "tel" | "url" | "search" | "number" | "decimal" | "numeric";
+    clearable?: boolean;
+    size?: "medium" | "large";
+    inputmode?: "text" | "search" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
+    minlength?: number | string;
+    maxlength?: number | string;
+    disabled?: boolean;
+    hideable?: boolean;
+    hideLabel?: boolean;
+    hideDetails?: boolean | "auto";
+    value?: string;
+    dataTest?: string;
+    counter?: number | null;
+    counterValue?: number | (() => number | null) | null;
+    rules?: Rules<string>;
+    validateOnBlur?: boolean;
+    required?: boolean;
+    /**
+     * Overrides the default validation message. If provided, this error message will always
+     * be shown, regardless of any other failing validation rules.
+     */
+    errorMessage?: string;
+}, {
+    input: Ref<HTMLInputElement | null>;
+    focus: () => void;
+    blur: () => void;
+    startValidating: () => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    change: (value: string) => any;
+    blur: (event: Event) => any;
+    click: (event: MouseEvent) => any;
+    focus: (event: Event) => any;
+    input: (value: string) => any;
+    keydown: (event: KeyboardEvent) => any;
+    keypress: (event: KeyboardEvent) => any;
+    keyup: (event: KeyboardEvent) => any;
+    "click:hide": (hidden: boolean) => any;
+}, string, PublicProps, Readonly<{
+    id?: string | null;
+    label?: string | null;
+    ariaLabel?: string | null;
+    placeholder?: string;
+    type?: "text" | "password" | "email" | "tel" | "url" | "search" | "number" | "decimal" | "numeric";
+    clearable?: boolean;
+    size?: "medium" | "large";
+    inputmode?: "text" | "search" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
+    minlength?: number | string;
+    maxlength?: number | string;
+    disabled?: boolean;
+    hideable?: boolean;
+    hideLabel?: boolean;
+    hideDetails?: boolean | "auto";
+    value?: string;
+    dataTest?: string;
+    counter?: number | null;
+    counterValue?: number | (() => number | null) | null;
+    rules?: Rules<string>;
+    validateOnBlur?: boolean;
+    required?: boolean;
+    /**
+     * Overrides the default validation message. If provided, this error message will always
+     * be shown, regardless of any other failing validation rules.
+     */
+    errorMessage?: string;
+}> & Readonly<{
+    onChange?: ((value: string) => any) | undefined;
+    onBlur?: ((event: Event) => any) | undefined;
+    onClick?: ((event: MouseEvent) => any) | undefined;
+    onFocus?: ((event: Event) => any) | undefined;
+    onInput?: ((value: string) => any) | undefined;
+    onKeydown?: ((event: KeyboardEvent) => any) | undefined;
+    onKeypress?: ((event: KeyboardEvent) => any) | undefined;
+    onKeyup?: ((event: KeyboardEvent) => any) | undefined;
+    "onClick:hide"?: ((hidden: boolean) => any) | undefined;
+}>, {
+    type: "text" | "password" | "email" | "tel" | "url" | "search" | "number" | "decimal" | "numeric";
+    label: string | null;
+    id: string | null;
+    value: string;
+    size: "medium" | "large";
+    dataTest: string;
+    placeholder: string;
+    disabled: boolean;
+    ariaLabel: string | null;
+    rules: Rules<string>;
+    required: boolean;
+    hideDetails: boolean | "auto";
+    counter: number | null;
+    counterValue: number | (() => number | null) | null;
+    clearable: boolean;
+    inputmode: "text" | "search" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
+    minlength: number | string;
+    maxlength: number | string;
+    hideable: boolean;
+    hideLabel: boolean;
+    validateOnBlur: boolean;
+    errorMessage: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {
+    input: HTMLInputElement;
+}, any>, Readonly<{
+    label?: () => VNode[];
+    'prepend-inner'?: () => VNode[];
+    append?: () => VNode[];
+    message?: () => VNode[];
+}> & {
+    label?: () => VNode[];
+    'prepend-inner'?: () => VNode[];
+    append?: () => VNode[];
+    message?: () => VNode[];
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,36 @@
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { RouteLocationRaw } from 'vue-router';
+type __VLS_Props = {
+    /** Controls whether the text link functions as a router-link */
+    to?: RouteLocationRaw;
+    /** Designates the text link as an anchor and applies the href attribute */
+    href?: string;
+    /** Designates the target attribute. Only use with the href prop. */
+    target?: string;
+    /** Toggles whether the link should have an underline */
+    underline?: boolean;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        default?: () => VNode[];
+    }> & {
+        default?: () => VNode[];
+    };
+    refs: {};
+    rootEl: HTMLAnchorElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    to: RouteLocationRaw;
+    target: string;
+    href: string;
+    underline: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLAnchorElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,22 @@
+import { IconDefinition } from '@fortawesome/fontawesome-svg-core';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type Size = 'medium' | 'large';
+type __VLS_Props = {
+    /** The alt text for the logo. */
+    alt: string;
+    /** The color of the fallback icon logo */
+    color?: string;
+    /** The Font Awesome icon to display as a fallback */
+    icon?: string | string[] | IconDefinition | null;
+    /** The size of the logo. Defaults to `medium`. */
+    size?: Size;
+    /** The URL of the logo image */
+    src?: string;
+};
+declare const _default: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    size: Size;
+    icon: string | string[] | IconDefinition | null;
+    color: string;
+    src: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+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,69 @@
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { ToastVariant } from '../types';
+type __VLS_Props = {
+    /** The data-test attribute for the toast. */
+    dataTest?: string;
+    /** Controls (overrides) whether the toast is dismissible. */
+    dismissible?: boolean | undefined;
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the error state
+     */
+    error?: boolean;
+    /** The message rendered in the toast, using the default slot overrides this value */
+    message?: string;
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the success state
+     */
+    success?: boolean;
+    /** Show/hides the toast */
+    value?: boolean;
+    /** The variant of the toast */
+    variant?: ToastVariant;
+    /**
+     * @deprecated use `variant` prop instead
+     * Renders the warning state
+     */
+    warning?: boolean;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        icon?: () => VNode[];
+        default?: () => VNode[];
+    }> & {
+        icon?: () => VNode[];
+        default?: () => VNode[];
+    };
+    refs: {
+        alert: unknown;
+    };
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    input: (value: boolean) => any;
+    hide: () => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onInput?: ((value: boolean) => any) | undefined;
+    onHide?: (() => any) | undefined;
+}>, {
+    error: boolean;
+    value: boolean;
+    dataTest: string;
+    message: string;
+    variant: ToastVariant;
+    warning: boolean;
+    dismissible: boolean;
+    success: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {
+    alert: unknown;
+}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,37 @@
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Props = {
+    /** Test selector for the component */
+    dataTest?: string;
+    /**
+     * Whether to hide the component. If "auto", the component will automatically
+     * hide itself if it has no content.
+     */
+    hide?: boolean | 'auto';
+    /** Validation message to display */
+    validationMessage?: string | null;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        default?: () => VNode[];
+        append?: () => VNode[];
+    }> & {
+        default?: () => VNode[];
+        append?: () => VNode[];
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    dataTest: string;
+    hide: boolean | "auto";
+    validationMessage: string | null;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};