npm - @datocms/svelte - Versions diffs - 1.2.2 → 1.3.0 - Mend

@datocms/svelte 1.2.2 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/package/components/Head/Head.svelte ADDED Viewed

@@ -0,0 +1,14 @@
+<script context="module"></script>
+<script>export let data = [];
+</script>
+<svelte:head>
+	{#each data as { tag, attributes, content }}
+		{#if content}
+			<svelte:element this={tag} {...attributes}>{content}</svelte:element>
+		{:else}
+			<svelte:element this={tag} {...attributes} />
+		{/if}
+	{/each}
+</svelte:head>

package/package/components/Head/Head.svelte.d.ts ADDED Viewed

@@ -0,0 +1,61 @@
+import { SvelteComponentTyped } from "svelte";
+export interface TitleMetaLinkTag {
+    /** the tag for the meta information */
+    tag: "title" | "meta" | "link";
+    /** the inner content of the meta tag */
+    content?: string | null | undefined;
+    /** the HTML attributes to attach to the meta tag */
+    attributes?: Record<string, string> | null | undefined;
+}
+export interface SeoTitleTag {
+    tag: 'title';
+    content: string | null;
+    attributes?: null;
+}
+export interface RegularMetaAttributes {
+    name: string;
+    content: string;
+}
+export interface OgMetaAttributes {
+    property: string;
+    content: string;
+}
+export interface SeoMetaTag {
+    tag: 'meta';
+    content?: null;
+    attributes: RegularMetaAttributes | OgMetaAttributes;
+}
+export interface FaviconAttributes {
+    sizes: string;
+    type: string;
+    rel: string;
+    href: string;
+}
+export interface AppleTouchIconAttributes {
+    sizes: string;
+    rel: 'apple-touch-icon';
+    href: string;
+}
+export interface SeoLinkTag {
+    tag: 'link';
+    content?: null;
+    attributes: FaviconAttributes | AppleTouchIconAttributes;
+}
+export type SeoTag = SeoTitleTag | SeoMetaTag;
+export type FaviconTag = SeoMetaTag | SeoLinkTag;
+export type SeoOrFaviconTag = SeoTag | FaviconTag;
+declare const __propDef: {
+    props: {
+        data?: (TitleMetaLinkTag | SeoOrFaviconTag)[] | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type HeadProps = typeof __propDef.props;
+export type HeadEvents = typeof __propDef.events;
+export type HeadSlots = typeof __propDef.slots;
+export default class Head extends SvelteComponentTyped<HeadProps, HeadEvents, HeadSlots> {
+}
+export {};

package/package/components/Head/README.md ADDED Viewed

@@ -0,0 +1,68 @@
+## Social share, SEO and Favicon meta tags
+Just like the image component, `<Head />` is a component specially designed to work seamlessly with DatoCMS’s [`_seoMetaTags` and `faviconMetaTags` GraphQL queries](https://www.datocms.com/docs/content-delivery-api/seo) so that you can handle proper SEO in your pages.
+You can use `<Head />` your components, and it will inject title, meta and link tags in the document's `<head></head>` tag.
+### Table of contents
+- [Usage](#usage)
+- [Example](#example)
+### Usage
+`<Head />`'s `data` prop takes an array of `Tag`s in the exact form they're returned by the following [DatoCMS GraphQL API](https://www.datocms.com/docs/content-delivery-api/seo) queries:
+- `_seoMetaTags` query on any record, or
+- `faviconMetaTags` on the global `_site` object.
+### Example
+Here is an example:
+```svelte
+<script>
+  import { onMount } from 'svelte';
+  import { Head } from '@datocms/svelte';
+  const query = `
+    query {
+      page: homepage {
+        title
+        seo: _seoMetaTags {
+          attributes
+          content
+          tag
+        }
+      }
+      site: _site {
+        favicon: faviconMetaTags {
+          attributes
+          content
+          tag
+        }
+      }
+    }
+  `;
+  export let data = null;
+  onMount(async () => {
+    const response = await fetch('https://graphql.datocms.com/', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: 'Bearer faeb9172e232a75339242faafb9e56de8c8f13b735f7090964'
+      },
+      body: JSON.stringify({ query })
+    });
+    const json = await response.json();
+    data = [...json.data.page.seo, ...json.data.site.favicon];
+  });
+</script>
+<Head {data} />
+```

package/package/components/Image/Image.svelte ADDED Viewed

@@ -0,0 +1,172 @@
+<script context="module">import IntersectionObserver from "svelte-intersection-observer";
+const isWindowDefined = typeof window !== "undefined";
+const noTypeCheck = (x) => x;
+const imageAddStrategy = ({ lazyLoad, intersecting, loaded }) => {
+  const isIntersectionObserverAvailable = isWindowDefined ? !!window.IntersectionObserver : false;
+  if (!lazyLoad) {
+    return true;
+  }
+  if (!isWindowDefined) {
+    return false;
+  }
+  if (isIntersectionObserverAvailable) {
+    return intersecting || loaded;
+  }
+  return true;
+};
+const imageShowStrategy = ({ lazyLoad, loaded }) => {
+  const isIntersectionObserverAvailable = isWindowDefined ? !!window.IntersectionObserver : false;
+  if (!lazyLoad) {
+    return true;
+  }
+  if (!isWindowDefined) {
+    return false;
+  }
+  if (isIntersectionObserverAvailable) {
+    return loaded;
+  }
+  return true;
+};
+const bogusBaseUrl = "https://example.com/";
+const buildSrcSet = (src, width, candidateMultipliers) => {
+  if (!(src && width)) {
+    return void 0;
+  }
+  return candidateMultipliers.map((multiplier) => {
+    const url = new URL(src, bogusBaseUrl);
+    if (multiplier !== 1) {
+      url.searchParams.set("dpr", `${multiplier}`);
+      const maxH = url.searchParams.get("max-h");
+      const maxW = url.searchParams.get("max-w");
+      if (maxH) {
+        url.searchParams.set("max-h", `${Math.floor(parseInt(maxH) * multiplier)}`);
+      }
+      if (maxW) {
+        url.searchParams.set("max-w", `${Math.floor(parseInt(maxW) * multiplier)}`);
+      }
+    }
+    const finalWidth = Math.floor(width * multiplier);
+    if (finalWidth < 50) {
+      return null;
+    }
+    return `${url.toString().replace(bogusBaseUrl, "/")} ${finalWidth}w`;
+  }).filter(Boolean).join(",");
+};
+</script>
+<script>import { createEventDispatcher } from "svelte";
+import Sizer from "./Sizer.svelte";
+import Placeholder from "./Placeholder.svelte";
+import Source from "./Source.svelte";
+const dispatch = createEventDispatcher();
+let element;
+let intersecting = false;
+let loaded = false;
+export let alt = null;
+export let data;
+let klass = null;
+export { klass as class };
+export let pictureClass = null;
+export let fadeInDuration = 500;
+export let intersectionThreshold = 0;
+export let intersectionMargin = "0px";
+let rawLazyLoad = true;
+export { rawLazyLoad as lazyLoad };
+export let style = {};
+export let pictureStyle = null;
+export let layout = "intrinsic";
+export let objectFit = void 0;
+export let objectPosition = void 0;
+export let usePlaceholder = true;
+export let sizes = null;
+export let priority = false;
+export let srcSetCandidates = [0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4];
+$:
+  ({ width, height, aspectRatio } = data);
+$:
+  lazyLoad = priority ? false : rawLazyLoad;
+$:
+  addImage = imageAddStrategy({
+    lazyLoad,
+    intersecting,
+    loaded
+  });
+$:
+  showImage = imageShowStrategy({
+    lazyLoad,
+    intersecting,
+    loaded
+  });
+let transition = fadeInDuration > 0 ? `opacity ${fadeInDuration}ms` : void 0;
+</script>
+<IntersectionObserver
+	{element}
+	bind:intersecting
+	threshold={intersectionThreshold}
+	rootMargin={intersectionMargin}
+>
+	<div
+		bind:this={element}
+		class={klass}
+		style:overflow="hidden"
+		style:position={style.position ?? layout === 'fill' ? 'absolute' : 'relative'}
+		style:width={style.width ?? layout === 'fixed' ? data.width : '100%'}
+		style:maxWidth={style.maxWidth ?? layout === 'intrinsic' ? data.width : null}
+		style:height={style.height ?? layout === 'fill' ? '100%' : null}
+		data-testid="image"
+	>
+		{#if layout !== 'fill' && width}
+			<Sizer {width} {height} {aspectRatio} />
+		{/if}
+		{#if usePlaceholder && (data.bgColor || data.base64)}
+			<Placeholder
+				base64={data.base64}
+				backgroundColor={data.bgColor}
+				{objectFit}
+				{objectPosition}
+				{showImage}
+				{fadeInDuration}
+			/>
+		{/if}
+		{#if addImage}
+			<picture style={pictureStyle} data-testid="picture">
+				{#if data.webpSrcSet}
+					<Source srcset={data.webpSrcSet} sizes={sizes ?? data.sizes ?? null} type="image/webp" />
+				{/if}
+				<Source
+					srcset={data.srcSet ?? buildSrcSet(data.src, data.width, srcSetCandidates) ?? null}
+					sizes={sizes ?? data.sizes ?? null}
+				/>
+				{#if data.src}
+					<img
+						{...noTypeCheck({
+							// See: https://github.com/sveltejs/language-tools/issues/1026#issuecomment-1002839154
+							fetchpriority: priority ? 'high' : undefined
+						})}
+						src={data.src}
+						alt={alt ?? data.alt ?? ''}
+						title={data.title ?? null}
+						on:load={() => {
+							dispatch('load');
+							loaded = true;
+						}}
+						class={pictureClass}
+						style:opacity={showImage ? 1 : 0}
+						style:transition
+						style:position="absolute"
+						style:left="0"
+						style:top="0"
+						style:width="100%"
+						style:height="100%"
+						style:objectFit
+						style:objectPosition
+						data-testid="img"
+					/>
+				{/if}
+			</picture>
+		{/if}
+	</div>
+</IntersectionObserver>

package/package/components/Image/Image.svelte.d.ts ADDED Viewed

@@ -0,0 +1,83 @@
+import { SvelteComponentTyped } from "svelte";
+export type Maybe<T> = T | null;
+export type ResponsiveImageType = {
+    /** A base64-encoded thumbnail to offer during image loading */
+    base64?: Maybe<string>;
+    /** The height of the image */
+    height?: Maybe<number>;
+    /** The width of the image */
+    width?: number;
+    /** The aspect ratio (width/height) of the image */
+    aspectRatio?: number;
+    /** The HTML5 `sizes` attribute for the image */
+    sizes?: Maybe<string>;
+    /** The fallback `src` attribute for the image */
+    src?: Maybe<string>;
+    /** The HTML5 `srcSet` attribute for the image */
+    srcSet?: Maybe<string>;
+    /** The HTML5 `srcSet` attribute for the image in WebP format, for browsers that support the format */
+    webpSrcSet?: Maybe<string>;
+    /** The background color for the image placeholder */
+    bgColor?: Maybe<string>;
+    /** Alternate text (`alt`) for the image */
+    alt?: Maybe<string>;
+    /** Title attribute (`title`) for the image */
+    title?: Maybe<string>;
+};
+import type * as CSS from 'csstype';
+declare const __propDef: {
+    props: {
+        alt?: string | null | undefined;
+        /** The actual response you get from a DatoCMS `responsiveImage` GraphQL query */ data: ResponsiveImageType;
+        /** Additional CSS className for root node */ class?: string | null | undefined;
+        /** Additional CSS class for the image inside the `<picture />` tag */ pictureClass?: string | null | undefined;
+        /** Duration (in ms) of the fade-in transition effect upoad image loading */ fadeInDuration?: number | undefined;
+        /** Indicate at what percentage of the placeholder visibility the loading of the image should be triggered. A value of 0 means that as soon as even one pixel is visible, the callback will be run. A value of 1.0 means that the threshold isn't considered passed until every pixel is visible */ intersectionThreshold?: number | undefined;
+        /** Margin around the placeholder. Can have values similar to the CSS margin property (top, right, bottom, left). The values can be percentages. This set of values serves to grow or shrink each side of the placeholder element's bounding box before computing intersections */ intersectionMargin?: string | undefined;
+        /** Whether enable lazy loading or not */ lazyLoad?: boolean | undefined;
+        /** Additional CSS rules to add to the root node */ style?: Record<string, string> | undefined;
+        /** Additional CSS rules to add to the image inside the `<picture />` tag */ pictureStyle?: string | null | undefined;
+        /**
+             * The layout behavior of the image as the viewport changes size
+             *
+             * Possible values:
+             *
+             * * `intrinsic` (default): the image will scale the dimensions down for smaller viewports, but maintain the original dimensions for larger viewports
+             * * `fixed`: the image dimensions will not change as the viewport changes (no responsiveness) similar to the native img element
+             * * `responsive`: the image will scale the dimensions down for smaller viewports and scale up for larger viewports
+             * * `fill`: image will stretch both width and height to the dimensions of the parent element, provided the parent element is `relative`
+             **/ layout?: "fill" | "intrinsic" | "fixed" | "responsive" | undefined;
+        /** Defines how the image will fit into its parent container when using layout="fill" */ objectFit?: CSS.Properties['objectFit'];
+        /** Defines how the image is positioned within its parent element when using layout="fill". */ objectPosition?: CSS.Properties['objectPosition'];
+        /** Whether the component should use a blurred image placeholder */ usePlaceholder?: boolean | undefined;
+        /**
+             * The HTML5 `sizes` attribute for the image
+             *
+             * Learn more about srcset and sizes:
+             * -> https://web.dev/learn/design/responsive-images/#sizes
+             * -> https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes
+             **/ sizes?: string | null | undefined;
+        /**
+             * When true, the image will be considered high priority. Lazy loading is automatically disabled, and fetchpriority="high" is added to the image.
+             * You should use the priority property on any image detected as the Largest Contentful Paint (LCP) element. It may be appropriate to have multiple priority images, as different images may be the LCP element for different viewport sizes.
+             * Should only be used when the image is visible above the fold.
+             **/ priority?: boolean | undefined;
+        /**
+             * If `data` does not contain `srcSet`, the candidates for the `srcset` of the image will be auto-generated based on these width multipliers
+             *
+             * Default candidate multipliers are [0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4]
+             **/ srcSetCandidates?: number[] | undefined;
+    };
+    events: {
+        load: CustomEvent<any>;
+    } & {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type ImageProps = typeof __propDef.props;
+export type ImageEvents = typeof __propDef.events;
+export type ImageSlots = typeof __propDef.slots;
+export default class Image extends SvelteComponentTyped<ImageProps, ImageEvents, ImageSlots> {
+}
+export {};

package/package/components/Image/Placeholder.svelte ADDED Viewed

@@ -0,0 +1,30 @@
+<script>export let base64 = null;
+export let backgroundColor = null;
+export let objectFit;
+export let objectPosition;
+export let showImage;
+export let fadeInDuration = 0;
+let transition = fadeInDuration > 0 ? `opacity ${fadeInDuration}ms` : void 0;
+let opacity = showImage ? 0 : 1;
+</script>
+<img
+	class="placeholder"
+	aria-hidden="true"
+	alt=""
+	src={base64}
+	style:backgroundColor
+	style:objectFit
+	style:objectPosition
+	style:transition
+	style:opacity
+/>
+<style>
+	.placeholder {
+		position: absolute;
+		width: 100%;
+		top: 0;
+		scale: 110%;
+	}
+</style>

package/package/components/Image/Placeholder.svelte.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { SvelteComponentTyped } from "svelte";
+import type * as CSS from 'csstype';
+declare const __propDef: {
+    props: {
+        base64?: string | null | undefined;
+        backgroundColor?: string | null | undefined;
+        objectFit: CSS.Properties['objectFit'];
+        objectPosition: CSS.Properties['objectPosition'];
+        showImage: boolean;
+        fadeInDuration?: number | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type PlaceholderProps = typeof __propDef.props;
+export type PlaceholderEvents = typeof __propDef.events;
+export type PlaceholderSlots = typeof __propDef.slots;
+export default class Placeholder extends SvelteComponentTyped<PlaceholderProps, PlaceholderEvents, PlaceholderSlots> {
+}
+export {};

package/package/components/Image/README.md ADDED Viewed

@@ -0,0 +1,167 @@
+## Progressive responsive image
+`<Image>` is a Svelte component specially designed to work seamlessly with DatoCMS’s [`responsiveImage` GraphQL query](https://www.datocms.com/docs/content-delivery-api/uploads#responsive-images) that optimizes image loading for your sites.
+### Table of contents
+- [Out-of-the-box features](#out-of-the-box-features)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Example](#example)
+- [Props](#props)
+  - [Layout mode](#layout-mode)
+  - [The `ResponsiveImage` object](#the-responsiveimage-object)
+### Out-of-the-box features
+- Offers optimized version of images for browsers that support WebP/AVIF format
+- Generates multiple smaller images so smartphones and tablets don’t download desktop-sized images
+- Efficiently lazy loads images to speed initial page load and save bandwidth
+- Holds the image position so your page doesn’t jump while images load
+- Uses either blur-up or background color techniques to show a preview of the image while it loads
+## Intersection Observer
+Intersection Observer is the API used to determine if the image is inside the viewport or not. [Browser support is really good](https://caniuse.com/intersectionobserver) - With Safari adding support in 12.1, all major browsers now support Intersection Observers natively.
+If the IntersectionObserver object is not available, the component treats the image as it's always visible in the viewport. Feel free to add a [polyfill](https://www.npmjs.com/package/intersection-observer) so that it will also 100% work on older versions of iOS and IE11.
+### Setup
+You can import the components like this:
+```js
+import { Image } from '@datocms/svelte';
+```
+### Usage
+1. Use `<Image>` it in place of the regular `<img />` tag
+2. Write a GraphQL query to your DatoCMS project using the [`responsiveImage` query](https://www.datocms.com/docs/content-delivery-api/images-and-videos#responsive-images)
+The GraphQL query returns multiple thumbnails with optimized compression. The `<Image>` component automatically sets up the "blur-up" effect as well as lazy loading of images further down the screen.
+### Example
+For a fully working example take a look at [`routes` directory](https://github.com/datocms/datocms-svelte/tree/main/src/routes/image/+page.svelte).
+Here is a minimal starting point:
+```svelte
+<script>
+import { onMount } from 'svelte';
+import { Image } from '@datocms/svelte';
+const query = gql`
+  query {
+    blogPost {
+      title
+      cover {
+        responsiveImage(
+          imgixParams: { fit: crop, w: 300, h: 300, auto: format }
+        ) {
+          # always required
+          src
+          width
+          height
+          # not required, but strongly suggested!
+          alt
+          title
+          # blur-up placeholder, JPEG format, base64-encoded, or...
+          base64
+          # background color placeholder
+          bgColor
+          # you can omit `sizes` if you explicitly pass the `sizes` prop to the image component
+          sizes
+        }
+      }
+    }
+  }
+`;
+export let data = null;
+onMount(async () => {
+  const response = await fetch('https://graphql.datocms.com/', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: "Bearer faeb9172e232a75339242faafb9e56de8c8f13b735f7090964",
+    },
+    body: JSON.stringify({ query })
+  })
+  const json = await response.json()
+  data = json.data;
+});
+</script>
+{#if data}
+  <Image data={data.blogPost.cover.responsiveImage} />
+{/if}
+```
+### Props
+| prop                  | type                                             | default           | required           | description                                                                                                                                                                                                                                                                                   |
+| --------------------- | ------------------------------------------------ | ----------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| data                  | `ResponsiveImage` object                         |                   | :white_check_mark: | The actual response you get from a DatoCMS `responsiveImage` GraphQL query.                                                                                                                                                                                                                   |
+| class                 | string                                           | null              | :x:                | Additional CSS class of root node                                                                                                                                                                                                                                                             |
+| style                 | CSS properties                                   | null              | :x:                | Additional CSS rules to add to the root node                                                                                                                                                                                                                                                  |
+| pictureClass          | string                                           | null              | :x:                | Additional CSS class for the inner `<picture />` tag                                                                                                                                                                                                                                          |
+| pictureStyle          | CSS properties                                   | null              | :x:                | Additional CSS rules to add to the inner `<picture />` tag                                                                                                                                                                                                                                    |
+| layout                | 'intrinsic' \| 'fixed' \| 'responsive' \| 'fill' | "intrinsic"       | :x:                | The layout behavior of the image as the viewport changes size                                                                                                                                                                                                                                 |
+| fadeInDuration        | integer                                          | 500               | :x:                | Duration (in ms) of the fade-in transition effect upoad image loading                                                                                                                                                                                                                         |
+| intersectionThreshold | float                                            | 0                 | :x:                | Indicate at what percentage of the placeholder visibility the loading of the image should be triggered. A value of 0 means that as soon as even one pixel is visible, the callback will be run. A value of 1.0 means that the threshold isn't considered passed until every pixel is visible. |
+| intersectionMargin    | string                                           | "0px 0px 0px 0px" | :x:                | Margin around the placeholder. Can have values similar to the CSS margin property (top, right, bottom, left). The values can be percentages. This set of values serves to grow or shrink each side of the placeholder element's bounding box before computing intersections.                  |
+| lazyLoad              | Boolean                                          | true              | :x:                | Wheter enable lazy loading or not                                                                                                                                                                                                                                                             |
+| explicitWidth         | Boolean                                          | false             | :x:                | Wheter the image wrapper should explicitely declare the width of the image or keep it fluid                                                                                                                                                                                                   |
+| objectFit             | String                                           | null              | :x:                | Defines how the image will fit into its parent container when using layout="fill"                                                                                                                                                                                                             |
+| objectPosition        | String                                           | null              | :x:                | Defines how the image is positioned within its parent element when using layout="fill".                                                                                                                                                                                                       |
+| priority              | Boolean                                          | false             | :x:                | Disables lazy loading, and sets the image [fetchPriority](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/fetchPriority) to "high"                                                                                                                         |
+| srcSetCandidates      | Array<number>                                    | [0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4] | :x:                | If `data` does not contain `srcSet`, the candidates for the `srcset` attribute of the image will be auto-generated based on these width multipliers                                                                                                                          |
+| sizes                 | string                                           | undefined         | :x:                | The HTML5 [`sizes`](https://web.dev/learn/design/responsive-images/#sizes) attribute for the image (will be used `data.sizes` as a fallback)                                                                                                                                 |
+| onLoad                | () => void                                       | undefined         | :x:                | Function triggered when the image has finished loading                                                                                                                                                                                                                       |
+| usePlaceholder        | Boolean                                          | true              | :x:                | Whether the component should use a blurred image placeholder                                                                                                                                                                                                                 |
+#### Layout mode
+With the `layout` property, you can configure the behavior of the image as the viewport changes size:
+- When `intrinsic`, the image will scale the dimensions down for smaller viewports, but maintain the original dimensions for larger viewports.
+- When `fixed`, the image dimensions will not change as the viewport changes (no responsiveness) similar to the native `img` element.
+- When `responsive` (default behaviour), the image will scale the dimensions down for smaller viewports and scale up for larger viewports.
+- When `fill`, the image will stretch both width and height to the dimensions of the parent element, provided the parent element is relative.
+  - This is usually paired with the `objectFit` and `objectPosition` properties.
+  - Ensure the parent element has `position: relative` in their stylesheet.
+#### The `ResponsiveImage` object
+The `data` prop expects an object with the same shape as the one returned by `responsiveImage` GraphQL call. It's up to you to make a GraphQL query that will return the properties you need for a specific use of the `<datocms-image>` component.
+- The minimum required properties for `data` are: `src`, `width` and `height`;
+- `alt` and `title`, while not mandatory, are all highly suggested, so remember to use them!
+- If you don't request `srcSet`, the component will auto-generate an `srcset` based on `src` + the `srcSetCandidates` prop (it can help reducing the GraphQL response size drammatically when many images are returned);
+- We strongly to suggest to always specify [`{ auto: format }`](https://docs.imgix.com/apis/rendering/auto/auto#format) in your `imgixParams`, instead of requesting `webpSrcSet`, so that you can also take advantage of more performant optimizations (AVIF), without increasing GraphQL response size;
+- If you request both the `bgColor` and `base64` property, the latter will take precedence, so just avoid querying both fields at the same time, as it will only make the GraphQL response bigger :wink:;
+- You can avoid requesting `sizes` and directly pass a `sizes` prop to the component to reduce the GraphQL response size;
+Here's a complete recap of what `responsiveImage` offers:
+| property    | type    | required           | description                                                                                     |
+| ----------- | ------- | ------------------ | ----------------------------------------------------------------------------------------------- |
+| src         | string  | :white_check_mark: | The `src` attribute for the image                                                               |
+| width       | integer | :white_check_mark: | The width of the image                                                                          |
+| height      | integer | :white_check_mark: | The height of the image                                                                         |
+| alt         | string  | :x:                | Alternate text (`alt`) for the image (not required, but strongly suggested!)                    |
+| title       | string  | :x:                | Title attribute (`title`) for the image (not required, but strongly suggested!)                 |
+| sizes       | string  | :x:                | The HTML5 `sizes` attribute for the image (omit it if you're already passing a `sizes` prop to the Image component) |
+| base64      | string  | :x:                | A base64-encoded thumbnail to offer during image loading                                        |
+| bgColor     | string  | :x:                | The background color for the image placeholder (omit it if you're already requesting `base64`)  |
+| srcSet      | string  | :x:                | The HTML5 `srcSet` attribute for the image (can be omitted, the Image component knows how to build it based on `src`) |
+| webpSrcSet  | string  | :x:                | The HTML5 `srcSet` attribute for the image in WebP format (deprecated, it's better to use the [`auto=format`](https://docs.imgix.com/apis/rendering/auto/auto#format) Imgix transform instead) |
+| aspectRatio | float   | :x:                | The aspect ratio (width/height) of the image                                                    |

package/package/components/Image/Sizer.svelte ADDED Viewed

@@ -0,0 +1,17 @@
+<script>import { encode } from "universal-base64";
+let klass = null;
+export { klass as class };
+export let width;
+export let height;
+export let aspectRatio;
+let svg = `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height ?? (aspectRatio ? width / aspectRatio : 0)}"></svg>`;
+</script>
+<img
+	class={klass}
+	style:display="block"
+	style:width="100%"
+	src="data:image/svg+xml;base64,{encode(svg)}"
+	aria-hidden="true"
+	alt=""
+/>

package/package/components/Image/Sizer.svelte.d.ts ADDED Viewed

@@ -0,0 +1,19 @@
+import { SvelteComponentTyped } from "svelte";
+declare const __propDef: {
+    props: {
+        class?: string | null | undefined;
+        width: number;
+        height: number | null | undefined;
+        aspectRatio: number | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type SizerProps = typeof __propDef.props;
+export type SizerEvents = typeof __propDef.events;
+export type SizerSlots = typeof __propDef.slots;
+export default class Sizer extends SvelteComponentTyped<SizerProps, SizerEvents, SizerSlots> {
+}
+export {};