@prismicio/vue 5.2.0 → 5.3.0-canary.5d9ea4c

package/README.md

@@ -12,10 +12,6 @@ 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 -->
 
@@ -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.
@@ -73,7 +69,7 @@ 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/technologies/vuejs
+[prismic-docs]: https://prismic.io/docs/technical-reference/prismicio-vue/v5
 [changelog]: ./CHANGELOG.md
 [contributing]: ./CONTRIBUTING.md
 [vue]: https://v3.vuejs.org
@@ -85,7 +81,7 @@ 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 -->
 
-[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 +92,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/PrismicEmbed.vue.d.cts

@@ -0,0 +1,25 @@
+import { ComponentOrTagName } from "./types.cjs";
+import * as vue16 from "vue";
+import { EmbedField } from "@prismicio/client";
+
+//#region src/PrismicEmbed.vue.d.ts
+/**
+ * Props for `<PrismicEmbed />`.
+ */
+type PrismicEmbedProps = {
+  /**
+   * The Prismic EMbed field to render.
+   */
+  field: EmbedField;
+  /**
+   * An HTML tag name or a component used to wrap the output.
+   *
+   * @defaultValue `"div"`
+   */
+  wrapper?: ComponentOrTagName;
+};
+declare const __VLS_export: vue16.DefineComponent<PrismicEmbedProps, {}, {}, {}, {}, vue16.ComponentOptionsMixin, vue16.ComponentOptionsMixin, {}, string, vue16.PublicProps, Readonly<PrismicEmbedProps> & Readonly<{}>, {}, {}, {}, {}, string, vue16.ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+//#endregion
+export { PrismicEmbedProps, _default };
+//# sourceMappingURL=PrismicEmbed.vue.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicEmbed.vue.d.cts","names":[],"sources":["../src/PrismicEmbed.vue"],"sourcesContent":[],"mappings":";;;;;;;;AAyDY,KAAA,iBAAA,GAAiB;EAwDvB;;;EAAY,KAAA,EApDV,UAoDU;EAAA;;;;;EAAA,OAAA,CAAA,EA7CP,kBA6CO;CAAA;AAAA,cAAZ,YAGkC,EAHtB,KAAA,CAAA,eAGsB,CAHtB,iBAGsB,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAHtB,KAAA,CAAA,qBAAA,EAAA,KAAA,CAAA,qBAAA,EAGsB,CAAA,CAAA,EAAA,MAAA,EAHtB,KAAA,CAAA,WAAA,EAAA,QAGsB,CAHtB,iBAGsB,CAAA,GAHtB,QAGsB,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,MAAA,EAHtB,KAAA,CAAA,uBAAA,EAGsB,KAAA,EAAA,CAAA,CAAA,EAAA,GAAA,CAAA;cAHtB,iBAGU"}

package/dist/PrismicImage.vue.d.cts

@@ -0,0 +1,301 @@
+import * as vue21 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;
+} | {
+  /**
+   * 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";
+});
+declare const __VLS_export: vue21.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;
+}) | ({
+  /**
+   * 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";
+}), {}, {}, {}, {}, vue21.ComponentOptionsMixin, vue21.ComponentOptionsMixin, {}, string, vue21.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;
+}) | ({
+  /**
+   * 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, vue21.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":";;;;;;;AAuOA;AAIQ,KAJI,iBAAA,GAIJ;EAAa;;;EAuDe,KAAA,EAvD5B,UAuD4B,GAvDf,UAuDe,CAAA,MAAA,CAAA;EAAlB;;;;;EAoBD,WAAA,CAAA,EApEF,UAoEE,CAAA,OApEgB,UAoEhB,CAAA,CAAA,CAAA,CAAA;EAwIX;;;;;;EA5JY,GAAA,CAAA,EAAA,EAAA;EAAZ;;;;;;;EAoBA,WAAA,CAAA,EAAA,EAAA;EAAW;;;;;;EApEF,KAAA,CAAA,EAAA,MAAA,GAAA,MAAA;EAgDqB;;;;;;EAhDrB,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA;CAqES,GAAA,CAAA;EAAlB;;;;;;;AAuIY;;;;WA5JZ,YAAY,kBAAkB;;;;;;;;;;;;;;;;kBAoB9B,YACA,kBAAkB;;cAuIlB,oBAAY;;;;SAnNV,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgD3B,YAAY,kBAAkB;;;;;;;;;SAvD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAoE3B,YACA,kBAAkB;oBADP,KAAA,CAAA,qBAAA;;;;SA3ET,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgD3B,YAAY,kBAAkB;;;;;;;;;SAvD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAoE3B,YACA,kBAAkB;;cAuIN,iBAGU"}

package/dist/PrismicLink.vue.d.cts

@@ -0,0 +1,282 @@
+import { ComponentOrTagName } from "./types.cjs";
+import * as vue26 from "vue";
+import { AsLinkAttrsConfig, LinkField, LinkResolverFunction, PrismicDocument } from "@prismicio/client";
+
+//#region src/PrismicLink.vue.d.ts
+
+/**
+ * Props for `<PrismicLink />`.
+ */
+type PrismicLinkProps = {
+  /**
+   * A link resolver function used to resolve links when not using the route
+   * resolver parameter with `@prismicio/client`.
+   *
+   * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
+   *
+   * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * The `rel` attribute for the link. By default, `"noreferrer"` is provided if
+   * the link's URL is external. This prop can be provided a function to use the
+   * link's metadata to determine the `rel` value.
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * An HTML tag name or a component used to render internal links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * An HTML tag name or a component used to render external links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
+   */
+  externalComponent?: ComponentOrTagName;
+} & ({
+  /**
+   * The Prismic link field to render.
+   */
+  field: LinkField;
+  document?: never;
+} | {
+  /**
+   * The Prismic document to render as a link.
+   */
+  document: PrismicDocument;
+  field?: never;
+});
+declare var __VLS_8: {};
+type __VLS_Slots = {} & {
+  default?: (props: typeof __VLS_8) => any;
+};
+declare const __VLS_base: vue26.DefineComponent<({
+  /**
+   * A link resolver function used to resolve links when not using the route
+   * resolver parameter with `@prismicio/client`.
+   *
+   * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
+   *
+   * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * The `rel` attribute for the link. By default, `"noreferrer"` is provided if
+   * the link's URL is external. This prop can be provided a function to use the
+   * link's metadata to determine the `rel` value.
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * An HTML tag name or a component used to render internal links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * An HTML tag name or a component used to render external links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic link field to render.
+   */
+  field: LinkField;
+  document?: never;
+}) | ({
+  /**
+   * A link resolver function used to resolve links when not using the route
+   * resolver parameter with `@prismicio/client`.
+   *
+   * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
+   *
+   * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * The `rel` attribute for the link. By default, `"noreferrer"` is provided if
+   * the link's URL is external. This prop can be provided a function to use the
+   * link's metadata to determine the `rel` value.
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * An HTML tag name or a component used to render internal links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * An HTML tag name or a component used to render external links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic document to render as a link.
+   */
+  document: PrismicDocument;
+  field?: never;
+}), {}, {}, {}, {}, vue26.ComponentOptionsMixin, vue26.ComponentOptionsMixin, {}, string, vue26.PublicProps, Readonly<({
+  /**
+   * A link resolver function used to resolve links when not using the route
+   * resolver parameter with `@prismicio/client`.
+   *
+   * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
+   *
+   * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * The `rel` attribute for the link. By default, `"noreferrer"` is provided if
+   * the link's URL is external. This prop can be provided a function to use the
+   * link's metadata to determine the `rel` value.
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * An HTML tag name or a component used to render internal links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * An HTML tag name or a component used to render external links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic link field to render.
+   */
+  field: LinkField;
+  document?: never;
+}) | ({
+  /**
+   * A link resolver function used to resolve links when not using the route
+   * resolver parameter with `@prismicio/client`.
+   *
+   * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
+   *
+   * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * The `rel` attribute for the link. By default, `"noreferrer"` is provided if
+   * the link's URL is external. This prop can be provided a function to use the
+   * link's metadata to determine the `rel` value.
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * An HTML tag name or a component used to render internal links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * An HTML tag name or a component used to render external links.
+   *
+   * @remarks
+   * HTML tag names will be rendered using the anchor tag interface (`href`,
+   * `target`, and `rel` attributes).
+   * @remarks
+   * Components will be rendered using Vue Router {@link RouterLink} interface
+   * (`to` props).
+   *
+   * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic document to render as a link.
+   */
+  document: PrismicDocument;
+  field?: never;
+})> & Readonly<{}>, {}, {}, {}, {}, string, vue26.ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+type __VLS_WithSlots<T, S> = T & {
+  new (): {
+    $slots: S;
+  };
+};
+//# sourceMappingURL=PrismicLink.vue.d.ts.map
+//#endregion
+export { PrismicLinkProps, _default };
+//# sourceMappingURL=PrismicLink.vue.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicLink.vue.d.cts","names":[],"sources":["../src/PrismicLink.vue"],"sourcesContent":[],"mappings":";;;;;;;;AAyLA;AASgB,KATJ,gBAAA,GASI;EASA;;;;;;AA4Cf;AAiFqB;EAOhB,YAAA,CAEJ,EA/Ic,oBA+Id;EA/Ic;;;;;;;EAuBK,GAAA,CAAA,EAAA,MAAA,GAdL,iBAcK,CAAA,KAAA,CAAA;EAcA;;;;;;;;;;;;EAdA,iBAAA,CAAA,EAAA,kBAAA;EAcA;;;;;;;AAwGL;;;;;EAG0B,iBACF,CAAA,EA5GnB,kBA4GmB;AAAxC,CAAA,GACK,CAAA;;;;SAvGK;;;;;;YAOG;;;YAoFT;KACC,WAAA;2BACwB;;cAKvB,kBAAU;;;;;;;;;iBA7IA;;;;;;;;iBASA;;;;;;;;;;;;;sBAcK;;;;;;;;;;;;;sBAcA;;;;;SAMX;;;;;;;;;;;iBA3CM;;;;;;;;iBASA;;;;;;;;;;;;;sBAcK;;;;;;;;;;;;;sBAcA;;;;;YAaR;;oBAAe,KAAA,CAAA,qBAAA;;;;;;;;;iBAlDZ;;;;;;;;iBASA;;;;;;;;;;;;;sBAcK;;;;;;;;;;;;;sBAcA;;;;;SAMX;;;;;;;;;;;iBA3CM;;;;;;;;iBASA;;;;;;;;;;;;;sBAcK;;;;;;;;;;;;;sBAcA;;;;;YAaR;;;cA8FP,cAAqB,uBAAuB,YAAY;cAApB,iBACd;KACvB,wBAAwB;;YAEnB"}