@prismicio/vue 5.3.0 → 6.0.0-canary.331d154

package/dist/PrismicImage.vue.d.ts

@@ -1,294 +1,267 @@
-import { ImageField, asImageSrc, asImagePixelDensitySrcSet, asImageWidthSrcSet } from '@prismicio/client';
-/**
- * Props for `<PrismicImage />`.
- */
-export type PrismicImageProps = {
-    /**
-     * The Prismic image field or thumbnail to render.
-     */
-    field: ImageField | ImageField<string>;
-    /**
-     * An object of Imgix URL API parameters to transform the image.
-     *
-     * See: https://docs.imgix.com/apis/rendering
-     */
-    imgixParams?: Parameters<typeof asImageSrc>[1];
-    /**
-     * Declare an image as decorative by providing `alt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    alt?: "";
-    /**
-     * Declare an image as decorative only if the image field does not have
-     * alternative text by providing `fallbackAlt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    fallbackAlt?: "";
-    /**
-     * The width attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
-     */
-    width?: number | string;
-    /**
-     * The height attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
-     */
-    height?: number | string;
+import * as vue0 from "vue";
+import { ImageField, asImagePixelDensitySrcSet, asImageSrc, asImageWidthSrcSet } from "@prismicio/client";
+
+//#region src/PrismicImage.vue.d.ts
+/** Props for `<PrismicImage />`. */
+type PrismicImageProps = {
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
 } & ({
-    /**
-     * Widths used to build a `srcset` value for the image field.
-     *
-     * If a `widths` prop is not given or `"defaults"` is passed, the
-     * following widths will be used: 640, 750, 828, 1080, 1200, 1920, 2048,
-     * 3840.
-     *
-     * If the image field contains responsive views, each responsive view can
-     * be used as a width in the resulting `srcset` by passing `"thumbnails"`
-     * as the `widths` prop.
-     */
-    widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    pixelDensities?: never;
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
 } | {
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    widths?: never;
-    /**
-     * Pixel densities used to build a `srcset` value for the image field.
-     *
-     * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
-     * densities will be used: 1, 2, 3.
-     */
-    pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
 });
-declare const _default: import('vue').DefineComponent<({
-    /**
-     * The Prismic image field or thumbnail to render.
-     */
-    field: ImageField | ImageField<string>;
-    /**
-     * An object of Imgix URL API parameters to transform the image.
-     *
-     * See: https://docs.imgix.com/apis/rendering
-     */
-    imgixParams?: Parameters<typeof asImageSrc>[1];
-    /**
-     * Declare an image as decorative by providing `alt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    alt?: "";
-    /**
-     * Declare an image as decorative only if the image field does not have
-     * alternative text by providing `fallbackAlt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    fallbackAlt?: "";
-    /**
-     * The width attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
-     */
-    width?: number | string;
-    /**
-     * The height attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
-     */
-    height?: number | string;
+declare const __VLS_export: vue0.DefineComponent<({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
 } & {
-    /**
-     * Widths used to build a `srcset` value for the image field.
-     *
-     * If a `widths` prop is not given or `"defaults"` is passed, the
-     * following widths will be used: 640, 750, 828, 1080, 1200, 1920, 2048,
-     * 3840.
-     *
-     * If the image field contains responsive views, each responsive view can
-     * be used as a width in the resulting `srcset` by passing `"thumbnails"`
-     * as the `widths` prop.
-     */
-    widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    pixelDensities?: never;
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
 }) | ({
-    /**
-     * The Prismic image field or thumbnail to render.
-     */
-    field: ImageField | ImageField<string>;
-    /**
-     * An object of Imgix URL API parameters to transform the image.
-     *
-     * See: https://docs.imgix.com/apis/rendering
-     */
-    imgixParams?: Parameters<typeof asImageSrc>[1];
-    /**
-     * Declare an image as decorative by providing `alt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    alt?: "";
-    /**
-     * Declare an image as decorative only if the image field does not have
-     * alternative text by providing `fallbackAlt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    fallbackAlt?: "";
-    /**
-     * The width attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
-     */
-    width?: number | string;
-    /**
-     * The height attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
-     */
-    height?: number | string;
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
 } & {
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    widths?: never;
-    /**
-     * Pixel densities used to build a `srcset` value for the image field.
-     *
-     * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
-     * densities will be used: 1, 2, 3.
-     */
-    pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
-}), {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<({
-    /**
-     * The Prismic image field or thumbnail to render.
-     */
-    field: ImageField | ImageField<string>;
-    /**
-     * An object of Imgix URL API parameters to transform the image.
-     *
-     * See: https://docs.imgix.com/apis/rendering
-     */
-    imgixParams?: Parameters<typeof asImageSrc>[1];
-    /**
-     * Declare an image as decorative by providing `alt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    alt?: "";
-    /**
-     * Declare an image as decorative only if the image field does not have
-     * alternative text by providing `fallbackAlt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    fallbackAlt?: "";
-    /**
-     * The width attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
-     */
-    width?: number | string;
-    /**
-     * The height attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
-     */
-    height?: number | string;
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+}), {}, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
 } & {
-    /**
-     * Widths used to build a `srcset` value for the image field.
-     *
-     * If a `widths` prop is not given or `"defaults"` is passed, the
-     * following widths will be used: 640, 750, 828, 1080, 1200, 1920, 2048,
-     * 3840.
-     *
-     * If the image field contains responsive views, each responsive view can
-     * be used as a width in the resulting `srcset` by passing `"thumbnails"`
-     * as the `widths` prop.
-     */
-    widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    pixelDensities?: never;
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
 }) | ({
-    /**
-     * The Prismic image field or thumbnail to render.
-     */
-    field: ImageField | ImageField<string>;
-    /**
-     * An object of Imgix URL API parameters to transform the image.
-     *
-     * See: https://docs.imgix.com/apis/rendering
-     */
-    imgixParams?: Parameters<typeof asImageSrc>[1];
-    /**
-     * Declare an image as decorative by providing `alt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    alt?: "";
-    /**
-     * Declare an image as decorative only if the image field does not have
-     * alternative text by providing `fallbackAlt=""`.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
-     */
-    fallbackAlt?: "";
-    /**
-     * The width attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
-     */
-    width?: number | string;
-    /**
-     * The height attribute of the image element.
-     *
-     * See:
-     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
-     */
-    height?: number | string;
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
 } & {
-    /**
-     * Not used when the `widths` prop is used.
-     */
-    widths?: never;
-    /**
-     * Pixel densities used to build a `srcset` value for the image field.
-     *
-     * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
-     * densities will be used: 1, 2, 3.
-     */
-    pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
-})> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-export default _default;
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+})> & Readonly<{}>, {}, {}, {}, {}, string, vue0.ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+//#endregion
+export { PrismicImageProps, _default };
+//# sourceMappingURL=PrismicImage.vue.d.ts.map

