@webstudio-is/sdk-components-react 0.71.0 → 0.73.0

package/lib/types/vimeo.d.ts

@@ -0,0 +1,73 @@
+import { type ComponentProps } from "react";
+declare const defaultTag = "div";
+type VimeoPlayerOptions = {
+    background?: boolean;
+    color?: string;
+    controls?: boolean;
+    dnt?: boolean;
+    interactive_params?: string;
+    title?: boolean;
+    portrait?: boolean;
+    /** The ID or the URL of the video on Vimeo. You must supply one of these values to identify the video. When the video's privacy setting is Private, you must use the URL, and the URL must include the h parameter. For more information, see our introductory guide. */
+    url?: string;
+    /** Whether to pause the current video when another Vimeo video on the same page starts to play. Set this value to false to permit simultaneous playback of all the videos on the page. This option has no effect if you've disabled cookies in your browser, either through browser settings or with an extension or plugin. */
+    autopause?: boolean;
+    /** Whether to enable the browser to enter picture-in-picture mode automatically when switching tabs or windows, where supported. */
+    autopip?: boolean;
+    /** Whether to start playback of the video automatically. This feature might not work on all devices. */
+    autoplay?: boolean;
+    /** Whether to display the video owner's name. */
+    byline?: boolean;
+    /** Whether to enable keyboard input to trigger player events. This setting doesn't affect tab control. */
+    keyboard?: boolean;
+    /** Whether to restart the video automatically after reaching the end. */
+    loop?: boolean;
+    /** Whether the video is muted upon loading. The true value is required for the autoplay behavior in some browsers. */
+    muted?: boolean;
+    /** Whether to include the picture-in-picture button among the player controls and enable the picture-in-picture API. */
+    pip?: boolean;
+    /** Whether the video plays inline on supported mobile devices. To force the device to play the video in fullscreen mode instead, set this value to false. */
+    playsinline?: boolean;
+    /** For videos on a Vimeo Plus account or higher: the playback quality of the video. Use auto for the best possible quality given available bandwidth and other factors. You can also specify 360p, 540p, 720p, 1080p, 2k, and 4k. */
+    quality?: "auto" | "360p" | "540p" | "720p" | "1080p" | "2k" | "4k";
+    /** Whether to return a responsive embed code, or one that provides intelligent adjustments based on viewing conditions. We recommend this option for mobile-optimized sites. */
+    responsive?: boolean;
+    /** Whether the player displays speed controls in the preferences menu and enables the playback rate API. */
+    speed?: boolean;
+    /**
+     * The text track to display with the video. Specify the text track by its language code (en), the language code and locale (en-US), or the language code and kind (en.captions). For this argument to work, the video must already have a text track of the given type; see our Help Center or Working with Text Track Uploads for more information.
+     * To enable automatically generated closed captions instead, provide the value en-x-autogen. Please note that, at the present time, automatic captions are always in English.
+     */
+    texttrack?: string;
+    /** Whether the responsive player and transparent background are enabled. */
+    transparent?: boolean;
+};
+type PlayerStatus = "initial" | "initialized" | "ready";
+export type VimeoOptions = Omit<VimeoPlayerOptions, "dnt" | "interactive_params" | "background" | "controls" | "color" | "byline" | "title" | "portrait"> & {
+    /** Whether the preview image should be loaded from Vimeo API. Ideally don't use it, because it will show up with some delay and will make your site feel slower. */
+    showPreview?: boolean;
+    /** Whether to prevent the player from tracking session data, including cookies. Keep in mind that setting this argument to true also blocks video stats. */
+    doNotTrack?: VimeoPlayerOptions["dnt"];
+    /** Key-value pairs representing dynamic parameters that are utilized on interactive videos with live elements, such as title=my-video,subtitle=interactive. */
+    interactiveParams?: VimeoPlayerOptions["interactive_params"];
+    /** Whether the player is in background mode, which hides the playback controls, enables autoplay, and loops the video. */
+    backgroundMode?: VimeoPlayerOptions["background"];
+    /** Whether to display the player's interactive elements, including the play bar and sharing buttons. Set this option to false for a chromeless experience. To control playback when the play/pause button is hidden, set autoplay to true, use keyboard controls (which remain active), or implement our player SDK. */
+    showControls?: VimeoPlayerOptions["controls"];
+    /** A color value of the playback controls, which is normally #00ADEF. The embed settings of the video might override this value. */
+    controlsColor?: VimeoPlayerOptions["color"];
+    /** Whether to display the video owner's name. */
+    showByline?: VimeoPlayerOptions["byline"];
+    /** Whether the player displays the title overlay. */
+    showTitle?: VimeoPlayerOptions["title"];
+    /** Whether to display the video owner's portrait. Only works if either title or byline are also enabled */
+    showPortrait?: VimeoPlayerOptions["portrait"];
+};
+type Props = Omit<ComponentProps<typeof defaultTag>, keyof VimeoOptions> & VimeoOptions;
+export declare const Vimeo: import("react").ForwardRefExoticComponent<Omit<Props, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
+export declare const VimeoContext: import("react").Context<{
+    previewImageUrl?: URL | undefined;
+    onInitPlayer: () => void;
+    status: PlayerStatus;
+}>;
+export {};

