Skip to content

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

add overlap indicator (#240)

Guy Ben-Aharonb1ad2641e3ea
diff --git a/index.html b/index.html
index 19a76bbb..9fb45ca2 100644
--- a/index.html
+++ b/index.html
@@ -11,6 +11,11 @@
href="https://fonts.googleapis.com/css2?family=Raleway:ital,wght@0,100..900;1,100..900&display=swap"
rel="stylesheet"
/>
+ <script
+ src="https://cdn.usefathom.com/script.js"
+ data-site="PRHIVBNN"
+ defer
+ ></script>
</head>
<body>
<div id="root"></div>
diff --git a/src/i18n/locales/de.ts b/src/i18n/locales/de.ts
index 03de78aa..b3dc5785 100644
--- a/src/i18n/locales/de.ts
+++ b/src/i18n/locales/de.ts
@@ -196,6 +196,8 @@ export const de: LanguageTranslation = {
undo: 'Rückgängig',
redo: 'Wiederholen',
reorder_diagram: 'Diagramm neu anordnen',
+ // TODO: Translate
+ highlight_overlapping_tables: 'Highlight Overlapping Tables',
},
new_diagram_dialog: {
diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts
index 01a69099..52e26337 100644
--- a/src/i18n/locales/en.ts
+++ b/src/i18n/locales/en.ts
@@ -193,6 +193,7 @@ export const en = {
undo: 'Undo',
redo: 'Redo',
reorder_diagram: 'Reorder Diagram',
+ highlight_overlapping_tables: 'Highlight Overlapping Tables',
},
new_diagram_dialog: {
diff --git a/src/i18n/locales/es.ts b/src/i18n/locales/es.ts
index 0d51b06b..9ee5123f 100644
--- a/src/i18n/locales/es.ts
+++ b/src/i18n/locales/es.ts
@@ -186,6 +186,8 @@ export const es: LanguageTranslation = {
undo: 'Deshacer',
redo: 'Rehacer',
reorder_diagram: 'Reordenar Diagrama',
+ // TODO: Translate
+ highlight_overlapping_tables: 'Highlight Overlapping Tables',
},
new_diagram_dialog: {
diff --git a/src/i18n/locales/fr.ts b/src/i18n/locales/fr.ts
index 90db244d..e9e206a5 100644
--- a/src/i18n/locales/fr.ts
+++ b/src/i18n/locales/fr.ts
@@ -186,6 +186,8 @@ export const fr: LanguageTranslation = {
undo: 'Annuler',
redo: 'Rétablir',
reorder_diagram: 'Réorganiser le Diagramme',
+ // TODO: Translate
+ highlight_overlapping_tables: 'Highlight Overlapping Tables',
},
new_diagram_dialog: {
diff --git a/src/i18n/locales/ja.ts b/src/i18n/locales/ja.ts
index 291cde89..b123edfe 100644
--- a/src/i18n/locales/ja.ts
+++ b/src/i18n/locales/ja.ts
@@ -196,6 +196,8 @@ export const ja: LanguageTranslation = {
undo: '元に戻す',
redo: 'やり直し',
reorder_diagram: 'ダイアグラムを並べ替え',
+ // TODO: Translate
+ highlight_overlapping_tables: 'Highlight Overlapping Tables',
},
new_diagram_dialog: {
diff --git a/src/lib/colors.ts b/src/lib/colors.ts
index 9757c35a..71fd4c69 100644
--- a/src/lib/colors.ts
+++ b/src/lib/colors.ts
@@ -12,9 +12,10 @@ export const colorOptions = [
'#ffe374', // A warm yellow.
'#ff9f74', // A peachy orange.
];
+
export const randomColor = () => {
return colorOptions[Math.floor(Math.random() * colorOptions.length)];
};
-export const greyColor = '#b0b0b0'; // A Cloudy Grey.
-export const blackColor = '#000'; // A Blacky black.
+export const viewColor = '#b0b0b0';
+export const materializedViewColor = '#7d7d7d';
diff --git a/src/lib/domain/db-table.ts b/src/lib/domain/db-table.ts
index 64551812..571360de 100644
--- a/src/lib/domain/db-table.ts
+++ b/src/lib/domain/db-table.ts
@@ -3,7 +3,7 @@ import type { DBField } from './db-field';
import type { TableInfo } from '../data/import-metadata/metadata-types/table-info';
import type { ColumnInfo } from '../data/import-metadata/metadata-types/column-info';
import type { IndexInfo } from '../data/import-metadata/metadata-types/index-info';
-import { blackColor, greyColor, randomColor } from '@/lib/colors';
+import { materializedViewColor, viewColor, randomColor } from '@/lib/colors';
import type { DBRelationship } from './db-relationship';
import type { PrimaryKeyInfo } from '../data/import-metadata/metadata-types/primary-key-info';
import type { ViewInfo } from '../data/import-metadata/metadata-types/view-info';
@@ -176,9 +176,9 @@ export const createTablesFromMetadata = ({
fields,
indexes: dbIndexes,
color: isMaterializedView
- ? blackColor
+ ? materializedViewColor
: isView
- ? greyColor
+ ? viewColor
: randomColor(),
isView: isView,
isMaterializedView: isMaterializedView,
diff --git a/src/pages/editor-page/canvas/canvas.tsx b/src/pages/editor-page/canvas/canvas.tsx
index 4992c562..f5e76d02 100644
--- a/src/pages/editor-page/canvas/canvas.tsx
+++ b/src/pages/editor-page/canvas/canvas.tsx
@@ -36,7 +36,7 @@ import {
} from './table-node/table-node-field';
import { Toolbar } from './toolbar/toolbar';
import { useToast } from '@/components/toast/use-toast';
-import { Pencil, LayoutGrid } from 'lucide-react';
+import { Pencil, LayoutGrid, AlertTriangle } from 'lucide-react';
import { Button } from '@/components/button/button';
import { useLayout } from '@/hooks/use-layout';
import { useBreakpoint } from '@/hooks/use-breakpoint';
@@ -135,6 +135,8 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables }) => {
const { showAlert } = useDialog();
const { isMd: isDesktop } = useBreakpoint('md');
const nodeTypes = useMemo(() => ({ table: TableNode }), []);
+ const [highlightOverlappingTables, setHighlightOverlappingTables] =
+ useState(false);
const [isInitialLoadingNodes, setIsInitialLoadingNodes] = useState(true);
const [overlapGraph, setOverlapGraph] =
@@ -292,6 +294,7 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables }) => {
data: {
...node.data,
isOverlapping,
+ highlightOverlappingTables,
},
};
})
@@ -302,6 +305,7 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables }) => {
filteredSchemas,
overlapGraph.lastUpdated,
overlapGraph.graph,
+ highlightOverlappingTables,
]);
const prevFilteredSchemas = useRef<string[] | undefined>(undefined);
@@ -670,6 +674,19 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables }) => {
});
}, [t, showAlert, reorderTables]);
+ const hasOverlappingTables = useMemo(
+ () =>
+ Array.from(overlapGraph.graph).some(
+ ([, value]) => value.length > 0
+ ),
+ [overlapGraph]
+ );
+
+ const pulseOverlappingTables = useCallback(() => {
+ setHighlightOverlappingTables(true);
+ setTimeout(() => setHighlightOverlappingTables(false), 600);
+ }, []);
+
return (
<CanvasContextMenu>
<div className="relative flex h-full">
@@ -702,22 +719,51 @@ export const Canvas: React.FC<CanvasProps> = ({ initialTables }) => {
showInteractive={false}
className="!shadow-none"
>
- <Tooltip>
- <TooltipTrigger asChild>
- <span>
- <Button
- variant="secondary"
- className="size-8 p-1 shadow-none"
- onClick={showReorderConfirmation}
- >
- <LayoutGrid className="size-4" />
- </Button>
- </span>
- </TooltipTrigger>
- <TooltipContent>
- {t('toolbar.reorder_diagram')}
- </TooltipContent>
- </Tooltip>
+ <div className="flex flex-col items-center gap-2 md:flex-row">
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <span>
+ <Button
+ variant="secondary"
+ className="size-8 p-1 shadow-none"
+ onClick={showReorderConfirmation}
+ >
+ <LayoutGrid className="size-4" />
+ </Button>
+ </span>
+ </TooltipTrigger>
+ <TooltipContent>
+ {t('toolbar.reorder_diagram')}
+ </TooltipContent>
+ </Tooltip>
+
+ <div
+ className={`transition-opacity duration-300 ease-in-out ${
+ hasOverlappingTables
+ ? 'opacity-100'
+ : 'opacity-0'
+ }`}
+ >
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <span>
+ <Button
+ variant="default"
+ className="size-8 p-1 shadow-none"
+ onClick={pulseOverlappingTables}
+ >
+ <AlertTriangle className="size-4 text-white" />
+ </Button>
+ </span>
+ </TooltipTrigger>
+ <TooltipContent>
+ {t(
+ 'toolbar.highlight_overlapping_tables'
+ )}
+ </TooltipContent>
+ </Tooltip>
+ </div>
+ </div>
</Controls>
{isLoadingDOM ? (
<Controls
diff --git a/src/pages/editor-page/canvas/table-node/table-node.tsx b/src/pages/editor-page/canvas/table-node/table-node.tsx
index 96e2d766..549efad0 100644
--- a/src/pages/editor-page/canvas/table-node/table-node.tsx
+++ b/src/pages/editor-page/canvas/table-node/table-node.tsx
@@ -27,6 +27,7 @@ export type TableNodeType = Node<
{
table: DBTable;
isOverlapping: boolean;
+ highlightOverlappingTables?: boolean;
},
'table'
>;
@@ -37,7 +38,12 @@ export const MIN_TABLE_SIZE = 224;
export const TABLE_MINIMIZED_FIELDS = 10;
export const TableNode: React.FC<NodeProps<TableNodeType>> = React.memo(
- ({ selected, dragging, id, data: { table, isOverlapping } }) => {
+ ({
+ selected,
+ dragging,
+ id,
+ data: { table, isOverlapping, highlightOverlappingTables },
+ }) => {
const { updateTable, relationships } = useChartDB();
const edges = useStore((store) => store.edges) as EdgeType[];
const { openTableFromSidebar, selectSidebarSection } = useLayout();
@@ -128,7 +134,13 @@ export const TableNode: React.FC<NodeProps<TableNodeType>> = React.memo(
? 'border-pink-600'
: 'border-slate-500 dark:border-slate-700',
isOverlapping
- ? 'ring-2 ring-offset-slate-50 dark:ring-offset-slate-900 ring-blue-500 ring-offset-2 animate-pulse-border animate-scale'
+ ? 'ring-2 ring-offset-slate-50 dark:ring-offset-slate-900 ring-blue-500 ring-offset-2'
+ : '',
+ !highlightOverlappingTables && isOverlapping
+ ? 'animate-scale'
+ : '',
+ highlightOverlappingTables && isOverlapping
+ ? 'animate-scale-2'
: ''
)}
onClick={(e) => {
diff --git a/tailwind.config.js b/tailwind.config.js
index d1186899..145dbf2f 100644
--- a/tailwind.config.js
+++ b/tailwind.config.js
@@ -67,19 +67,22 @@ module.exports = {
from: { height: 'var(--radix-accordion-content-height)' },
to: { height: '0' },
},
- 'pulse-border': {
- '0%, 100%': { borderColor: 'rgba(59, 130, 246, 0.5)' },
- '50%': { borderColor: 'rgba(59, 130, 246, 1)' },
- },
scale: {
'0%': { transform: 'scale(1)' },
'50%': { transform: 'scale(1.05)' },
'100%': { transform: 'scale(1)' },
},
+ 'scale-2': {
+ '0%': { transform: 'scale(1)' },
+ '50%': { transform: 'scale(1.05)' },
+ '100%': { transform: 'scale(1)' },
+ },
},
animation: {
'accordion-down': 'accordion-down 0.2s ease-out',
'accordion-up': 'accordion-up 0.2s ease-out',
+ scale: 'scale 1s ease-in-out 1',
+ 'scale-2': 'scale-2 1s ease-in-out 2',
},
},
},