@webstudio-is/sdk-components-react 0.70.0

package/src/heading.ws.tsx

@@ -0,0 +1,44 @@
+import { HeadingIcon } from "@webstudio-is/icons/svg";
+import type { ComponentProps } from "react";
+import {
+  defaultStates,
+  type PresetStyle,
+  type WsComponentMeta,
+  type WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { h1, h2, h3, h4, h5, h6 } from "@webstudio-is/react-sdk/css-normalize";
+import type { Heading } from "./heading";
+import { props } from "./__generated__/heading.props";
+
+type HeadingTags = NonNullable<ComponentProps<typeof Heading>["tag"]>;
+
+const presetStyle = {
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6,
+} satisfies PresetStyle<HeadingTags>;
+
+export const meta: WsComponentMeta = {
+  category: "text",
+  type: "rich-text",
+  label: "Heading",
+  icon: HeadingIcon,
+  states: defaultStates,
+  presetStyle,
+  template: [
+    {
+      type: "instance",
+      component: "Heading",
+      children: [{ type: "text", value: "Heading you can edit" }],
+    },
+  ],
+  order: 1,
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props,
+  initialProps: ["tag"],
+};

package/src/html-embed.stories.tsx

@@ -0,0 +1,16 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { HtmlEmbed as HtmlEmbedPrimitive } from "./html-embed";
+
+export default {
+  title: "Components/HtmlEmbed",
+  component: HtmlEmbedPrimitive,
+} as ComponentMeta<typeof HtmlEmbedPrimitive>;
+
+const Template: ComponentStory<typeof HtmlEmbedPrimitive> = (args) => (
+  <HtmlEmbedPrimitive {...args} />
+);
+
+export const HtmlEmbed = Template.bind({});
+HtmlEmbed.args = {
+  code: "<strong>custom code</strong>",
+};

package/src/html-embed.tsx

@@ -0,0 +1,96 @@
+import {
+  forwardRef,
+  useContext,
+  useEffect,
+  useRef,
+  type ForwardedRef,
+} from "react";
+import { mergeRefs } from "@react-aria/utils";
+import { ReactSdkContext } from "@webstudio-is/react-sdk";
+
+type Props = {
+  code: string;
+  executeScriptOnCanvas: boolean;
+};
+
+type ChildProps = {
+  innerRef: ForwardedRef<HTMLDivElement>;
+  // code can be actually undefined when prop is not provided
+  code?: string;
+};
+
+/**
+ * Scripts are executed when rendered client side.
+ * Necessary on canvas which does not have server rendering.
+ */
+const ExecutableHtml = (props: ChildProps) => {
+  const { code, innerRef, ...rest } = props;
+  const containerRef = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    const container = containerRef.current;
+    if (container === null || code === undefined) {
+      return;
+    }
+    // the trick to execute inserted scripts
+    // https://ghinda.net/article/script-tags
+    const range = document.createRange();
+    range.setStart(container, 0);
+    const fragment = range.createContextualFragment(code);
+    while (container.firstChild) {
+      container.removeChild(container.firstChild);
+    }
+    container.append(fragment);
+  }, [code]);
+
+  return (
+    <div
+      {...rest}
+      ref={mergeRefs(innerRef, containerRef)}
+      style={{ display: "contents" }}
+    />
+  );
+};
+
+/**
+ * Scripts are executed when rendered server side
+ */
+const InnerHtml = (props: ChildProps) => {
+  const { code, innerRef, ...rest } = props;
+
+  return (
+    <div
+      {...rest}
+      ref={innerRef}
+      style={{ display: "contents" }}
+      dangerouslySetInnerHTML={{ __html: props.code ?? "" }}
+    />
+  );
+};
+
+const Placeholder = (props: ChildProps) => {
+  const { code, innerRef, ...rest } = props;
+  return (
+    <div ref={innerRef} {...rest} style={{ padding: "20px" }}>
+      {'Open "Properties" panel to insert HTML code'}
+    </div>
+  );
+};
+
+export const HtmlEmbed = forwardRef<HTMLDivElement, Props>((props, ref) => {
+  const { renderer } = useContext(ReactSdkContext);
+  const { code, executeScriptOnCanvas, ...rest } = props;
+
+  // code can be actually undefined when prop is not provided
+  if (code === undefined || code.trim().length === 0) {
+    return <Placeholder innerRef={ref} {...rest} />;
+  }
+
+  if (renderer === "canvas" && executeScriptOnCanvas === true) {
+    return <ExecutableHtml innerRef={ref} code={code} {...rest} />;
+  }
+
+  return <InnerHtml innerRef={ref} code={code} {...rest} />;
+});
+
+HtmlEmbed.displayName = "HtmlEmbed";

