@prismicio/vue 5.2.0 → 5.3.0-canary.4c3e4ab

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/PrismicImage.vue.d.cts

@@ -0,0 +1,280 @@
+import * as vue11 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: vue11.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";
+}), {}, {}, {}, {}, vue11.ComponentOptionsMixin, vue11.ComponentOptionsMixin, {}, string, vue11.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, vue11.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":";;;;;;;AAqNA;AAIQ,KAJI,iBAAA,GAIJ;EAAa;;;EAsDe,KAAA,EAtD5B,UAsD4B,GAtDf,UAsDe,CAAA,MAAA,CAAA;EAAlB;;;;;EAcD,WAAA,CAAA,EA7DF,UA6DE,CAAA,OA7DgB,UA6DhB,CAAA,CAAA,CAAA,CAAA;EAiIX;;;;;;EA/IY,GAAA,CAAA,EAAA,EAAA;EAAZ;;;;;;;EAcA,WAAA,CAAA,EAAA,EAAA;EAAW;;;;;;EA7DF,KAAA,CAAA,EAAA,MAAA,GAAA,MAAA;EA+CqB;;;;;;EA/CrB,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA;CA8DS,GAAA,CAAA;EAAlB;;;;;;;AAgIY;;;WA/IZ,YAAY,kBAAkB;;;;;;;;;;kBAc9B,YACA,kBAAkB;;cAgIlB,oBAAY;;;;SArMV,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;;cAgIN,iBAGU"}

package/dist/PrismicLink.vue.d.cts

