@webstudio-is/react-sdk 0.6.1 → 0.7.1

package/lib/components/image-dev.stories.js

@@ -0,0 +1,102 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeroImage = exports.FillParentImage = exports.AspectRatioImage = exports.UnknownWidthImage = exports.FixedWidthImageCover = exports.FixedWidthImage = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const warn_once_1 = __importDefault(require("warn-once"));
+const image_1 = require("./image");
+const image_ws_1 = __importDefault(require("./image.ws"));
+// to not allow include local assets everywhere, just enable it for this file
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+const logo_webp_1 = __importDefault(require("../../storybook-assets/logo.webp"));
+exports.default = {
+    title: "Components/ImageDev",
+};
+/**
+ * In case you need to test img with real cloudflare trasforms
+ * set  USE_CLOUDFLARE_IMAGE_TRANSFORM = true
+ **/
+const USE_CLOUDFLARE_IMAGE_TRANSFORM = false;
+// For cloudflare image transform testing, logo should be the most consistent image on the site
+const REMOTE_SELF_DOMAIN_IMAGE = "https://webstudio.is/logo.webp";
+const imageSrc = USE_CLOUDFLARE_IMAGE_TRANSFORM
+    ? REMOTE_SELF_DOMAIN_IMAGE
+    : logo_webp_1.default;
+// In case of REMOTE_DEBUG
+const cloudflareImageLoader = ({ width, src, quality }) => {
+    // No image transformation in development
+    const resizeOrigin = "https://webstudio.is";
+    const pathParams = [
+        `width=${width}`,
+        quality != null && `quality=${quality}`,
+        "format=auto",
+    ].filter(Boolean);
+    const pathname = `/cdn-cgi/image/${pathParams.join(",")}/${src}`;
+    const url = new URL(pathname, resizeOrigin);
+    return url.href;
+};
+const localImageLoader = ({ width, src, quality }) => {
+    // Just emulate like we really resize the image
+    const params = new URLSearchParams();
+    params.set("width", `${width}`);
+    params.set("quality", `${quality}`);
+    return `${src}?${params.toString()}`;
+};
+const imageLoader = USE_CLOUDFLARE_IMAGE_TRANSFORM
+    ? cloudflareImageLoader
+    : localImageLoader;
+const ImageBase = (args) => {
+    (0, warn_once_1.default)(!(image_ws_1.default.defaultStyle?.maxWidth?.value === 100 &&
+        image_ws_1.default.defaultStyle?.maxWidth?.unit === "%"), "We expect that the image default style has maxWidth: 100%");
+    (0, warn_once_1.default)(image_ws_1.default.defaultStyle?.display?.value !== "block", "We expect that the image default style has display: block");
+    const style = {
+        maxWidth: "100%",
+        display: "block",
+        ...args.style,
+    };
+    return ((0, jsx_runtime_1.jsx)(image_1.Image, { ...args, optimize: true, loader: imageLoader, style: style }));
+};
+/**
+ * Load images depending on image width and device per pixel ratio.
+ **/
+const FixedWidthImage = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, width: "300", height: "400" }));
+exports.FixedWidthImage = FixedWidthImage;
+/**
+ * Preserve ratio using object-fit: cover. Load images depending on image width and device per pixel ratio.
+ **/
+const FixedWidthImageCover = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, width: "300", height: "400", style: { objectFit: "cover" } }));
+exports.FixedWidthImageCover = FixedWidthImageCover;
+/**
+ * Load images depending on the viewport width.
+ **/
+const UnknownWidthImage = () => (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc });
+exports.UnknownWidthImage = UnknownWidthImage;
+/**
+ * Fit width of the parent container, has own aspect-ratio and object-fit=cover.
+ * Load images depending on the viewport width.
+ **/
+const AspectRatioImage = () => ((0, jsx_runtime_1.jsx)("div", { style: { width: "50%" }, children: (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, style: { aspectRatio: "2/1", objectFit: "cover", width: "100%" } }) }));
+exports.AspectRatioImage = AspectRatioImage;
+/**
+ * Fill width and height of the relative parent container, object-fit=cover. Load images depending on the viewport width.
+ **/
+const FillParentImage = () => ((0, jsx_runtime_1.jsx)("div", { style: { width: "50%", aspectRatio: "2/1", position: "relative" }, children: (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, style: {
+            objectFit: "cover",
+            position: "absolute",
+            width: "100%",
+            height: "100%",
+        } }) }));
+exports.FillParentImage = FillParentImage;
+/**
+ * "sizes" attribute explicitly equal to 100vw allowing to skip the default behavior.
+ * See DEFAULT_SIZES in the Image component. Load images depending on the viewport width.
+ **/
+const HeroImage = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, sizes: "100vw", style: {
+        aspectRatio: "3/1",
+        objectFit: "cover",
+        width: "100%",
+    } }));
+exports.HeroImage = HeroImage;

