Skip to content

VE-6559:add isOpenInBuilder utility function and integrate into VisualBuilder components #446

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
SahilCs15 merged 1 commit into from
Jun 16, 2025
Merged

VE-6559:add isOpenInBuilder utility function and integrate into VisualBuilder components #446

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
11 changes: 10 additions & 1 deletion src/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,13 @@ export function isOpeningInTimeline(): boolean {
return !!previewTimestamp;
}
return false;
}
}

export function isOpenInBuilder(): boolean {
if (hasWindow()) {
const urlParams = new URLSearchParams(window.location.search);
const builder = urlParams.get("builder");
return !!builder;
}
return false;
}
15 changes: 13 additions & 2 deletions src/visualBuilder/__test__/click/fields/boolean.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -107,7 +116,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(booleanField);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, booleanField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
booleanField
);
});

afterAll(() => {
Expand Down Expand Up @@ -147,7 +159,6 @@ describe("When an element is clicked in visual builder mode", () => {
});

test("should send a focus field message to parent", async () => {

await waitFor(() => {
expect(visualBuilderPostMessage?.send).toBeCalledWith(
VisualBuilderPostMessageEvents.FOCUS_FIELD,
Expand Down
14 changes: 13 additions & 1 deletion src/visualBuilder/__test__/click/fields/date.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -107,7 +116,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(dateField);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, dateField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
dateField
);
});

afterAll(() => {
Expand Down
19 changes: 17 additions & 2 deletions src/visualBuilder/__test__/click/fields/file.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -105,7 +114,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(fileField);
document.body.appendChild(imageField);
visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, fileField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
fileField
);
});

afterAll(() => {
Expand Down Expand Up @@ -202,7 +214,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
Expand Down
19 changes: 17 additions & 2 deletions src/visualBuilder/__test__/click/fields/group.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -98,7 +107,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(groupField);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, groupField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
groupField
);
});

afterAll(() => {
Expand Down Expand Up @@ -190,7 +202,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
Expand Down
19 changes: 17 additions & 2 deletions src/visualBuilder/__test__/click/fields/html-rte.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -96,7 +105,10 @@ describe("When an element is clicked in visual builder mode", () => {
);
document.body.appendChild(htmlRteField);
visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, htmlRteField)
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
htmlRteField
);
});

afterAll(() => {
Expand Down Expand Up @@ -177,7 +189,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});
afterAll(() => {
visualBuilder.destroy();
Expand Down
19 changes: 17 additions & 2 deletions src/visualBuilder/__test__/click/fields/json-rte.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
let mouseClickEvent: Event;

Expand Down Expand Up @@ -97,7 +106,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(jsonRteField);
visualBuilder = new VisualBuilder();

await triggerAndWaitForClickAction(visualBuilderPostMessage, jsonRteField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
jsonRteField
);
});

afterAll(() => {
Expand Down Expand Up @@ -178,7 +190,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
Expand Down
19 changes: 17 additions & 2 deletions src/visualBuilder/__test__/click/fields/link.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
beforeAll(() => {
FieldSchemaMap.setFieldSchema(
Expand Down Expand Up @@ -91,7 +100,10 @@ describe("When an element is clicked in visual builder mode", () => {

document.body.appendChild(linkField);
visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, linkField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
linkField
);
});

afterAll(() => {
Expand Down Expand Up @@ -173,7 +185,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
Expand Down
20 changes: 17 additions & 3 deletions src/visualBuilder/__test__/click/fields/markdown.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,16 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

describe("When an element is clicked in visual builder mode", () => {
vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
beforeAll(() => {
FieldSchemaMap.setFieldSchema(
"all_fields",
Expand Down Expand Up @@ -93,7 +101,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(markdownField);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, markdownField);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
markdownField
);
});

afterAll(() => {
Expand Down Expand Up @@ -174,7 +185,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(container);

visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
Expand Down
23 changes: 18 additions & 5 deletions src/visualBuilder/__test__/click/fields/multi-line.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,16 @@ vi.mock("../../../utils/visualBuilderPostMessage", async () => {
};
});

describe("When an element is clicked in visual builder mode", () => {
vi.mock("../../../../utils/index.ts", async () => {
const actual = await vi.importActual("../../../../utils");
return {
__esModule: true,
...actual,
isOpenInBuilder: vi.fn().mockReturnValue(true),
};
});

describe("When an element is clicked in visual builder mode", () => {
beforeAll(async () => {
FieldSchemaMap.setFieldSchema(
"all_fields",
Expand Down Expand Up @@ -115,7 +123,10 @@ describe("When an element is clicked in visual builder mode", () => {
document.body.appendChild(multiLineField);
visualBuilder = new VisualBuilder();

await triggerAndWaitForClickAction(visualBuilderPostMessage, multiLineField)
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
multiLineField
);
});

afterAll(() => {
Expand Down Expand Up @@ -222,12 +233,15 @@ describe("When an element is clicked in visual builder mode", () => {
audienceMode: false,
};
visualBuilder = new VisualBuilder();
await triggerAndWaitForClickAction(visualBuilderPostMessage, container);
await triggerAndWaitForClickAction(
visualBuilderPostMessage,
container
);
});

afterAll(() => {
visualBuilder.destroy();
})
});
test("should have outline", () => {
expect(container.classList.contains("cslp-edit-mode"));
});
Expand All @@ -252,7 +266,6 @@ describe("When an element is clicked in visual builder mode", () => {
VISUAL_BUILDER_FIELD_TYPE_ATTRIBUTE_KEY
);
});

});

test("container should not contain a contenteditable attribute but the children can", async () => {
Expand Down
Loading
Loading