package/lib/types/vimeo.stories.d.ts

@@ -0,0 +1,71 @@
+/// <reference types="react" />
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+declare const _default: ComponentMeta<import("react").ForwardRefExoticComponent<Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "url" | "transparent" | "loop" | "muted" | "quality" | "showPreview" | "autopause" | "autopip" | "autoplay" | "keyboard" | "pip" | "playsinline" | "responsive" | "speed" | "texttrack" | "doNotTrack" | "interactiveParams" | "backgroundMode" | "showControls" | "controlsColor" | "showByline" | "showTitle" | "showPortrait"> & Omit<{
+    background?: boolean | undefined;
+    color?: string | undefined;
+    controls?: boolean | undefined;
+    dnt?: boolean | undefined;
+    interactive_params?: string | undefined;
+    title?: boolean | undefined;
+    portrait?: boolean | undefined;
+    url?: string | undefined;
+    autopause?: boolean | undefined;
+    autopip?: boolean | undefined;
+    autoplay?: boolean | undefined;
+    byline?: boolean | undefined;
+    keyboard?: boolean | undefined;
+    loop?: boolean | undefined;
+    muted?: boolean | undefined;
+    pip?: boolean | undefined;
+    playsinline?: boolean | undefined;
+    quality?: "auto" | "360p" | "540p" | "720p" | "1080p" | "2k" | "4k" | undefined;
+    responsive?: boolean | undefined;
+    speed?: boolean | undefined;
+    texttrack?: string | undefined;
+    transparent?: boolean | undefined;
+}, "title" | "color" | "background" | "controls" | "dnt" | "interactive_params" | "byline" | "portrait"> & {
+    showPreview?: boolean | undefined;
+    doNotTrack?: boolean | undefined;
+    interactiveParams?: string | undefined;
+    backgroundMode?: boolean | undefined;
+    showControls?: boolean | undefined;
+    controlsColor?: string | undefined;
+    showByline?: boolean | undefined;
+    showTitle?: boolean | undefined;
+    showPortrait?: boolean | undefined;
+}, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;
+export default _default;
+export declare const Vimeo: ComponentStory<import("react").ForwardRefExoticComponent<Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "url" | "transparent" | "loop" | "muted" | "quality" | "showPreview" | "autopause" | "autopip" | "autoplay" | "keyboard" | "pip" | "playsinline" | "responsive" | "speed" | "texttrack" | "doNotTrack" | "interactiveParams" | "backgroundMode" | "showControls" | "controlsColor" | "showByline" | "showTitle" | "showPortrait"> & Omit<{
+    background?: boolean | undefined;
+    color?: string | undefined;
+    controls?: boolean | undefined;
+    dnt?: boolean | undefined;
+    interactive_params?: string | undefined;
+    title?: boolean | undefined;
+    portrait?: boolean | undefined;
+    url?: string | undefined;
+    autopause?: boolean | undefined;
+    autopip?: boolean | undefined;
+    autoplay?: boolean | undefined;
+    byline?: boolean | undefined;
+    keyboard?: boolean | undefined;
+    loop?: boolean | undefined;
+    muted?: boolean | undefined;
+    pip?: boolean | undefined;
+    playsinline?: boolean | undefined;
+    quality?: "auto" | "360p" | "540p" | "720p" | "1080p" | "2k" | "4k" | undefined;
+    responsive?: boolean | undefined;
+    speed?: boolean | undefined;
+    texttrack?: string | undefined;
+    transparent?: boolean | undefined;
+}, "title" | "color" | "background" | "controls" | "dnt" | "interactive_params" | "byline" | "portrait"> & {
+    showPreview?: boolean | undefined;
+    doNotTrack?: boolean | undefined;
+    interactiveParams?: string | undefined;
+    backgroundMode?: boolean | undefined;
+    showControls?: boolean | undefined;
+    controlsColor?: string | undefined;
+    showByline?: boolean | undefined;
+    showTitle?: boolean | undefined;
+    showPortrait?: boolean | undefined;
+}, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;

