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.

Instance name setting (#1146)

Oleg Isonen040d30778de2
diff --git a/apps/builder/app/builder/features/inspector/inspector.tsx b/apps/builder/app/builder/features/inspector/inspector.tsx
index 7ad444a28f..bbf5e233c9 100644
--- a/apps/builder/app/builder/features/inspector/inspector.tsx
+++ b/apps/builder/app/builder/features/inspector/inspector.tsx
@@ -18,6 +18,7 @@ import { PropsPanel } from "~/builder/features/props-panel";
import { FloatingPanelProvider } from "~/builder/shared/floating-panel";
import { theme } from "@webstudio-is/design-system";
import { selectedInstanceStore } from "~/shared/nano-states";
+import { SettingsPanel } from "../settings-panel";
type InspectorProps = {
publish: Publish;
@@ -55,17 +56,17 @@ export const Inspector = ({ publish }: InspectorProps) => {
skipDelayDuration={0}
>
<FloatingPanelProvider container={tabsRef}>
- <Flex as={Tabs} defaultValue="style" ref={tabsRef}>
+ <Flex as={Tabs} defaultValue="style" grow ref={tabsRef}>
<TabsList>
<TabsTrigger value="style">
<DeprecatedText2>Style</DeprecatedText2>
</TabsTrigger>
{/* @note: events would be part of props */}
<TabsTrigger value="props">
- <DeprecatedText2>Props</DeprecatedText2>
+ <DeprecatedText2>Properties</DeprecatedText2>
</TabsTrigger>
- <TabsTrigger value="inspect">
- <DeprecatedText2>Inspect</DeprecatedText2>
+ <TabsTrigger value="settings">
+ <DeprecatedText2>Settings</DeprecatedText2>
</TabsTrigger>
</TabsList>
<TabsContent value="style" css={contentStyle}>
@@ -78,6 +79,9 @@ export const Inspector = ({ publish }: InspectorProps) => {
selectedInstance={selectedInstance}
/>
</TabsContent>
+ <TabsContent value="settings" css={contentStyle}>
+ <SettingsPanel selectedInstance={selectedInstance} />
+ </TabsContent>
</Flex>
</FloatingPanelProvider>
</EnhancedTooltipProvider>
diff --git a/apps/builder/app/builder/features/settings-panel/index.ts b/apps/builder/app/builder/features/settings-panel/index.ts
new file mode 100644
index 0000000000..ebb719d4d4
--- /dev/null
+++ b/apps/builder/app/builder/features/settings-panel/index.ts
@@ -0,0 +1 @@
+export * from "./settings-panel";
diff --git a/apps/builder/app/builder/features/settings-panel/settings-panel.tsx b/apps/builder/app/builder/features/settings-panel/settings-panel.tsx
new file mode 100644
index 0000000000..ac2fa0c35a
--- /dev/null
+++ b/apps/builder/app/builder/features/settings-panel/settings-panel.tsx
@@ -0,0 +1,31 @@
+import { Flex, Label, TextField, theme } from "@webstudio-is/design-system";
+import type { Instance } from "@webstudio-is/project-build";
+import { getComponentMeta } from "@webstudio-is/react-sdk";
+import { useSettingsLogic } from "./use-settings-logic";
+
+type SettingsPanelProps = {
+ selectedInstance: Instance;
+};
+
+export const SettingsPanel = ({ selectedInstance }: SettingsPanelProps) => {
+ const { setLabel, handleBlur, handleKeyDown } = useSettingsLogic({
+ selectedInstance,
+ });
+ const label = getComponentMeta(selectedInstance.component)?.label;
+ return (
+ <Flex css={{ px: theme.spacing[9] }}>
+ <Flex gap="1" direction="column" grow>
+ <Label>Instance Name</Label>
+ <TextField
+ onBlur={handleBlur}
+ onKeyDown={handleKeyDown}
+ placeholder={label}
+ defaultValue={selectedInstance.label}
+ onChange={(event) => {
+ setLabel(event.target.value.trim());
+ }}
+ />
+ </Flex>
+ </Flex>
+ );
+};
diff --git a/apps/builder/app/builder/features/settings-panel/use-settings-logic.ts b/apps/builder/app/builder/features/settings-panel/use-settings-logic.ts
new file mode 100644
index 0000000000..5556f82bc6
--- /dev/null
+++ b/apps/builder/app/builder/features/settings-panel/use-settings-logic.ts
@@ -0,0 +1,40 @@
+import type { Instance } from "@webstudio-is/project-build";
+import store from "immerhin";
+import { type KeyboardEventHandler, useRef } from "react";
+import { instancesStore } from "~/shared/nano-states";
+
+type SettingUpdate = { label?: string };
+
+export const useSettingsLogic = ({
+ selectedInstance,
+}: {
+ selectedInstance: Instance;
+}) => {
+ const changes = useRef<SettingUpdate>({});
+
+ const setLabel = (value: SettingUpdate[keyof SettingUpdate]) => {
+ // Empty string should be replaced with `undefined` so that we can render default label
+ changes.current.label = value || undefined;
+ };
+
+ const updateLabel = () => {
+ store.createTransaction([instancesStore], (instances) => {
+ const instance = instances.get(selectedInstance.id);
+ if (instance !== undefined) {
+ instance.label = changes.current.label;
+ }
+ });
+ };
+
+ const handleKeyDown: KeyboardEventHandler = (event) => {
+ if (event.key === "Enter") {
+ updateLabel();
+ }
+ };
+
+ return {
+ setLabel,
+ handleBlur: updateLabel,
+ handleKeyDown,
+ };
+};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/drop-target-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/drop-target-outline.tsx
index b1b9cfaa3b..467e551214 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/drop-target-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/drop-target-outline.tsx
@@ -9,10 +9,7 @@ export const DropTargetOutline = ({
}) => {
return (
<Outline rect={dropTarget.rect}>
- <Label
- component={dropTarget.instance.component}
- instanceRect={dropTarget.rect}
- />
+ <Label instance={dropTarget.instance} instanceRect={dropTarget.rect} />
</Outline>
);
};
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 4583a0b0d9..bb500c333e 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
@@ -2,6 +2,7 @@ import { useStore } from "@nanostores/react";
import {
hoveredInstanceIdStore,
hoveredInstanceOutlineStore,
+ instancesStore,
selectedInstanceIdStore,
useTextEditingInstanceId,
} from "~/shared/nano-states";
@@ -13,12 +14,16 @@ export const HoveredInstanceOutline = () => {
const hoveredInstanceId = useStore(hoveredInstanceIdStore);
const instanceOutline = useStore(hoveredInstanceOutlineStore);
const [textEditingInstanceId] = useTextEditingInstanceId();
+ const instances = useStore(instancesStore);
const isEditingText = textEditingInstanceId !== undefined;
const isHoveringSelectedInstance = selectedInstanceId === hoveredInstanceId;
+ const instance = hoveredInstanceId
+ ? instances.get(hoveredInstanceId)
+ : undefined;
if (
- hoveredInstanceId === undefined ||
+ instance === undefined ||
instanceOutline === undefined ||
isHoveringSelectedInstance ||
isEditingText
@@ -28,10 +33,7 @@ export const HoveredInstanceOutline = () => {
return (
<Outline rect={instanceOutline.rect}>
- <Label
- component={instanceOutline.component}
- instanceRect={instanceOutline.rect}
- />
+ <Label instance={instance} instanceRect={instanceOutline.rect} />
</Outline>
);
};
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 a716751f86..9be4893a5b 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
@@ -3,6 +3,7 @@ import { styled, type Rect } from "@webstudio-is/design-system";
import type { Instance } from "@webstudio-is/project-build";
import { getComponentMeta } from "@webstudio-is/react-sdk";
import { theme } from "@webstudio-is/design-system";
+import { getInstanceLabel } from "~/builder/shared/tree";
type LabelPosition = "top" | "inside" | "bottom";
type LabelRefCallback = (element: HTMLElement | null) => void;
@@ -72,20 +73,20 @@ const LabelContainer = styled(
);
type LabelProps = {
- component: Instance["component"];
+ instance: { label?: string; component: Instance["component"] };
instanceRect: Rect;
};
-export const Label = ({ component, instanceRect }: LabelProps) => {
+export const Label = ({ instance, instanceRect }: LabelProps) => {
const [labelRef, position] = useLabelPosition(instanceRect);
- const meta = getComponentMeta(component);
+ const meta = getComponentMeta(instance?.component);
if (meta === undefined) {
return <></>;
}
return (
<LabelContainer position={position} ref={labelRef}>
<meta.Icon width="1em" height="1em" />
- {meta.label}
+ {getInstanceLabel(instance, meta)}
</LabelContainer>
);
};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
index 1f49d8e425..43b418233e 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
@@ -27,7 +27,7 @@ export const SelectedInstanceOutline = () => {
return (
<Outline rect={rect}>
- <Label component={selectedInstance.component} instanceRect={rect} />
+ <Label instance={selectedInstance} instanceRect={rect} />
</Outline>
);
};
diff --git a/apps/builder/app/builder/shared/inspector/component-info.tsx b/apps/builder/app/builder/shared/inspector/component-info.tsx
index 9a4ca5f9c4..4c898367f0 100644
--- a/apps/builder/app/builder/shared/inspector/component-info.tsx
+++ b/apps/builder/app/builder/shared/inspector/component-info.tsx
@@ -1,24 +1,22 @@
import type { Instance } from "@webstudio-is/project-build";
import { getComponentMeta } from "@webstudio-is/react-sdk";
-import { Flex, DeprecatedText2 } from "@webstudio-is/design-system";
-import { theme } from "@webstudio-is/design-system";
+import { Flex, Text } from "@webstudio-is/design-system";
+import { getInstanceLabel } from "../tree";
export const ComponentInfo = ({
selectedInstance,
}: {
selectedInstance: Instance;
}) => {
+ const meta = getComponentMeta(selectedInstance.component);
+ if (meta === undefined) {
+ return null;
+ }
return (
<Flex justify="between" align="center">
- <DeprecatedText2
- css={{
- fontSize: theme.deprecatedFontSize[3],
- color: theme.colors.slate11,
- fontWeight: "500",
- }}
- >{`Selected: ${
- getComponentMeta(selectedInstance.component)?.label
- }`}</DeprecatedText2>
+ <Text>{`Selected: ${getInstanceLabel(selectedInstance, meta)} (${
+ meta.label
+ })`}</Text>
</Flex>
);
};
diff --git a/apps/builder/app/builder/shared/tree/index.tsx b/apps/builder/app/builder/shared/tree/index.tsx
index dbee3d677b..e368b90bc4 100644
--- a/apps/builder/app/builder/shared/tree/index.tsx
+++ b/apps/builder/app/builder/shared/tree/index.tsx
@@ -10,7 +10,10 @@ import {
type TreeItemRenderProps,
} from "@webstudio-is/design-system";
import type { Instance } from "@webstudio-is/project-build";
-import { getComponentMeta } from "@webstudio-is/react-sdk";
+import {
+ getComponentMeta,
+ type WsComponentMeta,
+} from "@webstudio-is/react-sdk";
import { utils } from "@webstudio-is/project";
import { instancesIndexStore } from "~/shared/nano-states";
import { getInstanceAncestorsAndSelf } from "~/shared/tree-utils";
@@ -50,7 +53,9 @@ const instanceRelatedProps = {
}
return (
<TreeItemBody {...props} selectionEvent="focus">
- <TreeItemLabel prefix={<meta.Icon />}>{meta.label}</TreeItemLabel>
+ <TreeItemLabel prefix={<meta.Icon />}>
+ {getInstanceLabel(props.itemData, meta)}
+ </TreeItemLabel>
</TreeItemBody>
);
},
@@ -98,3 +103,10 @@ export const InstanceTreeNode = (
renderItem={instanceRelatedProps.renderItem}
/>
);
+
+export const getInstanceLabel = (
+ instance: { label?: string },
+ meta: WsComponentMeta
+) => {
+ return instance.label || meta.label;
+};
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 c60cce22c9..072ca803b2 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -7,6 +7,7 @@ import type { Instance, Prop } from "@webstudio-is/project-build";
import {
renderWebstudioComponentChildren,
idAttribute,
+ componentAttribute,
} from "@webstudio-is/react-sdk";
import type { GetComponent } from "@webstudio-is/react-sdk";
import {
@@ -97,7 +98,7 @@ export const WebstudioComponentDev = ({
// we should replace id, data-component and data-id with "data-ws"=instance.id and grab the rest always over the id
// for this we need to also make search by id fast
id: instance.id,
- "data-ws-component": instance.component,
+ [componentAttribute]: instance.component,
[idAttribute]: instance.id,
onClick: (event: MouseEvent) => {
if (
diff --git a/apps/builder/app/canvas/hovered-instance-connector.ts b/apps/builder/app/canvas/hovered-instance-connector.ts
index 6042cad1c9..9e47128a22 100644
--- a/apps/builder/app/canvas/hovered-instance-connector.ts
+++ b/apps/builder/app/canvas/hovered-instance-connector.ts
@@ -47,13 +47,12 @@ const startHoveredInstanceConnection = () => {
// debounce is used to avoid laggy hover because of iframe message delay
const updateHoveredRect = debounce((element: Element) => {
- const component = element.getAttribute("data-ws-component") ?? undefined;
- if (component === undefined) {
+ const instanceId = element.getAttribute(idAttribute) ?? undefined;
+ if (instanceId === undefined) {
return;
}
hoveredInstanceOutlineStore.set({
- // store component in outline to show correct label when hover over elements fast
- component: component,
+ instanceId,
rect: element.getBoundingClientRect(),
});
}, 50);
diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.ts
index 31191a6186..dc9a9d1e9f 100644
--- a/apps/builder/app/canvas/shared/styles.ts
+++ b/apps/builder/app/canvas/shared/styles.ts
@@ -11,6 +11,7 @@ import {
import type { StyleDecl } from "@webstudio-is/project-build";
import {
collapsedAttribute,
+ componentAttribute,
getComponentMeta,
getComponentNames,
idAttribute,
@@ -132,9 +133,12 @@ export const GlobalStyles = () => {
const meta = getComponentMeta(component);
const presetStyle = meta?.presetStyle;
if (presetStyle !== undefined) {
- presetStylesEngine.addStyleRule(`[data-ws-component=${component}]`, {
- style: presetStyle,
- });
+ presetStylesEngine.addStyleRule(
+ `[${componentAttribute}=${component}]`,
+ {
+ style: presetStyle,
+ }
+ );
}
}
presetStylesEngine.render();
diff --git a/apps/builder/app/canvas/shared/use-track-selected-element.ts b/apps/builder/app/canvas/shared/use-track-selected-element.ts
index 8e6cdabd9b..426f463fa4 100644
--- a/apps/builder/app/canvas/shared/use-track-selected-element.ts
+++ b/apps/builder/app/canvas/shared/use-track-selected-element.ts
@@ -8,6 +8,7 @@ import {
} from "~/shared/nano-states";
import { publish } from "~/shared/pubsub";
import { findClosestRichTextInstance } from "~/shared/tree-utils";
+import { componentAttribute } from "@webstudio-is/react-sdk";
declare module "~/shared/pubsub" {
export interface PubsubMap {
@@ -45,7 +46,7 @@ export const useTrackSelectedElement = () => {
// If we click on an element that is not a component, we search for a parent component.
if (element.dataset.wsComponent === undefined) {
const instanceElement = element.closest<HTMLElement>(
- "[data-ws-component]"
+ `[${componentAttribute}]`
);
if (instanceElement === null) {
return;
diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.ts
index cc77e10c5e..008b4ca828 100644
--- a/apps/builder/app/shared/nano-states/nano-states.ts
+++ b/apps/builder/app/shared/nano-states/nano-states.ts
@@ -97,6 +97,7 @@ export const patchInstancesMutable = (
}
};
+// @todo will be removed soon
const denormalizeTree = (
instances: Instances,
rootInstanceId: Instance["id"]
@@ -106,6 +107,7 @@ const denormalizeTree = (
type: "instance",
id: instance.id,
component: instance.component,
+ label: instance.label,
children: [],
};
for (const child of instance.children) {
@@ -385,7 +387,7 @@ export const hoveredInstanceIdStore = atom<undefined | Instance["id"]>(
undefined
);
export const hoveredInstanceOutlineStore = atom<
- undefined | { component: string; rect: DOMRect }
+ undefined | { instanceId: Instance["id"]; rect: DOMRect }
>(undefined);
export const isPreviewModeStore = atom<boolean>(false);
diff --git a/packages/project-build/src/schema/instances.ts b/packages/project-build/src/schema/instances.ts
index 8288cc33a4..249eceff39 100644
--- a/packages/project-build/src/schema/instances.ts
+++ b/packages/project-build/src/schema/instances.ts
@@ -5,6 +5,7 @@ import { z } from "zod";
export type BaseInstance = {
id: string;
component: string;
+ label?: string;
};
export type Instance = BaseInstance & {
@@ -38,6 +39,7 @@ export const InstancesItem = z.object({
type: z.literal("instance"),
id: InstanceId,
component: z.string(),
+ label: z.string().optional(),
children: z.array(z.union([Id, Text])),
});
@@ -56,6 +58,7 @@ export const Instance: z.ZodType<Instance> = z.lazy(() =>
type: z.literal("instance"),
id: z.string(),
component: z.string(),
+ label: z.string().optional(),
children: z.array(z.union([Instance, Text])),
})
);
diff --git a/packages/project/src/shared/styles/css.ts b/packages/project/src/shared/styles/css.ts
index e95bc08573..fdf6e1a6e4 100644
--- a/packages/project/src/shared/styles/css.ts
+++ b/packages/project/src/shared/styles/css.ts
@@ -2,6 +2,7 @@ import { createCssEngine } from "@webstudio-is/css-engine";
import type { Asset } from "@webstudio-is/asset-uploader";
import type { Build } from "@webstudio-is/project-build";
import {
+ componentAttribute,
getComponentMeta,
getComponentNames,
idAttribute,
@@ -36,7 +37,7 @@ export const generateCssText = (data: Data) => {
const meta = getComponentMeta(component);
const presetStyle = meta?.presetStyle;
if (presetStyle !== undefined) {
- engine.addStyleRule(`[data-ws-component=${component}]`, {
+ engine.addStyleRule(`[${componentAttribute}=${component}]`, {
style: presetStyle,
});
}