Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

feat(view-menu): add toggle for mini map visibility (#496) (#505)

Peter8abf2a7bfcc3
diff --git a/src/context/local-config-context/local-config-context.tsx b/src/context/local-config-context/local-config-context.tsx
index 2445c16c..79cd16dd 100644
--- a/src/context/local-config-context/local-config-context.tsx
+++ b/src/context/local-config-context/local-config-context.tsx
@@ -38,6 +38,9 @@ export interface LocalConfigContext {
showDependenciesOnCanvas: boolean;
setShowDependenciesOnCanvas: (showDependenciesOnCanvas: boolean) => void;
+
+ showMiniMapOnCanvas: boolean;
+ setShowMiniMapOnCanvas: (showMiniMapOnCanvas: boolean) => void;
}
export const LocalConfigContext = createContext<LocalConfigContext>({
@@ -70,4 +73,7 @@ export const LocalConfigContext = createContext<LocalConfigContext>({
showDependenciesOnCanvas: false,
setShowDependenciesOnCanvas: emptyFn,
+
+ showMiniMapOnCanvas: false,
+ setShowMiniMapOnCanvas: emptyFn,
});
diff --git a/src/context/local-config-context/local-config-provider.tsx b/src/context/local-config-context/local-config-provider.tsx
index 852695be..14b80457 100644
--- a/src/context/local-config-context/local-config-provider.tsx
+++ b/src/context/local-config-context/local-config-provider.tsx
@@ -13,6 +13,7 @@ const starUsDialogLastOpenKey = 'star_us_dialog_last_open';
const buckleWaitlistOpenedKey = 'buckle_waitlist_opened';
const buckleDialogLastOpenKey = 'buckle_dialog_last_open';
const showDependenciesOnCanvasKey = 'show_dependencies_on_canvas';
+const showMiniMapOnCanvasKey = 'show_minimap_on_canvas';
export const LocalConfigProvider: React.FC<React.PropsWithChildren> = ({
children,
@@ -67,6 +68,11 @@ export const LocalConfigProvider: React.FC<React.PropsWithChildren> = ({
'true'
);
+ const [showMiniMapOnCanvas, setShowMiniMapOnCanvas] =
+ React.useState<boolean>(
+ (localStorage.getItem(showMiniMapOnCanvasKey) || 'true') === 'true'
+ );
+
useEffect(() => {
localStorage.setItem(
starUsDialogLastOpenKey,
@@ -122,6 +128,13 @@ export const LocalConfigProvider: React.FC<React.PropsWithChildren> = ({
);
}, [showDependenciesOnCanvas]);
+ useEffect(() => {
+ localStorage.setItem(
+ showMiniMapOnCanvasKey,
+ showMiniMapOnCanvas.toString()
+ );
+ }, [showMiniMapOnCanvas]);
+
return (
<LocalConfigContext.Provider
value={{
@@ -145,6 +158,8 @@ export const LocalConfigProvider: React.FC<React.PropsWithChildren> = ({
buckleDialogLastOpen,
buckleWaitlistOpened,
setBuckleWaitlistOpened,
+ showMiniMapOnCanvas,
+ setShowMiniMapOnCanvas,
}}
>
{children}
diff --git a/src/i18n/locales/ar.ts b/src/i18n/locales/ar.ts
index 24c48a92..8b802c9a 100644
--- a/src/i18n/locales/ar.ts
+++ b/src/i18n/locales/ar.ts
@@ -30,6 +30,9 @@ export const ar: LanguageTranslation = {
theme: 'المظهر',
show_dependencies: 'إظهار الاعتمادات',
hide_dependencies: 'إخفاء الاعتمادات',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'مشاركة',
diff --git a/src/i18n/locales/bn.ts b/src/i18n/locales/bn.ts
index 787a6928..a923d251 100644
--- a/src/i18n/locales/bn.ts
+++ b/src/i18n/locales/bn.ts
@@ -30,6 +30,9 @@ export const bn: LanguageTranslation = {
theme: 'থিম',
show_dependencies: 'নির্ভরতাগুলি দেখান',
hide_dependencies: 'নির্ভরতাগুলি লুকান',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
diff --git a/src/i18n/locales/de.ts b/src/i18n/locales/de.ts
index 5d0f61f2..5d4f4e3f 100644
--- a/src/i18n/locales/de.ts
+++ b/src/i18n/locales/de.ts
@@ -30,6 +30,9 @@ export const de: LanguageTranslation = {
theme: 'Stil',
show_dependencies: 'Abhängigkeiten anzeigen',
hide_dependencies: 'Abhängigkeiten ausblenden',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts
index e2e7a612..e1e9546c 100644
--- a/src/i18n/locales/en.ts
+++ b/src/i18n/locales/en.ts
@@ -30,6 +30,8 @@ export const en = {
theme: 'Theme',
show_dependencies: 'Show Dependencies',
hide_dependencies: 'Hide Dependencies',
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'Share',
diff --git a/src/i18n/locales/es.ts b/src/i18n/locales/es.ts
index b6d8cf5a..9625ccf3 100644
--- a/src/i18n/locales/es.ts
+++ b/src/i18n/locales/es.ts
@@ -30,6 +30,9 @@ export const es: LanguageTranslation = {
theme: 'Tema',
show_dependencies: 'Mostrar dependencias',
hide_dependencies: 'Ocultar dependencias',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/fr.ts b/src/i18n/locales/fr.ts
index d9737ba6..5b9540c5 100644
--- a/src/i18n/locales/fr.ts
+++ b/src/i18n/locales/fr.ts
@@ -30,6 +30,9 @@ export const fr: LanguageTranslation = {
theme: 'Thème',
show_dependencies: 'Afficher les Dépendances',
hide_dependencies: 'Masquer les Dépendances',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'Partage',
diff --git a/src/i18n/locales/gu.ts b/src/i18n/locales/gu.ts
index 9b951cd5..619783aa 100644
--- a/src/i18n/locales/gu.ts
+++ b/src/i18n/locales/gu.ts
@@ -30,6 +30,9 @@ export const gu: LanguageTranslation = {
theme: 'થિમ',
show_dependencies: 'નિર્ભરતાઓ બતાવો',
hide_dependencies: 'નિર્ભરતાઓ છુપાવો',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
diff --git a/src/i18n/locales/hi.ts b/src/i18n/locales/hi.ts
index 76deed82..5d3f07a2 100644
--- a/src/i18n/locales/hi.ts
+++ b/src/i18n/locales/hi.ts
@@ -30,6 +30,9 @@ export const hi: LanguageTranslation = {
theme: 'थीम',
show_dependencies: 'निर्भरता दिखाएँ',
hide_dependencies: 'निर्भरता छिपाएँ',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/id_ID.ts b/src/i18n/locales/id_ID.ts
index 750f8081..9ca8eb8e 100644
--- a/src/i18n/locales/id_ID.ts
+++ b/src/i18n/locales/id_ID.ts
@@ -30,6 +30,9 @@ export const id_ID: LanguageTranslation = {
theme: 'Tema',
show_dependencies: 'Tampilkan Dependensi',
hide_dependencies: 'Sembunyikan Dependensi',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'Bagikan',
diff --git a/src/i18n/locales/ja.ts b/src/i18n/locales/ja.ts
index d2eee480..7f674645 100644
--- a/src/i18n/locales/ja.ts
+++ b/src/i18n/locales/ja.ts
@@ -31,6 +31,9 @@ export const ja: LanguageTranslation = {
// TODO: Translate
show_dependencies: 'Show Dependencies',
hide_dependencies: 'Hide Dependencies',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/ko_KR.ts b/src/i18n/locales/ko_KR.ts
index 80cc8bb2..4948167d 100644
--- a/src/i18n/locales/ko_KR.ts
+++ b/src/i18n/locales/ko_KR.ts
@@ -30,6 +30,9 @@ export const ko_KR: LanguageTranslation = {
theme: '테마',
show_dependencies: '종속성 보이기',
hide_dependencies: '종속성 숨기기',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: '공유',
diff --git a/src/i18n/locales/mr.ts b/src/i18n/locales/mr.ts
index 286af692..99df6b7f 100644
--- a/src/i18n/locales/mr.ts
+++ b/src/i18n/locales/mr.ts
@@ -30,6 +30,9 @@ export const mr: LanguageTranslation = {
theme: 'थीम',
show_dependencies: 'डिपेंडेन्सि दाखवा',
hide_dependencies: 'डिपेंडेन्सि लपवा',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
// TODO: Add translations
diff --git a/src/i18n/locales/ne.ts b/src/i18n/locales/ne.ts
index ffaebdef..400ab163 100644
--- a/src/i18n/locales/ne.ts
+++ b/src/i18n/locales/ne.ts
@@ -30,6 +30,9 @@ export const ne: LanguageTranslation = {
theme: 'थिम',
show_dependencies: 'डिपेन्डेन्सीहरू देखाउनुहोस्',
hide_dependencies: 'डिपेन्डेन्सीहरू लुकाउनुहोस्',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'शेयर गर्नुहोस्',
diff --git a/src/i18n/locales/pt_BR.ts b/src/i18n/locales/pt_BR.ts
index dd44318a..6d7fd5df 100644
--- a/src/i18n/locales/pt_BR.ts
+++ b/src/i18n/locales/pt_BR.ts
@@ -30,6 +30,9 @@ export const pt_BR: LanguageTranslation = {
theme: 'Tema',
show_dependencies: 'Mostrar Dependências',
hide_dependencies: 'Ocultar Dependências',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/ru.ts b/src/i18n/locales/ru.ts
index eeffb9a9..71752beb 100644
--- a/src/i18n/locales/ru.ts
+++ b/src/i18n/locales/ru.ts
@@ -30,6 +30,9 @@ export const ru: LanguageTranslation = {
theme: 'Тема',
show_dependencies: 'Показать зависимости',
hide_dependencies: 'Скрыть зависимости',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'Поделиться',
diff --git a/src/i18n/locales/te.ts b/src/i18n/locales/te.ts
index 0f3985bb..5fe19e4d 100644
--- a/src/i18n/locales/te.ts
+++ b/src/i18n/locales/te.ts
@@ -30,6 +30,9 @@ export const te: LanguageTranslation = {
theme: 'థీమ్',
show_dependencies: 'ఆధారాలు చూపించండి',
hide_dependencies: 'ఆధారాలను దాచండి',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/tr.ts b/src/i18n/locales/tr.ts
index 9a92487e..d13ce666 100644
--- a/src/i18n/locales/tr.ts
+++ b/src/i18n/locales/tr.ts
@@ -30,6 +30,9 @@ export const tr: LanguageTranslation = {
theme: 'Tema',
show_dependencies: 'Bağımlılıkları Göster',
hide_dependencies: 'Bağımlılıkları Gizle',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/uk.ts b/src/i18n/locales/uk.ts
index b7bd8955..0fbf39f2 100644
--- a/src/i18n/locales/uk.ts
+++ b/src/i18n/locales/uk.ts
@@ -30,6 +30,9 @@ export const uk: LanguageTranslation = {
theme: 'Тема',
show_dependencies: 'Показати залежності',
hide_dependencies: 'Приховати залежності',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
// TODO: Translate
share: {
diff --git a/src/i18n/locales/vi.ts b/src/i18n/locales/vi.ts
index edaeb6f2..903f0a3f 100644
--- a/src/i18n/locales/vi.ts
+++ b/src/i18n/locales/vi.ts
@@ -30,6 +30,9 @@ export const vi: LanguageTranslation = {
theme: 'Chủ đề',
show_dependencies: 'Hiển thị các phụ thuộc',
hide_dependencies: 'Ẩn các phụ thuộc',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: 'Chia sẻ',
diff --git a/src/i18n/locales/zh_CN.ts b/src/i18n/locales/zh_CN.ts
index 28486cb7..078f776e 100644
--- a/src/i18n/locales/zh_CN.ts
+++ b/src/i18n/locales/zh_CN.ts
@@ -30,6 +30,9 @@ export const zh_CN: LanguageTranslation = {
theme: '主题',
show_dependencies: '展示依赖',
hide_dependencies: '隐藏依赖',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: '分享',
diff --git a/src/i18n/locales/zh_TW.ts b/src/i18n/locales/zh_TW.ts
index 6c116728..996f9c6d 100644
--- a/src/i18n/locales/zh_TW.ts
+++ b/src/i18n/locales/zh_TW.ts
@@ -30,6 +30,9 @@ export const zh_TW: LanguageTranslation = {
theme: '主題',
show_dependencies: '顯示相依性',
hide_dependencies: '隱藏相依性',
+ // TODO: Translate
+ show_minimap: 'Show Mini Map',
+ hide_minimap: 'Hide Mini Map',
},
share: {
share: '分享',
diff --git a/src/pages/editor-page/canvas/canvas.tsx b/src/pages/editor-page/canvas/canvas.tsx
index 5f8a8674..819dee9c 100644
--- a/src/pages/editor-page/canvas/canvas.tsx
+++ b/src/pages/editor-page/canvas/canvas.tsx
@@ -133,7 +133,8 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables, readonly }) => {
} = useChartDB();
const { showSidePanel } = useLayout();
const { effectiveTheme } = useTheme();
- const { scrollAction, showDependenciesOnCanvas } = useLocalConfig();
+ const { scrollAction, showDependenciesOnCanvas, showMiniMapOnCanvas } =
+ useLocalConfig();
const { showAlert } = useAlert();
const { isMd: isDesktop } = useBreakpoint('md');
const nodeTypes = useMemo(() => ({ table: TableNode }), []);
@@ -871,12 +872,14 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables, readonly }) => {
>
<Toolbar readonly={readonly} />
</Controls>
- <MiniMap
- style={{
- width: isDesktop ? 100 : 60,
- height: isDesktop ? 100 : 60,
- }}
- />
+ {showMiniMapOnCanvas && (
+ <MiniMap
+ style={{
+ width: isDesktop ? 100 : 60,
+ height: isDesktop ? 100 : 60,
+ }}
+ />
+ )}
<Background
variant={BackgroundVariant.Dots}
gap={16}
diff --git a/src/pages/editor-page/top-navbar/top-navbar.tsx b/src/pages/editor-page/top-navbar/top-navbar.tsx
index 5798a964..0725465e 100644
--- a/src/pages/editor-page/top-navbar/top-navbar.tsx
+++ b/src/pages/editor-page/top-navbar/top-navbar.tsx
@@ -65,6 +65,8 @@ export const TopNavbar: React.FC<TopNavbarProps> = () => {
showCardinality,
setShowDependenciesOnCanvas,
showDependenciesOnCanvas,
+ setShowMiniMapOnCanvas,
+ showMiniMapOnCanvas,
} = useLocalConfig();
const { effectiveTheme } = useTheme();
const { t } = useTranslation();
@@ -205,6 +207,10 @@ export const TopNavbar: React.FC<TopNavbarProps> = () => {
window.open('https://waitlist.buckle.dev', '_blank');
}, []);
+ const showOrHideMiniMap = useCallback(() => {
+ setShowMiniMapOnCanvas(!showMiniMapOnCanvas);
+ }, [showMiniMapOnCanvas, setShowMiniMapOnCanvas]);
+
const renderGetBuckleButton = useCallback(() => {
return (
<button
@@ -512,6 +518,12 @@ export const TopNavbar: React.FC<TopNavbarProps> = () => {
: t('menu.view.show_dependencies')}
</MenubarItem>
) : null}
+
+ <MenubarItem onClick={showOrHideMiniMap}>
+ {showMiniMapOnCanvas
+ ? t('menu.view.hide_minimap')
+ : t('menu.view.show_minimap')}
+ </MenubarItem>
<MenubarSeparator />
<MenubarSub>
<MenubarSubTrigger>