package/lib/types/vimeo.ws.d.ts

@@ -0,0 +1,3 @@
+import { type WsComponentMeta, type WsComponentPropsMeta } from "@webstudio-is/react-sdk";
+export declare const meta: WsComponentMeta;
+export declare const propsMeta: WsComponentPropsMeta;

package/lib/vimeo-play-button.js

@@ -0,0 +1,21 @@
+import { jsx } from "react/jsx-runtime";
+import {
+  forwardRef,
+  useContext
+} from "react";
+import { VimeoContext } from "./vimeo";
+import { Button, defaultTag } from "./button";
+const VimeoPlayButton = forwardRef(
+  (props, ref) => {
+    const vimeoContext = useContext(VimeoContext);
+    if (vimeoContext.status !== "initial") {
+      return null;
+    }
+    return /* @__PURE__ */ jsx(Button, { ...props, onClick: vimeoContext.onInitPlayer, ref });
+  }
+);
+VimeoPlayButton.displayName = "VimeoPlayButton";
+export {
+  VimeoPlayButton,
+  defaultTag
+};

package/lib/vimeo-play-button.ws.js

@@ -0,0 +1,26 @@
+import {
+  defaultStates
+} from "@webstudio-is/react-sdk";
+import { props } from "./__generated__/vimeo-play-button.props";
+import { ButtonElementIcon } from "@webstudio-is/icons/svg";
+import { button } from "@webstudio-is/react-sdk/css-normalize";
+const presetStyle = {
+  button
+};
+const meta = {
+  category: "hidden",
+  type: "container",
+  invalidAncestors: ["Button"],
+  requiredAncestors: ["Vimeo"],
+  label: "Play Button",
+  icon: ButtonElementIcon,
+  presetStyle,
+  states: defaultStates
+};
+const propsMeta = {
+  props
+};
+export {
+  meta,
+  propsMeta
+};

package/lib/vimeo-preview-image.js

@@ -0,0 +1,23 @@
+import { jsx } from "react/jsx-runtime";
+import {
+  forwardRef,
+  useContext
+} from "react";
+import { Image } from "./image";
+import { VimeoContext } from "./vimeo";
+const base64Preview = `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkOAMAANIAzr59FiYAAAAASUVORK5CYII=`;
+const VimeoPreviewImage = forwardRef(({ src, ...rest }, ref) => {
+  const vimeoContext = useContext(VimeoContext);
+  return /* @__PURE__ */ jsx(
+    Image,
+    {
+      ...rest,
+      src: String(vimeoContext.previewImageUrl ?? src ?? base64Preview),
+      ref
+    }
+  );
+});
+VimeoPreviewImage.displayName = "VimeoPreviewImage";
+export {
+  VimeoPreviewImage
+};

package/lib/vimeo-preview-image.ws.js

@@ -0,0 +1,20 @@
+import {
+  propsOverrides as imagePropsOverrides,
+  propsMeta as imagePropsMeta,
+  meta as imageMeta
+} from "./image.ws";
+import { props } from "./__generated__/vimeo-preview-image.props";
+const meta = {
+  ...imageMeta,
+  category: "hidden",
+  label: "Preview Image",
+  requiredAncestors: ["Vimeo"]
+};
+const propsMeta = {
+  props: { ...props, ...imagePropsOverrides },
+  initialProps: imagePropsMeta.initialProps
+};
+export {
+  meta,
+  propsMeta
+};

package/lib/vimeo-spinner.js

@@ -0,0 +1,20 @@
+import { jsx } from "react/jsx-runtime";
+import {
+  forwardRef,
+  useContext
+} from "react";
+import { VimeoContext } from "./vimeo";
+const defaultTag = "div";
+const VimeoSpinner = forwardRef(
+  (props, ref) => {
+    const vimeoContext = useContext(VimeoContext);
+    if (vimeoContext.status !== "initialized") {
+      return null;
+    }
+    return /* @__PURE__ */ jsx("div", { ...props, ref });
+  }
+);
+VimeoSpinner.displayName = "VimeoSpinner";
+export {
+  VimeoSpinner
+};

