Skip to content

feat: wrap text with span element when droppping instances into it #5237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged

feat: wrap text with span element when droppping instances into it #5237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 148 additions & 138 deletions apps/builder/app/shared/instance-utils.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import type {
Asset,
Breakpoint,
Instance,
Prop,
StyleDecl,
StyleDeclKey,
StyleSource,
Expand Down Expand Up @@ -172,175 +171,186 @@ const createFontAsset = (id: string, family: string): Asset => {

describe("insert instance children", () => {
test("insert instance children into empty target", () => {
const instances = toMap([createInstance("body", "Body", [])]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId"></ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["bodyId"],
position: "end",
});
expect(data.instances).toEqual(
toMap([createInstance("body", "Body", [{ type: "id", value: "box" }])])
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="divId"></ws.element>
</ws.element>
)
);
});

test("insert instance children into the end of target", () => {
const instances = toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId"></ws.element>
</ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["bodyId"],
position: "end",
});
expect(data.instances).toEqual(
toMap([
createInstance("body", "Body", [
{ type: "id", value: "text" },
{ type: "id", value: "box" },
]),
])
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId"></ws.element>
<ws.element ws:tag="div" ws:id="divId"></ws.element>
</ws.element>
)
);
});

test("insert instance children into the start of target", () => {
const instances = toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId"></ws.element>
</ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["bodyId"],
position: 0,
});
expect(data.instances).toEqual(
toMap([
createInstance("body", "Body", [
{ type: "id", value: "box" },
{ type: "id", value: "text" },
]),
])
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="divId"></ws.element>
<ws.element ws:tag="div" ws:id="textId"></ws.element>
</ws.element>
)
);
});

test("insert instance children at the start of text", () => {
const instances = toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [{ type: "text", value: "text" }]),
]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["text", "body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
text
</ws.element>
</ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["textId", "bodyId"],
position: 0,
});
const [_bodyId, _textId, spanId] = data.instances.keys();
expect(data.instances).toEqual(
toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [
{ type: "id", value: "box" },
{ type: "id", value: spanId },
]),
createInstance(spanId, "Text", [{ type: "text", value: "text" }]),
])
);
expect(data.props).toEqual(
toMap<Prop>([
{
id: expect.any(String) as unknown as string,
instanceId: spanId,
name: "tag",
type: "string",
value: "span",
},
])
const [_bodyId, _textId, _divId, spanId] = data.instances.keys();
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
<ws.element ws:tag="div" ws:id="divId"></ws.element>
<ws.element ws:tag="span" ws:id={spanId}>
text
</ws.element>
</ws.element>
</ws.element>
)
);
});

test("insert instance children at the end of text", () => {
const instances = toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [{ type: "text", value: "text" }]),
]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["text", "body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
text
</ws.element>
</ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["textId", "bodyId"],
position: "end",
});
const [_bodyId, _textId, spanId] = data.instances.keys();
expect(data.instances).toEqual(
toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [
{ type: "id", value: spanId },
{ type: "id", value: "box" },
]),
createInstance(spanId, "Text", [{ type: "text", value: "text" }]),
])
);
expect(data.props).toEqual(
toMap<Prop>([
{
id: expect.any(String) as unknown as string,
instanceId: spanId,
name: "tag",
type: "string",
value: "span",
},
])
const [_bodyId, _textId, _divId, spanId] = data.instances.keys();
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
<ws.element ws:tag="span" ws:id={spanId}>
text
</ws.element>
<ws.element ws:tag="div" ws:id="divId"></ws.element>
</ws.element>
</ws.element>
)
);
});

test("insert instance children between text children", () => {
const instances = toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [
{ type: "id", value: "bold" },
{ type: "text", value: "text" },
{ type: "id", value: "italic" },
]),
createInstance("bold", "Bold", [{ type: "text", value: "bold" }]),
createInstance("italic", "Italic", [{ type: "text", value: "italic" }]),
]);
const data = getWebstudioDataStub({ instances });
insertInstanceChildrenMutable(data, [{ type: "id", value: "box" }], {
parentSelector: ["text", "body"],
const data = renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
<ws.element ws:tag="strong" ws:id="strongId">
strong
</ws.element>
text
<ws.element ws:tag="em" ws:id="emId">
emphasis
</ws.element>
</ws.element>
</ws.element>
);
const [div] = renderTemplate(
<ws.element ws:tag="div" ws:id="divId"></ws.element>
).instances;
data.instances.set(div.id, div);
insertInstanceChildrenMutable(data, [{ type: "id", value: "divId" }], {
parentSelector: ["textId", "bodyId"],
position: 1,
});
const [_bodyId, _textId, _boldId, _italicId, leftSpanId, rightSpanId] =
data.instances.keys();
expect(data.instances).toEqual(
toMap([
createInstance("body", "Body", [{ type: "id", value: "text" }]),
createInstance("text", "Text", [
{ type: "id", value: leftSpanId },
{ type: "id", value: "box" },
{ type: "id", value: rightSpanId },
]),
createInstance("bold", "Bold", [{ type: "text", value: "bold" }]),
createInstance("italic", "Italic", [{ type: "text", value: "italic" }]),
createInstance(leftSpanId, "Text", [{ type: "id", value: "bold" }]),
createInstance(rightSpanId, "Text", [
{ type: "text", value: "text" },
{ type: "id", value: "italic" },
]),
])
);
expect(data.props).toEqual(
toMap<Prop>([
{
id: expect.any(String) as unknown as string,
instanceId: leftSpanId,
name: "tag",
type: "string",
value: "span",
},
{
id: expect.any(String) as unknown as string,
instanceId: rightSpanId,
name: "tag",
type: "string",
value: "span",
},
])
const [
_bodyId,
_textId,
_strongId,
_emId,
_divId,
leftSpanId,
rightSpanId,
] = data.instances.keys();
expect(data).toEqual(
renderData(
<ws.element ws:tag="body" ws:id="bodyId">
<ws.element ws:tag="div" ws:id="textId">
<ws.element ws:tag="span" ws:id={leftSpanId}>
<ws.element ws:tag="strong" ws:id="strongId">
strong
</ws.element>
</ws.element>
<ws.element ws:tag="div" ws:id="divId"></ws.element>
<ws.element ws:tag="span" ws:id={rightSpanId}>
text
<ws.element ws:tag="em" ws:id="emId">
emphasis
</ws.element>
</ws.element>
</ws.element>
</ws.element>
)
);
});
});
Expand Down
2 changes: 1 addition & 1 deletion apps/builder/app/shared/instance-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ export const findAllEditableInstanceSelector = ({
};

export const insertInstanceChildrenMutable = (
data: WebstudioData,
data: Omit<WebstudioData, "pages">,
children: Instance["children"],
insertTarget: Insertable
) => {
Expand Down
Loading