Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Set layout via Query Params (#1024)

x3rt21c4e4e0fb30
diff --git a/src/App.jsx b/src/App.jsx
index 592e36c1..ababeb3c 100644
--- a/src/App.jsx
+++ b/src/App.jsx
@@ -9,8 +9,8 @@ import NotFound from "./pages/NotFound";
export default function App() {
return (
- <SettingsContextProvider>
- <BrowserRouter>
+ <BrowserRouter>
+ <SettingsContextProvider>
<RestoreScroll />
<Routes>
<Route path="/" element={<LandingPage />} />
@@ -21,8 +21,8 @@ export default function App() {
<Route path="/templates" element={<Templates />} />
<Route path="*" element={<NotFound />} />
</Routes>
- </BrowserRouter>
- </SettingsContextProvider>
+ </SettingsContextProvider>
+ </BrowserRouter>
);
}
diff --git a/src/components/EditorHeader/ControlPanel.jsx b/src/components/EditorHeader/ControlPanel.jsx
index b9175a33..ca4e4286 100644
--- a/src/components/EditorHeader/ControlPanel.jsx
+++ b/src/components/EditorHeader/ControlPanel.jsx
@@ -10,7 +10,7 @@ import {
IconEdit,
IconShareStroked,
} from "@douyinfe/semi-icons";
-import { Link, useMatch, useNavigate, useParams } from "react-router-dom";
+import { Link, useMatch, useParams } from "react-router-dom";
import icon from "../../assets/icon_dark_64.png";
import {
Button,
@@ -62,6 +62,7 @@ import {
useAreas,
useEnums,
useFullscreen,
+ useNavigateWithParams,
} from "../../hooks";
import { enterFullscreen, exitFullscreen } from "../../utils/fullscreen";
import { dataURItoBlob } from "../../utils/utils";
@@ -132,7 +133,7 @@ export default function ControlPanel({
const { t, i18n } = useTranslation();
const { version, gistId, setGistId } = useContext(IdContext);
const isTemplate = useMatch("/editor/templates/:id");
- const navigate = useNavigate();
+ const navigate = useNavigateWithParams();
const undo = () => {
if (undoStack.length === 0) return;
diff --git a/src/components/EditorHeader/Modal/Modal.jsx b/src/components/EditorHeader/Modal/Modal.jsx
index fb7ff8f0..c2a42893 100644
--- a/src/components/EditorHeader/Modal/Modal.jsx
+++ b/src/components/EditorHeader/Modal/Modal.jsx
@@ -10,6 +10,7 @@ import {
useAreas,
useDiagram,
useEnums,
+ useNavigateWithParams,
useNotes,
useSettings,
useTransform,
@@ -32,7 +33,6 @@ import Open from "./Open";
import Rename from "./Rename";
import SetTableWidth from "./SetTableWidth";
import Share from "./Share";
-import { useNavigate } from "react-router-dom";
import { mergeCustomTypes } from "../../../utils/customTypes";
const extensionToLanguage = {
@@ -78,7 +78,7 @@ export default function Modal({
const [selectedTemplateId, setSelectedTemplateId] = useState(-1);
const [selectedDiagramId, setSelectedDiagramId] = useState(0);
const [saveAsTitle, setSaveAsTitle] = useState(title);
- const navigate = useNavigate();
+ const navigate = useNavigateWithParams();
const overwriteDiagram = () => {
setTables(importData.tables);
diff --git a/src/components/EditorHeader/Modal/Share.jsx b/src/components/EditorHeader/Modal/Share.jsx
index 3e6460d1..dd33bdb0 100644
--- a/src/components/EditorHeader/Modal/Share.jsx
+++ b/src/components/EditorHeader/Modal/Share.jsx
@@ -1,8 +1,8 @@
-import { Banner, Button, Input, Spin, Toast } from "@douyinfe/semi-ui";
-import { useCallback, useContext, useEffect, useState } from "react";
+import { Banner, Button, Input, Spin, Toast, Collapse, Tag, Space, Radio, RadioGroup, Typography } from "@douyinfe/semi-ui";
+import { useCallback, useContext, useEffect, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { IdContext } from "../../Workspace";
-import { IconLink } from "@douyinfe/semi-icons";
+import { IconLink, IconCode } from "@douyinfe/semi-icons";
import {
useAreas,
useDiagram,
@@ -15,6 +15,7 @@ import { databases } from "../../../data/databases";
import { MODAL } from "../../../data/constants";
import { create, patch, SHARE_FILENAME } from "../../../api/gists";
import { getCustomTypes } from "../../../utils/customTypes";
+import { queryConfig } from "../../../utils/queryConfig";
export default function Share({ title, setModal }) {
const { t } = useTranslation();
@@ -27,7 +28,24 @@ export default function Share({ title, setModal }) {
const { enums } = useEnums();
const { transform } = useTransform();
const [error, setError] = useState(null);
- const url = window.location.origin + "/editor?shareId=" + gistId;
+ const [embedSettings, setEmbedSettings] = useState({
+ theme: null,
+ hideHeader: null,
+ hideSidebar: null,
+ hideToolbar: null,
+ });
+
+ const url = useMemo(() => {
+ const baseUrl = window.location.origin + "/editor?shareId=" + gistId;
+ const params = new URLSearchParams();
+ Object.entries(embedSettings).forEach(([key, value]) => {
+ if (value) {
+ params.append(queryConfig[key].key, value);
+ }
+ });
+ const queryString = params.toString();
+ return queryString ? baseUrl + "&" + queryString : baseUrl;
+ }, [gistId, embedSettings]);
const diagramToString = useCallback(() => {
const allCustomTypes = getCustomTypes();
@@ -136,6 +154,76 @@ export default function Share({ title, setModal }) {
<div className="flex gap-3">
<Input value={url} size="large" readonly />
</div>
+ <div className="mt-3">
+ <Collapse>
+ <Collapse.Panel
+ header={
+ <div className="flex items-center justify-between w-full pr-4">
+ <Space>
+ <IconCode />
+ <Typography.Text strong>
+ {t("embed_settings")}
+ </Typography.Text>
+ </Space>
+ <Space>
+ {queryConfig.theme.isValid(embedSettings.theme) && (
+ <Tag color="blue" size="small">
+ {t(embedSettings.theme)}
+ </Tag>
+ )}
+ {embedSettings.hideHeader && (
+ <Tag color="blue" size="small">
+ {t("header")}
+ </Tag>
+ )}
+ {embedSettings.hideSidebar && (
+ <Tag color="blue" size="small">
+ {t("sidebar")}
+ </Tag>
+ )}
+ {embedSettings.hideToolbar && (
+ <Tag color="blue" size="small">
+ {t("toolbar")}
+ </Tag>
+ )}
+ </Space>
+ </div>
+ }
+ itemKey="embed-settings"
+ >
+ <div className="space-y-4 py-2">
+ {Object.entries(queryConfig).map(([key, config]) => (
+ <div
+ key={key}
+ className="flex items-center justify-between gap-4"
+ >
+ <Typography.Text>{t(config.label)}</Typography.Text>
+ <RadioGroup
+ type="button"
+ name={config.key}
+ value={embedSettings[key]}
+ onChange={(e) =>
+ setEmbedSettings((prev) => ({
+ ...prev,
+ [key]: e.target.value,
+ }))
+ }
+ >
+ {config.options.map((option) => (
+ <Radio
+ key={String(option.value)}
+ value={option.value}
+ >
+ {t(option.label)}
+ </Radio>
+ ))}
+ </RadioGroup>
+ </div>
+ ))}
+ </div>
+ </Collapse.Panel>
+ </Collapse>
+ </div>
<div className="text-xs mt-2">{t("share_info")}</div>
<div className="flex gap-2 mt-3">
<Button block onClick={unshare}>
diff --git a/src/components/Workspace.jsx b/src/components/Workspace.jsx
index cf8c4cb1..40b64075 100644
--- a/src/components/Workspace.jsx
+++ b/src/components/Workspace.jsx
@@ -16,6 +16,7 @@ import {
useTypes,
useSaveState,
useEnums,
+ useNavigateWithParams,
} from "../hooks";
import FloatingControls from "./FloatingControls";
import { Button, Modal, Tag } from "@douyinfe/semi-ui";
@@ -25,7 +26,6 @@ import { databases } from "../data/databases";
import { isRtl } from "../i18n/utils/rtl";
import {
useMatch,
- useNavigate,
useParams,
useSearchParams,
} from "react-router-dom";
@@ -77,7 +77,7 @@ export default function WorkSpace() {
const isDiagram = useMatch("/editor/diagrams/:id");
const isTemplate = useMatch("/editor/templates/:id");
- const navigate = useNavigate();
+ const navigate = useNavigateWithParams();
const handleResize = (e) => {
if (!resize) return;
diff --git a/src/context/LayoutContext.jsx b/src/context/LayoutContext.jsx
index ec9ae61a..7785d099 100644
--- a/src/context/LayoutContext.jsx
+++ b/src/context/LayoutContext.jsx
@@ -1,19 +1,58 @@
import { createContext, useState } from "react";
+import { useSearchParams } from "react-router-dom";
+import { queryConfig } from "../utils/queryConfig";
export const LayoutContext = createContext(null);
+const defaultLayout = {
+ header: true,
+ sidebar: true,
+ issues: true,
+ toolbar: true,
+ dbmlEditor: false,
+ readOnly: false,
+};
+
export default function LayoutContextProvider({ children }) {
+ const [searchParams] = useSearchParams();
+
+ const hideHeaderParam = searchParams.get(queryConfig.hideHeader.key);
+ const hideSidebarParam = searchParams.get(queryConfig.hideSidebar.key);
+ const hideToolbarParam = searchParams.get(queryConfig.hideToolbar.key);
+
const [layout, setLayout] = useState({
- header: true,
- sidebar: true,
- issues: true,
- toolbar: true,
- dbmlEditor: false,
- readOnly: false,
+ ...defaultLayout,
+ header: queryConfig.hideHeader.isActive(hideHeaderParam)
+ ? false
+ : defaultLayout.header,
+ sidebar: queryConfig.hideSidebar.isActive(hideSidebarParam)
+ ? false
+ : defaultLayout.sidebar,
+ toolbar: queryConfig.hideToolbar.isActive(hideToolbarParam)
+ ? false
+ : defaultLayout.toolbar,
});
+ const effectiveLayout = {
+ ...layout,
+ header: queryConfig.hideHeader.isForced(hideHeaderParam)
+ ? false
+ : layout.header,
+ sidebar: queryConfig.hideSidebar.isForced(hideSidebarParam)
+ ? false
+ : layout.sidebar,
+ toolbar: queryConfig.hideToolbar.isForced(hideToolbarParam)
+ ? false
+ : layout.toolbar,
+ };
+
return (
- <LayoutContext.Provider value={{ layout, setLayout }}>
+ <LayoutContext.Provider
+ value={{
+ layout: effectiveLayout,
+ setLayout,
+ }}
+ >
{children}
</LayoutContext.Provider>
);
diff --git a/src/context/SettingsContext.jsx b/src/context/SettingsContext.jsx
index 48beb770..33919841 100644
--- a/src/context/SettingsContext.jsx
+++ b/src/context/SettingsContext.jsx
@@ -1,5 +1,7 @@
import { createContext, useEffect, useState } from "react";
+import { useSearchParams } from "react-router-dom";
import { tableWidth } from "../data/constants";
+import { queryConfig } from "../utils/queryConfig";
const defaultSettings = {
strictMode: false,
@@ -19,14 +21,21 @@ const defaultSettings = {
export const SettingsContext = createContext(defaultSettings);
export default function SettingsContextProvider({ children }) {
- const [settings, setSettings] = useState(defaultSettings);
+ const [searchParams] = useSearchParams();
- useEffect(() => {
- const settings = localStorage.getItem("settings");
- if (settings) {
- setSettings({ ...defaultSettings, ...JSON.parse(settings) });
+ const [settings, setSettings] = useState(() => {
+ const savedSettings = localStorage.getItem("settings");
+ let baseSettings = savedSettings
+ ? { ...defaultSettings, ...JSON.parse(savedSettings) }
+ : defaultSettings;
+
+ const theme = searchParams.get(queryConfig.theme.key);
+ if (queryConfig.theme.isValid(theme)) {
+ baseSettings = { ...baseSettings, mode: theme };
}
- }, []);
+
+ return baseSettings;
+ });
useEffect(() => {
document.body.setAttribute("theme-mode", settings.mode);
diff --git a/src/hooks/index.js b/src/hooks/index.js
index bc279d88..b90bbb53 100644
--- a/src/hooks/index.js
+++ b/src/hooks/index.js
@@ -12,3 +12,4 @@ export { default as useTypes } from "./useTypes";
export { default as useUndoRedo } from "./useUndoRedo";
export { default as useEnums } from "./useEnums";
export { default as useThemedPage } from "./useThemedPage";
+export { default as useNavigateWithParams } from "./useNavigateWithParams";
diff --git a/src/hooks/useNavigateWithParams.js b/src/hooks/useNavigateWithParams.js
new file mode 100644
index 00000000..9d1f16f8
--- /dev/null
+++ b/src/hooks/useNavigateWithParams.js
@@ -0,0 +1,13 @@
+import { useCallback } from "react";
+import { useNavigate } from "react-router-dom";
+
+export default function useNavigateWithParams() {
+ const navigate = useNavigate();
+
+ return useCallback(
+ (to, options = {}) => {
+ navigate(to + window.location.search, options);
+ },
+ [navigate],
+ );
+}
diff --git a/src/i18n/locales/en.js b/src/i18n/locales/en.js
index a818ed03..0c60fdbd 100644
--- a/src/i18n/locales/en.js
+++ b/src/i18n/locales/en.js
@@ -48,6 +48,7 @@ const en = {
view: "View",
header: "Menubar",
sidebar: "Sidebar",
+ toolbar: "Toolbar",
issues: "Issues",
presentation_mode: "Presentation mode",
strict_mode: "Strict mode",
@@ -291,7 +292,11 @@ const en = {
database: "Database",
saved: "Saved",
structure: "Structure",
- code: "Code"
+ code: "Code",
+ embed_settings: "Embed settings",
+ default: "Default",
+ hide: "Hide",
+ force_hide: "Force hide"
},
};
diff --git a/src/utils/queryConfig.js b/src/utils/queryConfig.js
new file mode 100644
index 00000000..f01e061a
--- /dev/null
+++ b/src/utils/queryConfig.js
@@ -0,0 +1,45 @@
+export const queryConfig = {
+ theme: {
+ key: "theme",
+ label: "theme",
+ options: [
+ { label: "default", value: null },
+ { label: "light", value: "light" },
+ { label: "dark", value: "dark" },
+ ],
+ isValid: (val) => ["light", "dark"].includes(val),
+ },
+ hideHeader: {
+ key: "hideHeader",
+ label: "header",
+ options: [
+ { label: "default", value: null },
+ { label: "hide", value: "true" },
+ { label: "force_hide", value: "force" },
+ ],
+ isActive: (val) => val === "true" || val === "force",
+ isForced: (val) => val === "force",
+ },
+ hideSidebar: {
+ key: "hideSidebar",
+ label: "sidebar",
+ options: [
+ { label: "default", value: null },
+ { label: "hide", value: "true" },
+ { label: "force_hide", value: "force" },
+ ],
+ isActive: (val) => val === "true" || val === "force",
+ isForced: (val) => val === "force",
+ },
+ hideToolbar: {
+ key: "hideToolbar",
+ label: "toolbar",
+ options: [
+ { label: "default", value: null },
+ { label: "hide", value: "true" },
+ { label: "force_hide", value: "force" },
+ ],
+ isActive: (val) => val === "true" || val === "force",
+ isForced: (val) => val === "force",
+ },
+};