package/lib/vimeo-spinner.ws.js

@@ -0,0 +1,25 @@
+import {
+  defaultStates
+} from "@webstudio-is/react-sdk";
+import { props } from "./__generated__/vimeo-spinner.props";
+import { div } from "@webstudio-is/react-sdk/css-normalize";
+import { BoxIcon } from "@webstudio-is/icons/svg";
+const presetStyle = {
+  div
+};
+const meta = {
+  type: "container",
+  icon: BoxIcon,
+  states: defaultStates,
+  presetStyle,
+  category: "hidden",
+  label: "Spinner",
+  requiredAncestors: ["Vimeo"]
+};
+const propsMeta = {
+  props
+};
+export {
+  meta,
+  propsMeta
+};

package/lib/vimeo.js

@@ -0,0 +1,282 @@
+import { jsx } from "react/jsx-runtime";
+import { colord } from "colord";
+import {
+  forwardRef,
+  useState,
+  useRef,
+  useEffect,
+  useContext,
+  createContext,
+  useMemo
+} from "react";
+import { ReactSdkContext } from "@webstudio-is/react-sdk";
+import { shallowEqual } from "shallow-equal";
+const defaultTag = "div";
+const getUrl = (options) => {
+  if (options.url === void 0) {
+    return;
+  }
+  let url;
+  try {
+    const userUrl = new URL(options.url);
+    url = new URL(IFRAME_CDN);
+    url.pathname = `/video${userUrl.pathname}`;
+  } catch {
+  }
+  if (url === void 0) {
+    return;
+  }
+  let option;
+  for (option in options) {
+    const value = options[option];
+    if (option === "url" || value === void 0) {
+      continue;
+    }
+    url.searchParams.append(option, value.toString());
+  }
+  url.searchParams.set("autoplay", "true");
+  if (typeof options.color === "string") {
+    const color = colord(options.color).toHex().replace("#", "");
+    url.searchParams.set("color", color);
+  }
+  if (options.portrait) {
+    url.searchParams.set("title", "true");
+  }
+  if (options.byline) {
+    url.searchParams.set("portrait", "true");
+    url.searchParams.set("title", "true");
+  }
+  return url.toString();
+};
+const preconnect = (url) => {
+  const link = document.createElement("link");
+  link.rel = "preconnect";
+  link.href = url;
+  link.crossOrigin = "true";
+  document.head.append(link);
+};
+let warmed = false;
+const PLAYER_CDN = "https://f.vimeocdn.com";
+const IFRAME_CDN = "https://player.vimeo.com";
+const IMAGE_CDN = "https://i.vimeocdn.com";
+const warmConnections = () => {
+  if (warmed) {
+    return;
+  }
+  preconnect(PLAYER_CDN);
+  preconnect(IFRAME_CDN);
+  preconnect(IMAGE_CDN);
+  warmed = true;
+};
+const createPlayer = (parent, options, callback) => {
+  const url = getUrl(options);
+  if (url === void 0) {
+    return;
+  }
+  const iframe = document.createElement("iframe");
+  iframe.setAttribute(
+    "allow",
+    "accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture;"
+  );
+  iframe.setAttribute("frameborder", "0");
+  iframe.setAttribute("allowfullscreen", "true");
+  iframe.setAttribute("src", url);
+  iframe.setAttribute(
+    "style",
+    "position: absolute; width: 100%; height: 100%; opacity: 0; transition: opacity 1s;"
+  );
+  iframe.addEventListener(
+    "load",
+    () => {
+      iframe.style.opacity = "1";
+      callback();
+    },
+    { once: true }
+  );
+  parent.appendChild(iframe);
+  return () => {
+    iframe.parentElement?.removeChild(iframe);
+  };
+};
+const getVideoId = (url) => {
+  try {
+    const parsedUrl = new URL(url);
+    const id = parsedUrl.pathname.split("/")[1];
+    if (id === "" || id == null) {
+      return;
+    }
+    return id;
+  } catch {
+  }
+};
+const loadPreviewImage = async (element, videoUrl) => {
+  const videoId = getVideoId(videoUrl);
+  const apiUrl = `https://vimeo.com/api/v2/video/${videoId}.json`;
+  const response = (await (await fetch(apiUrl)).json())[0];
+  const thumbnail = response.thumbnail_large;
+  const imgId = thumbnail.substr(thumbnail.lastIndexOf("/") + 1).split("_")[0];
+  const imageUrl = new URL(IMAGE_CDN);
+  imageUrl.pathname = `/video/${imgId}.webp`;
+  imageUrl.searchParams.append("mw", "1100");
+  imageUrl.searchParams.append("mh", "619");
+  imageUrl.searchParams.append("q", "70");
+  return imageUrl;
+};
+const useVimeo = ({
+  options,
+  renderer,
+  showPreview
+}) => {
+  const [playerStatus, setPlayerStatus] = useState("initial");
+  const elementRef = useRef(null);
+  const [previewImageUrl, setPreviewImageUrl] = useState();
+  useEffect(() => {
+    setPlayerStatus(
+      options.autoplay && renderer !== "canvas" ? "initialized" : "initial"
+    );
+  }, [options.autoplay, renderer]);
+  useEffect(() => {
+    if (elementRef.current === null || playerStatus === "ready" || options.url === void 0) {
+      return;
+    }
+    if (showPreview) {
+      loadPreviewImage(elementRef.current, options.url).then(
+        setPreviewImageUrl
+      );
+      return;
+    }
+    setPreviewImageUrl(void 0);
+  }, [renderer, showPreview, options.url, playerStatus]);
+  const optionsRef = useRef(options);
+  const stableOptions = useMemo(() => {
+    if (shallowEqual(options, optionsRef.current) === false) {
+      optionsRef.current = options;
+    }
+    return optionsRef.current;
+  }, [options]);
+  useEffect(() => {
+    if (elementRef.current === null || playerStatus === "initial") {
+      return;
+    }
+    return createPlayer(elementRef.current, stableOptions, () => {
+      setPlayerStatus("ready");
+    });
+  }, [stableOptions, playerStatus]);
+  return { previewImageUrl, playerStatus, setPlayerStatus, elementRef };
+};
+const Vimeo = forwardRef(
+  ({
+    url,
+    autoplay = false,
+    autopause = true,
+    backgroundMode = false,
+    showByline = false,
+    showControls = true,
+    doNotTrack = false,
+    keyboard = true,
+    loop = false,
+    muted = false,
+    pip = false,
+    playsinline = true,
+    showPortrait = true,
+    quality = "auto",
+    responsive = true,
+    speed = false,
+    showTitle = false,
+    transparent = true,
+    showPreview = false,
+    autopip,
+    controlsColor,
+    interactiveParams,
+    texttrack,
+    children,
+    ...rest
+  }, ref) => {
+    const { renderer } = useContext(ReactSdkContext);
+    const { previewImageUrl, playerStatus, setPlayerStatus, elementRef } = useVimeo({
+      renderer,
+      showPreview,
+      options: {
+        url,
+        autoplay,
+        autopause,
+        keyboard,
+        loop,
+        muted,
+        pip,
+        playsinline,
+        quality,
+        responsive,
+        speed,
+        transparent,
+        portrait: showPortrait,
+        byline: showByline,
+        title: showTitle,
+        color: controlsColor,
+        controls: showControls,
+        interactive_params: interactiveParams,
+        background: backgroundMode,
+        dnt: doNotTrack
+      }
+    });
+    return /* @__PURE__ */ jsx(
+      VimeoContext.Provider,
+      {
+        value: {
+          status: playerStatus,
+          previewImageUrl,
+          onInitPlayer() {
+            if (renderer !== "canvas") {
+              setPlayerStatus("initialized");
+            }
+          }
+        },
+        children: /* @__PURE__ */ jsx(
+          "div",
+          {
+            ...rest,
+            ref: (value) => {
+              elementRef.current = value;
+              if (ref !== null) {
+                typeof ref === "function" ? ref(value) : ref.current = value;
+              }
+            },
+            onPointerOver: () => {
+              if (renderer !== "canvas") {
+                warmConnections();
+              }
+            },
+            children: url === void 0 ? /* @__PURE__ */ jsx(EmptyState, {}) : children
+          }
+        )
+      }
+    );
+  }
+);
+Vimeo.displayName = "Vimeo";
+const EmptyState = () => {
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      style: {
+        display: "flex",
+        width: "100%",
+        height: "100%",
+        alignItems: "center",
+        justifyContent: "center",
+        fontSize: "1.2em"
+      },
+      children: "Open the Properties panel and paste a video URL, e.g. https://vimeo.com/831343124."
+    }
+  );
+};
+const VimeoContext = createContext({
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onInitPlayer: () => {
+  },
+  status: "initial"
+});
+export {
+  Vimeo,
+  VimeoContext
+};