Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Prevent editing of radix input and textarea in canvas mode (#2160)

Bogdan Chadkin75c5cdc17946
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 17c789bcec..3e05443260 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -55,6 +55,7 @@ import { subscribeInstanceHovering } from "./instance-hovering";
import { useHashLinkSync } from "~/shared/pages";
import { useMount } from "~/shared/hook-utils/use-mount";
import { useSelectedInstance } from "./instance-selected-react";
+import { subscribeInterceptedEvents } from "./interceptor";
registerContainers();
@@ -224,6 +225,8 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {
useHashLinkSync();
+ useEffect(subscribeInterceptedEvents, []);
+
const components = useStore(registeredComponentsStore);
const instances = useStore(instancesStore);
const elements = useElementsTree(components, instances, params);
diff --git a/apps/builder/app/canvas/features/webstudio-component/link.ts b/apps/builder/app/canvas/features/webstudio-component/link.ts
deleted file mode 100644
index 414bb119fe..0000000000
--- a/apps/builder/app/canvas/features/webstudio-component/link.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-import type { MouseEvent } from "react";
-import { findPageByIdOrPath } from "@webstudio-is/project-build";
-import { pagesStore, isPreviewModeStore } from "~/shared/nano-states";
-import { switchPage } from "~/shared/pages";
-
-const isAbsoluteUrl = (href: string) => {
- try {
- new URL(href);
- return true;
- } catch {
- return false;
- }
-};
-
-export const handleLinkClick = (event: MouseEvent) => {
- const pages = pagesStore.get();
-
- if (isPreviewModeStore.get() === false || pages === undefined) {
- return;
- }
-
- const href = event.currentTarget.getAttribute("href");
-
- if (href === null) {
- return;
- }
-
- if (isAbsoluteUrl(href)) {
- window.open(href, "_blank");
- return;
- }
-
- const pageHref = new URL(href, "https://any-valid.url");
-
- const page = findPageByIdOrPath(pages, pageHref.pathname);
-
- if (page) {
- switchPage(page.id, pageHref.hash);
- return;
- }
-};
diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
index b6c4c09cee..2a8b7f8578 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -1,6 +1,4 @@
import {
- type MouseEvent,
- type FormEvent,
useEffect,
forwardRef,
type ForwardedRef,
@@ -40,7 +38,6 @@ import {
type InstanceSelector,
areInstanceSelectorsEqual,
} from "~/shared/tree-utils";
-import { handleLinkClick } from "./link";
import { mergeRefs } from "@react-aria/utils";
import { composeEventHandlers } from "@radix-ui/primitive";
import { setDataCollapsed } from "~/canvas/collapsed";
@@ -134,24 +131,6 @@ type WebstudioComponentDevProps = {
components: Components;
};
-/**
- * For some components that are wrapped with Radix Slot-like components (Triggers etc where asChild=true),
- * Slots in react-aria https://react-spectrum.adobe.com/react-spectrum/layout.html#slots
- * events are passed implicitly. We aim to merge these implicit events with the explicitly defined ones.
- **/
-type ImplicitEvents = {
- onClick?: undefined | ((event: never) => void);
- onSubmit?: undefined | ((event: never) => void);
- /**
- * We ignore the remaining events because we currently detect events using the 'on' prefix.
- * This approach (defining type like above instead of Partial<Record<`on${string}`, Handler>>)
- * is necessary due to our TypeScript settings, where 'no exactOptionalPropertyTypes' is set,
- * which makes it impossible to define a Partial<Record<>> with optional keys.
- * (without exactOptionalPropertyTypes ts defines it as {[key: string]: Handler | undefined)}
- * instead of {[key: string]?: Handler | undefined)})
- **/
-};
-
const existingElements = new Set<string>();
/**
@@ -173,7 +152,7 @@ const useCollapsedOnNewElement = (instanceId: Instance["id"]) => {
// eslint-disable-next-line react/display-name
export const WebstudioComponentDev = forwardRef<
HTMLElement,
- WebstudioComponentDevProps & ImplicitEvents
+ WebstudioComponentDevProps
>(({ instance, instanceSelector, children, components, ...restProps }, ref) => {
const { renderer } = useContext(ReactSdkContext);
const instanceId = instance.id;
@@ -230,36 +209,11 @@ export const WebstudioComponentDev = forwardRef<
} & Record<string, unknown> = {
...instanceProps,
tabIndex: 0,
- onClick: (event: MouseEvent) => {
- if (event.currentTarget instanceof HTMLAnchorElement) {
- // @todo use Navigation API once implemented everywhere
- // https://developer.mozilla.org/en-US/docs/Web/API/Navigation_API
- handleLinkClick(event);
- event.preventDefault();
- } else if (typeof instanceProps.onClick === "function") {
- // bypass onClick for non-link component, for example button
- instanceProps.onClick(event);
- }
- },
- onSubmit: (event: FormEvent) => {
- // Prevent submitting the form when clicking a button type submit
- event.preventDefault();
- if (typeof instanceProps.onSubmit === "function") {
- // bypass handler
- instanceProps.onSubmit(event);
- }
- },
[componentAttribute]: instance.component,
[idAttribute]: instance.id,
[selectorIdAttribute]: instanceSelector.join(","),
};
- if (renderer === "canvas") {
- if (instance.component === "Input" || instance.component === "Textarea") {
- props.readOnly = true;
- }
- }
-
for (const [name, value] of Object.entries(restProps)) {
if (typeof value === "function") {
// prevent passing any callbacks from outside while in canvas mode
@@ -275,7 +229,11 @@ export const WebstudioComponentDev = forwardRef<
* purposes (setting variable).
**/
if (name.startsWith("on") && typeof props[name] === "function") {
- props[name] = composeEventHandlers(value, props[name] as typeof value);
+ type Callback = (event: unknown) => void;
+ props[name] = composeEventHandlers(
+ value as Callback,
+ props[name] as Callback
+ );
continue;
}
}
diff --git a/apps/builder/app/canvas/interceptor.ts b/apps/builder/app/canvas/interceptor.ts
new file mode 100644
index 0000000000..6e508819ca
--- /dev/null
+++ b/apps/builder/app/canvas/interceptor.ts
@@ -0,0 +1,70 @@
+import { findPageByIdOrPath } from "@webstudio-is/project-build";
+import { isPreviewModeStore, pagesStore } from "~/shared/nano-states";
+import { switchPage } from "~/shared/pages";
+
+const isAbsoluteUrl = (href: string) => {
+ try {
+ new URL(href);
+ return true;
+ } catch {
+ return false;
+ }
+};
+
+const handleLinkClick = (element: HTMLAnchorElement) => {
+ const pages = pagesStore.get();
+ const href = element.getAttribute("href");
+ if (href === null || pages === undefined) {
+ return;
+ }
+
+ if (isAbsoluteUrl(href)) {
+ window.open(href, "_blank");
+ return;
+ }
+
+ const pageHref = new URL(href, "https://any-valid.url");
+ const page = findPageByIdOrPath(pages, pageHref.pathname);
+ if (page) {
+ switchPage(page.id, pageHref.hash);
+ return;
+ }
+};
+
+export const subscribeInterceptedEvents = () => {
+ const handleClick = (event: MouseEvent) => {
+ if (event.target instanceof HTMLElement) {
+ const a = event.target.closest("a");
+ if (a) {
+ event.preventDefault();
+ if (isPreviewModeStore.get()) {
+ handleLinkClick(a);
+ }
+ }
+ }
+ };
+ const handleSubmit = (event: SubmitEvent) => {
+ // prevent submitting the form when clicking a button type submit
+ event.preventDefault();
+ };
+ const handleKeydown = (event: KeyboardEvent) => {
+ if (isPreviewModeStore.get()) {
+ return;
+ }
+ // prevent typing in inputs only in canvas mode
+ if (
+ event.target instanceof HTMLInputElement ||
+ event.target instanceof HTMLTextAreaElement
+ ) {
+ event.preventDefault();
+ }
+ };
+ document.documentElement.addEventListener("click", handleClick);
+ document.documentElement.addEventListener("submit", handleSubmit);
+ document.documentElement.addEventListener("keydown", handleKeydown);
+ return () => {
+ document.documentElement.removeEventListener("click", handleClick);
+ document.documentElement.removeEventListener("submit", handleSubmit);
+ document.documentElement.removeEventListener("keydown", handleKeydown);
+ };
+};