Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: LEAP-1424: LEAP-1370: Allow to zoom and pan the image in preview modal #6781

Merged
merged 26 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ceb62fd
feat: LEAP-1424: Open preview window for images in Grid view
hlomzik Dec 3, 2024
0dd939d
Fix missing react hooks imports
hlomzik Dec 3, 2024
c7ae398
Add hotkeys for navigation between pages
hlomzik Dec 3, 2024
5eb7e44
Small comment about key and image flickering
hlomzik Dec 3, 2024
54a4dcf
Add more hotkeys, improve appearance, add tooltip
hlomzik Dec 3, 2024
9ca7d19
Add FF to control preview in Grid View
hlomzik Dec 7, 2024
e279968
Show preview modal only if there is an image in a task
hlomzik Dec 7, 2024
3029244
Simple code improvement
hlomzik Dec 7, 2024
d57dad7
Wrap methods in `useCallback()`
hlomzik Dec 10, 2024
2ca9ee0
Wrap one more function with `useCallback()`
hlomzik Dec 10, 2024
01d0bb6
Merge branch 'develop' into 'fb-leap-1424/grid-preview'
MihajloHoma Dec 11, 2024
63c9adc
feat: LEAP-1370: Allow to zoom and pan the image in preview modal
hlomzik Dec 12, 2024
d425b42
Prevent Quick View from opening in a background by hotkey
hlomzik Dec 12, 2024
7426d82
Move zoom settings to constants
hlomzik Dec 12, 2024
94fcfeb
Constrain image to not fall behind some limits
hlomzik Dec 12, 2024
3609025
Fix hotkeys interception for background hotkeys
hlomzik Dec 12, 2024
e2e1365
Fix hotkeys interception for background hotkeys
hlomzik Dec 12, 2024
3d482b8
Merge branch 'develop' into 'fb-leap-1424/grid-preview'
MihajloHoma Dec 13, 2024
0200389
Properly handle view change
hlomzik Dec 13, 2024
fb65a2a
Properly handle view change
hlomzik Dec 13, 2024
a166400
Fix linting
hlomzik Dec 13, 2024
28e62c3
Fix linting
hlomzik Dec 13, 2024
b737b18
Merge branch 'fb-leap-1424/grid-preview' into fb-leap-1370/zoom-image…
hlomzik Dec 13, 2024
876b69c
Fix silly mistake
hlomzik Dec 16, 2024
dfabd62
Merge branch 'develop' into 'fb-leap-1370/zoom-image-preview'
hlomzik Dec 17, 2024
1b3a3b1
Merge branch 'develop' into fb-leap-1370/zoom-image-preview
hlomzik Dec 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion web/libs/datamanager/src/components/Common/Table/utils.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export const prepareColumns = (columns, hidden) => {
if (!hidden?.length) return columns;
return columns.filter((col) => {
return !(hidden ?? []).includes(col.id);
return !hidden.includes(col.id);
});
};

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.modal {
padding: 16px;
position: relative;
}

.header {
display: flex;
justify-content: space-between;
align-items: center;
box-sizing: content-box;
margin-bottom: 16px;
}

.tooltip {
font-size: 12px;
max-width: 300px;
line-height: 16px;

p {
margin-bottom: 4px;
}

p:last-child {
margin-bottom: 0;
}
}

.actions {
margin-left: auto;

& > * {
width: 20px;
margin-left: 16px;
text-align: center;
cursor: pointer;
}
}

.container {
overflow: hidden;
width: 100%;
height: 100%;
min-height: 100px;
display: flex;
position: relative;
}

.container button {
padding: 0;
flex: 20px 0 0;
cursor: pointer;
background: none;

&:hover {
background: var(--sand_200);
}
}

.image {
pointer-events: none;
user-select: none;
}
178 changes: 178 additions & 0 deletions web/libs/datamanager/src/components/MainView/GridView/GridPreview.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
import { CloseOutlined, LeftCircleOutlined, QuestionCircleOutlined, RightCircleOutlined } from "@ant-design/icons";
import { Checkbox } from "@humansignal/ui";
import { observer } from "mobx-react";
import type { PropsWithChildren } from "react";
import { createContext, useCallback, useEffect, useRef, useState } from "react";
import { modal } from "../../Common/Modal/Modal";
import { Icon } from "../../Common/Icon/Icon";
import { Tooltip } from "../../Common/Tooltip/Tooltip";
import { ImagePreview } from "./ImagePreview";

import styles from "./GridPreview.module.scss";

type Task = {
id: number;
data: Record<string, string>;
};

type GridViewContextType = {
tasks: Task[];
imageField: string | undefined;
currentTaskId: number | null;
setCurrentTaskId: (id: number | null) => void;
};

type TaskModalProps = GridViewContextType & { view: any; imageField: string };