package/src/html-embed.ws.ts

@@ -0,0 +1,27 @@
+import { EmbedIcon } from "@webstudio-is/icons/svg";
+import type {
+  WsComponentMeta,
+  WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { props } from "./__generated__/html-embed.props";
+
+export const meta: WsComponentMeta = {
+  category: "general",
+  type: "embed",
+  label: "HTML Embed",
+  icon: EmbedIcon,
+  stylable: false,
+  order: 7,
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props: {
+    ...props,
+    code: {
+      required: true,
+      control: "code",
+      type: "string",
+      rows: 10,
+    },
+  },
+};

package/src/image.stories.tsx

@@ -0,0 +1,15 @@
+import type { ComponentMeta, ComponentStory } from "@storybook/react";
+import { Image as ImagePrimitive } from "./image";
+
+export default {
+  title: "Components/Image",
+  component: ImagePrimitive,
+} as ComponentMeta<typeof ImagePrimitive>;
+
+const Template: ComponentStory<typeof ImagePrimitive> = (args) => (
+  <ImagePrimitive {...args} />
+);
+
+export const Image = Template.bind({});
+
+Image.args = {};

package/src/image.tsx

@@ -0,0 +1,83 @@
+import {
+  type ComponentPropsWithoutRef,
+  type ElementRef,
+  forwardRef,
+  useMemo,
+} from "react";
+import {
+  Image as WebstudioImage,
+  createImageLoader,
+} from "@webstudio-is/image";
+import {
+  usePropAsset,
+  getInstanceIdFromComponentProps,
+  getParams,
+} from "@webstudio-is/react-sdk";
+
+export const defaultTag = "img";
+
+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>`)}`;
+
+type Props = ComponentPropsWithoutRef<typeof WebstudioImage>;
+
+export const Image = forwardRef<ElementRef<typeof defaultTag>, Props>(
+  (props, ref) => {
+    const asset = usePropAsset(getInstanceIdFromComponentProps(props), "src");
+
+    const loader = useMemo(() => {
+      const params = getParams();
+      return createImageLoader({ imageBaseUrl: params.imageBaseUrl });
+    }, []);
+
+    const src = asset?.name ?? props.src;
+
+    if (asset == null || loader == null) {
+      return (
+        <img key={src} {...props} src={src || imagePlaceholderSvg} ref={ref} />
+      );
+    }
+
+    return (
+      <WebstudioImage
+        /**
+         * `key` is needed to recreate the image in case of asset change in builder,
+         * this gives immediate feedback when an asset is changed.
+         * Also, it visually fixes image distortion when another asset has a seriously different  aspectRatio
+         * (we change aspectRatio CSS prop on asset change)
+         *
+         * In non-builder mode, key on images are usually also a good idea,
+         * prevents showing outdated images on route change.
+         **/
+        key={src}
+        {...props}
+        loader={loader}
+        src={src}
+        ref={ref}
+      />
+    );
+  }
+);
+
+Image.displayName = "Image";

package/src/image.ws.tsx

@@ -0,0 +1,54 @@
+import { ImageIcon } from "@webstudio-is/icons/svg";
+import {
+  defaultStates,
+  type PresetStyle,
+  type WsComponentMeta,
+  type WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { img } from "@webstudio-is/react-sdk/css-normalize";
+import type { defaultTag } from "./image";
+import { props } from "./__generated__/image.props";
+
+const presetStyle = {
+  img: [
+    ...img,
+
+    // Otherwise on new image insert onto canvas it can overfit screen size multiple times
+    {
+      property: "maxWidth",
+      value: { type: "unit", unit: "%", value: 100 },
+    },
+    // inline | inline-block is not suitable because without line-height: 0 on the parent you get unsuitable spaces/margins
+    // see https://stackoverflow.com/questions/24771194/is-the-margin-of-inline-block-4px-is-static-for-all-browsers
+    {
+      property: "display",
+      value: { type: "keyword", value: "block" },
+    },
+  ],
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+  category: "media",
+  type: "embed",
+  label: "Image",
+  icon: ImageIcon,
+  states: defaultStates,
+  presetStyle,
+  order: 0,
+};
+
+// "loader" is our internal prop not intended to show up in the props panel
+const { loader, ...publicProps } = props;
+
+export const propsMeta: WsComponentPropsMeta = {
+  props: {
+    ...publicProps,
+    src: {
+      type: "string",
+      control: "file",
+      label: "Source",
+      required: false,
+    },
+  },
+  initialProps: ["src", "width", "height", "alt", "loading"],
+};

package/src/input.stories.tsx

@@ -0,0 +1,14 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { Input as InputPrimitive } from "./input";
+
+export default {
+  title: "Components/Input",
+  component: InputPrimitive,
+} as ComponentMeta<typeof InputPrimitive>;
+
+const Template: ComponentStory<typeof InputPrimitive> = (args) => (
+  <InputPrimitive {...args} />
+);
+
+export const Input = Template.bind({});
+Input.args = {};

package/src/input.tsx

@@ -0,0 +1,13 @@
+import { forwardRef, type ElementRef, type ComponentProps } from "react";
+
+export const defaultTag = "input";
+
+export const Input = forwardRef<
+  ElementRef<typeof defaultTag>,
+  ComponentProps<typeof defaultTag> & {
+    type?: "text" | "email" | "password" | "number" | "tel" | "url";
+  }
+  // Make sure children are not passed down to an input, because this will result in error.
+>(({ children: _children, ...props }, ref) => <input {...props} ref={ref} />);
+
+Input.displayName = "Input";

package/src/input.ws.tsx

@@ -0,0 +1,40 @@
+import { FormTextFieldIcon } from "@webstudio-is/icons/svg";
+import {
+  defaultStates,
+  type PresetStyle,
+  type WsComponentMeta,
+  type WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { input } from "@webstudio-is/react-sdk/css-normalize";
+import type { defaultTag } from "./input";
+import { props } from "./__generated__/input.props";
+
+const presetStyle = {
+  input,
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+  category: "forms",
+  type: "control",
+  label: "Text Input",
+  icon: FormTextFieldIcon,
+  presetStyle,
+  order: 3,
+  states: [
+    ...defaultStates,
+    { selector: "::placeholder", label: "Placeholder" },
+    { selector: ":valid", label: "Valid" },
+    { selector: ":invalid", label: "Invalid" },
+    { selector: ":required", label: "Required" },
+    { selector: ":optional", label: "Optional" },
+    { selector: ":disabled", label: "Disabled" },
+    { selector: ":enabled", label: "Enabled" },
+    { selector: ":read-only", label: "Read Only" },
+    { selector: ":read-write", label: "Read Write" },
+  ],
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props,
+  initialProps: ["name", "type", "placeholder", "required", "autoFocus"],
+};

package/src/italic.stories.tsx

@@ -0,0 +1,16 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { Italic as ItalicPrimitive } from "./italic";
+
+export default {
+  title: "Components/Italic",
+  component: ItalicPrimitive,
+} as ComponentMeta<typeof ItalicPrimitive>;
+
+const Template: ComponentStory<typeof ItalicPrimitive> = (args) => (
+  <ItalicPrimitive {...args} />
+);
+
+export const Italic = Template.bind({});
+Italic.args = {
+  children: "some italic text",
+};

package/src/italic.tsx

@@ -0,0 +1,10 @@
+import { forwardRef, type ElementRef, type ComponentProps } from "react";
+
+export const defaultTag = "i";
+
+export const Italic = forwardRef<
+  ElementRef<typeof defaultTag>,
+  ComponentProps<typeof defaultTag>
+>((props, ref) => <i {...props} ref={ref} />);
+
+Italic.displayName = "Italic";

package/src/italic.ws.tsx

@@ -0,0 +1,32 @@
+import { TextItalicIcon } from "@webstudio-is/icons/svg";
+import type { defaultTag } from "./italic";
+import {
+  defaultStates,
+  type PresetStyle,
+  type WsComponentMeta,
+  type WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { i } from "@webstudio-is/react-sdk/css-normalize";
+import { props } from "./__generated__/italic.props";
+
+const presetStyle = {
+  i: [
+    ...i,
+    {
+      property: "fontStyle",
+      value: { type: "keyword", value: "italic" },
+    },
+  ],
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+  type: "rich-text-child",
+  label: "Italic Text",
+  icon: TextItalicIcon,
+  states: defaultStates,
+  presetStyle,
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props,
+};

package/src/label.tsx

@@ -0,0 +1,10 @@
+import { forwardRef, type ElementRef, type ComponentProps } from "react";
+
+export const defaultTag = "label";
+
+export const Label = forwardRef<
+  ElementRef<typeof defaultTag>,
+  ComponentProps<typeof defaultTag>
+>((props, ref) => <label {...props} ref={ref} />);
+
+Label.displayName = "Label";

package/src/label.ws.tsx

@@ -0,0 +1,48 @@
+import { TextBlockIcon } from "@webstudio-is/icons/svg";
+import {
+  type WsComponentMeta,
+  type WsComponentPropsMeta,
+  type PresetStyle,
+  defaultStates,
+} from "@webstudio-is/react-sdk";
+import { label } from "@webstudio-is/react-sdk/css-normalize";
+import { props } from "./__generated__/label.props";
+import type { defaultTag } from "./label";
+
+const presetStyle = {
+  label: [
+    ...label,
+    { property: "display", value: { type: "keyword", value: "block" } },
+  ],
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+  category: "forms",
+  type: "rich-text",
+  label: "Input Label",
+  icon: TextBlockIcon,
+  states: defaultStates,
+  presetStyle,
+  order: 2,
+  template: [
+    {
+      type: "instance",
+      component: "Label",
+      children: [{ type: "text", value: "Form Label" }],
+    },
+  ],
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props: {
+    ...props,
+    htmlFor: {
+      required: false,
+      control: "text",
+      type: "string",
+      rows: 0,
+      label: "For",
+    },
+  },
+  initialProps: ["htmlFor"],
+};

package/src/link-block.stories.tsx

@@ -0,0 +1,16 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { LinkBlock as LinkBlockPrimitive } from "./link-block";
+
+export default {
+  title: "Components/Link Block",
+  component: LinkBlockPrimitive,
+} as ComponentMeta<typeof LinkBlockPrimitive>;
+
+const Template: ComponentStory<typeof LinkBlockPrimitive> = (args) => (
+  <LinkBlockPrimitive {...args} />
+);
+
+export const LinkBlock = Template.bind({});
+LinkBlock.args = {
+  children: "Link Block",
+};

package/src/link-block.tsx

@@ -0,0 +1,9 @@
+import { forwardRef } from "react";
+import { Link } from "./link";
+export { defaultTag } from "./link";
+
+export const LinkBlock: typeof Link = forwardRef((props, ref) => (
+  <Link {...props} ref={ref} />
+));
+
+LinkBlock.displayName = "LinkBlock";

package/src/link-block.ws.tsx

@@ -0,0 +1,38 @@
+import { LinkBlockIcon } from "@webstudio-is/icons/svg";
+import type {
+  PresetStyle,
+  WsComponentMeta,
+  WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import { a } from "@webstudio-is/react-sdk/css-normalize";
+import { props } from "./__generated__/link-block.props";
+import { meta as linkMeta, propsMeta as linkPropsMeta } from "./link.ws";
+import type { defaultTag } from "./link-block";
+
+const presetStyle = {
+  a: [
+    ...a,
+    {
+      property: "display",
+      value: { type: "keyword", value: "inline-block" },
+    },
+  ],
+} satisfies PresetStyle<typeof defaultTag>;
+
+export const meta: WsComponentMeta = {
+  category: "general",
+  type: "container",
+  label: "Link Block",
+  icon: LinkBlockIcon,
+  states: linkMeta.states,
+  presetStyle,
+  order: 2,
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+  props: {
+    ...props,
+    href: linkPropsMeta.props.href,
+  },
+  initialProps: linkPropsMeta.initialProps,
+};

package/src/link.stories.tsx

@@ -0,0 +1,16 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { Link as LinkPrimitive } from "./link";
+
+export default {
+  title: "Components/Link",
+  component: LinkPrimitive,
+} as ComponentMeta<typeof LinkPrimitive>;
+
+const Template: ComponentStory<typeof LinkPrimitive> = (args) => (
+  <LinkPrimitive {...args} />
+);
+
+export const Link = Template.bind({});
+Link.args = {
+  children: "Link",
+};

package/src/link.tsx

@@ -0,0 +1,44 @@
+import { forwardRef, type ComponentProps } from "react";
+import {
+  usePropUrl,
+  getInstanceIdFromComponentProps,
+  getParams,
+} from "@webstudio-is/react-sdk";
+
+export const defaultTag = "a";
+
+// @todo props that come from remix link, shouldn't be here at all
+// - prefetch should be only on remix component and it already is
+// - props meta should be generated from Remix link
+// - changing this requires update in app/canvas/custom-components/link.tsx
+type Props = Omit<ComponentProps<"a">, "href" | "target"> & {
+  href?: string;
+  target?: "_self" | "_blank" | "_parent" | "_top";
+  prefetch?: "none" | "intent" | "render";
+};
+
+export const Link = forwardRef<HTMLAnchorElement, Props>((props, ref) => {
+  const href = usePropUrl(getInstanceIdFromComponentProps(props), "href");
+
+  const { assetBaseUrl } = getParams();
+
+  let url = "#";
+
+  switch (href?.type) {
+    case "page":
+      url = href.page.path === "" ? "/" : href.page.path;
+      if (href.hash !== undefined) {
+        url += `#${href.hash}`;
+      }
+      break;
+    case "asset":
+      url = `${assetBaseUrl}${href.asset.name}`;
+      break;
+    case "string":
+      url = href.url;
+  }
+
+  return <a {...props} href={url} ref={ref} />;
+});
+
+Link.displayName = "Link";