Skip to content

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

fix: move dbml into sections menu (#862)

Guy Ben-Aharon2531a7023f36
diff --git a/src/context/layout-context/layout-context.tsx b/src/context/layout-context/layout-context.tsx
index a3c2df1a..945b525a 100644
--- a/src/context/layout-context/layout-context.tsx
+++ b/src/context/layout-context/layout-context.tsx
@@ -2,6 +2,7 @@ import { emptyFn } from '@/lib/utils';
import { createContext } from 'react';
export type SidebarSection =
+ | 'dbml'
| 'tables'
| 'relationships'
| 'dependencies'
diff --git a/src/pages/editor-page/editor-sidebar/editor-sidebar.tsx b/src/pages/editor-page/editor-sidebar/editor-sidebar.tsx
index 97ae38f6..2e1732b3 100644
--- a/src/pages/editor-page/editor-sidebar/editor-sidebar.tsx
+++ b/src/pages/editor-page/editor-sidebar/editor-sidebar.tsx
@@ -10,7 +10,14 @@ import {
SidebarMenuButton,
SidebarMenuItem,
} from '@/components/sidebar/sidebar';
-import { BookOpen, Group, FileType, Plus, FolderOpen } from 'lucide-react';
+import {
+ BookOpen,
+ Group,
+ FileType,
+ Plus,
+ FolderOpen,
+ CodeXml,
+} from 'lucide-react';
import { SquareStack, Table, Workflow } from 'lucide-react';
import { useLayout } from '@/hooks/use-layout';
import { useTranslation } from 'react-i18next';
@@ -76,6 +83,15 @@ export const EditorSidebar: React.FC<EditorSidebarProps> = () => {
},
active: selectedSidebarSection === 'tables',
},
+ {
+ title: 'DBML',
+ icon: CodeXml,
+ onClick: () => {
+ showSidePanel();
+ selectSidebarSection('dbml');
+ },
+ active: selectedSidebarSection === 'dbml',
+ },
{
title: t('editor_sidebar.relationships'),
icon: Workflow,
diff --git a/src/pages/editor-page/side-panel/dbml-section/dbml-section.tsx b/src/pages/editor-page/side-panel/dbml-section/dbml-section.tsx
new file mode 100644
index 00000000..70de948f
--- /dev/null
+++ b/src/pages/editor-page/side-panel/dbml-section/dbml-section.tsx
@@ -0,0 +1,17 @@
+import React from 'react';
+import { TableDBML } from './table-dbml/table-dbml';
+
+export interface DBMLSectionProps {}
+
+export const DBMLSection: React.FC<DBMLSectionProps> = () => {
+ return (
+ <section
+ className="flex flex-1 flex-col overflow-hidden px-2"
+ data-vaul-no-drag
+ >
+ <div className="flex flex-1 flex-col overflow-hidden">
+ <TableDBML />
+ </div>
+ </section>
+ );
+};
diff --git a/src/pages/editor-page/side-panel/tables-section/table-dbml/table-dbml.tsx b/src/pages/editor-page/side-panel/dbml-section/table-dbml/table-dbml.tsx
similarity index 99%
rename from src/pages/editor-page/side-panel/tables-section/table-dbml/table-dbml.tsx
rename to src/pages/editor-page/side-panel/dbml-section/table-dbml/table-dbml.tsx
index 333f3fae..b5bae139 100644
--- a/src/pages/editor-page/side-panel/tables-section/table-dbml/table-dbml.tsx
+++ b/src/pages/editor-page/side-panel/dbml-section/table-dbml/table-dbml.tsx
@@ -5,7 +5,6 @@ import React, {
useCallback,
useRef,
} from 'react';
-import type { DBTable } from '@/lib/domain/db-table';
import { useChartDB } from '@/hooks/use-chartdb';
import { useTheme } from '@/hooks/use-theme';
import { CodeSnippet } from '@/components/code-snippet/code-snippet';
@@ -36,9 +35,7 @@ import type * as monaco from 'monaco-editor';
import { useTranslation } from 'react-i18next';
import { useFullScreenLoader } from '@/hooks/use-full-screen-spinner';
-export interface TableDBMLProps {
- filteredTables: DBTable[];
-}
+export interface TableDBMLProps {}
const getEditorTheme = (theme: EffectiveTheme) => {
return theme === 'dark' ? 'dbml-dark' : 'dbml-light';
diff --git a/src/pages/editor-page/side-panel/side-panel.tsx b/src/pages/editor-page/side-panel/side-panel.tsx
index 2943e8e4..8cc52290 100644
--- a/src/pages/editor-page/side-panel/side-panel.tsx
+++ b/src/pages/editor-page/side-panel/side-panel.tsx
@@ -18,6 +18,7 @@ import { useBreakpoint } from '@/hooks/use-breakpoint';
import { AreasSection } from './areas-section/areas-section';
import { CustomTypesSection } from './custom-types-section/custom-types-section';
import { DatabaseType } from '@/lib/domain/database-type';
+import { DBMLSection } from './dbml-section/dbml-section';
export interface SidePanelProps {}
@@ -75,6 +76,8 @@ export const SidePanel: React.FC<SidePanelProps> = () => {
) : null}
{selectedSidebarSection === 'tables' ? (
<TablesSection />
+ ) : selectedSidebarSection === 'dbml' ? (
+ <DBMLSection />
) : selectedSidebarSection === 'relationships' ? (
<RelationshipsSection />
) : selectedSidebarSection === 'dependencies' ? (
diff --git a/src/pages/editor-page/side-panel/tables-section/tables-section.tsx b/src/pages/editor-page/side-panel/tables-section/tables-section.tsx
index 9197f1ed..500c4628 100644
--- a/src/pages/editor-page/side-panel/tables-section/tables-section.tsx
+++ b/src/pages/editor-page/side-panel/tables-section/tables-section.tsx
@@ -1,7 +1,7 @@
-import React, { useCallback, useMemo, useState } from 'react';
+import React, { useCallback, useMemo } from 'react';
import { TableList } from './table-list/table-list';
import { Button } from '@/components/button/button';
-import { Table, List, X, Code } from 'lucide-react';
+import { Table, X } from 'lucide-react';
import { Input } from '@/components/input/input';
import type { DBTable } from '@/lib/domain/db-table';
import { useChartDB } from '@/hooks/use-chartdb';
@@ -9,16 +9,8 @@ import { useLayout } from '@/hooks/use-layout';
import { EmptyState } from '@/components/empty-state/empty-state';
import { ScrollArea } from '@/components/scroll-area/scroll-area';
import { useTranslation } from 'react-i18next';
-import {
- Tooltip,
- TooltipContent,
- TooltipTrigger,
-} from '@/components/tooltip/tooltip';
import { useViewport } from '@xyflow/react';
import { useDialog } from '@/hooks/use-dialog';
-import { TableDBML } from './table-dbml/table-dbml';
-import { useHotkeys } from 'react-hotkeys-hook';
-import { getOperatingSystem } from '@/lib/utils';
import type { DBSchema } from '@/lib/domain';
import { useDiagramFilter } from '@/context/diagram-filter-context/use-diagram-filter';
import { filterTable } from '@/lib/domain/diagram-filter/filter';
@@ -34,7 +26,6 @@ export const TablesSection: React.FC<TablesSectionProps> = () => {
const { t } = useTranslation();
const { openTableFromSidebar } = useLayout();
const [filterText, setFilterText] = React.useState('');
- const [showDBML, setShowDBML] = useState(false);
const filterInputRef = React.useRef<HTMLInputElement>(null);
const filteredTables = useMemo(() => {
@@ -104,52 +95,12 @@ export const TablesSection: React.FC<TablesSectionProps> = () => {
setFilterText('');
}, []);
- const operatingSystem = useMemo(() => getOperatingSystem(), []);
-
- useHotkeys(
- operatingSystem === 'mac' ? 'meta+p' : 'ctrl+p',
- () => {
- setShowDBML((value) => !value);
- },
- {
- preventDefault: true,
- },
- [setShowDBML]
- );
-
return (
<section
className="flex flex-1 flex-col overflow-hidden px-2"
data-vaul-no-drag
>
<div className="flex items-center justify-between gap-4 py-1">
- <div>
- <Tooltip>
- <TooltipTrigger asChild>
- <span>
- <Button
- variant="ghost"
- className="size-8 p-0"
- onClick={() =>
- setShowDBML((value) => !value)
- }
- >
- {showDBML ? (
- <List className="size-4" />
- ) : (
- <Code className="size-4" />
- )}
- </Button>
- </span>
- </TooltipTrigger>
- <TooltipContent>
- {showDBML
- ? t('side_panel.tables_section.show_list')
- : t('side_panel.tables_section.show_dbml')}
- {operatingSystem === 'mac' ? ' (⌘P)' : ' (Ctrl+P)'}
- </TooltipContent>
- </Tooltip>
- </div>
<div className="flex-1">
<Input
ref={filterInputRef}
@@ -170,40 +121,36 @@ export const TablesSection: React.FC<TablesSectionProps> = () => {
</Button>
</div>
<div className="flex flex-1 flex-col overflow-hidden">
- {showDBML ? (
- <TableDBML filteredTables={filteredTables} />
- ) : (
- <ScrollArea className="h-full">
- {tables.length === 0 ? (
- <EmptyState
- title={t(
- 'side_panel.tables_section.empty_state.title'
- )}
- description={t(
- 'side_panel.tables_section.empty_state.description'
- )}
- className="mt-20"
- />
- ) : filterText && filteredTables.length === 0 ? (
- <div className="mt-10 flex flex-col items-center gap-2">
- <div className="text-sm text-muted-foreground">
- {t('side_panel.tables_section.no_results')}
- </div>
- <Button
- variant="outline"
- size="sm"
- onClick={handleClearFilter}
- className="gap-1"
- >
- <X className="size-3.5" />
- {t('side_panel.tables_section.clear')}
- </Button>
+ <ScrollArea className="h-full">
+ {tables.length === 0 ? (
+ <EmptyState
+ title={t(
+ 'side_panel.tables_section.empty_state.title'
+ )}
+ description={t(
+ 'side_panel.tables_section.empty_state.description'
+ )}
+ className="mt-20"
+ />
+ ) : filterText && filteredTables.length === 0 ? (
+ <div className="mt-10 flex flex-col items-center gap-2">
+ <div className="text-sm text-muted-foreground">
+ {t('side_panel.tables_section.no_results')}
</div>
- ) : (
- <TableList tables={filteredTables} />
- )}
- </ScrollArea>
- )}
+ <Button
+ variant="outline"
+ size="sm"
+ onClick={handleClearFilter}
+ className="gap-1"
+ >
+ <X className="size-3.5" />
+ {t('side_panel.tables_section.clear')}
+ </Button>
+ </div>
+ ) : (
+ <TableList tables={filteredTables} />
+ )}
+ </ScrollArea>
</div>
</section>
);