export const GridViewContext = createContext<GridViewContextType>({
tasks: [],
imageField: undefined,
currentTaskId: null,
setCurrentTaskId: () => {},
});

const TaskModal = observer(({ view, tasks, imageField, currentTaskId, setCurrentTaskId }: TaskModalProps) => {
const index = tasks.findIndex((task) => task.id === currentTaskId);
const task = tasks[index];

const goToNext = useCallback(() => {
if (index < tasks.length - 1) {
setCurrentTaskId(tasks[index + 1].id);
}
}, [index, tasks]);

const goToPrev = useCallback(() => {
if (index > 0) {
setCurrentTaskId(tasks[index - 1].id);
}
}, [index, tasks]);

const onSelect = useCallback(() => {
if (task) {
view.toggleSelected(task.id);
}
}, [task, view]);

const onClose = useCallback(() => {
setCurrentTaskId(null);
}, []);

// assign hotkeys
useEffect(() => {
const onKeyDown = (event: KeyboardEvent) => {
if (event.key === "ArrowLeft") {
goToPrev();
} else if (event.key === "ArrowRight") {
goToNext();
} else if (event.key === " ") {
onSelect();
event.preventDefault();
} else if (event.key === "Escape") {
onClose();
} else {
// pass this event through for other keys
return;
}

event.stopPropagation();
};

document.addEventListener("keydown", onKeyDown);
return () => document.removeEventListener("keydown", onKeyDown);
}, [goToNext, goToPrev, onSelect, onClose]);

if (!task) {
return null;
}

const tooltip = (
<div className={styles.tooltip}>
<p>Preview of the task image to quickly navigate through the tasks and select the ones you want to work on.</p>
<p>Use [arrow keys] to navigate.</p>
<p>[Escape] to close the modal.</p>
<p>[Space] to select/unselect the task.</p>
</div>
);

return (
<div className={styles.modal}>
<div className={styles.header}>
<Checkbox checked={view.selected.isSelected(task.id)} onChange={onSelect}>
Task {task.id}
</Checkbox>
<div className={styles.actions}>
<Tooltip title={tooltip}>
<Icon icon={QuestionCircleOutlined} />
</Tooltip>
<Icon icon={CloseOutlined} onClick={onClose} />
</div>
</div>
<div className={styles.container}>
<button type="button" onClick={goToPrev} disabled={index === 0}>
<Icon icon={LeftCircleOutlined} />
</button>
<ImagePreview task={task} field={imageField} />
<button type="button" onClick={goToNext} disabled={index === tasks.length - 1}>
<Icon icon={RightCircleOutlined} />
</button>
</div>
</div>
);
});

type GridViewProviderProps = PropsWithChildren<{
data: Task[];
view: any;
fields: { alias: string; currentType: string }[];
}>;

export const GridViewProvider: React.FC<GridViewProviderProps> = ({ children, data, view, fields }) => {
const [currentTaskId, setCurrentTaskId] = useState<number | null>(null);
const modalRef = useRef<{ update: (props: object) => void; close: () => void } | null>(null);
const imageField = fields.find((f) => f.currentType === "Image")?.alias;

const onClose = useCallback(() => {
modalRef.current = null;
setCurrentTaskId(null);
}, []);

useEffect(() => {
if (currentTaskId === null) {
modalRef.current?.close();
return;
}

if (!imageField) return;

const children = (
<TaskModal
view={view}
tasks={data}
imageField={imageField}
currentTaskId={currentTaskId}
setCurrentTaskId={setCurrentTaskId}
/>
);

if (!modalRef.current) {
modalRef.current = modal({
bare: true,
title: "Task Preview",
style: { width: 800 },
children,
onHidden: onClose,
});
} else {
modalRef.current.update({ children });
}
}, [currentTaskId, data, onClose]);

// close the modal when we leave the view (by browser controls or by hotkeys)
useEffect(() => () => modalRef.current?.close(), []);

return (
<GridViewContext.Provider value={{ tasks: data, imageField, currentTaskId, setCurrentTaskId }}>
{children}
</GridViewContext.Provider>
);
};
94 changes: 55 additions & 39 deletions web/libs/datamanager/src/components/MainView/GridView/GridView.jsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { observer } from "mobx-react";
import React from "react";
import { useCallback, useContext, useMemo } from "react";
import AutoSizer from "react-virtualized-auto-sizer";
import { FixedSizeGrid } from "react-window";
import InfiniteLoader from "react-window-infinite-loader";
Expand All @@ -8,9 +8,10 @@ import { Checkbox } from "@humansignal/ui";
import { Space } from "../../Common/Space/Space";
import { getProperty, prepareColumns } from "../../Common/Table/utils";
import * as DataGroups from "../../DataGroups";
import "./GridView.scss";
import { FF_LOPS_E_3, isFF } from "../../../utils/feature-flags";
import { FF_GRID_PREVIEW, FF_LOPS_E_3, isFF } from "../../../utils/feature-flags";
import { SkeletonLoader } from "../../Common/SkeletonLoader";
import { GridViewContext, GridViewProvider } from "./GridPreview";
import "./GridView.scss";