package/dist/PrismicImage.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.vue.d.ts","names":[],"sources":["../src/PrismicImage.vue"],"sourcesContent":[],"mappings":";;;;;KAgNY,iBAAA;EAAA;EAEJ,KAAA,EAAA,UAAA,GAAa,UAAb,CAAA,MAAA,CAAA;EAAa;;;;;EAsDf,WAAA,CAAA,EA/CS,UA+CT,CAAA,OA/C2B,UA+C3B,CAAA,CAAA,CAAA,CAAA;EAekB;;;;AAIvB;;EAzEoB,GAAA,CAAA,EAAA,EAAA;EAOY;;;;;;;EAAA,WAAA,CAAA,EAAA,EAAA;EAAlB;;;;;;;EAPP;;;;;;EAsDF,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA;CAtDE,GAAA,CAAA;EAAa;;;;;;;;;;EAsMH,MAAA,CAAA,EAhJZ,WAgJY,CAhJA,UAgJA,CAAA,OAhJkB,kBAgJlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,QAAA,CAAA,GAAA,YAAA,GAAA,UAAA;EAAA,cAGsB,CAAA,EAAA,KAAZ;;;;;;;;;kBArItB,YACA,kBAAkB;;cAiIlB,mBAAY;;SAtMV,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;oBADP,IAAA,CAAA,qBAAA;;SApET,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;;cAiIN,iBAGU"}