@starlightcms/react-sdk 0.10.0 → 0.11.0

package/dist/cjs/ResponsiveImage/types.d.ts

@@ -20,8 +20,8 @@ export interface ResponsiveImageProps {
     sizes?: string;
     /**
      * Alternate text description of the image. If set and the given image is a
-     * Starlight media object, it will overwrite this image's alternative text
-     * set in Starlight.
+     * Starlight media object, it will be used in place of the image's
+     * alternative text set in Starlight.
      */
     alt?: string;
     /**

package/dist/cjs/ResponsiveImage/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ResponsiveImage/types.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject } from '@starlightcms/js-sdk'\nimport { RefObject } from 'react'\n\n/**\n * Props accepted by the {@link ResponsiveImage} component.\n * @group ResponsiveImage\n */\nexport interface ResponsiveImageProps {\n  className?: string\n  /**\n   * The image to render. It should be a URI string or the object returned by\n   * Starlight on a Media File field. Required.\n   */\n  image: MediaObject | string\n  /**\n   * An HTML <img> `sizes` attribute. If provided, the browser will render the\n   * best fit image size variation to the current viewport size. See\n   * [the MDN documentation on the sizes property](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)\n   * to learn how to configure this attribute.\n   */\n  sizes?: string\n  /**\n   * Alternate text description of the image. If set and the given image is a\n   * Starlight media object, it will overwrite this image's alternative text\n   * set in Starlight.\n   */\n  alt?: string\n  /**\n   * Defines which image variation will be rendered. Defaults to `optimized`.\n   */\n  variation?: string\n  /**\n   * Defines the background color of the image while it loads. It accepts any\n   * CSS color, including `transparent`. Defaults to the color generated by\n   * Starlight when the image was uploaded, or transparent when the given image\n   * is a URI string.\n   */\n  background?: string\n  /**\n   * Defines the scrollable parent of the image. Set this to the nearest\n   * scrollable HTMLElement parent of this image if lazy-loading is not working.\n   * See [the MDN documentation on IntersectionObserver.root](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/root)\n   * to learn more.\n   */\n  lazyRoot?: RefObject<HTMLElement> | null\n  /**\n   * Defines how close to the viewport an image has to be to start loading.\n   * See [the MDN documentation on IntersectionObserver.rootMargin](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/rootMargin)\n   * to learn more. Defaults to 200px.\n   */\n  lazyRootMargin?: string\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ResponsiveImage/types.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject } from '@starlightcms/js-sdk'\nimport { RefObject } from 'react'\n\n/**\n * Props accepted by the {@link ResponsiveImage} component.\n * @group ResponsiveImage\n */\nexport interface ResponsiveImageProps {\n  className?: string\n  /**\n   * The image to render. It should be a URI string or the object returned by\n   * Starlight on a Media File field. Required.\n   */\n  image: MediaObject | string\n  /**\n   * An HTML <img> `sizes` attribute. If provided, the browser will render the\n   * best fit image size variation to the current viewport size. See\n   * [the MDN documentation on the sizes property](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)\n   * to learn how to configure this attribute.\n   */\n  sizes?: string\n  /**\n   * Alternate text description of the image. If set and the given image is a\n   * Starlight media object, it will be used in place of the image's\n   * alternative text set in Starlight.\n   */\n  alt?: string\n  /**\n   * Defines which image variation will be rendered. Defaults to `optimized`.\n   */\n  variation?: string\n  /**\n   * Defines the background color of the image while it loads. It accepts any\n   * CSS color, including `transparent`. Defaults to the color generated by\n   * Starlight when the image was uploaded, or transparent when the given image\n   * is a URI string.\n   */\n  background?: string\n  /**\n   * Defines the scrollable parent of the image. Set this to the nearest\n   * scrollable HTMLElement parent of this image if lazy-loading is not working.\n   * See [the MDN documentation on IntersectionObserver.root](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/root)\n   * to learn more.\n   */\n  lazyRoot?: RefObject<HTMLElement> | null\n  /**\n   * Defines how close to the viewport an image has to be to start loading.\n   * See [the MDN documentation on IntersectionObserver.rootMargin](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/rootMargin)\n   * to learn more. Defaults to 200px.\n   */\n  lazyRootMargin?: string\n}\n"]}

package/dist/esm/ResponsiveImage/types.d.ts

@@ -20,8 +20,8 @@ export interface ResponsiveImageProps {
     sizes?: string;
     /**
      * Alternate text description of the image. If set and the given image is a
-     * Starlight media object, it will overwrite this image's alternative text
-     * set in Starlight.
+     * Starlight media object, it will be used in place of the image's
+     * alternative text set in Starlight.
      */
     alt?: string;
     /**

package/dist/esm/ResponsiveImage/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ResponsiveImage/types.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject } from '@starlightcms/js-sdk'\nimport { RefObject } from 'react'\n\n/**\n * Props accepted by the {@link ResponsiveImage} component.\n * @group ResponsiveImage\n */\nexport interface ResponsiveImageProps {\n  className?: string\n  /**\n   * The image to render. It should be a URI string or the object returned by\n   * Starlight on a Media File field. Required.\n   */\n  image: MediaObject | string\n  /**\n   * An HTML <img> `sizes` attribute. If provided, the browser will render the\n   * best fit image size variation to the current viewport size. See\n   * [the MDN documentation on the sizes property](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)\n   * to learn how to configure this attribute.\n   */\n  sizes?: string\n  /**\n   * Alternate text description of the image. If set and the given image is a\n   * Starlight media object, it will overwrite this image's alternative text\n   * set in Starlight.\n   */\n  alt?: string\n  /**\n   * Defines which image variation will be rendered. Defaults to `optimized`.\n   */\n  variation?: string\n  /**\n   * Defines the background color of the image while it loads. It accepts any\n   * CSS color, including `transparent`. Defaults to the color generated by\n   * Starlight when the image was uploaded, or transparent when the given image\n   * is a URI string.\n   */\n  background?: string\n  /**\n   * Defines the scrollable parent of the image. Set this to the nearest\n   * scrollable HTMLElement parent of this image if lazy-loading is not working.\n   * See [the MDN documentation on IntersectionObserver.root](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/root)\n   * to learn more.\n   */\n  lazyRoot?: RefObject<HTMLElement> | null\n  /**\n   * Defines how close to the viewport an image has to be to start loading.\n   * See [the MDN documentation on IntersectionObserver.rootMargin](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/rootMargin)\n   * to learn more. Defaults to 200px.\n   */\n  lazyRootMargin?: string\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ResponsiveImage/types.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject } from '@starlightcms/js-sdk'\nimport { RefObject } from 'react'\n\n/**\n * Props accepted by the {@link ResponsiveImage} component.\n * @group ResponsiveImage\n */\nexport interface ResponsiveImageProps {\n  className?: string\n  /**\n   * The image to render. It should be a URI string or the object returned by\n   * Starlight on a Media File field. Required.\n   */\n  image: MediaObject | string\n  /**\n   * An HTML <img> `sizes` attribute. If provided, the browser will render the\n   * best fit image size variation to the current viewport size. See\n   * [the MDN documentation on the sizes property](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)\n   * to learn how to configure this attribute.\n   */\n  sizes?: string\n  /**\n   * Alternate text description of the image. If set and the given image is a\n   * Starlight media object, it will be used in place of the image's\n   * alternative text set in Starlight.\n   */\n  alt?: string\n  /**\n   * Defines which image variation will be rendered. Defaults to `optimized`.\n   */\n  variation?: string\n  /**\n   * Defines the background color of the image while it loads. It accepts any\n   * CSS color, including `transparent`. Defaults to the color generated by\n   * Starlight when the image was uploaded, or transparent when the given image\n   * is a URI string.\n   */\n  background?: string\n  /**\n   * Defines the scrollable parent of the image. Set this to the nearest\n   * scrollable HTMLElement parent of this image if lazy-loading is not working.\n   * See [the MDN documentation on IntersectionObserver.root](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/root)\n   * to learn more.\n   */\n  lazyRoot?: RefObject<HTMLElement> | null\n  /**\n   * Defines how close to the viewport an image has to be to start loading.\n   * See [the MDN documentation on IntersectionObserver.rootMargin](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/rootMargin)\n   * to learn more. Defaults to 200px.\n   */\n  lazyRootMargin?: string\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@starlightcms/react-sdk",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "The Starlight SDK for React",
   "workspaces": [
     "website"
@@ -60,7 +60,7 @@
     ]
   },
   "dependencies": {
-    "@starlightcms/js-sdk": "^0.12.1"
+    "@starlightcms/js-sdk": "^0.13.1"
   },
   "peerDependencies": {
     "react": ">=16.0.0"