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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
refactor: move text editing into commands (#2394)
Bogdan Chadkin92e6dbd11823
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsxindex 3d29600adf..44d354585f 100644--- a/apps/builder/app/builder/builder.tsx+++ b/apps/builder/app/builder/builder.tsx@@ -2,7 +2,7 @@ import { useCallback, useEffect } from "react";import { useStore } from "@nanostores/react";import { useUnmount } from "react-use";import { TooltipProvider } from "@radix-ui/react-tooltip";-import { type Publish, usePublish, $publisher } from "~/shared/pubsub";+import { usePublish, $publisher } from "~/shared/pubsub";import type { Asset } from "@webstudio-is/sdk";import type { Build } from "@webstudio-is/project-build";import type { Project } from "@webstudio-is/project";@@ -191,13 +191,11 @@ const ChromeWrapper = ({ children, isPreviewMode }: ChromeWrapperProps) => {type NavigatorPanelProps = {isPreviewMode: boolean;navigatorLayout: "docked" | "undocked";- publish: Publish;};const NavigatorPanel = ({isPreviewMode,navigatorLayout,- publish,}: NavigatorPanelProps) => {if (navigatorLayout === "docked") {return null;@@ -212,7 +210,7 @@ const NavigatorPanel = ({height: "100%",}}>- <Navigator isClosable={false} publish={publish} />+ <Navigator isClosable={false} /></Box></SidePanel>);@@ -323,7 +321,6 @@ export const Builder = ({<NavigatorPanelisPreviewMode={isPreviewMode}navigatorLayout={navigatorLayout}- publish={publish}/><SidePanelgridArea="inspector"diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsxindex befbc99efe..446e3a14a5 100644--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx@@ -1,18 +1,21 @@import { Flex, Separator } from "@webstudio-is/design-system";import { NavigatorTree } from "~/builder/shared/navigator-tree";import { Header, CloseButton } from "../header";-import type { Publish } from "~/shared/pubsub";-import { usePublishInstanceTreeShortcuts } from "~/builder/shared/shortcuts";import { CssPreview } from "./css-preview";+import { useHotkeys } from "react-hotkeys-hook";+import { emitCommand } from "~/builder/shared/commands";type NavigatorProps = {isClosable?: boolean;onClose?: () => void;- publish: Publish;};-export const Navigator = ({ isClosable, onClose, publish }: NavigatorProps) => {- const shortcutRef = usePublishInstanceTreeShortcuts<HTMLDivElement>(publish);+export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {+ const shortcutRef = useHotkeys<HTMLDivElement>(+ "enter",+ () => emitCommand("editInstanceText"),+ []+ );return (<Flex ref={shortcutRef} css={{ height: "100%", flexDirection: "column" }}>diff --git a/apps/builder/app/builder/features/sidebar-left/panels/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/panels/navigator/navigator.tsxindex 8906ac0049..f325ad07ac 100644--- a/apps/builder/app/builder/features/sidebar-left/panels/navigator/navigator.tsx+++ b/apps/builder/app/builder/features/sidebar-left/panels/navigator/navigator.tsx@@ -1,17 +1,14 @@import { ListNestedIcon } from "@webstudio-is/icons";import { Navigator } from "../../navigator";import type { TabName } from "../../types";-import type { Publish } from "~/shared/pubsub";type TabContentProps = {onSetActiveTab: (tabName: TabName) => void;- publish: Publish;};-export const TabContent = ({ onSetActiveTab, publish }: TabContentProps) => {+export const TabContent = ({ onSetActiveTab }: TabContentProps) => {return (<Navigator- publish={publish}onClose={() => {onSetActiveTab("none");}}diff --git a/apps/builder/app/builder/shared/commands.ts b/apps/builder/app/builder/shared/commands.tsindex c7da351c09..6765b44c03 100644--- a/apps/builder/app/builder/shared/commands.ts+++ b/apps/builder/app/builder/shared/commands.ts@@ -3,6 +3,7 @@ import { $isPreviewMode } from "~/shared/nano-states";export const { emitCommand, subscribeCommands } = createCommandsEmitter({source: "builder",+ externalCommands: ["editInstanceText"],commands: [{name: "togglePreview",diff --git a/apps/builder/app/builder/shared/shortcuts/use-publish-shortcuts.ts b/apps/builder/app/builder/shared/shortcuts/use-publish-shortcuts.tsindex d9da68e70a..02d958bbd8 100644--- a/apps/builder/app/builder/shared/shortcuts/use-publish-shortcuts.ts+++ b/apps/builder/app/builder/shared/shortcuts/use-publish-shortcuts.ts@@ -1,14 +1,10 @@import { useHotkeys } from "react-hotkeys-hook";-import { shortcuts, options, instanceTreeShortcuts } from "~/shared/shortcuts";+import { shortcuts, options } from "~/shared/shortcuts";import type { Publish } from "~/shared/pubsub";-import { mergeRefs } from "@react-aria/utils";-import type { Ref } from "react";declare module "~/shared/pubsub" {export interface PubsubMap {- shortcut:- | { name: keyof typeof shortcuts }- | { name: keyof typeof instanceTreeShortcuts };+ shortcut: { name: keyof typeof shortcuts };}}@@ -23,7 +19,7 @@ export const usePublishShortcuts = (publish: Publish) => {// eslint-disable-next-line react-hooks/rules-of-hooksuseHotkeys(shortcuts[name],- (event) => {+ (_event) => {publish({type: "shortcut",payload: { name },@@ -34,32 +30,3 @@ export const usePublishShortcuts = (publish: Publish) => {);});};--/**- * Forwarding shortcuts to the canvas.- */-export const usePublishInstanceTreeShortcuts = <T extends HTMLElement>(- publish: Publish-) => {- const refs: Ref<T>[] = [];- for (const [name, instaceTreeShortcut] of Object.entries(- instanceTreeShortcuts- )) {- // as long as the array is static, it's ok- // eslint-disable-next-line react-hooks/rules-of-hooks- const ref = useHotkeys(- instaceTreeShortcut,- (event) => {- publish({- type: "shortcut",- payload: { name: name as keyof typeof instanceTreeShortcuts },- });- },- options,- []- );- refs.push(ref as Ref<T>);- }-- return mergeRefs<T>(...refs);-};diff --git a/apps/builder/app/builder/shared/sync/sync-server.ts b/apps/builder/app/builder/shared/sync/sync-server.tsindex 68d4798339..930ab21c0c 100644--- a/apps/builder/app/builder/shared/sync/sync-server.ts+++ b/apps/builder/app/builder/shared/sync/sync-server.ts@@ -25,6 +25,37 @@ const MAX_ALLOWED_API_ERRORS = 5;const INTERVAL_ERROR = 5000;const MAX_INTERVAL_ERROR = 2 * 60000;+const persistedNamespaces = new Set([+ "pages",+ "breakpoints",+ "instances",+ "styles",+ "styleSources",+ "styleSourceSelections",+ "props",+ "dataSources",+ "assets",+]);++const filterTransactions = (+ transactions: ReturnType<typeof sync>,+ namespaces: Set<string>+) => {+ const filteredTransactions: ReturnType<typeof sync> = [];+ for (const transaction of transactions) {+ const filteredChanges = transaction.changes.filter((change) =>+ namespaces.has(change.namespace)+ );+ if (filteredChanges.length !== 0) {+ filteredTransactions.push({+ ...transaction,+ changes: filteredChanges,+ });+ }+ }+ return filteredTransactions;+};+const pause = (timeout: number) => {return new Promise((resolve) => setTimeout(resolve, timeout));};@@ -269,7 +300,7 @@ const useSyncProject = async ({});const updateProjectTransactions = () => {- const transactions = sync();+ const transactions = filterTransactions(sync(), persistedNamespaces);if (transactions.length === 0) {return;}diff --git a/apps/builder/app/canvas/canvas-shortcuts.ts b/apps/builder/app/canvas/canvas-shortcuts.tsindex 87856ae74e..7974c6885c 100644--- a/apps/builder/app/canvas/canvas-shortcuts.ts+++ b/apps/builder/app/canvas/canvas-shortcuts.ts@@ -1,7 +1,6 @@import { useHotkeys } from "react-hotkeys-hook";-import { shortcuts, instanceTreeShortcuts, options } from "~/shared/shortcuts";+import { shortcuts, options } from "~/shared/shortcuts";import { publish, useSubscribe } from "~/shared/pubsub";-import { enterEditingMode, escapeSelection } from "~/shared/instance-utils";declare module "~/shared/pubsub" {export interface PubsubMap {@@ -22,11 +21,7 @@ export const useCanvasShortcuts = () => {const shortcutHandlerMap = {breakpointsMenu: publishOpenBreakpointsMenu,esc: publishCancelCurrentDrag,- enter: enterEditingMode,- } as const satisfies Record<- keyof typeof shortcuts | keyof typeof instanceTreeShortcuts,- unknown- >;+ } as const satisfies Record<keyof typeof shortcuts, unknown>;useHotkeys(shortcuts.breakpointsMenu,@@ -39,15 +34,11 @@ export const useCanvasShortcuts = () => {shortcuts.esc,() => {shortcutHandlerMap.esc();- // Reset selection for local canvas escape, but not for the Builder escape via useSubscribe- escapeSelection();},options,[]);- useHotkeys(instanceTreeShortcuts.enter, shortcutHandlerMap.enter, {}, []);-// Shortcuts from the parent windowuseSubscribe("shortcut", ({ name }) => {shortcutHandlerMap[name]();diff --git a/apps/builder/app/canvas/shared/commands.ts b/apps/builder/app/canvas/shared/commands.tsindex 467651fc18..d86f291a26 100644--- a/apps/builder/app/canvas/shared/commands.ts+++ b/apps/builder/app/canvas/shared/commands.ts@@ -1,6 +1,68 @@import { createCommandsEmitter } from "~/shared/commands-emitter";+import { getElementByInstanceSelector } from "~/shared/dom-utils";+import { findClosestEditableInstanceSelector } from "~/shared/instance-utils";+import {+ instancesStore,+ registeredComponentMetasStore,+ selectedInstanceSelectorStore,+ selectedStyleSourceSelectorStore,+ textEditingInstanceSelectorStore,+} from "~/shared/nano-states";export const { emitCommand, subscribeCommands } = createCommandsEmitter({source: "canvas",- commands: [],+ commands: [+ {+ name: "editInstanceText",+ defaultHotkeys: ["enter"],+ // builder invokes command with custom hotkey setup+ disableHotkeyOutsideApp: true,+ handler: () => {+ const selectedInstanceSelector = selectedInstanceSelectorStore.get();+ if (selectedInstanceSelector === undefined) {+ return;+ }+ const editableInstanceSelector = findClosestEditableInstanceSelector(+ selectedInstanceSelector,+ instancesStore.get(),+ registeredComponentMetasStore.get()+ );+ if (editableInstanceSelector === undefined) {+ return;+ }+ const element = getElementByInstanceSelector(editableInstanceSelector);+ if (element === undefined) {+ return;+ }+ // When an event is triggered from the Builder,+ // the canvas element may be unfocused, so it's important to focus the element on the canvas.+ element.focus();+ selectedInstanceSelectorStore.set(editableInstanceSelector);+ textEditingInstanceSelectorStore.set(editableInstanceSelector);+ },+ },++ {+ name: "escapeSelection",+ defaultHotkeys: ["escape"],+ // reset selection for canvas, but not for the builder+ disableHotkeyOutsideApp: true,+ handler: () => {+ const selectedInstanceSelector = selectedInstanceSelectorStore.get();+ const textEditingInstanceSelector =+ textEditingInstanceSelectorStore.get();+ if (selectedInstanceSelector === undefined) {+ return;+ }+ // exit text editing mode first without unselecting instance+ if (textEditingInstanceSelector) {+ textEditingInstanceSelectorStore.set(undefined);+ return;+ }+ // unselect both instance and style source+ selectedInstanceSelectorStore.set(undefined);+ selectedStyleSourceSelectorStore.set(undefined);+ },+ },+ ],});diff --git a/apps/builder/app/shared/commands-emitter.ts b/apps/builder/app/shared/commands-emitter.tsindex 2db760654a..94559e628c 100644--- a/apps/builder/app/shared/commands-emitter.ts+++ b/apps/builder/app/shared/commands-emitter.ts@@ -1,5 +1,6 @@import { isHotkeyPressed } from "react-hotkeys-hook";import { atom, onMount } from "nanostores";+import store from "immerhin";import { $publisher, subscribe } from "~/shared/pubsub";type CommandMeta<CommandName extends string> = {@@ -7,6 +8,8 @@ type CommandMeta<CommandName extends string> = {name: CommandName;// default because hotkeys can be customized from uidefaultHotkeys?: string[];+ // listen hotkeys only locally without sharing with other apps+ disableHotkeyOutsideApp?: boolean;};type CommandHandler = () => void;@@ -36,10 +39,8 @@ export const createCommandsEmitter = <CommandName extends string>({externalCommands?: CommandName[];commands: Command<CommandName>[];}) => {- const commandMetas = new Map($commandMetas.get());const commandHandlers = new Map<string, CommandHandler>();for (const { handler, ...meta } of commands) {- commandMetas.set(meta.name, meta);commandHandlers.set(meta.name, handler);}@@ -49,8 +50,11 @@ export const createCommandsEmitter = <CommandName extends string>({// schedule store.set to the next tick// so store.listen is executed after store.set belowPromise.resolve().then(() => {- // @todo use patches to avoid race when both builder and canvas send commands- $commandMetas.set(commandMetas);+ store.createTransaction([$commandMetas], (commandMetas) => {+ for (const { handler, ...meta } of commands) {+ commandMetas.set(meta.name, meta);+ }+ });});});}@@ -88,6 +92,12 @@ export const createCommandsEmitter = <CommandName extends string>({) {continue;}+ if (+ commandMeta.disableHotkeyOutsideApp &&+ commandHandlers.has(commandMeta.name) === false+ ) {+ continue;+ }emitted = true;emitCommand(commandMeta.name as CommandName);}diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.tsindex 9ae912b913..aa1afb9754 100644--- a/apps/builder/app/shared/instance-utils.ts+++ b/apps/builder/app/shared/instance-utils.ts@@ -36,7 +36,6 @@ import {} from "./tree-utils";import { removeByMutable } from "./array-utils";import { isBaseBreakpoint } from "./breakpoints";-import { getElementByInstanceSelector } from "./dom-utils";import { humanizeString } from "./string-utils";const getLabelFromComponentName = (component: Instance["component"]) => {@@ -505,44 +504,3 @@ export const deleteSelectedInstance = () => {}deleteInstance(selectedInstanceSelector);};--export const enterEditingMode = (event?: KeyboardEvent) => {- const selectedInstanceSelector = selectedInstanceSelectorStore.get();- if (selectedInstanceSelector === undefined) {- return;- }- const editableInstanceSelector = findClosestEditableInstanceSelector(- selectedInstanceSelector,- instancesStore.get(),- registeredComponentMetasStore.get()- );- if (editableInstanceSelector === undefined) {- return;- }- const element = getElementByInstanceSelector(editableInstanceSelector);- if (element === undefined) {- return;- }- // When an event is triggered from the Builder,- // the canvas element may be unfocused, so it's important to focus the element on the canvas.- element.focus();- // Prevents inserting a newline when entering text-editing mode- event?.preventDefault();- selectedInstanceSelectorStore.set(editableInstanceSelector);- textEditingInstanceSelectorStore.set(editableInstanceSelector);-};--export const escapeSelection = () => {- const selectedInstanceSelector = selectedInstanceSelectorStore.get();- const textEditingInstanceSelector = textEditingInstanceSelectorStore.get();- if (selectedInstanceSelector === undefined) {- return;- }- // exit text editing mode first without unselecting instance- if (textEditingInstanceSelector) {- textEditingInstanceSelectorStore.set(undefined);- return;- }- selectedInstanceSelectorStore.set(undefined);- selectedStyleSourceSelectorStore.set(undefined);-};diff --git a/apps/builder/app/shared/shortcuts/shortcuts.ts b/apps/builder/app/shared/shortcuts/shortcuts.tsindex 8cfec7c4ee..9e1f5f7667 100644--- a/apps/builder/app/shared/shortcuts/shortcuts.ts+++ b/apps/builder/app/shared/shortcuts/shortcuts.ts@@ -13,10 +13,6 @@ export const shortcuts = {breakpointsMenu: "meta+b, ctrl+b",} as const;-export const instanceTreeShortcuts = {- enter: "enter",-} as const;-export const options: Options = {enableOnFormTags: true,};diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.tsindex edc7ae4123..0c94609796 100644--- a/apps/builder/app/shared/sync/sync-stores.ts+++ b/apps/builder/app/shared/sync/sync-stores.ts@@ -72,8 +72,8 @@ export const registerContainers = () => {store.register("props", propsStore);store.register("dataSources", dataSourcesStore);store.register("assets", assetsStore);+ store.register("commandMetas", $commandMetas);// synchronize whole states- clientStores.set("commandMetas", $commandMetas);clientStores.set("project", projectStore);clientStores.set("dataSourceVariables", dataSourceVariablesStore);clientStores.set("selectedPageId", selectedPageIdStore);