@prismicio/vue 3.0.0-beta.1 → 3.0.0-beta.2

package/src/types.ts

@@ -15,6 +15,9 @@ import type {
 	HTMLFunctionSerializer,
 	HTMLMapSerializer,
 	LinkResolverFunction,
+	asImageSrc,
+	asImageWidthSrcSet,
+	asImagePixelDensitySrcSet,
 } from "@prismicio/helpers";
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -89,6 +92,7 @@ type PrismicPluginComponentsOptions = {
 	 *
 	 * @remarks
 	 * Components will be rendered using the {@link SliceComponentProps} interface.
+	 *
 	 * @defaultValue `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}
 	 */
 	sliceZoneDefaultComponent?: SliceComponentType;
@@ -308,6 +312,26 @@ export type PrismicPluginHelpers = {
 	 */
 	asDate: typeof asDate;
 
+	/**
+	 * Returns the URL of an Image field with optional image transformations (via
+	 * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc} function.
+	 */
+	asImageSrc: typeof asImageSrc;
+
+	/**
+	 * Creates a width-based `srcset` from an Image field with optional image
+	 * transformations (via Imgix URL parameters). This is `@prismicio/helpers`
+	 * {@link asImageWidthSrcSet} function.
+	 */
+	asImageWidthSrcSet: typeof asImageWidthSrcSet;
+
+	/**
+	 * Creates a pixel-density-based `srcset` from an Image field with optional
+	 * image transformations (via Imgix URL parameters). This is
+	 * `@prismicio/helpers` {@link asImagePixelDensitySrcSet} function.
+	 */
+	asImagePixelDensitySrcSet: typeof asImagePixelDensitySrcSet;
+
 	/**
 	 * Converts a document into a link field. This is `@prismicio/helpers`
 	 * {@link documentToLinkField} function.

package/src/useStatefulPrismicClientMethod.ts

@@ -91,10 +91,12 @@ const isParams = (
  * @typeParam TClientMethodName - A method name from `@prismicio/client`
  * @typeParam TClientMethodArguments - The method expected arguments
  * @typeParam TClientMethodReturnType - The method expected return type
+ *
  * @param method - The `@prismicio/client` method name to use
  * @param args - The arguments to use with requested method
  *
  * @returns The composable payload {@link ClientComposableReturnType}
+ *
  * @internal
  */
 export const useStatefulPrismicClientMethod = <

package/vetur/attributes.json

@@ -16,9 +16,17 @@
 		"type": "string | object | function",
 		"description": "An HTML tag name, a component, or a functional component used to render images. Defaults to the one provided to `@prismicio/vue` plugin if configured, `\"img\"` otherwise."
 	},
-	"prismic-image/image-component-additional-props": {
+	"prismic-image/imgix-params": {
 		"type": "object",
-		"description": "A map of additional props to pass to the component used to render images when using one."
+		"description": "An object of Imgix URL API parameters."
+	},
+	"prismic-image/widths": {
+		"type": "array | string",
+		"description": "Adds an additional `srcset` attribute to the image following given widths."
+	},
+	"prismic-image/pixel-densities": {
+		"type": "array | string",
+		"description": "Adds an additional `srcset` attribute to the image following giving pixel densities."
 	},
 
 	"prismic-link/field": {

package/vetur/tags.json

@@ -7,7 +7,9 @@
 		"attributes": [
 			"field",
 			"image-component",
-			"image-component-additional-props"
+			"imgix-params",
+			"widths",
+			"pixel-densities"
 		],
 		"description": "Component to render a Prismic image field."
 	},