@explorer-1/vue 1.1.2 → 1.1.4

package/dist/src/components/BaseImage/BaseImage.stories.d.ts

@@ -0,0 +1,141 @@
+declare const _default: {
+    title: string;
+    component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        imageClass: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        objectFitClass: {
+            type: import('vue').PropType<"cover" | "fill" | "none" | "contain" | "scaleDown">;
+            required: false;
+            default: string;
+            validator: (prop: string) => boolean;
+        };
+        src: {
+            type: StringConstructor;
+            required: true;
+        };
+        srcset: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        alt: {
+            type: StringConstructor;
+            default: string;
+        };
+        width: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: string;
+        };
+        height: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: string;
+        };
+        loading: {
+            type: import('vue').PropType<"lazy" | "eager" | undefined>;
+            required: false;
+            default: string;
+        };
+    }>, {}, {}, {
+        computedClass(): string;
+    }, {
+        imageFailed(): void;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        imageClass: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        objectFitClass: {
+            type: import('vue').PropType<"cover" | "fill" | "none" | "contain" | "scaleDown">;
+            required: false;
+            default: string;
+            validator: (prop: string) => boolean;
+        };
+        src: {
+            type: StringConstructor;
+            required: true;
+        };
+        srcset: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        alt: {
+            type: StringConstructor;
+            default: string;
+        };
+        width: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: string;
+        };
+        height: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: string;
+        };
+        loading: {
+            type: import('vue').PropType<"lazy" | "eager" | undefined>;
+            required: false;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        alt: string;
+        width: string | number;
+        height: string | number;
+        srcset: string;
+        loading: "lazy" | "eager" | undefined;
+        imageClass: string;
+        objectFitClass: "cover" | "fill" | "none" | "contain" | "scaleDown";
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    excludeStories: RegExp;
+    parameters: {
+        docs: {
+            description: {
+                component: string;
+            };
+        };
+        html: {
+            root: string;
+        };
+    };
+};
+export default _default;
+export declare const BaseImageData: {
+    src: string;
+    srcset: string;
+    alt: string;
+    width: number;
+    height: number;
+    imageClass: string;
+    objectFitClass: string;
+};
+export declare const BaseStory: {
+    args: {
+        src: string;
+        srcset: string;
+        alt: string;
+        width: number;
+        height: number;
+        imageClass: string;
+        objectFitClass: string;
+    };
+    decorators: (() => {
+        template: string;
+    })[];
+};
+export declare const LazyLoading: {
+    args: {
+        src: string;
+        srcset: string;
+        alt: string;
+        width: number;
+        height: number;
+        imageClass: string;
+        objectFitClass: string;
+    };
+    decorators: (() => {
+        template: string;
+    })[];
+};

package/dist/src/components/BaseImage/BaseImage.vue.d.ts

