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

package/README.md

@@ -12,18 +12,14 @@ Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.jso
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
-[![Codecov][codecov-src]][codecov-href]
-[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
-[![License][license-src]][license-href]
 
 <!-- Replacing link to Prismic with [Prismic][prismic] is useful here -->
 
-[Vue][vue] plugin, components, and composables to fetch and present [Prismic][prismic] content.
+[Vue][vue-docs] plugin, components, and composables to fetch and present [Prismic][prismic] content.
 
-- 📝 &nbsp;Display content from Prismic like [Rich Text][prismic-rich-text] and [Link][prismic-link] fields;
-- 🍡 &nbsp;Render Prismic [Slice Zones][prismic-slices] declaratively with Vue components;
-- 🎣 &nbsp;Fetch Prismic content using Vue [composition API][vue-composition] or [vue-options].
+- 📝 &nbsp;Display content from Prismic like [rich text][prismic-rich-text] and [link][prismic-link] fields.
+- 🍡 &nbsp;Render Prismic [slice zones][prismic-slices] declaratively with Vue components.
+- 🎣 &nbsp;Fetch Prismic content throughout your Vue application.
 
 ## Install
 
@@ -52,7 +48,7 @@ For more clarity on this project and its structure you can also check out the de
 ## License
 
 ```
-   Copyright 2013-2024 Prismic <contact@prismic.io> (https://prismic.io)
+   Copyright 2013-2025 Prismic <contact@prismic.io> (https://prismic.io)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -74,18 +70,16 @@ For more clarity on this project and its structure you can also check out the de
 <!-- Replace link with a more useful one if available -->
 
 [prismic-docs]: https://prismic.io/docs/technical-reference/prismicio-vue/v5
+[vue-docs]: https://vuejs.org
 [changelog]: ./CHANGELOG.md
 [contributing]: ./CONTRIBUTING.md
-[vue]: https://v3.vuejs.org
-[prismic-rich-text]: https://prismic.io/docs/core-concepts/rich-text-title
-[prismic-link]: https://prismic.io/docs/core-concepts/link-content-relationship
-[prismic-slices]: https://prismic.io/docs/core-concepts/slices
-[vue-composition]: https://v3.vuejs.org/guide/composition-api-introduction.html
-[vue-options]: https://v3.vuejs.org/guide/introduction.html
+[prismic-rich-text]: https://prismic.io/docs/fields/rich-text
+[prismic-link]: https://prismic.io/docs/fields/link
+[prismic-slices]: https://prismic.io/docs/slices
 
 <!-- Replace link with a more useful one if available -->
 
-[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/vue-js/16
+[forum-question]: https://community.prismic.io
 [repo-bug-report]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=bug&template=bug_report.md&title=
 [repo-feature-request]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
 [repo-pull-requests]: https://github.com/prismicio/prismic-vue/pulls
@@ -96,11 +90,3 @@ For more clarity on this project and its structure you can also check out the de
 [npm-version-href]: https://npmjs.com/package/@prismicio/vue
 [npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/vue.svg
 [npm-downloads-href]: https://npmjs.com/package/@prismicio/vue
-[github-actions-ci-src]: https://github.com/prismicio/prismic-vue/workflows/ci/badge.svg
-[github-actions-ci-href]: https://github.com/prismicio/prismic-vue/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-vue.svg
-[codecov-href]: https://codecov.io/gh/prismicio/prismic-vue
-[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
-[conventional-commits-href]: https://conventionalcommits.org
-[license-src]: https://img.shields.io/npm/l/@prismicio/vue.svg
-[license-href]: https://npmjs.com/package/@prismicio/vue

package/dist/PrismicImage.cjs

@@ -0,0 +1,8 @@
+const require_PrismicImage_vue_vue_type_script_setup_true_lang = require('./PrismicImage.vue_vue_type_script_setup_true_lang.cjs');
+
+//#region src/PrismicImage.vue
+var PrismicImage_default = require_PrismicImage_vue_vue_type_script_setup_true_lang.default;
+
+//#endregion
+exports.default = PrismicImage_default;
+//# sourceMappingURL=PrismicImage.cjs.map

package/dist/PrismicImage.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.cjs","names":[],"sources":["../src/PrismicImage.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { ImageField, asImageSrc } from \"@prismicio/client\"\nimport {\n\tasImagePixelDensitySrcSet,\n\tasImageWidthSrcSet,\n\tisFilled,\n} from \"@prismicio/client\"\nimport { DEV } from \"esm-env\"\nimport { computed, watchEffect } from \"vue\"\n\nimport { devMsg } from \"./lib/devMsg\"\n\n/** Props for `<PrismicImage />`. */\nexport type PrismicImageProps = {\n\t/** The Prismic image field or thumbnail to render. */\n\tfield: ImageField | ImageField<string>\n\n\t/**\n\t * An object of Imgix URL API parameters to transform the image.\n\t *\n\t * See: https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: Parameters<typeof asImageSrc>[1]\n\n\t/**\n\t * Declare an image as decorative by providing `alt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\talt?: \"\"\n\n\t/**\n\t * Declare an image as decorative only if the image field does not have\n\t * alternative text by providing `fallbackAlt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\tfallbackAlt?: \"\"\n\n\t/**\n\t * The width attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width\n\t */\n\twidth?: number | string\n\n\t/**\n\t * The height attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height\n\t */\n\theight?: number | string\n} & (\n\t| {\n\t\t\t/**\n\t\t\t * Widths (in pixels) used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If omitted or set to `\"defaults\"`, the following widths will be used:\n\t\t\t * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.\n\t\t\t *\n\t\t\t * If the image field contains responsive views, each responsive view can\n\t\t\t * be used as a width in the resulting `srcset` by passing `\"thumbnails\"`\n\t\t\t * as the `widths` prop.\n\t\t\t */\n\t\t\twidths?:\n\t\t\t\t| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>[\"widths\"]\n\t\t\t\t| \"thumbnails\"\n\t\t\t\t| \"defaults\"\n\t\t\tpixelDensities?: never\n\t  }\n\t| {\n\t\t\twidths?: never\n\t\t\t/**\n\t\t\t * Pixel densities used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If a `pixelDensities` prop is passed `\"defaults\"`, the following pixel\n\t\t\t * densities will be used: 1, 2, 3.\n\t\t\t */\n\t\t\tpixelDensities:\n\t\t\t\t| NonNullable<\n\t\t\t\t\t\tParameters<typeof asImagePixelDensitySrcSet>[1]\n\t\t\t\t  >[\"pixelDensities\"]\n\t\t\t\t| \"defaults\"\n\t  }\n)\n\nconst props = defineProps<PrismicImageProps>()\ndefineOptions({ name: \"PrismicImage\" })\n\nif (DEV) {\n\twatchEffect(() => {\n\t\tif (typeof props.alt === \"string\" && props.alt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"alt\" prop can only be used to declare an image as decorative by passing an empty string (alt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"alt\" prop or changing it to alt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (typeof props.fallbackAlt === \"string\" && props.fallbackAlt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"fallbackAlt\" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"fallbackAlt\" prop or changing it to fallbackAlt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (props.widths && props.pixelDensities) {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] Only one of \"widths\" or \"pixelDensities\" props can be provided. You can resolve this warning by removing either the \"widths\" or \"pixelDensities\" prop. \"widths\" will be used in this case.`,\n\t\t\t)\n\t\t}\n\t})\n}\n\nconst castInt = (input: string | number | undefined): number | undefined => {\n\tif (typeof input === \"number\" || typeof input === \"undefined\") {\n\t\treturn input\n\t} else {\n\t\tconst parsed = Number.parseInt(input)\n\n\t\tif (Number.isNaN(parsed)) {\n\t\t\treturn undefined\n\t\t} else {\n\t\t\treturn parsed\n\t\t}\n\t}\n}\n\nconst image = computed(() => {\n\tif (!isFilled.imageThumbnail(props.field)) {\n\t\treturn\n\t}\n\n\tlet src: string | undefined\n\tlet srcSet: string | undefined\n\tif (props.widths || !props.pixelDensities) {\n\t\tconst res = asImageWidthSrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\twidths: props.widths === \"defaults\" ? undefined : props.widths,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t} else if (props.pixelDensities) {\n\t\tconst res = asImagePixelDensitySrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\tpixelDensities:\n\t\t\t\tprops.pixelDensities === \"defaults\" ? undefined : props.pixelDensities,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t}\n\n\tconst ar = props.field.dimensions.width / props.field.dimensions.height\n\n\tconst castedWidth = castInt(props.width)\n\tconst castedHeight = castInt(props.height)\n\n\tlet resolvedWidth = castedWidth ?? props.field.dimensions.width\n\tlet resolvedHeight = castedHeight ?? props.field.dimensions.height\n\n\tif (castedWidth != null && castedHeight == null) {\n\t\tresolvedHeight = castedWidth / ar\n\t} else if (castedWidth == null && castedHeight != null) {\n\t\tresolvedWidth = castedHeight * ar\n\t}\n\n\treturn {\n\t\tsrc,\n\t\tsrcSet,\n\t\talt: props.alt ?? (props.field.alt || props.fallbackAlt),\n\t\twidth: Math.round(resolvedWidth),\n\t\theight: Math.round(resolvedHeight),\n\t}\n})\n</script>\n\n<template>\n\t<img\n\t\tv-if=\"image\"\n\t\t:src=\"image.src\"\n\t\t:srcset=\"image.srcSet\"\n\t\t:alt=\"image.alt\"\n\t\t:width=\"image.width\"\n\t\t:height=\"image.height\"\n\t/>\n</template>\n"],"mappings":""}

