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.

feat: Add Editable Block Component (#4437)

Ivan Starkov2acb4ac5962d
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 1dfb015c7f..284c844251 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -93,6 +93,7 @@ const SidePanel = ({
}: SidePanelProps) => {
return (
<Box
+ id="jopa"
as="aside"
css={{
position: "relative",
@@ -120,7 +121,6 @@ const Main = ({ children }: { children: ReactNode }) => (
direction="column"
css={{
gridArea: "main",
- overflow: "hidden",
position: "relative",
}}
>
@@ -416,6 +416,9 @@ export const Builder = ({
/>
}
/>
+ <SidePanel gridArea="sidebar">
+ <SidebarLeft publish={publish} />
+ </SidePanel>
<Main>
<Workspace onTransitionEnd={onTransitionEnd}>
{dataLoadingState === "loaded" && (
@@ -429,9 +432,6 @@ export const Builder = ({
{isDesignMode && <AiCommandBar />}
</Main>
- <SidePanel gridArea="sidebar">
- <SidebarLeft publish={publish} />
- </SidePanel>
<SidePanel
gridArea="inspector"
isPreviewMode={isPreviewMode}
diff --git a/apps/builder/app/builder/features/navigator/navigator-tree.tsx b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
index 35525e65d3..2037770345 100644
--- a/apps/builder/app/builder/features/navigator/navigator-tree.tsx
+++ b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
@@ -33,6 +33,7 @@ import {
} from "@webstudio-is/icons";
import {
$dragAndDropState,
+ $editableBlockChildOutline,
$editingItemSelector,
$hoveredInstanceSelector,
$instances,
@@ -590,8 +591,10 @@ export const NavigatorTree = () => {
},
}}
buttonProps={{
- onMouseEnter: () =>
- $hoveredInstanceSelector.set(item.selector),
+ onMouseEnter: () => {
+ $hoveredInstanceSelector.set(item.selector);
+ $editableBlockChildOutline.set(undefined);
+ },
onMouseLeave: () => $hoveredInstanceSelector.set(undefined),
onClick: () => selectInstance(item.selector),
onFocus: () => selectInstance(item.selector),
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
index a21f4001f2..a86db29d9c 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
@@ -19,6 +19,7 @@ import { ResizeHandles } from "./resize-handles";
import { MediaBadge } from "./media-badge";
import { applyScale } from "./outline";
import { $scale } from "~/builder/shared/nano-states";
+import { EditableBlockChildHoveredInstanceOutline } from "./outline/hovered-instance-outline";
const containerStyle = css({
position: "absolute",
@@ -65,19 +66,18 @@ export const CanvasTools = () => {
}
return (
- <div className={containerStyle()}>
+ <>
<MediaBadge />
<ResizeHandles />
{isPreviewMode === false && (
<>
- <div className={containerStyle({ overflow: "hidden" })}>
- <SelectedInstanceOutline />
- <HoveredInstanceOutline />
- <CollaborativeInstanceOutline />
- </div>
+ <SelectedInstanceOutline />
+ <HoveredInstanceOutline />
+ <EditableBlockChildHoveredInstanceOutline />
+ <CollaborativeInstanceOutline />
<TextToolbar />
</>
)}
- </div>
+ </>
);
};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
index dc407ea78c..75cc72afee 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
@@ -1,30 +1,121 @@
import { useStore } from "@nanostores/react";
import {
+ $editableBlockChildOutline,
$hoveredInstanceOutlineAndInstance,
$hoveredInstanceSelector,
$instances,
+ $isContentMode,
$textEditingInstanceSelector,
+ type EditableBlockChildOutline,
} from "~/shared/nano-states";
-import { Outline } from "./outline";
+import { EditableBlockChildAddButtonOutline, Outline } from "./outline";
import { Label } from "./label";
import { applyScale } from "./apply-scale";
import { $scale } from "~/builder/shared/nano-states";
import { findClosestSlot } from "~/shared/instance-utils";
import { shallowEqual } from "shallow-equal";
+import type { InstanceSelector } from "~/shared/tree-utils";
+import { IconButton, theme, Tooltip } from "@webstudio-is/design-system";
+import { PlusIcon } from "@webstudio-is/icons";
+import { useRef, useState } from "react";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
+
+export const EditableBlockChildHoveredInstanceOutline = () => {
+ const editableBlockChildOutline = useStore($editableBlockChildOutline);
+ const scale = useStore($scale);
+ const isContentMode = useStore($isContentMode);
+ const timeoutRef = useRef<undefined | ReturnType<typeof setTimeout>>(
+ undefined
+ );
+ const [buttonOutline, setButtonOutline] = useState<
+ undefined | EditableBlockChildOutline
+ >(undefined);
+
+ const outline = editableBlockChildOutline ?? buttonOutline;
+
+ if (isFeatureEnabled("contentEditableMode") === false) {
+ return;
+ }
+
+ if (!isContentMode) {
+ return;
+ }
+
+ if (outline === undefined) {
+ return;
+ }
+
+ const rect = applyScale(outline.rect, scale);
+
+ return (
+ <EditableBlockChildAddButtonOutline rect={rect}>
+ <Tooltip content="Add next block" side="top" disableHoverableContent>
+ <IconButton
+ variant={"local"}
+ css={{
+ borderStyle: "solid",
+ borderColor: `oklch(from ${theme.colors.backgroundPrimary} l c h / 0.7)`,
+ borderRadius: "100%",
+ pointerEvents: "all",
+ // mr: theme.spacing[12],
+ }}
+ onClick={() => {
+ alert("not implemented");
+ }}
+ onMouseEnter={() => {
+ clearTimeout(timeoutRef.current);
+
+ setButtonOutline(outline);
+ }}
+ onMouseLeave={() => {
+ clearTimeout(timeoutRef.current);
+
+ timeoutRef.current = setTimeout(() => {
+ setButtonOutline(undefined);
+ }, 100);
+ }}
+ >
+ <PlusIcon />
+ </IconButton>
+ </Tooltip>
+ </EditableBlockChildAddButtonOutline>
+ );
+};
+
+const isDescendantOrSelf = (
+ descendant: InstanceSelector,
+ self: InstanceSelector
+) => {
+ return descendant.join(",").endsWith(self.join(","));
+};
export const HoveredInstanceOutline = () => {
const instances = useStore($instances);
const hoveredInstanceSelector = useStore($hoveredInstanceSelector);
+ const editableBlockChildOutline = useStore($editableBlockChildOutline);
const outline = useStore($hoveredInstanceOutlineAndInstance);
const scale = useStore($scale);
const textEditingInstanceSelector = useStore($textEditingInstanceSelector);
+ const isContentMode = useStore($isContentMode);
if (outline === undefined || hoveredInstanceSelector === undefined) {
return;
}
+ if (isFeatureEnabled("contentEditableMode") && isContentMode) {
+ if (
+ shallowEqual(editableBlockChildOutline?.selector, hoveredInstanceSelector)
+ ) {
+ return;
+ }
+ }
+
if (
- shallowEqual(hoveredInstanceSelector, textEditingInstanceSelector?.selector)
+ textEditingInstanceSelector?.selector &&
+ isDescendantOrSelf(
+ hoveredInstanceSelector,
+ textEditingInstanceSelector?.selector
+ )
) {
return;
}
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/label.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/label.tsx
index fdf72187d7..489a946608 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/label.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/label.tsx
@@ -61,13 +61,21 @@ const LabelContainer = styled(
variants: {
position: {
top: {
+ left: -1,
top: `-${theme.spacing[10]}`,
+ borderTopLeftRadius: theme.borderRadius[4],
+ borderTopRightRadius: theme.borderRadius[4],
},
inside: {
top: 0,
+ borderBottomLeftRadius: theme.borderRadius[4],
+ borderBottomRightRadius: theme.borderRadius[4],
},
bottom: {
+ left: -1,
bottom: `-${theme.spacing[10]}`,
+ borderBottomLeftRadius: theme.borderRadius[4],
+ borderBottomRightRadius: theme.borderRadius[4],
},
},
variant: {
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
index 7081481adb..bf4a20669c 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
@@ -21,35 +21,38 @@ const angleKeyframes = keyframes({
},
});
-const baseStyle = css({
- boxSizing: "border-box",
- position: "absolute",
- pointerEvents: "none",
- top: 0,
- left: 0,
+const baseOutlineStyle = css({
borderWidth: 1,
variants: {
variant: {
default: {
- // Semi-transparent color allows user to see the carret when outlining content editable
- outline: `1px solid oklch(from ${theme.colors.backgroundPrimary} l c h / 0.7) `,
- outlineOffset: -1,
+ borderStyle: "solid",
+ borderColor: `oklch(from ${theme.colors.backgroundPrimary} l c h / 0.7)`,
},
collaboration: {
[angleVar]: `0deg`,
- border: `1px solid`,
+ borderStyle: "solid",
borderImage: `conic-gradient(from var(${angleVar}), #39FBBB 0%, #4A4EFA 12.5%, #E63CFE 25%, #FFAE3C 37.5%, #39FBBB 50%, #4A4EFA 62.5%, #E63CFE 75%, #FFAE3C 87.5%) 1`,
animation: `2s ${angleKeyframes} linear infinite`,
},
slot: {
- outline: `1px solid ${theme.colors.foregroundReusable}`,
- outlineOffset: -1,
+ borderStyle: "solid",
+ borderColor: theme.colors.foregroundReusable,
},
},
},
defaultVariants: { variant: "default" },
});
+const baseStyle = css({
+ boxSizing: "border-box",
+ position: "absolute",
+ display: "grid",
+ pointerEvents: "none",
+ top: 0,
+ left: 0,
+});
+
const useDynamicStyle = (rect?: Rect) => {
return useMemo(() => {
if (rect === undefined) {
@@ -69,12 +72,50 @@ type OutlineProps = {
variant?: "default" | "collaboration" | "slot";
};
+export const EditableBlockChildAddButtonOutline = ({
+ rect,
+ children,
+}: {
+ rect: Rect;
+ children: ReactNode;
+}) => {
+ const dynamicStyle = useDynamicStyle(rect);
+
+ return (
+ <>
+ <div
+ className={`${baseStyle()} ${baseOutlineStyle()}`}
+ style={dynamicStyle}
+ >
+ <div
+ style={{
+ height: 0,
+ width: 0,
+ display: "grid",
+ alignContent: "center",
+ justifyContent: "center",
+
+ justifySelf: "start",
+ alignSelf: "start",
+ }}
+ >
+ {children}
+ </div>
+ </div>
+ </>
+ );
+};
+
export const Outline = ({ children, rect, variant }: OutlineProps) => {
const dynamicStyle = useDynamicStyle(rect);
+
return (
<>
{propertyStyle}
- <div className={baseStyle({ variant })} style={dynamicStyle}>
+ <div
+ className={`${baseStyle()} ${baseOutlineStyle({ variant })}`}
+ style={dynamicStyle}
+ >
{children}
</div>
</>
diff --git a/apps/builder/app/builder/features/workspace/workspace.tsx b/apps/builder/app/builder/features/workspace/workspace.tsx
index 6a4407a855..771dd3a468 100644
--- a/apps/builder/app/builder/features/workspace/workspace.tsx
+++ b/apps/builder/app/builder/features/workspace/workspace.tsx
@@ -16,7 +16,8 @@ const workspaceStyle = css({
background: theme.colors.backgroundCanvas,
position: "relative",
// Prevent scrollIntoView from scrolling the whole page
- overflow: "clip",
+ // Commented to see what it will break
+ // overflow: "clip",
});
const canvasContainerStyle = css({
@@ -104,22 +105,28 @@ export const Workspace = ({ children, onTransitionEnd }: WorkspaceProps) => {
};
return (
- <div
- className={workspaceStyle()}
- onClick={handleWorkspaceClick}
- ref={workspaceRef}
- >
+ <>
<div
- className={canvasContainerStyle()}
- style={canvasStyle}
- onTransitionEnd={onTransitionEnd}
+ className={workspaceStyle()}
+ onClick={handleWorkspaceClick}
+ ref={workspaceRef}
>
- {children}
- </div>
- <div className={canvasContainerStyle()} style={outlineStyle}>
- <CanvasTools />
+ <div
+ className={canvasContainerStyle()}
+ style={canvasStyle}
+ onTransitionEnd={onTransitionEnd}
+ >
+ {children}
+ </div>
+ <div
+ data-name="canvas-tools-wrapper"
+ className={canvasContainerStyle()}
+ style={outlineStyle}
+ >
+ <CanvasTools />
+ </div>
</div>
<Toaster />
- </div>
+ </>
);
};
diff --git a/apps/builder/app/canvas/features/build-mode/editable-block-template.tsx b/apps/builder/app/canvas/features/build-mode/editable-block-template.tsx
new file mode 100644
index 0000000000..8290b17a3d
--- /dev/null
+++ b/apps/builder/app/canvas/features/build-mode/editable-block-template.tsx
@@ -0,0 +1,12 @@
+import type {
+ AnyComponent,
+ WebstudioComponentSystemProps,
+} from "@webstudio-is/react-sdk";
+import * as React from "react";
+
+export const EditableBlockTemplate = React.forwardRef<
+ HTMLDivElement,
+ WebstudioComponentSystemProps
+>((props, ref) => {
+ return <div ref={ref} {...props} />;
+}) as AnyComponent;
diff --git a/apps/builder/app/canvas/features/build-mode/editable-block.tsx b/apps/builder/app/canvas/features/build-mode/editable-block.tsx
new file mode 100644
index 0000000000..7b08492ab7
--- /dev/null
+++ b/apps/builder/app/canvas/features/build-mode/editable-block.tsx
@@ -0,0 +1,12 @@
+import type {
+ AnyComponent,
+ WebstudioComponentSystemProps,
+} from "@webstudio-is/react-sdk";
+import * as React from "react";
+
+export const EditableBlock = React.forwardRef<
+ HTMLDivElement,
+ WebstudioComponentSystemProps
+>((props, ref) => {
+ return <div ref={ref} {...props} />;
+}) as AnyComponent;
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
index 9040975b78..1bd36cfa20 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
@@ -33,6 +33,8 @@ import {
type LexicalEditor,
type SerializedEditorState,
$createTextNode,
+ KEY_DOWN_COMMAND,
+ COMMAND_PRIORITY_NORMAL,
} from "lexical";
import { LinkNode } from "@lexical/link";
import { LexicalComposer } from "@lexical/react/LexicalComposer";
@@ -44,7 +46,11 @@ import { LinkPlugin } from "@lexical/react/LexicalLinkPlugin";
import { nanoid } from "nanoid";
import { createRegularStyleSheet } from "@webstudio-is/css-engine";
import type { Instance, Instances } from "@webstudio-is/sdk";
-import { collapsedAttribute, idAttribute } from "@webstudio-is/react-sdk";
+import {
+ collapsedAttribute,
+ idAttribute,
+ selectorIdAttribute,
+} from "@webstudio-is/react-sdk";
import type { InstanceSelector } from "~/shared/tree-utils";
import { ToolbarConnectorPlugin } from "./toolbar-connector";
import { type Refs, $convertToLexical, $convertToUpdates } from "./interop";
@@ -52,6 +58,9 @@ import { colord } from "colord";
import { useEffectEvent } from "~/shared/hook-utils/effect-event";
import { findAllEditableInstanceSelector } from "~/shared/instance-utils";
import {
+ $editableBlockChildOutline,
+ $hoveredInstanceOutline,
+ $hoveredInstanceSelector,
$registeredComponentMetas,
$textEditingInstanceSelector,
} from "~/shared/nano-states";
@@ -62,10 +71,16 @@ import {
import deepEqual from "fast-deep-equal";
import { setDataCollapsed } from "~/canvas/collapsed";
import { $selectedPage, selectInstance } from "~/shared/awareness";
-// import { AutoFocusPlugin } from "@lexical/react/LexicalAutoFocusPlugin";
-const BindInstanceToNodePlugin = ({ refs }: { refs: Refs }) => {
+const BindInstanceToNodePlugin = ({
+ refs,
+ rootInstanceSelector,
+}: {
+ refs: Refs;
+ rootInstanceSelector: InstanceSelector;
+}) => {
const [editor] = useLexicalComposerContext();
+
useEffect(() => {
for (const [nodeKey, instanceId] of refs) {
// extract key from stored key:style format
@@ -73,9 +88,16 @@ const BindInstanceToNodePlugin = ({ refs }: { refs: Refs }) => {
const element = editor.getElementByKey(key);
if (element) {
element.setAttribute(idAttribute, instanceId);
+ // We set id + root selector here, for simplicity
+ // This solves hover behavior during mouseMove for editable child outline
+ // @todo: A normal selector must be used, but it would require significantly more code to detect the tree structure.
+ element.setAttribute(
+ selectorIdAttribute,
+ [idAttribute, ...rootInstanceSelector].join(",")
+ );
}
}
- }, [editor, refs]);
+ }, [editor, refs, rootInstanceSelector]);
return null;
};
@@ -828,6 +850,28 @@ const LinkSanitizePlugin = (): null => {
return null;
};
+const AnyKeyDownPlugin = ({ onKeyDown }: { onKeyDown: () => void }) => {
+ const [editor] = useLexicalComposerContext();
+
+ useEffect(() => {
+ return editor.registerCommand(
+ KEY_DOWN_COMMAND,
+ () => {
+ const selection = $getSelection();
+ if (!$isRangeSelection(selection)) {
+ return false;
+ }
+
+ onKeyDown();
+ return false;
+ },
+ COMMAND_PRIORITY_NORMAL
+ );
+ }, [editor, onKeyDown]);
+
+ return null;
+};
+
export const TextEditor = ({
rootInstanceSelector,
instances,
@@ -980,11 +1024,11 @@ export const TextEditor = ({
handleChange(state);
$textEditingInstanceSelector.set({
- selector: editableInstanceSelectors[nextIndex],
+ selector: nextSelector,
...args,
});
- selectInstance(editableInstanceSelectors[nextIndex]);
+ selectInstance(nextSelector);
break;
}
@@ -992,6 +1036,12 @@ export const TextEditor = ({
[handleChange, instances, rootInstanceSelector]
);
+ const handleAnyKeydown = useCallback(() => {
+ $editableBlockChildOutline.set(undefined);
+ $hoveredInstanceOutline.set(undefined);
+ $hoveredInstanceSelector.set(undefined);
+ }, []);
+
return (
<LexicalComposer initialConfig={initialConfig}>
<RemoveParagaphsPlugin />
@@ -1004,7 +1054,10 @@ export const TextEditor = ({
}
}}
/>
- <BindInstanceToNodePlugin refs={refs} />
+ <BindInstanceToNodePlugin
+ refs={refs}
+ rootInstanceSelector={rootInstanceSelector}
+ />
<RichTextPlugin
ErrorBoundary={LexicalErrorBoundary}
contentEditable={contentEditable}
@@ -1017,6 +1070,7 @@ export const TextEditor = ({
<SwitchBlockPlugin onNext={handleNext} />
<OnChangeOnBlurPlugin onChange={handleChange} />
<InitCursorPlugin />
+ <AnyKeyDownPlugin onKeyDown={handleAnyKeydown} />
<InitialJSONStatePlugin
onInitialState={(json) => {
lastSavedStateJsonRef.current = json;
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 618a1e061f..87a644219b 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -26,6 +26,8 @@ import {
type AnyComponent,
textContentAttribute,
descendantComponent,
+ editableBlockComponent,
+ editableBlockTemplateComponent,
} from "@webstudio-is/react-sdk";
import { rawTheme } from "@webstudio-is/design-system";
import {
@@ -49,6 +51,8 @@ import {
createInstanceChildrenElements,
type WebstudioComponentProps,
} from "~/canvas/elements";
+import { EditableBlock } from "../build-mode/editable-block";
+import { EditableBlockTemplate } from "../build-mode/editable-block-template";
const ContentEditable = ({
renderComponentWithRef,
@@ -428,6 +432,14 @@ export const WebstudioComponentCanvas = forwardRef<
return <></>;
}
+ if (instance.component === editableBlockComponent) {
+ Component = EditableBlock;
+ }
+
+ if (instance.component === editableBlockTemplateComponent) {
+ Component = EditableBlockTemplate;
+ }
+
const props: {
[componentAttribute]: string;
[idAttribute]: string;
diff --git a/apps/builder/app/canvas/instance-hovering.ts b/apps/builder/app/canvas/instance-hovering.ts
index 2ae47b3087..e5d1dec023 100644
--- a/apps/builder/app/canvas/instance-hovering.ts
+++ b/apps/builder/app/canvas/instance-hovering.ts
@@ -1,5 +1,11 @@
import { idAttribute } from "@webstudio-is/react-sdk";
-import { $hoveredInstanceSelector, $instances } from "~/shared/nano-states";
+import {
+ $editableBlockChildOutline,
+ $hoveredInstanceSelector,
+ $instances,
+ $textEditingInstanceSelector,
+ findEditableBlockChildSelector,
+} from "~/shared/nano-states";
import { $hoveredInstanceOutline } from "~/shared/nano-states";
import {
getAllElementsBoundingBox,
@@ -11,6 +17,13 @@ import type { InstanceSelector } from "~/shared/tree-utils";
type TimeoutId = undefined | ReturnType<typeof setTimeout>;
+const isDescendantOrSelf = (
+ descendant: InstanceSelector,
+ self: InstanceSelector
+) => {
+ return descendant.join(",").endsWith(self.join(","));
+};
+
export const subscribeInstanceHovering = ({
signal,
}: {
@@ -20,13 +33,6 @@ export const subscribeInstanceHovering = ({
let updateOnMouseMove = false;
let isScrolling = false;
- const updateHoveredInstance = (element: Element) => {
- const instanceSelector = getInstanceSelectorFromElement(element);
- if (instanceSelector) {
- $hoveredInstanceSelector.set(instanceSelector);
- }
- };
-
let mouseOutTimeoutId: TimeoutId = undefined;
const eventOptions = { passive: true, signal };
@@ -54,8 +60,27 @@ export const subscribeInstanceHovering = ({
// the mouseover event triggers on elements created after Lexical loses focus.
// This causes an outline to appear on the element under the now-invisible mouse pointer
// (as the browser hides the pointer on blur), creating some visual distraction.
- if (updateOnMouseMove && hoveredElement !== undefined) {
- updateHoveredInstance(hoveredElement);
+ if (hoveredElement !== undefined) {
+ const instanceSelector = getInstanceSelectorFromElement(hoveredElement);
+ if (instanceSelector) {
+ if (updateOnMouseMove) {
+ $hoveredInstanceSelector.set(instanceSelector);
+ updateEditableChildOutline(instanceSelector);
+ } else {
+ const textSelector = $textEditingInstanceSelector.get()?.selector;
+
+ // We need to update the editable child's outline even if the mouseover event is not triggered.
+ // This can happen if the user enters text editing mode, presses any key, and then moves the mouse.
+ // In this case, the mouseover event does not occur, but we still need to show the editable child's outline.
+ if (
+ textSelector &&
+ isDescendantOrSelf(instanceSelector, textSelector) && // optimisation
+ $editableBlockChildOutline.get() === undefined
+ ) {
+ updateEditableChildOutline(instanceSelector);
+ }
+ }
+ }
}
updateOnMouseMove = false;
},
@@ -68,6 +93,8 @@ export const subscribeInstanceHovering = ({
mouseOutTimeoutId = setTimeout(() => {
updateOnMouseMove = false;
hoveredElement = undefined;
+
+ $editableBlockChildOutline.set(undefined);
$hoveredInstanceSelector.set(undefined);
$hoveredInstanceOutline.set(undefined);
}, 100);
@@ -81,11 +108,8 @@ export const subscribeInstanceHovering = ({
eventOptions
);
- const updateHoveredRect = (
- elements: Element[],
- instanceSelector: Readonly<InstanceSelector>
- ) => {
- if (elements.length === 0) {
+ const updateEditableChildOutline = (instanceSelector: InstanceSelector) => {
+ if (isScrolling) {
return;
}
@@ -93,6 +117,47 @@ export const subscribeInstanceHovering = ({
return;
}
+ const editableBlockChildSelector =
+ findEditableBlockChildSelector(instanceSelector);
+
+ if (editableBlockChildSelector === undefined) {
+ $editableBlockChildOutline.set(undefined);
+ return;
+ }
+
+ const editableBlockChildElements = getVisibleElementsByInstanceSelector(
+ editableBlockChildSelector
+ );
+ const editableBlockChildRect = getAllElementsBoundingBox(
+ editableBlockChildElements
+ );
+
+ if (editableBlockChildRect === undefined) {
+ $editableBlockChildOutline.set(undefined);
+ return;
+ }
+
+ $editableBlockChildOutline.set({
+ selector: editableBlockChildSelector,
+ rect: editableBlockChildRect,
+ });
+ };
+
+ const updateHoveredRect = (instanceSelector: Readonly<InstanceSelector>) => {
+ if (isScrolling) {
+ return;
+ }
+
+ if (instanceSelector.length === 0) {
+ return;
+ }
+
+ const elements = getVisibleElementsByInstanceSelector(instanceSelector);
+
+ if (elements.length === 0) {
+ return;
+ }
+
const [instanceId] = instanceSelector;
const instances = $instances.get();
const instance = instances.get(instanceId);
@@ -100,12 +165,10 @@ export const subscribeInstanceHovering = ({
return;
}
- if (!isScrolling) {
- $hoveredInstanceOutline.set({
- instanceId: instance.id,
- rect: getAllElementsBoundingBox(elements),
- });
- }
+ $hoveredInstanceOutline.set({
+ instanceId: instance.id,
+ rect: getAllElementsBoundingBox(elements),
+ });
};
// remove hover outline when scroll starts
@@ -114,6 +177,7 @@ export const subscribeInstanceHovering = ({
onScrollStart() {
isScrolling = true;
$hoveredInstanceOutline.set(undefined);
+ $editableBlockChildOutline.set(undefined);
},
onScrollEnd() {
isScrolling = false;
@@ -124,7 +188,7 @@ export const subscribeInstanceHovering = ({
return;
}
- updateHoveredRect([hoveredElement], instanceSelector);
+ updateHoveredRect(instanceSelector);
}
},
});
@@ -133,8 +197,7 @@ export const subscribeInstanceHovering = ({
const unsubscribeHoveredInstanceId = $hoveredInstanceSelector.subscribe(
(instanceSelector) => {
if (instanceSelector) {
- const elements = getVisibleElementsByInstanceSelector(instanceSelector);
- updateHoveredRect(elements, instanceSelector);
+ updateHoveredRect(instanceSelector);
} else {
$hoveredInstanceOutline.set(undefined);
}
diff --git a/apps/builder/app/shared/nano-states/canvas.ts b/apps/builder/app/shared/nano-states/canvas.ts
index 26d5ddfaeb..9352298722 100644
--- a/apps/builder/app/shared/nano-states/canvas.ts
+++ b/apps/builder/app/shared/nano-states/canvas.ts
@@ -3,6 +3,7 @@ import type { Instance, Instances } from "@webstudio-is/sdk";
import type { FontWeight } from "@webstudio-is/fonts";
import { $instances } from "./instances";
import type { InstanceSelector } from "../tree-utils";
+import { editableBlockComponent } from "@webstudio-is/react-sdk";
export type TextToolbarState = {
selectionRect: undefined | DOMRect;
@@ -21,6 +22,11 @@ type InstanceOutline = {
rect: DOMRect;
};
+export type EditableBlockChildOutline = {
+ selector: InstanceSelector;
+ rect: DOMRect;
+};
+
const getInstanceOutlineAndInstance = (
instances: Instances,
instanceOutline: undefined | InstanceOutline
@@ -63,6 +69,26 @@ export const $collaborativeInstanceSelector = atom<
export const $collaborativeInstanceRect = atom<undefined | DOMRect>(undefined);
+export const $editableBlockChildOutline = atom<
+ undefined | EditableBlockChildOutline
+>(undefined);
+
+export const findEditableBlockChildSelector = (
+ instanceSelector: InstanceSelector
+) => {
+ const instances = $instances.get();
+ let editableBlockChildSelector: InstanceSelector | undefined = undefined;
+
+ for (let i = 1; i < instanceSelector.length; ++i) {
+ const instance = instances.get(instanceSelector[i]);
+ if (instance?.component === editableBlockComponent) {
+ editableBlockChildSelector = instanceSelector.slice(i - 1);
+
+ return editableBlockChildSelector;
+ }
+ }
+};
+
export const $canvasIframeState = atom<"idle" | "ready">("idle");
export const $detectedFontsWeights = atom<Map<string, Array<FontWeight>>>(
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index f518421153..8e2863d077 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -41,6 +41,7 @@ import {
$collaborativeInstanceSelector,
$hoveredInstanceOutline,
$selectedInstanceOutline,
+ $editableBlockChildOutline,
$textToolbar,
$registeredComponentMetas,
$registeredComponentPropsMetas,
@@ -137,6 +138,11 @@ const createObjectPool = () => {
$selectedInstanceOutline
),
new NanostoresSyncObject("hoveredInstanceOutline", $hoveredInstanceOutline),
+ new NanostoresSyncObject(
+ "editableBlockChildOutline",
+ $editableBlockChildOutline
+ ),
+
new NanostoresSyncObject(
"collaborativeInstanceSelector",
$collaborativeInstanceSelector
diff --git a/packages/react-sdk/src/core-components.ts b/packages/react-sdk/src/core-components.ts
index 0ca2ff8a9a..b90752b0fe 100644
--- a/packages/react-sdk/src/core-components.ts
+++ b/packages/react-sdk/src/core-components.ts
@@ -1,7 +1,9 @@
import {
+ EditIcon,
ListViewIcon,
PaintBrushIcon,
SettingsIcon,
+ TriggerIcon,
} from "@webstudio-is/icons/svg";
import { html } from "@webstudio-is/sdk/normalize.css";
import type {
@@ -124,16 +126,66 @@ const descendantPropsMeta: WsComponentPropsMeta = {
initialProps: ["selector"],
};
+export const editableBlockTemplateComponent = "ws:editable-block-template";
+
+export const editableBlockTemplateMeta: WsComponentMeta = {
+ category: "hidden",
+ detachable: false,
+ type: "container",
+ icon: TriggerIcon,
+ stylable: false,
+};
+
+const editableBlockTemplatePropsMeta: WsComponentPropsMeta = {
+ props: {},
+ initialProps: [],
+};
+
+export const editableBlockComponent = "ws:editable-block";
+
+const editableBlockMeta: WsComponentMeta = {
+ category: "data",
+ order: 2,
+ type: "container",
+ label: "Editable Block",
+ icon: EditIcon,
+ stylable: false,
+ template: [
+ {
+ type: "instance",
+ component: editableBlockComponent,
+ props: [],
+ children: [
+ {
+ type: "instance",
+ label: "Templates",
+ component: editableBlockTemplateComponent,
+ children: [],
+ },
+ ],
+ },
+ ],
+};
+
+const editableBlockPropsMeta: WsComponentPropsMeta = {
+ props: {},
+ initialProps: [],
+};
+
export const coreMetas = {
[rootComponent]: rootMeta,
[collectionComponent]: collectionMeta,
[descendantComponent]: descendantMeta,
+ [editableBlockComponent]: editableBlockMeta,
+ [editableBlockTemplateComponent]: editableBlockTemplateMeta,
};
export const corePropsMetas = {
[rootComponent]: rootPropsMeta,
[collectionComponent]: collectionPropsMeta,
[descendantComponent]: descendantPropsMeta,
+ [editableBlockComponent]: editableBlockPropsMeta,
+ [editableBlockTemplateComponent]: editableBlockTemplatePropsMeta,
};
// components with custom implementation
@@ -141,4 +193,6 @@ export const corePropsMetas = {
export const isCoreComponent = (component: string) =>
component === rootComponent ||
component === collectionComponent ||
- component === descendantComponent;
+ component === descendantComponent ||
+ component === editableBlockComponent ||
+ component === editableBlockTemplateComponent;