const GridHeader = observer(({ row, selected }) => {
const isSelected = selected.isSelected(row.id);
Expand Down Expand Up @@ -56,11 +57,24 @@ const GridDataGroup = observer(({ type, value, field, row }) => {
});

const GridCell = observer(({ view, selected, row, fields, onClick, ...props }) => {
const { setCurrentTaskId, imageField } = useContext(GridViewContext);

const handleBodyClick = useCallback(
(e) => {
if (!isFF(FF_GRID_PREVIEW) || !imageField) return;
e.stopPropagation();
setCurrentTaskId(row.id);
},
[imageField, row.id],
);

return (
<Elem {...props} name="cell" onClick={onClick} mod={{ selected: selected.isSelected(row.id) }}>
<Elem name="cell-content">
<GridHeader view={view} row={row} fields={fields} selected={view.selected} />
<GridBody view={view} row={row} fields={fields} />
<Elem name="cell-body" onClick={handleBodyClick}>
<GridBody view={view} row={row} fields={fields} />
</Elem>
</Elem>
</Elem>
);
Expand All @@ -71,7 +85,7 @@ export const GridView = observer(({ data, view, loadMore, fields, onChange, hidd

const getCellIndex = (row, column) => columnCount * row + column;

const fieldsData = React.useMemo(() => {
const fieldsData = useMemo(() => {
return prepareColumns(fields, hiddenFields);
}, [fields, hiddenFields]);

Expand All @@ -83,7 +97,7 @@ export const GridView = observer(({ data, view, loadMore, fields, onChange, hidd
return res + height;
}, 16);

const renderItem = React.useCallback(
const renderItem = useCallback(
({ style, rowIndex, columnIndex }) => {
const index = getCellIndex(rowIndex, columnIndex);
const row = data[index];
Expand Down Expand Up @@ -124,7 +138,7 @@ export const GridView = observer(({ data, view, loadMore, fields, onChange, hidd

const itemCount = Math.ceil(data.length / columnCount);

const isItemLoaded = React.useCallback(
const isItemLoaded = useCallback(
(index) => {
const rowIndex = index * columnCount;
const rowFullfilled = data.slice(rowIndex, columnCount).length === columnCount;
Expand All @@ -135,37 +149,39 @@ export const GridView = observer(({ data, view, loadMore, fields, onChange, hidd
);

return (
<Block name="grid-view" mod={{ columnCount }}>
<Elem tag={AutoSizer} name="resize">
{({ width, height }) => (
<InfiniteLoader
itemCount={itemCount}
isItemLoaded={isItemLoaded}
loadMoreItems={loadMore}
threshold={Math.floor(view.dataStore.pageSize / 2)}
minimumBatchSize={view.dataStore.pageSize}
>
{({ onItemsRendered, ref }) => (
<Elem
tag={FixedSizeGrid}
ref={ref}
width={width}
height={height}
name="list"
rowHeight={rowHeight + 42}
overscanRowCount={view.dataStore.pageSize}
columnCount={columnCount}
columnWidth={width / columnCount - 9.5}
rowCount={itemCount}
onItemsRendered={onItemsRenderedWrap(onItemsRendered)}
style={{ overflowX: "hidden" }}
>
{renderItem}
</Elem>
)}
</InfiniteLoader>
)}
</Elem>
</Block>
<GridViewProvider data={data} view={view} fields={fieldsData}>
<Block name="grid-view" mod={{ columnCount }}>
<Elem tag={AutoSizer} name="resize">
{({ width, height }) => (
<InfiniteLoader
itemCount={itemCount}
isItemLoaded={isItemLoaded}
loadMoreItems={loadMore}
threshold={Math.floor(view.dataStore.pageSize / 2)}
minimumBatchSize={view.dataStore.pageSize}
>
{({ onItemsRendered, ref }) => (
<Elem
tag={FixedSizeGrid}
ref={ref}
width={width}
height={height}
name="list"
rowHeight={rowHeight + 42}
overscanRowCount={view.dataStore.pageSize}
columnCount={columnCount}
columnWidth={width / columnCount - 9.5}
rowCount={itemCount}
onItemsRendered={onItemsRenderedWrap(onItemsRendered)}
style={{ overflowX: "hidden" }}
>
{renderItem}
</Elem>
)}
</InfiniteLoader>
)}
</Elem>
</Block>
</GridViewProvider>
);
});
Loading
Loading