package/dist/PrismicImage.js

@@ -0,0 +1,8 @@
+import PrismicImage_vue_vue_type_script_setup_true_lang_default from "./PrismicImage.vue_vue_type_script_setup_true_lang.js";
+
+//#region src/PrismicImage.vue
+var PrismicImage_default = PrismicImage_vue_vue_type_script_setup_true_lang_default;
+
+//#endregion
+export { PrismicImage_default as default };
+//# sourceMappingURL=PrismicImage.js.map

package/dist/PrismicImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.js","names":[],"sources":["../src/PrismicImage.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { ImageField, asImageSrc } from \"@prismicio/client\"\nimport {\n\tasImagePixelDensitySrcSet,\n\tasImageWidthSrcSet,\n\tisFilled,\n} from \"@prismicio/client\"\nimport { DEV } from \"esm-env\"\nimport { computed, watchEffect } from \"vue\"\n\nimport { devMsg } from \"./lib/devMsg\"\n\n/** Props for `<PrismicImage />`. */\nexport type PrismicImageProps = {\n\t/** The Prismic image field or thumbnail to render. */\n\tfield: ImageField | ImageField<string>\n\n\t/**\n\t * An object of Imgix URL API parameters to transform the image.\n\t *\n\t * See: https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: Parameters<typeof asImageSrc>[1]\n\n\t/**\n\t * Declare an image as decorative by providing `alt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\talt?: \"\"\n\n\t/**\n\t * Declare an image as decorative only if the image field does not have\n\t * alternative text by providing `fallbackAlt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\tfallbackAlt?: \"\"\n\n\t/**\n\t * The width attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width\n\t */\n\twidth?: number | string\n\n\t/**\n\t * The height attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height\n\t */\n\theight?: number | string\n} & (\n\t| {\n\t\t\t/**\n\t\t\t * Widths (in pixels) used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If omitted or set to `\"defaults\"`, the following widths will be used:\n\t\t\t * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.\n\t\t\t *\n\t\t\t * If the image field contains responsive views, each responsive view can\n\t\t\t * be used as a width in the resulting `srcset` by passing `\"thumbnails\"`\n\t\t\t * as the `widths` prop.\n\t\t\t */\n\t\t\twidths?:\n\t\t\t\t| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>[\"widths\"]\n\t\t\t\t| \"thumbnails\"\n\t\t\t\t| \"defaults\"\n\t\t\tpixelDensities?: never\n\t  }\n\t| {\n\t\t\twidths?: never\n\t\t\t/**\n\t\t\t * Pixel densities used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If a `pixelDensities` prop is passed `\"defaults\"`, the following pixel\n\t\t\t * densities will be used: 1, 2, 3.\n\t\t\t */\n\t\t\tpixelDensities:\n\t\t\t\t| NonNullable<\n\t\t\t\t\t\tParameters<typeof asImagePixelDensitySrcSet>[1]\n\t\t\t\t  >[\"pixelDensities\"]\n\t\t\t\t| \"defaults\"\n\t  }\n)\n\nconst props = defineProps<PrismicImageProps>()\ndefineOptions({ name: \"PrismicImage\" })\n\nif (DEV) {\n\twatchEffect(() => {\n\t\tif (typeof props.alt === \"string\" && props.alt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"alt\" prop can only be used to declare an image as decorative by passing an empty string (alt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"alt\" prop or changing it to alt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (typeof props.fallbackAlt === \"string\" && props.fallbackAlt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"fallbackAlt\" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"fallbackAlt\" prop or changing it to fallbackAlt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (props.widths && props.pixelDensities) {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] Only one of \"widths\" or \"pixelDensities\" props can be provided. You can resolve this warning by removing either the \"widths\" or \"pixelDensities\" prop. \"widths\" will be used in this case.`,\n\t\t\t)\n\t\t}\n\t})\n}\n\nconst castInt = (input: string | number | undefined): number | undefined => {\n\tif (typeof input === \"number\" || typeof input === \"undefined\") {\n\t\treturn input\n\t} else {\n\t\tconst parsed = Number.parseInt(input)\n\n\t\tif (Number.isNaN(parsed)) {\n\t\t\treturn undefined\n\t\t} else {\n\t\t\treturn parsed\n\t\t}\n\t}\n}\n\nconst image = computed(() => {\n\tif (!isFilled.imageThumbnail(props.field)) {\n\t\treturn\n\t}\n\n\tlet src: string | undefined\n\tlet srcSet: string | undefined\n\tif (props.widths || !props.pixelDensities) {\n\t\tconst res = asImageWidthSrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\twidths: props.widths === \"defaults\" ? undefined : props.widths,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t} else if (props.pixelDensities) {\n\t\tconst res = asImagePixelDensitySrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\tpixelDensities:\n\t\t\t\tprops.pixelDensities === \"defaults\" ? undefined : props.pixelDensities,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t}\n\n\tconst ar = props.field.dimensions.width / props.field.dimensions.height\n\n\tconst castedWidth = castInt(props.width)\n\tconst castedHeight = castInt(props.height)\n\n\tlet resolvedWidth = castedWidth ?? props.field.dimensions.width\n\tlet resolvedHeight = castedHeight ?? props.field.dimensions.height\n\n\tif (castedWidth != null && castedHeight == null) {\n\t\tresolvedHeight = castedWidth / ar\n\t} else if (castedWidth == null && castedHeight != null) {\n\t\tresolvedWidth = castedHeight * ar\n\t}\n\n\treturn {\n\t\tsrc,\n\t\tsrcSet,\n\t\talt: props.alt ?? (props.field.alt || props.fallbackAlt),\n\t\twidth: Math.round(resolvedWidth),\n\t\theight: Math.round(resolvedHeight),\n\t}\n})\n</script>\n\n<template>\n\t<img\n\t\tv-if=\"image\"\n\t\t:src=\"image.src\"\n\t\t:srcset=\"image.srcSet\"\n\t\t:alt=\"image.alt\"\n\t\t:width=\"image.width\"\n\t\t:height=\"image.height\"\n\t/>\n</template>\n"],"mappings":""}

package/dist/PrismicImage.vue.d.cts

@@ -0,0 +1,267 @@
+import * as vue31 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 (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;
+} | {
+  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 __VLS_export: vue31.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 (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;
+} & {
+  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";
+}), {}, {}, {}, {}, vue31.ComponentOptionsMixin, vue31.ComponentOptionsMixin, {}, string, vue31.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 (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;
+} & {
+  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, vue31.ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+//#endregion
+export { PrismicImageProps, _default };
+//# sourceMappingURL=PrismicImage.vue.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.vue.d.cts","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,KAAA;;;;;;;;;kBArIlC,YACA,kBAAkB;;cAiIlB,oBAAY;;SAtMV,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;oBADP,KAAA,CAAA,qBAAA;;SApET,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;;cAiIN,iBAGU"}