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.

Switch pages on client side (#1225)

Bogdan Chadkin78f7882ddbc1
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 607d80d6bf..ddaf38e42a 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -1,10 +1,6 @@
-import { useCallback, useEffect, useMemo } from "react";
+import { useCallback, useEffect } from "react";
import { type Publish, usePublish, useSubscribe } from "~/shared/pubsub";
-import {
- type Build,
- type Pages,
- findPageByIdOrPath,
-} from "@webstudio-is/project-build";
+import type { Build } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
import { theme, Box, type CSS, Flex, Grid } from "@webstudio-is/design-system";
import type { AuthPermit } from "@webstudio-is/trpc-interface";
@@ -17,7 +13,7 @@ import robotoMonoFont from "@fontsource/roboto-mono/index.css";
import { useSharedShortcuts } from "~/shared/shortcuts";
import { SidebarLeft } from "./features/sidebar-left";
import { Inspector } from "./features/inspector";
-import { usePages, useProject, useCurrentPageId } from "./shared/nano-states";
+import { useProject } from "./shared/nano-states";
import { Topbar } from "./features/topbar";
import builderStyles from "./builder.css";
import { Footer } from "./features/footer";
@@ -30,7 +26,7 @@ import {
} from "./features/workspace";
import { usePublishShortcuts } from "./shared/shortcuts";
import {
- selectedPageStore,
+ selectedPageIdStore,
useDragAndDropState,
useIsPreviewMode,
useSetAssets,
@@ -39,6 +35,7 @@ import {
useSetBreakpoints,
useSetInstances,
useSetIsPreviewMode,
+ useSetPages,
useSetProps,
useSetStyles,
useSetStyleSources,
@@ -50,6 +47,7 @@ import { getBuildUrl } from "~/shared/router-utils";
import { useCopyPaste } from "~/shared/copy-paste";
import { AssetsProvider } from "./shared/assets";
import type { Asset } from "@webstudio-is/asset-uploader";
+import { useSearchParams } from "@remix-run/react";
registerContainers();
@@ -68,20 +66,6 @@ const useSetProject = (project: Project) => {
}, [project, setProject]);
};
-const useSetPages = (pages: Pages) => {
- const [, setPages] = usePages();
- useEffect(() => {
- setPages(pages);
- }, [pages, setPages]);
-};
-
-const useSetCurrentPageId = (pageId: string) => {
- const [, setCurrentPageId] = useCurrentPageId();
- useEffect(() => {
- setCurrentPageId(pageId);
- }, [pageId, setCurrentPageId]);
-};
-
const useNavigatorLayout = () => {
// We need to render the detached state only once the setting was actually loaded from local storage.
// Otherwise we may show the detached state because its the default and then hide it immediately.
@@ -248,8 +232,6 @@ const NavigatorPanel = ({ isPreviewMode }: NavigatorPanelProps) => {
export type BuilderProps = {
project: Project;
- pages: Pages;
- pageId: string;
build: Build;
assets: Asset[];
buildOrigin: string;
@@ -260,8 +242,6 @@ export type BuilderProps = {
export const Builder = ({
project,
- pages,
- pageId,
build,
assets,
buildOrigin,
@@ -269,6 +249,7 @@ export const Builder = ({
authToken,
authPermit,
}: BuilderProps) => {
+ useSetPages(build.pages);
useSetBreakpoints(build.breakpoints);
useSetProps(build.props);
useSetStyles(build.styles);
@@ -276,13 +257,14 @@ export const Builder = ({
useSetStyleSourceSelections(build.styleSourceSelections);
useSetInstances(build.instances);
+ const [searchParams] = useSearchParams();
+ const pageId = searchParams.get("pageId") ?? build.pages.homePage.id;
+ selectedPageIdStore.set(pageId);
useSetAssets(assets);
useSetAuthToken(authToken);
useSetAuthPermit(authPermit);
useSetProject(project);
- useSetPages(pages);
- useSetCurrentPageId(pageId);
const [publish, publishRef] = usePublish();
useBuilderStore(publish);
useSyncServer({
@@ -312,20 +294,10 @@ export const Builder = ({
[publishRef, onRefReadCanvasWidth, onRefReadCanvas]
);
- const page = useMemo(() => {
- const page = findPageByIdOrPath(pages, pageId);
- if (page === undefined) {
- throw new Error(`Page with id ${pageId} not found`);
- }
- return page;
- }, [pages, pageId]);
-
- selectedPageStore.set(page);
-
const canvasUrl = getBuildUrl({
buildOrigin,
project,
- page,
+ page: build.pages.homePage,
mode: "edit",
authReadToken,
});
@@ -333,12 +305,7 @@ export const Builder = ({
return (
<AssetsProvider authToken={authToken}>
<ChromeWrapper isPreviewMode={isPreviewMode}>
- <Topbar
- gridArea="header"
- project={project}
- publish={publish}
- page={page}
- />
+ <Topbar gridArea="header" project={project} publish={publish} />
<Main>
<Workspace onTransitionEnd={onTransitionEnd} publish={publish}>
<CanvasIframe
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 b97b42afd3..4ffbdac8b5 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
@@ -1,4 +1,5 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { useStore } from "@nanostores/react";
import { useNavigate } from "@remix-run/react";
import {
DeprecatedIconButton,
@@ -21,17 +22,17 @@ import {
} from "@webstudio-is/icons";
import type { Page, Pages } from "@webstudio-is/project-build";
import type { Publish } from "~/shared/pubsub";
-import {
- useCurrentPageId,
- usePages,
- useProject,
-} from "~/builder/shared/nano-states";
+import { useProject } from "~/builder/shared/nano-states";
import { builderPath } from "~/shared/router-utils";
import type { TabName } from "../../types";
import { CloseButton, Header } from "../../header";
import { SettingsPanel } from "./settings-panel";
import { NewPageSettings, PageSettings } from "./settings";
-import { useAuthToken } from "~/shared/nano-states";
+import {
+ pagesStore,
+ selectedPageIdStore,
+ useAuthToken,
+} from "~/shared/nano-states";
type TabContentProps = {
onSetActiveTab: (tabName: TabName) => void;
@@ -149,7 +150,7 @@ const PagesPanel = ({
onEdit?: (pageId: string | undefined) => void;
editingPageId?: string;
}) => {
- const [pages] = usePages();
+ const pages = useStore(pagesStore);
const pagesTree = useMemo(() => pages && toTreeData(pages), [pages]);
const renderItem = useCallback(
@@ -231,7 +232,7 @@ const PagesPanel = ({
};
export const TabContent = (props: TabContentProps) => {
- const [currentPageId] = useCurrentPageId();
+ const currentPageId = useStore(selectedPageIdStore);
const [project] = useProject();
const [authToken] = useAuthToken();
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
index 2f84efc794..6a0a976928 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
@@ -1,5 +1,6 @@
import { z } from "zod";
import { useState, useCallback, ComponentProps } from "react";
+import { useStore } from "@nanostores/react";
import { useDebouncedCallback } from "use-debounce";
import { useUnmount } from "react-use";
import slugify from "slugify";
@@ -26,7 +27,6 @@ import {
Tooltip,
} from "@webstudio-is/design-system";
import { ChevronDoubleLeftIcon, TrashIcon } from "@webstudio-is/icons";
-import { usePages } from "~/builder/shared/nano-states";
import { useOnFetchEnd, usePersistentFetcher } from "~/shared/fetcher";
import {
normalizeErrors,
@@ -41,6 +41,7 @@ import type {
import { restPagesPath } from "~/shared/router-utils";
import { Header, HeaderSuffixSpacer } from "../../header";
import { deleteInstance } from "~/shared/instance-utils";
+import { pagesStore } from "~/shared/nano-states";
const Group = styled(Flex, {
marginBottom: theme.spacing[9],
@@ -226,12 +227,18 @@ export const NewPageSettings = ({
onSuccess?: (page: Page) => void;
projectId: string;
}) => {
- const [pages] = usePages();
+ const pages = useStore(pagesStore);
const fetcher = useFetcher<CreatePageData>();
useOnFetchEnd(fetcher, (data) => {
if (data.status === "ok") {
+ if (pages !== undefined) {
+ pagesStore.set({
+ homePage: pages.homePage,
+ pages: [...pages.pages, data.page],
+ });
+ }
onSuccess?.(data.page);
}
});
@@ -367,7 +374,7 @@ export const PageSettings = ({
const fetcher = useFetcher<EditPageData>();
- const [pages, setPages] = usePages();
+ const pages = useStore(pagesStore);
const page = pages && findPageByIdOrPath(pages, pageId);
// Updating client side store like that is a temporary solution
@@ -377,10 +384,10 @@ export const PageSettings = ({
return;
}
if (pages.homePage.id === page.id) {
- setPages({ homePage: page, pages: pages.pages });
+ pagesStore.set({ homePage: page, pages: pages.pages });
return;
}
- setPages({
+ pagesStore.set({
homePage: pages.homePage,
pages: pages.pages.map((item) => (item.id === page.id ? page : item)),
});
@@ -393,7 +400,7 @@ export const PageSettings = ({
if (page) {
deleteInstance(page.rootInstanceId);
}
- setPages({
+ pagesStore.set({
homePage: pages.homePage,
pages: pages.pages.filter((item) => item.id !== pageId),
});
diff --git a/apps/builder/app/builder/features/topbar/topbar.tsx b/apps/builder/app/builder/features/topbar/topbar.tsx
index 959f4b10c7..54df4220b1 100644
--- a/apps/builder/app/builder/features/topbar/topbar.tsx
+++ b/apps/builder/app/builder/features/topbar/topbar.tsx
@@ -1,5 +1,6 @@
-import type { Publish } from "~/shared/pubsub";
+import { useStore } from "@nanostores/react";
import {
+ theme,
css,
Flex,
Text,
@@ -7,9 +8,9 @@ import {
ToolbarSeparator,
ToolbarToggleGroup,
} from "@webstudio-is/design-system";
-import type { Page } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
-import { theme } from "@webstudio-is/design-system";
+import type { Publish } from "~/shared/pubsub";
+import { selectedPageStore } from "~/shared/nano-states";
import { PreviewButton } from "./preview";
import { ShareButton } from "./share";
import { PublishButton } from "./publish";
@@ -28,11 +29,15 @@ const topbarContainerStyle = css({
type TopbarProps = {
gridArea: string;
project: Project;
- page: Page;
publish: Publish;
};
-export const Topbar = ({ gridArea, project, page, publish }: TopbarProps) => {
+export const Topbar = ({ gridArea, project, publish }: TopbarProps) => {
+ const page = useStore(selectedPageStore);
+ if (page === undefined) {
+ return null;
+ }
+
return (
<Toolbar className={topbarContainerStyle({ css: { gridArea } })}>
<Flex grow={false} shrink={false}>
diff --git a/apps/builder/app/builder/shared/nano-states/index.ts b/apps/builder/app/builder/shared/nano-states/index.ts
index aa2d17e0e8..34801395e8 100644
--- a/apps/builder/app/builder/shared/nano-states/index.ts
+++ b/apps/builder/app/builder/shared/nano-states/index.ts
@@ -1,8 +1,6 @@
import { atom, type WritableAtom } from "nanostores";
import { useStore } from "@nanostores/react";
-import type { Pages } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
-import type { AssetContainer, DeletingAssetContainer } from "../assets";
const useValue = <T>(atom: WritableAtom<T>) => {
const value = useStore(atom);
@@ -22,17 +20,6 @@ export const useCanvasWidth = () => useValue(canvasWidthContainer);
const canvasRectContainer = atom<DOMRect | undefined>();
export const useCanvasRect = () => useValue(canvasRectContainer);
-const assetsContainer = atom<Array<AssetContainer | DeletingAssetContainer>>(
- []
-);
-export const useAssetsContainer = () => useValue(assetsContainer);
-
-const pagesContainer = atom<Pages | undefined>();
-export const usePages = () => useValue(pagesContainer);
-
-const currentPageIdContainer = atom<string | undefined>();
-export const useCurrentPageId = () => useValue(currentPageIdContainer);
-
const projectContainer = atom<Project | undefined>();
export const useProject = () => useValue(projectContainer);
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index a2ef9d6ac2..d917b961dc 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,4 +1,5 @@
import { useMemo, Fragment, useEffect } from "react";
+import { useStore } from "@nanostores/react";
import { computed } from "nanostores";
import type { CanvasData } from "@webstudio-is/project";
import type { Instance } from "@webstudio-is/project-build";
@@ -26,6 +27,7 @@ import {
useRootInstance,
useSubscribeScrollState,
useIsPreviewMode,
+ selectedPageStore,
} from "~/shared/nano-states";
import { usePublishScrollState } from "./shared/use-publish-scroll-state";
import { useDragAndDrop } from "./shared/use-drag-drop";
@@ -105,16 +107,17 @@ export const Canvas = ({
// e.g. toggling preview is still needed in both modes
useShortcuts();
useSharedShortcuts();
+ const selectedPage = useStore(selectedPageStore);
useEffect(() => {
- const rootInstanceId = data.page.rootInstanceId;
+ const rootInstanceId = selectedPage?.rootInstanceId;
if (rootInstanceId !== undefined) {
setDataCollapsed(rootInstanceId);
}
});
useWindowResizeDebounced(() => {
- const rootInstanceId = data.page.rootInstanceId;
+ const rootInstanceId = selectedPage?.rootInstanceId;
if (rootInstanceId !== undefined) {
setDataCollapsed(rootInstanceId);
}
diff --git a/apps/builder/app/routes/builder/$projectId.tsx b/apps/builder/app/routes/builder/$projectId.tsx
index ab74049fca..11f5a5fb08 100644
--- a/apps/builder/app/routes/builder/$projectId.tsx
+++ b/apps/builder/app/routes/builder/$projectId.tsx
@@ -24,7 +24,6 @@ export const loader = async ({
const context = await createContext(request);
const url = new URL(request.url);
- const pageIdParam = url.searchParams.get("pageId");
const project = await db.project.loadById(params.projectId, context);
@@ -46,15 +45,11 @@ export const loader = async ({
const devBuild = await loadBuildByProjectId(project.id, "dev");
const assets = await loadByProject(project.id, context);
- const pages = devBuild.pages;
-
const authReadToken = await createAuthReadToken({ projectId: project.id });
const authToken = url.searchParams.get("authToken") ?? undefined;
return {
project,
- pages,
- pageId: pageIdParam || devBuild.pages.homePage.id,
build: devBuild,
assets,
buildOrigin: getBuildOrigin(request),
@@ -85,7 +80,15 @@ export const shouldRevalidate: ShouldRevalidateFunction = ({
nextUrl,
defaultShouldRevalidate,
}) => {
- return currentUrl.href === nextUrl.href ? false : defaultShouldRevalidate;
+ const currentUrlCopy = new URL(currentUrl);
+ const nextUrlCopy = new URL(nextUrl);
+ // prevent revalidating data when pageId changes
+ // to not regenerate auth token and preserve canvas url
+ currentUrlCopy.searchParams.delete("pageId");
+ nextUrlCopy.searchParams.delete("pageId");
+ return currentUrlCopy.href === nextUrlCopy.href
+ ? false
+ : defaultShouldRevalidate;
};
export default BuilderRoute;
diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.ts
index e258bf9821..2a96239afb 100644
--- a/apps/builder/app/shared/nano-states/nano-states.ts
+++ b/apps/builder/app/shared/nano-states/nano-states.ts
@@ -12,6 +12,7 @@ import type {
Instances,
InstancesItem,
Page,
+ Pages,
Prop,
Props,
StyleDecl,
@@ -40,7 +41,32 @@ const useValue = <T>(atom: WritableAtom<T>) => {
return [value, atom.set] as const;
};
-export const selectedPageStore = atom<undefined | Page>(undefined);
+export const pagesStore = atom<undefined | Pages>(undefined);
+export const useSetPages = (pages: Pages) => {
+ useSyncInitializeOnce(() => {
+ pagesStore.set(pages);
+ });
+};
+
+export const selectedPageIdStore = atom<undefined | Page["id"]>(undefined);
+export const useSetSelectedPageId = (pageId: Page["id"]) => {
+ useSyncInitializeOnce(() => {
+ selectedPageIdStore.set(pageId);
+ });
+};
+
+export const selectedPageStore = computed(
+ [pagesStore, selectedPageIdStore],
+ (pages, selectedPageId) => {
+ if (pages === undefined) {
+ return undefined;
+ }
+ if (pages.homePage.id === selectedPageId) {
+ return pages.homePage;
+ }
+ return pages.pages.find((page) => page.id === selectedPageId);
+ }
+);
export const instancesStore = atom<Map<InstancesItem["id"], InstancesItem>>(
new Map()
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 64fcd6ef89..1cf8aeff13 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -4,14 +4,15 @@ import type { WritableAtom } from "nanostores";
import { useEffect } from "react";
import { type Publish, subscribe } from "~/shared/pubsub";
import {
+ pagesStore,
instancesStore,
propsStore,
breakpointsContainer,
stylesStore,
styleSourcesStore,
styleSourceSelectionsStore,
+ selectedPageIdStore,
assetContainersStore,
- selectedPageStore,
selectedInstanceIdStore,
selectedInstanceBrowserStyleStore,
hoveredInstanceIdStore,
@@ -49,6 +50,7 @@ const clientStores = new Map<string, WritableAtom<unknown>>();
export const registerContainers = () => {
// synchronize patches
+ store.register("pages", pagesStore);
store.register("breakpoints", breakpointsContainer);
store.register("instances", instancesStore);
store.register("styles", stylesStore);
@@ -56,8 +58,8 @@ export const registerContainers = () => {
store.register("styleSourceSelections", styleSourceSelectionsStore);
store.register("props", propsStore);
// synchronize whole states
+ clientStores.set("selectedPageId", selectedPageIdStore);
clientStores.set("assetContainers", assetContainersStore);
- clientStores.set("selectedPage", selectedPageStore);
clientStores.set("selectedInstanceId", selectedInstanceIdStore);
clientStores.set(
"selectedInstanceBrowserStyle",