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.

Sync pages change (#1856)

Ivan Starkovcba00105dbeb
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index e26532f5a4..f9e8a46a23 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -23,9 +23,6 @@ import {
import { usePublishShortcuts } from "./shared/shortcuts";
import {
projectStore,
- selectedInstanceSelectorStore,
- selectedPageIdStore,
- selectedPageStore,
useIsPreviewMode,
useSetAssets,
useSetAuthPermit,
@@ -44,10 +41,9 @@ import { type Settings, useClientSettings } from "./shared/client-settings";
import { getBuildUrl } from "~/shared/router-utils";
import { useCopyPaste } from "~/shared/copy-paste";
import type { Asset } from "@webstudio-is/asset-uploader";
-import { useSearchParams } from "@remix-run/react";
-import { useSyncInitializeOnce } from "~/shared/hook-utils";
import { BlockingAlerts } from "./features/blocking-alerts";
import { useStore } from "@nanostores/react";
+import { useSyncPageUrl } from "~/shared/pages";
registerContainers();
@@ -243,6 +239,7 @@ export const Builder = ({
authToken,
authPermit,
}: BuilderProps) => {
+ useSetProject(project);
useSetPages(build.pages);
useSetBreakpoints(build.breakpoints);
useSetProps(build.props);
@@ -252,29 +249,12 @@ export const Builder = ({
useSetStyleSourceSelections(build.styleSourceSelections);
useSetInstances(build.instances);
- const [searchParams] = useSearchParams();
- const pageId = searchParams.get("pageId") ?? build.pages.homePage.id;
-
- useSyncInitializeOnce(() => {
- selectedPageIdStore.set(pageId);
- const page = selectedPageStore.get();
- if (page) {
- selectedInstanceSelectorStore.set([page.rootInstanceId]);
- }
- });
- useEffect(() => {
- selectedPageIdStore.set(pageId);
- const page = selectedPageStore.get();
- if (page) {
- selectedInstanceSelectorStore.set([page.rootInstanceId]);
- }
- }, [pageId]);
+ useSyncPageUrl();
useSetAssets(assets);
-
useSetAuthToken(authToken);
useSetAuthPermit(authPermit);
- useSetProject(project);
+
const [publish, publishRef] = usePublish();
useBuilderStore(publish);
useSyncServer({
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
index 9b2132f671..d0c0b7d73b 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
@@ -27,7 +27,7 @@ import { CloseButton, Header } from "../../header";
import { SettingsPanel } from "./settings-panel";
import { NewPageSettings, PageSettings } from "./settings";
import { pagesStore, selectedPageIdStore } from "~/shared/nano-states";
-import { useSwitchPage } from "~/shared/pages";
+import { switchPage } from "~/shared/pages";
type TabContentProps = {
onSetActiveTab: (tabName: TabName) => void;
@@ -228,8 +228,6 @@ const PagesPanel = ({
export const TabContent = (props: TabContentProps) => {
const currentPageId = useStore(selectedPageIdStore);
- const switchPage = useSwitchPage();
-
const newPageId = "new-page";
const [editingPageId, setEditingPageId] = useState<string>();
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 ecd9a36514..a2c7faf956 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
@@ -9,7 +9,6 @@ import {
} from "~/shared/nano-states";
import { HoveredInstanceOutline, SelectedInstanceOutline } from "./outline";
import { TextToolbar } from "./text-toolbar";
-import { useSubscribeSwitchPage } from "~/shared/pages";
import { Label } from "./outline/label";
import { Outline } from "./outline/outline";
import { useSubscribeDragAndDropState } from "./use-subscribe-drag-drop-state";
@@ -36,7 +35,6 @@ type CanvasToolsProps = {
export const CanvasTools = ({ publish }: CanvasToolsProps) => {
// @todo try to setup cross-frame atoms to avoid this
useSubscribeDragAndDropState();
- useSubscribeSwitchPage();
const [isPreviewMode] = useIsPreviewMode();
const [dragAndDropState] = useDragAndDropState();
diff --git a/apps/builder/app/canvas/features/webstudio-component/link.ts b/apps/builder/app/canvas/features/webstudio-component/link.ts
index 2f1ef63103..414bb119fe 100644
--- a/apps/builder/app/canvas/features/webstudio-component/link.ts
+++ b/apps/builder/app/canvas/features/webstudio-component/link.ts
@@ -1,13 +1,7 @@
import type { MouseEvent } from "react";
-import { findPageByIdOrPath, type Page } from "@webstudio-is/project-build";
+import { findPageByIdOrPath } from "@webstudio-is/project-build";
import { pagesStore, isPreviewModeStore } from "~/shared/nano-states";
-import { publish } from "~/shared/pubsub";
-
-declare module "~/shared/pubsub" {
- export interface PubsubMap {
- switchPage: { pageId: Page["id"] };
- }
-}
+import { switchPage } from "~/shared/pages";
const isAbsoluteUrl = (href: string) => {
try {
@@ -31,16 +25,17 @@ export const handleLinkClick = (event: MouseEvent) => {
return;
}
- const [withoutHash] = href.split("#");
+ if (isAbsoluteUrl(href)) {
+ window.open(href, "_blank");
+ return;
+ }
- const page = findPageByIdOrPath(pages, withoutHash);
+ const pageHref = new URL(href, "https://any-valid.url");
+
+ const page = findPageByIdOrPath(pages, pageHref.pathname);
if (page) {
- publish({ type: "switchPage", payload: { pageId: page.id } });
+ switchPage(page.id, pageHref.hash);
return;
}
-
- if (isAbsoluteUrl(href)) {
- window.open(href, "_blank");
- }
};
diff --git a/apps/builder/app/shared/nano-states/pages.ts b/apps/builder/app/shared/nano-states/pages.ts
index 113a5d1cd0..2fbdb511ca 100644
--- a/apps/builder/app/shared/nano-states/pages.ts
+++ b/apps/builder/app/shared/nano-states/pages.ts
@@ -10,11 +10,7 @@ export const useSetPages = (pages: Pages) => {
};
export const selectedPageIdStore = atom<undefined | Page["id"]>(undefined);
-export const useSetSelectedPageId = (pageId: Page["id"]) => {
- useSyncInitializeOnce(() => {
- selectedPageIdStore.set(pageId);
- });
-};
+export const selectedPageHashStore = atom<string>("");
export const selectedPageStore = computed(
[pagesStore, selectedPageIdStore],
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index 8f909d8e95..b9d5076fdf 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -1,41 +1,96 @@
+import { useStore } from "@nanostores/react";
import { useNavigate } from "@remix-run/react";
-import type { Page } from "@webstudio-is/project-build";
+import { findPageByIdOrPath, type Page } from "@webstudio-is/project-build";
+import { useEffect } from "react";
import {
authTokenStore,
pagesStore,
projectStore,
+ selectedPageStore,
+ selectedPageIdStore,
+ selectedPageHashStore,
selectedInstanceSelectorStore,
} from "~/shared/nano-states";
import { builderPath } from "~/shared/router-utils";
-import { useSubscribe } from "~/shared/pubsub";
+import { useSyncInitializeOnce } from "../hook-utils";
-export const useSwitchPage = () => {
+export const switchPage = (pageId?: Page["id"], pageHash?: string) => {
+ const pages = pagesStore.get();
+
+ if (pages === undefined) {
+ return;
+ }
+
+ const page = findPageByIdOrPath(pages, pageId ?? "");
+
+ selectedPageHashStore.set(pageHash ?? "");
+ selectedPageIdStore.set(page?.id ?? pages.homePage.id);
+ selectedInstanceSelectorStore.set([
+ page?.rootInstanceId ?? pages.homePage.rootInstanceId,
+ ]);
+};
+
+const setPageStateFromUrl = () => {
+ const searchParams = new URLSearchParams(window.location.search);
+ const pages = pagesStore.get();
+
+ const pageId = searchParams.get("pageId") ?? pages?.homePage.id;
+ const pageHash = searchParams.get("pageHash") ?? "";
+
+ switchPage(pageId, pageHash);
+};
+
+/**
+ * Sync
+ * - searchParams to atoms
+ * - initial loading
+ * - popstate
+ *
+ * - atoms to searchParams
+ * - on atom change
+ */
+export const useSyncPageUrl = () => {
const navigate = useNavigate();
+ const page = useStore(selectedPageStore);
+ const pageHash = useStore(selectedPageHashStore);
- /**
- * If no `pageId` provided, switches to default page (home)
- */
- return (pageId?: Page["id"]) => {
+ // Get pageId and pageHash from URL
+ useSyncInitializeOnce(() => {
+ setPageStateFromUrl();
+ });
+
+ useEffect(() => {
+ window.addEventListener("popstate", setPageStateFromUrl);
+ return () => {
+ window.removeEventListener("popstate", setPageStateFromUrl);
+ };
+ }, []);
+
+ useEffect(() => {
const project = projectStore.get();
const pages = pagesStore.get();
- if (project === undefined || pages === undefined) {
+ if (page === undefined || project === undefined || pages === undefined) {
return;
}
- selectedInstanceSelectorStore.set(undefined);
+ const searchParams = new URLSearchParams(window.location.search);
+
+ const searchParamsPageId = searchParams.get("pageId") ?? pages.homePage.id;
+ const searchParamsPageHash = searchParams.get("pageHash") ?? "";
+
+ // Do not navigate on popstate change
+ if (searchParamsPageId === page.id && searchParamsPageHash === pageHash) {
+ return;
+ }
navigate(
builderPath({
projectId: project.id,
- pageId: pageId === pages.homePage.id ? undefined : pageId,
+ pageId: page.id === pages.homePage.id ? undefined : page.id,
authToken: authTokenStore.get(),
+ pageHash: pageHash === "" ? undefined : pageHash,
})
);
- };
-};
-
-export const useSubscribeSwitchPage = () => {
- const switchPage = useSwitchPage();
- useSubscribe("switchPage", ({ pageId }) => switchPage(pageId));
+ }, [navigate, page, pageHash]);
};
diff --git a/apps/builder/app/shared/router-utils/path-utils.ts b/apps/builder/app/shared/router-utils/path-utils.ts
index 8c1f23e0eb..211bdb6d77 100644
--- a/apps/builder/app/shared/router-utils/path-utils.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.ts
@@ -18,12 +18,18 @@ export const builderPath = ({
projectId,
pageId,
authToken,
+ pageHash,
}: {
projectId: string;
pageId?: string;
authToken?: string;
+ pageHash?: string;
}) => {
- return `/builder/${projectId}${searchParams({ pageId, authToken })}`;
+ return `/builder/${projectId}${searchParams({
+ pageId,
+ authToken,
+ pageHash,
+ })}`;
};
export const builderUrl = (props: {
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 668b022a7a..b036b8b211 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -15,6 +15,7 @@ import {
styleSourceSelectionsStore,
assetsStore,
selectedPageIdStore,
+ selectedPageHashStore,
selectedInstanceSelectorStore,
selectedInstanceBrowserStyleStore,
selectedInstanceUnitSizesStore,
@@ -74,6 +75,7 @@ export const registerContainers = () => {
clientStores.set("project", projectStore);
clientStores.set("dataSourceValues", dataSourceValuesStore);
clientStores.set("selectedPageId", selectedPageIdStore);
+ clientStores.set("selectedPageHash", selectedPageHashStore);
clientStores.set("selectedInstanceSelector", selectedInstanceSelectorStore);
clientStores.set(
"selectedInstanceBrowserStyle",