@@ -0,0 +1,222 @@
+import { ComponentOrTagName } from "./types.cjs";
+import * as vue16 from "vue";
+import { AsLinkAttrsConfig, LinkField, LinkResolverFunction, PrismicDocument } from "@prismicio/client";
+
+//#region src/PrismicLink.vue.d.ts
+
+/**
+ * Props for `<PrismicLink />`.
+ */
+type PrismicLinkProps = {
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  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.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * The component rendered for internal URLs.
+   *
+   * If your app uses a client-side router that requires a special Link
+   * component, provide the Link component to this prop.
+   *
+   * @defaultValue `<RouterLink>`
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * The component rendered for external URLs.
+   *
+   * @defaultValue `<a>`
+   */
+  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: vue16.DefineComponent<({
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  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.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * The component rendered for internal URLs.
+   *
+   * If your app uses a client-side router that requires a special Link
+   * component, provide the Link component to this prop.
+   *
+   * @defaultValue `<RouterLink>`
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * The component rendered for external URLs.
+   *
+   * @defaultValue `<a>`
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic link field to render.
+   */
+  field: LinkField;
+  document?: never;
+}) | ({
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  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.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * The component rendered for internal URLs.
+   *
+   * If your app uses a client-side router that requires a special Link
+   * component, provide the Link component to this prop.
+   *
+   * @defaultValue `<RouterLink>`
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * The component rendered for external URLs.
+   *
+   * @defaultValue `<a>`
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic document to render as a link.
+   */
+  document: PrismicDocument;
+  field?: never;
+}), {}, {}, {}, {}, vue16.ComponentOptionsMixin, vue16.ComponentOptionsMixin, {}, string, vue16.PublicProps, Readonly<({
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  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.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * The component rendered for internal URLs.
+   *
+   * If your app uses a client-side router that requires a special Link
+   * component, provide the Link component to this prop.
+   *
+   * @defaultValue `<RouterLink>`
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * The component rendered for external URLs.
+   *
+   * @defaultValue `<a>`
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic link field to render.
+   */
+  field: LinkField;
+  document?: never;
+}) | ({
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  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.
+   */
+  rel?: string | AsLinkAttrsConfig["rel"];
+  /**
+   * The component rendered for internal URLs.
+   *
+   * If your app uses a client-side router that requires a special Link
+   * component, provide the Link component to this prop.
+   *
+   * @defaultValue `<RouterLink>`
+   */
+  internalComponent?: ComponentOrTagName;
+  /**
+   * The component rendered for external URLs.
+   *
+   * @defaultValue `<a>`
+   */
+  externalComponent?: ComponentOrTagName;
+} & {
+  /**
+   * The Prismic document to render as a link.
+   */
+  document: PrismicDocument;
+  field?: never;
+})> & Readonly<{}>, {}, {}, {}, {}, string, vue16.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":";;;;;;;;AAkKA;AAUgB,KAVJ,gBAAA,GAUI;EAOA;;;;;;AAiCf;AA0EqB;AAEc;EApHpB,YAAA,CAAA,EAAA,oBAAA;EAOA;;;;;EAAA,GAAA,CAAA,EAAA,MAAA,GAAA,iBAAA,CAAA,KAAA,CAAA;EAUK;;;;;;;;EAAA,iBAAA,CAAA,EAAA,kBAAA;EAOA;;;;;EAAA,iBAAA,CAAA,EAAA,kBAAA;CAaR,GAAA,CAAA;;;;OAoFG,EA3FN,SA2FM;EAAA,QAAA,CAAA,EAAA,KAAA;AAAA,CAAA,GAGV;EAA4C;;;EAAR,QAAA,EAvF7B,eAuF6B;EAAA,KAAA,CAAA,EAAA,KACF;AAAxC,CAAA,CAAA;YAXI;KACC,WAAA;2BACwB;;cAKvB,kBAAU;;;;;;;;;;iBAzHA;;;;;;iBAOA;;;;;;;;;sBAUK;;;;;;sBAOA;;;;;SAMX;;;;;;;;;;;;iBA9BM;;;;;;iBAOA;;;;;;;;;sBAUK;;;;;;sBAOA;;;;;YAaR;;oBAAe,KAAA,CAAA,qBAAA;;;;;;;;;;iBArCZ;;;;;;iBAOA;;;;;;;;;sBAUK;;;;;;sBAOA;;;;;SAMX;;;;;;;;;;;;iBA9BM;;;;;;iBAOA;;;;;;;;;sBAUK;;;;;;sBAOA;;;;;YAaR;;;cAuFP,cAAqB,uBAAuB,YAAY;cAApB,iBACd;KACvB,wBAAwB;;YAEnB"}

package/dist/PrismicRichText/PrismicRichText.vue.d.cts

@@ -0,0 +1,77 @@
+import { ComponentOrTagName } from "../types.cjs";
+import { VueRichTextSerializer } from "./types.cjs";
+import * as vue4 from "vue";
+import { PropType } from "vue";
+import { LinkResolverFunction, RichTextField } from "@prismicio/client";
+
+//#region src/PrismicRichText/PrismicRichText.vue.d.ts
+/**
+ * Props for `<PrismicRichText />`.
+ */
+type PrismicRichTextProps = {
+  /**
+   * The Prismic rich text field to render.
+   */
+  field: RichTextField | null | undefined;
+  /**
+   * The link resolver used to resolve links.
+   *
+   * @remarks
+   * If your app uses route resolvers when querying for your Prismic
+   * repository's content, a link resolver does not need to be provided.
+   *
+   * @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
+   */
+  linkResolver?: LinkResolverFunction;
+  /**
+   * An object that maps a rich text block type to a Vue component or a
+   * shorthand definition.
+   *
+   * @example
+   *
+   * ```javascript
+   * {
+   *   heading1: Heading1,
+   *   paragraph: { class: 'prose'},
+   *   strong: { as: 'em', class: 'font-bold' },
+   * }
+   * ```
+   */
+  components?: VueRichTextSerializer;
+  /**
+   * The value to be rendered when the field is empty. If a fallback is not
+   * given, `null` will be rendered.
+   */
+  fallback?: ComponentOrTagName;
+};
+declare const __VLS_export: vue4.DefineComponent<vue4.ExtractPropTypes<{
+  field: {
+    type: PropType<PrismicRichTextProps["field"]>;
+  };
+  linkResolver: {
+    type: PropType<PrismicRichTextProps["linkResolver"]>;
+  };
+  components: {
+    type: PropType<PrismicRichTextProps["components"]>;
+  };
+  fallback: {
+    type: PropType<PrismicRichTextProps["fallback"]>;
+  };
+}>, {}, {}, {}, {}, vue4.ComponentOptionsMixin, vue4.ComponentOptionsMixin, {}, string, vue4.PublicProps, Readonly<vue4.ExtractPropTypes<{
+  field: {
+    type: PropType<PrismicRichTextProps["field"]>;
+  };
+  linkResolver: {
+    type: PropType<PrismicRichTextProps["linkResolver"]>;
+  };
+  components: {
+    type: PropType<PrismicRichTextProps["components"]>;
+  };
+  fallback: {
+    type: PropType<PrismicRichTextProps["fallback"]>;
+  };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, vue4.ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+//#endregion
+export { PrismicRichTextProps, _default };
+//# sourceMappingURL=PrismicRichText.vue.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicRichText.vue.d.cts","names":[],"sources":["../../src/PrismicRichText/PrismicRichText.vue"],"sourcesContent":[],"mappings":";;;;;;;;;;AAgKY,KAAA,oBAAA,GAAoB;EAIxB;;;EAiCI,KAAA,EAjCJ,aAiCI,GAAA,IAAA,GAAA,SAAA;EAAkB;AAC7B;;;;;;;;EA2HqC,YAAA,CAAA,EAlJtB,oBAkJsB;EAAQ;;;;;;;;;;;;;;eAlIhC;;;;AAsHI;aAhHN;;cAgHN,mBAAY,gBAY4B,IAAA,CAZ5B;;UAGU,SAAS;;;UAGjB,SAAS;;;UAGX,SAAS;;;UAGW,SACnC;;oBAbe,IAAA,CAAA,qBAAA,qEAY4B,IAAA,CAAA;;UATlB,SAAS;;;UAGjB,SAAS;;;UAGX,SAAS;;;UAGW,SACnC;;;cAbe,iBAkBU"}

package/dist/PrismicRichText/getRichTextComponentProps.d.cts

@@ -0,0 +1,54 @@
+import { RichTextComponentProps } from "./types.cjs";
+import { PropType } from "vue";
+import { RTAnyNode } from "@prismicio/client";
+
+//#region src/PrismicRichText/getRichTextComponentProps.d.ts
+
+/**
+ * Native Vue props for a component rendering nodes from a Prismic rich text
+ * field using the `<PrismicRichText />` component.
+ *
+ * @typeParam TRTNode - The type of rich text node(s) this component handles
+ */
+type DefineComponentRichTextComponentProps<TRTNode extends RTAnyNode = RTAnyNode> = {
+  node: {
+    type: PropType<RichTextComponentProps<TRTNode>["node"]>;
+    required: true;
+  };
+};
+/**
+ * Gets native Vue props for a component rendering nodes from a Prismic rich
+ * text field using the `<PrismicRichText />` component.
+ *
+ * Props are: `["node"]`
+ *
+ * @example
+ *
+ * ```javascript
+ * // Defining a new rich text component
+ * import { getRichTextComponentProps } from "@prismicio/vue"
+ *
+ * defineProps(getRichTextComponentProps())
+ * ```
+ *
+ * @example
+ *
+ * ```typescript
+ * // Defining a new rich text component for a specific node type
+ * import { getRichTextComponentProps } from "@prismicio/vue"
+ *
+ * defineProps(getRichTextComponentProps("heading1"))
+ * ```
+ *
+ * @typeParam TRTType - The type of rich text node(s) this component handles
+ *
+ * @param type - The type of rich text node this component handles
+ *
+ * @returns Props object to use with `defineProps()`
+ */
+declare const getRichTextComponentProps: <TRTType extends RTAnyNode["type"]>(type?: TRTType) => DefineComponentRichTextComponentProps<Extract<RTAnyNode, {
+  type: TRTType;
+}>>;
+//#endregion
+export { getRichTextComponentProps };
+//# sourceMappingURL=getRichTextComponentProps.d.cts.map