package/lib/components/image.d.ts

@@ -0,0 +1,11 @@
+import React, { type ComponentProps } from "react";
+import { type ImageLoader } from "../component-utils/image";
+declare const defaultTag = "img";
+declare type ImageProps = ComponentProps<typeof defaultTag> & {
+    quality?: number;
+    loader?: ImageLoader;
+    optimize?: boolean;
+};
+export declare const Image: React.ForwardRefExoticComponent<Pick<ImageProps, "key" | "quality" | "loader" | keyof React.ImgHTMLAttributes<HTMLImageElement> | "optimize"> & React.RefAttributes<HTMLImageElement>>;
+export {};
+//# sourceMappingURL=image.d.ts.map

package/lib/components/image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/components/image.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+B,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AAChF,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEhF,QAAA,MAAM,UAAU,QAAQ,CAAC;AAEzB,aAAK,UAAU,GAAG,cAAc,CAAC,OAAO,UAAU,CAAC,GAAG;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,KAAK,wLAmBjB,CAAC"}

package/lib/components/image.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Image = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const image_1 = require("../component-utils/image");
+const defaultTag = "img";
+exports.Image = (0, react_1.forwardRef)(({ quality, loader, optimize, ...imageProps }, ref) => {
+    // Temporary set to false, to support previous image behaviour
+    const DEFAULT_OPTIMIZE = false;
+    const imageAttributes = (0, image_1.getImageAttributes)({
+        src: imageProps.src,
+        srcSet: imageProps.srcSet,
+        sizes: imageProps.sizes,
+        width: imageProps.width,
+        quality,
+        loader,
+        optimize: optimize ?? DEFAULT_OPTIMIZE,
+    }) ?? { src: imagePlaceholderSvg };
+    return ((0, jsx_runtime_1.jsx)("img", { ...imageProps, ...imageAttributes, decoding: "async", ref: ref }));
+});
+exports.Image.defaultProps = {
+    src: "",
+    width: "",
+    height: "",
+    loading: "lazy",
+    alt: "",
+};
+exports.Image.displayName = "Image";
+const imagePlaceholderSvg = `data:image/svg+xml;base64,${btoa(`<svg
+  width="140"
+  height="140"
+  viewBox="0 0 600 600"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+  >
+  <rect width="600" height="600" fill="#CCCCCC" />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M450 170H150C141.716 170 135 176.716 135 185V415C135 423.284 141.716 430 150 430H450C458.284 430 465 423.284 465 415V185C465 176.716 458.284 170 450 170ZM150 145C127.909 145 110 162.909 110 185V415C110 437.091 127.909 455 150 455H450C472.091 455 490 437.091 490 415V185C490 162.909 472.091 145 450 145H150Z"
+    fill="#A2A2A2"
+  />
+  <path
+    d="M237.135 235.012C237.135 255.723 220.345 272.512 199.635 272.512C178.924 272.512 162.135 255.723 162.135 235.012C162.135 214.301 178.924 197.512 199.635 197.512C220.345 197.512 237.135 214.301 237.135 235.012Z"
+    fill="#A2A2A2"
+  />
+  <path
+    d="M160 405V367.205L221.609 306.364L256.552 338.628L358.161 234L440 316.043V405H160Z"
+    fill="#A2A2A2"
+  />
+</svg>`)}`;