@@ -0,0 +1,116 @@
+import { PropType } from 'vue';
+type ImageLoader = 'lazy' | 'eager' | undefined;
+declare const objectFitClasses: {
+    readonly none: "object-none";
+    readonly contain: "object-contain";
+    readonly cover: "object-cover";
+    readonly fill: "object-fill";
+    readonly scaleDown: "object-scale-down";
+};
+type ObjectFitClassesKey = keyof typeof objectFitClasses;
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /** CSS classes to apply directory to the `<img>` element */
+    imageClass: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /** Tailwind CSS object fit classes to specify how the image will scale within `BaseImagePlaceholder` */
+    objectFitClass: {
+        type: PropType<ObjectFitClassesKey>;
+        required: false;
+        default: string;
+        validator: (prop: string) => boolean;
+    };
+    /** `<img> src` attribute */
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** `<img> srcset` attribute  */
+    srcset: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /** `<img> alt` attribute */
+    alt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** `<img> width` attribute */
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /** `<img> height` attribute */
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /** `<img> loading` attribute */
+    loading: {
+        type: PropType<ImageLoader>;
+        required: false;
+        default: string;
+    };
+}>, {}, {}, {
+    computedClass(): string;
+}, {
+    imageFailed(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /** CSS classes to apply directory to the `<img>` element */
+    imageClass: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /** Tailwind CSS object fit classes to specify how the image will scale within `BaseImagePlaceholder` */
+    objectFitClass: {
+        type: PropType<ObjectFitClassesKey>;
+        required: false;
+        default: string;
+        validator: (prop: string) => boolean;
+    };
+    /** `<img> src` attribute */
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** `<img> srcset` attribute  */
+    srcset: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /** `<img> alt` attribute */
+    alt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** `<img> width` attribute */
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /** `<img> height` attribute */
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /** `<img> loading` attribute */
+    loading: {
+        type: PropType<ImageLoader>;
+        required: false;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    alt: string;
+    width: string | number;
+    height: string | number;
+    srcset: string;
+    loading: ImageLoader;
+    imageClass: string;
+    objectFitClass: "cover" | "fill" | "none" | "contain" | "scaleDown";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/src/components/BaseImageCaption/BaseImageCaption.stories.d.ts

@@ -0,0 +1,37 @@
+import { default as BaseImageCaption } from './BaseImageCaption.vue';
+declare namespace _default {
+    export let title: string;
+    export { BaseImageCaption as component };
+    export let excludeStories: RegExp;
+    export namespace parameters {
+        namespace docs {
+            namespace description {
+                let component: string;
+            }
+        }
+    }
+    export namespace argTypes {
+        namespace customLink {
+            export let type: string;
+            let description_1: string;
+            export { description_1 as description };
+        }
+        namespace customLinkText {
+            let type_1: string;
+            export { type_1 as type };
+            let description_2: string;
+            export { description_2 as description };
+        }
+    }
+}
+export default _default;
+export namespace BaseImageCaptionData {
+    let caption: string;
+    let credit: string;
+    let detailUrl: string;
+}
+export namespace BaseStory {
+    namespace args {
+        export { BaseImageCaptionData as data };
+    }
+}

package/dist/src/components/BaseImageCaption/BaseImageCaption.vue.d.ts

@@ -0,0 +1,355 @@
+import { PropType } from 'vue';
+import { ImageObject, VideoObject } from '../../interfaces';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /** `{ImageObject}` data */
+    data: {
+        type: PropType<Partial<ImageObject> | Partial<VideoObject> | any>;
+        required: true;
+    };
+    /** Appends a link to the end of the caption. Overrides "Full Image Details" link, if it exists. */
+    customLink: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Text for the custom link. Does not appear if `customLink` is blank */
+    customLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /** `{ImageObject}` data */
+    data: {
+        type: PropType<Partial<ImageObject> | Partial<VideoObject> | any>;
+        required: true;
+    };
+    /** Appends a link to the end of the caption. Overrides "Full Image Details" link, if it exists. */
+    customLink: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Text for the custom link. Does not appear if `customLink` is blank */
+    customLinkText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    customLink: string;
+    customLinkText: string;
+}, {}, {
+    BaseLink: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        variant: {
+            type: PropType<"default" | "primary" | "secondary" | "none">;
+            required: false;
+            default: string;
+            validator: (prop: string) => boolean;
+        };
+        to: {
+            type: (ObjectConstructor | StringConstructor)[];
+            default: undefined;
+        };
+        exact: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        href: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        addSlash: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        title: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+        linkClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        target: {
+            type: StringConstructor;
+            required: false;
+            default: undefined;
+        };
+        externalTargetBlank: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caret: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caretWrapperClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        caretClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        caretInline: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caretColor: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretMarginLeft: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretMarginRight: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretLeft: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        usePrimaryColor: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>, {}, {}, {
+        computedVariants(): {
+            readonly primary: "text-subtitle text-action can-hover:hover:text-action-dark";
+            readonly secondary: "text-subtitle text-action can-hover:hover:text-action-dark";
+            readonly default: "-default underline text-action can-hover:hover:text-action-dark";
+            readonly none: "";
+        } | {
+            readonly primary: "text-subtitle text-primary can-hover:hover:text-primary-dark";
+            readonly secondary: "text-subtitle text-primary can-hover:hover:text-primary-dark";
+            readonly default: "-default underline text-primary can-hover:hover:text-primary-dark";
+            readonly none: "";
+        };
+        computedClass(): string;
+        isEduExternal(): boolean | string;
+        isExternal(): boolean;
+        theTarget(): string | undefined;
+        theRel(): string | undefined;
+        computedTo(): string | undefined;
+        computedHref(): string | undefined;
+        themeStore: () => import('pinia').Store<"theme", import('../../store/theme').State, {
+            isEdu(state: {
+                theme: import('../../interfaces').Explorer1Theme | null;
+            } & import('pinia').PiniaCustomStateProperties<import('../../store/theme').State>): boolean;
+        }, {
+            setTheme(value: import('../../interfaces').Explorer1Theme): void;
+        }>;
+    }, {
+        clickEvent(): void;
+        addTrailingSlash(path: string): string;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("linkClicked" | "specificLinkClicked")[], "linkClicked" | "specificLinkClicked", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        variant: {
+            type: PropType<"default" | "primary" | "secondary" | "none">;
+            required: false;
+            default: string;
+            validator: (prop: string) => boolean;
+        };
+        to: {
+            type: (ObjectConstructor | StringConstructor)[];
+            default: undefined;
+        };
+        exact: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        href: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        addSlash: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        title: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: string;
+        };
+        linkClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        target: {
+            type: StringConstructor;
+            required: false;
+            default: undefined;
+        };
+        externalTargetBlank: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caret: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caretWrapperClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        caretClass: {
+            type: StringConstructor;
+            default: string;
+        };
+        caretInline: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        caretColor: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretMarginLeft: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretMarginRight: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        caretLeft: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        usePrimaryColor: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        onLinkClicked?: ((...args: any[]) => any) | undefined;
+        onSpecificLinkClicked?: ((...args: any[]) => any) | undefined;
+    }>, {
+        title: string;
+        caretLeft: boolean;
+        variant: "default" | "primary" | "secondary" | "none";
+        to: string | Record<string, any>;
+        exact: boolean;
+        href: string;
+        addSlash: boolean;
+        ariaLabel: string;
+        linkClass: string;
+        target: string;
+        externalTargetBlank: boolean;
+        caret: boolean;
+        caretWrapperClass: string;
+        caretClass: string;
+        caretInline: boolean;
+        caretColor: string;
+        caretMarginLeft: string;
+        caretMarginRight: string;
+        usePrimaryColor: boolean;
+    }, {}, {
+        MixinAnimationCaret: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+            passedWrapperClass: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            arrowClass: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            color: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            marginLeft: {
+                type: StringConstructor;
+                default: string;
+                required: false;
+            };
+            marginRight: {
+                type: StringConstructor;
+                default: string;
+                required: false;
+            };
+            inline: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+            caretLeft: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+        }>, {}, {}, {
+            computedClass(): string;
+        }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+            passedWrapperClass: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            arrowClass: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            color: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            marginLeft: {
+                type: StringConstructor;
+                default: string;
+                required: false;
+            };
+            marginRight: {
+                type: StringConstructor;
+                default: string;
+                required: false;
+            };
+            inline: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+            caretLeft: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+        }>> & Readonly<{}>, {
+            inline: boolean;
+            passedWrapperClass: string;
+            arrowClass: string;
+            color: string;
+            marginLeft: string;
+            marginRight: string;
+            caretLeft: boolean;
+        }, {}, {
+            IconCaret: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+        }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;