@prismicio/client/dist/helpers/asImageWidthSrcSet.d.ts

The official JavaScript + TypeScript client library for Prismic

import { ImageFieldImage } from "../types/value/image.js";
import { BuildWidthSrcSetParams } from "imgix-url-builder";

//#region src/helpers/asImageWidthSrcSet.d.ts

/**
 * The return type of `asImageWidthSrcSet()`.
 */
type AsImageWidthSrcSetReturnType<Field extends ImageFieldImage | null | undefined> = Field extends ImageFieldImage<"filled"> ? {
  /**
   * The image field's URL with imgix URL parameters (if given).
   */
  src: string;
  /**
   * A width-based `srcset` attribute value for the image field with imgix
   * URL parameters (if given).
   */
  srcset: string;
} : null;
/**
 * Configuration for `asImageWidthSrcSet()`.
 */
type AsImageWidthSrcSetConfig = Omit<BuildWidthSrcSetParams, "widths"> & {
  widths?: "thumbnails" | BuildWidthSrcSetParams["widths"];
};
/**
 * Creates a width-based `srcset` from an image field with optional image
 * transformations via imgix URL parameters.
 *
 * If a `widths` parameter is not given, the following widths (in pixels) will
 * be used by default: 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` parameter.
 *
 * @example
 *
 * ```ts
 * const srcset = asImageWidthSrcSet(document.data.photo, {
 * 	widths: [400, 800, 1600],
 * 	sat: -100,
 * })
 * // => {
 * //   src: "https://images.prismic.io/repo/image.png?sat=-100",
 * //   srcset: "https://images.prismic.io/repo/image.png?sat=-100&width=400 400w, " +
 * //           "https://images.prismic.io/repo/image.png?sat=-100&width=800 800w, " +
 * //           "https://images.prismic.io/repo/image.png?sat=-100&width=1600 1600w"
 * // }
 * ```
 *
 * @param field - An image field (or one of its responsive views) from which to
 *   get an image URL.
 * @param config - An object of imgix URL API parameters. The `widths` parameter
 *   defines the resulting `srcset` widths. Pass `"thumbnails"` to automatically
 *   use the field's responsive views.
 *
 * @returns A `srcset` attribute value for the image field with imgix URL
 *   parameters, or `null` if the field is empty.
 *
 * @see Learn how to optimize images with imgix: {@link https://prismic.io/docs/fields/image}
 * @see imgix URL parameters reference: {@link https://docs.imgix.com/apis/rendering}
 */
declare const asImageWidthSrcSet: <Field extends ImageFieldImage | null | undefined>(field: Field, config?: AsImageWidthSrcSetConfig) => AsImageWidthSrcSetReturnType<Field>;
//#endregion
export { asImageWidthSrcSet };
//# sourceMappingURL=asImageWidthSrcSet.d.ts.map