Skip to content

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

fix: add field comments indicators with tooltips (#989)

Jonathan Fishner41c05c067f8a
diff --git a/src/pages/editor-page/canvas/table-node/table-edit-mode/table-edit-mode-field.tsx b/src/pages/editor-page/canvas/table-node/table-edit-mode/table-edit-mode-field.tsx
index da46531e..5f9c674b 100644
--- a/src/pages/editor-page/canvas/table-node/table-edit-mode/table-edit-mode-field.tsx
+++ b/src/pages/editor-page/canvas/table-node/table-edit-mode/table-edit-mode-field.tsx
@@ -72,9 +72,9 @@ export const TableEditModeField: React.FC<TableEditModeFieldProps> = React.memo(
)}
>
<div className="flex flex-1 items-center justify-start gap-1 overflow-hidden">
- <Tooltip>
- <TooltipTrigger asChild>
- <span className="min-w-0 flex-1">
+ <span className="relative min-w-0 flex-1">
+ <Tooltip>
+ <TooltipTrigger asChild>
<Input
ref={inputRef}
className="h-8 w-full !truncate bg-background focus-visible:ring-0"
@@ -88,10 +88,27 @@ export const TableEditModeField: React.FC<TableEditModeFieldProps> = React.memo(
}
autoFocus={focused}
/>
- </span>
- </TooltipTrigger>
- <TooltipContent>{fieldName}</TooltipContent>
- </Tooltip>
+ </TooltipTrigger>
+ <TooltipContent>{fieldName}</TooltipContent>
+ </Tooltip>
+ {field.comments ? (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <div className="absolute right-0 top-0 h-full w-[10px] cursor-pointer">
+ <div className="pointer-events-none absolute right-0 top-0 size-0 border-l-[10px] border-t-[10px] border-l-transparent border-t-pink-500" />
+ </div>
+ </TooltipTrigger>
+ <TooltipContent>
+ <div>
+ <div className="font-normal text-white/70 dark:text-black/70">
+ Comment:
+ </div>
+ <div>{field.comments}</div>
+ </div>
+ </TooltipContent>
+ </Tooltip>
+ ) : null}
+ </span>
<Tooltip>
<TooltipTrigger
className="flex h-8 min-w-0 flex-1"
diff --git a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field-modal/table-field-modal.tsx b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field-modal/table-field-modal.tsx
index d60318cc..e8c9f4e2 100644
--- a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field-modal/table-field-modal.tsx
+++ b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field-modal/table-field-modal.tsx
@@ -39,6 +39,8 @@ export interface TableFieldPopoverProps {
databaseType: DatabaseType;
updateField: (attrs: Partial<DBField>) => void;
removeField: () => void;
+ open?: boolean;
+ onOpenChange?: (open: boolean) => void;
}
export const TableFieldPopover: React.FC<TableFieldPopoverProps> = ({
@@ -47,11 +49,28 @@ export const TableFieldPopover: React.FC<TableFieldPopoverProps> = ({
databaseType,
updateField,
removeField,
+ open: controlledOpen,
+ onOpenChange: controlledOnOpenChange,
}) => {
const { readonly } = useChartDB();
const { t } = useTranslation();
const [localField, setLocalField] = React.useState<DBField>(field);
- const [isOpen, setIsOpen] = React.useState(false);
+ const [internalOpen, setInternalOpen] = React.useState(false);
+
+ const isOpen = useMemo(
+ () => controlledOpen ?? internalOpen,
+ [controlledOpen, internalOpen]
+ );
+ const setIsOpen = useCallback(
+ (open: boolean) => {
+ if (controlledOnOpenChange) {
+ controlledOnOpenChange(open);
+ } else {
+ setInternalOpen(open);
+ }
+ },
+ [controlledOnOpenChange, setInternalOpen]
+ );
// Check if this field is the only primary key in the table
const isOnlyPrimaryKey = React.useMemo(() => {
diff --git a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
index b3d72d9d..2d6f3d8d 100644
--- a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
+++ b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState, useCallback } from 'react';
import { GripVertical, KeyRound } from 'lucide-react';
import { Input } from '@/components/input/input';
import { generateDBFieldSuffix, type DBField } from '@/lib/domain/db-field';
@@ -58,6 +58,11 @@ export const TableField: React.FC<TableFieldProps> = ({
const typeRequiresNotNull = requiresNotNull(field.type.name);
+ const [popoverOpen, setPopoverOpen] = useState(false);
+ const handleCommentIndicatorClick = useCallback(() => {
+ setPopoverOpen(true);
+ }, []);
+
return (
<div
className="flex flex-1 touch-none flex-row justify-between gap-2 p-1"
@@ -74,9 +79,9 @@ export const TableField: React.FC<TableFieldProps> = ({
<GripVertical className="size-3.5 text-muted-foreground" />
</div>
) : null}
- <Tooltip>
- <TooltipTrigger asChild>
- <span className="min-w-0 flex-1">
+ <span className="relative min-w-0 flex-1">
+ <Tooltip>
+ <TooltipTrigger asChild>
<Input
className="h-8 w-full !truncate focus-visible:ring-0"
type="text"
@@ -89,10 +94,30 @@ export const TableField: React.FC<TableFieldProps> = ({
}
readOnly={readonly}
/>
- </span>
- </TooltipTrigger>
- <TooltipContent>{field.name}</TooltipContent>
- </Tooltip>
+ </TooltipTrigger>
+ <TooltipContent>{field.name}</TooltipContent>
+ </Tooltip>
+ {field.comments ? (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <div
+ className="absolute right-0 top-0 h-full w-[10px] cursor-pointer"
+ onClick={handleCommentIndicatorClick}
+ >
+ <div className="pointer-events-none absolute right-0 top-0 size-0 border-l-[10px] border-t-[10px] border-l-transparent border-t-pink-500" />
+ </div>
+ </TooltipTrigger>
+ <TooltipContent>
+ <div>
+ <div className="font-normal text-white/70 dark:text-black/70">
+ Comment:
+ </div>
+ <div>{field.comments}</div>
+ </div>
+ </TooltipContent>
+ </Tooltip>
+ ) : null}
+ </span>
<Tooltip>
<TooltipTrigger className="flex h-8 min-w-0 flex-1" asChild>
<span>
@@ -165,6 +190,8 @@ export const TableField: React.FC<TableFieldProps> = ({
updateField={updateField}
removeField={removeField}
databaseType={databaseType}
+ open={popoverOpen}
+ onOpenChange={setPopoverOpen}
/>
</div>
</div>