feat: change floating molecule position from pixels to percentage

refactor: action buttons refactor: disable structure auto crop test: fix 'hide floating molecule' button selector test: fix 'Move floating molecule' button selector
cheminfo · Jan 31, 2025 · a778abc · a778abc
1 parent 162946d
commit a778abc
Show file tree

Hide file tree

Showing 7 changed files with 155 additions and 84 deletions.
diff --git a/src/component/1d-2d/components/FloatMoleculeStructures/ActionsButton.tsx b/src/component/1d-2d/components/FloatMoleculeStructures/ActionsButton.tsx
diff --git a/src/component/1d-2d/components/FloatMoleculeStructures/DraggableStructure.tsx b/src/component/1d-2d/components/FloatMoleculeStructures/DraggableStructure.tsx
@@ -1,7 +1,10 @@
 import styled from '@emotion/styled';
 import type { Ranges, Zones } from 'nmr-processing';
 import OCL from 'openchemlib/full';
+import { useEffect, useState } from 'react';
 import { ResponsiveChart } from 'react-d3-utils';
+import { BsArrowsMove } from 'react-icons/bs';
+import { FaTimes } from 'react-icons/fa';
 import OCLnmr from 'react-ocl-nmr';
 import { Rnd } from 'react-rnd';
 
@@ -12,14 +15,15 @@ import type {
 } from '../../../../data/molecules/Molecule.js';
 import { useDispatch } from '../../../context/DispatchContext.js';
 import { useGlobal } from '../../../context/GlobalContext.js';
+import { ActionsButtonsPopover } from '../../../elements/ActionsButtonsPopover.js';
+import type { ActionsButtonsPopoverProps } from '../../../elements/ActionsButtonsPopover.js';
 import { useHighlightColor } from '../../../hooks/useHighlightColor.js';
+import { useSVGUnitConverter } from '../../../hooks/useSVGUnitConverter.js';
 import { useCheckExportStatus } from '../../../hooks/useViewportSize.js';
 import { useMoleculeEditor } from '../../../modal/MoleculeStructureEditorModal.js';
 import useAtomAssignment from '../../../panels/MoleculesPanel/useAtomAssignment.js';
 import type { DisplayerMode } from '../../../reducer/Reducer.js';
 
-import ActionsButton from './ActionsButton.js';
-
 interface DraggableMoleculeProps extends DraggableStructureProps {
   width: number;
   height: number;
@@ -35,15 +39,9 @@ interface DraggableStructureProps {
   molecule: StateMoleculeExtended;
 }
 
-const AUTO_CROP_MARGIN = 30;
-
 const ReactRnd = styled(Rnd)`
   border: 1px solid transparent;
 
-  button {
-    visibility: hidden;
-  }
-
   .content {
     width: 100%;
     height: 100%;
@@ -52,10 +50,6 @@ const ReactRnd = styled(Rnd)`
   &:hover {
     border: 1px solid #ebecf1;
     background-color: white;
-
-    button {
-      visibility: visible;
-    }
   }
 `;
 
@@ -65,6 +59,15 @@ export function DraggableStructure(props: DraggableStructureProps) {
   const isExportProcessStart = useCheckExportStatus();
   const dispatch = useDispatch();
   const { modal, openMoleculeEditor } = useMoleculeEditor();
+  const { percentToPixel, pixelToPercent } = useSVGUnitConverter();
+  const [bounding, setBounding] = useState<MoleculeBoundingRect>(
+    moleculeView.floating.bounding,
+  );
+  const [isMoveActive, setIsMoveActive] = useState(false);
+
+  useEffect(() => {
+    setBounding({ ...moleculeView.floating.bounding });
+  }, [moleculeView.floating.bounding]);
 
   function floatMoleculeHandler() {
     dispatch({
@@ -88,10 +91,44 @@ export function DraggableStructure(props: DraggableStructureProps) {
     });
   }
 
+  function handleDrag(internalBounding: Pick<MoleculeBoundingRect, 'x' | 'y'>) {
+    setBounding((prevBounding) => ({
+      ...prevBounding,
+      ...convertPositionToPercent(internalBounding),
+    }));
+  }
+
+  function convertPositionToPercent({
+    x,
+    y,
+  }: Pick<MoleculeBoundingRect, 'x' | 'y'>) {
+    return { x: pixelToPercent(x, 'x'), y: pixelToPercent(y, 'y') };
+  }
+
   if (!viewerRef) return null;
 
+  const actionsButtons: ActionsButtonsPopoverProps['buttons'] = [
+    {
+      icon: <BsArrowsMove />,
+      intent: 'none',
+      title: 'Move molecule',
+      style: { cursor: 'move' },
+      className: 'handle',
+    },
+    {
+      icon: <FaTimes />,
+      intent: 'danger',
+      title: 'Hide molecule',
+      onClick: floatMoleculeHandler,
+    },
+  ];
+
+  const { x: xInPercent, y: yInPercent, width, height } = bounding;
+
+  const x = percentToPixel(xInPercent, 'x');
+  const y = percentToPixel(yInPercent, 'y');
+
   if (isExportProcessStart) {
-    const { width, height, x, y } = moleculeView.floating.bounding;
     return (
       <g transform={`translate(${x} ${y})`}>
         <DraggableMolecule {...{ width, height }} {...props} />
@@ -101,33 +138,55 @@ export function DraggableStructure(props: DraggableStructureProps) {
 
   return (
     <ReactRnd
-      default={moleculeView.floating.bounding}
-      minWidth={90 + AUTO_CROP_MARGIN * 2}
-      minHeight={100 + AUTO_CROP_MARGIN * 2}
+      default={{ x, y, width, height }}
+      position={{ x, y }}
+      minWidth={90}
+      minHeight={100}
       dragHandleClassName="handle"
       enableUserSelectHack={false}
       bounds={viewerRef}
       style={{ zIndex: 1 }}
       className="draggable-molecule"
+      onDragStart={() => setIsMoveActive(true)}
       onResizeStop={(e, dir, eRef, { width, height }) =>
         dragFloatMoleculeHandler({ width, height })
       }
+      onDrag={(e, { x, y }) => {
+        handleDrag({ x, y });
+      }}
       onDragStop={(e, { x, y }) => {
-        dragFloatMoleculeHandler({ x, y });
+        dragFloatMoleculeHandler(convertPositionToPercent({ x, y }));
+        setIsMoveActive(false);
       }}
       resizeHandleWrapperStyle={{ backgroundColor: 'white' }}
     >
-      <div
-        className="content"
-        onDoubleClick={() => openMoleculeEditor(molecule)}
+      <ActionsButtonsPopover
+        buttons={actionsButtons}
+        fill
+        positioningStrategy="fixed"
+        position="top-left"
+        direction="row"
+        targetProps={{ style: { width: '100%', height: '100%' } }}
+        space={2}
+        {...(isMoveActive && { isOpen: true })}
+        modifiers={{
+          offset: {
+            data: { x, y },
+          },
+        }}
       >
-        <ActionsButton onFloatBtnClick={floatMoleculeHandler} />
-        <ResponsiveChart>
-          {({ width, height }) => {
-            return <DraggableMolecule {...{ width, height }} {...props} />;
-          }}
-        </ResponsiveChart>
-      </div>
+        <div
+          className="content"
+          onDoubleClick={() => openMoleculeEditor(molecule)}
+        >
+          <ResponsiveChart>
+            {({ width, height }) => {
+              return <DraggableMolecule {...{ width, height }} {...props} />;
+            }}
+          </ResponsiveChart>
+        </div>
+      </ActionsButtonsPopover>
+
       {modal}
     </ReactRnd>
   );
@@ -158,10 +217,8 @@ function DraggableMolecule(props: DraggableMoleculeProps) {
     <OCLnmr
       OCL={OCL}
       id={`molSVG${index || ''}`}
-      autoCrop
-      autoCropMargin={AUTO_CROP_MARGIN}
-      height={height - AUTO_CROP_MARGIN * 2}
-      width={width - AUTO_CROP_MARGIN * 2}
+      height={height}
+      width={width}
       label={molecule.label}
       labelFontSize={15}
       labelColor="rgb(0,0,0)"

diff --git a/src/component/elements/ActionsButtonsPopover.tsx b/src/component/elements/ActionsButtonsPopover.tsx
@@ -20,24 +20,33 @@ const Container = styled.div<Pick<CSSProperties, 'flexDirection' | 'gap'>>`
     padding: 5px;
   }
 `;
-
+interface ActionButtonProps
+  extends Pick<
+    ButtonProps,
+    | 'icon'
+    | 'onClick'
+    | 'intent'
+    | 'disabled'
+    | 'onPointerDown'
+    | 'style'
+    | 'className'
+  > {
+  title?: string;
+  visible?: boolean;
+  css?: Interpolation<Theme>;
+}
 export interface ActionsButtonsPopoverProps
   extends Omit<PopoverProps, 'interactionKind' | 'content'> {
-  buttons: Array<
-    Pick<
-      ButtonProps,
-      'icon' | 'onClick' | 'intent' | 'disabled' | 'onPointerDown' | 'style'
-    > & {
-      title?: string;
-      visible?: boolean;
-      css?: Interpolation<Theme>;
-    }
-  >;
+  buttons: ActionButtonProps[];
   contentStyle?: CSSProperties;
   direction?: 'column' | 'row';
   space?: number;
 }
 
+function ActionButton(props: ButtonProps) {
+  return <Button {...props} />;
+}
+
 export function ActionsButtonsPopover(props: ActionsButtonsPopoverProps) {
   const {
     buttons,
@@ -60,7 +69,7 @@ export function ActionsButtonsPopover(props: ActionsButtonsPopoverProps) {
           {buttons
             .filter((button) => button?.visible !== false)
             .map(({ title, visible, ...otherProps }, index) => (
-              <Button
+              <ActionButton
                 key={title || index}
                 tooltipProps={{ content: title || '', compact: true }}
                 {...otherProps}

diff --git a/src/component/hooks/useSVGUnitConverter.ts b/src/component/hooks/useSVGUnitConverter.ts
@@ -0,0 +1,28 @@
+import { useChartData } from '../context/ChartContext.js';
+
+function truncate(value, numberOfDigits = 0) {
+  const power = 10 ** numberOfDigits;
+  return Math.trunc(value * power) / power;
+}
+
+export function convertPixelToPercent(value: number, baseValue: number) {
+  return truncate((value / baseValue) * 100, 3);
+}
+export function convertPercentToPixel(value: number, baseValue: number) {
+  return Math.round((value / 100) * baseValue);
+}
+
+export function useSVGUnitConverter() {
+  const { width, height } = useChartData();
+
+  function pixelToPercent(value: number, axis: 'x' | 'y') {
+    const size = axis === 'x' ? width : height;
+    return convertPixelToPercent(value, size);
+  }
+  function percentToPixel(value: number, axis: 'x' | 'y') {
+    const size = axis === 'x' ? width : height;
+    return convertPercentToPixel(value, size);
+  }
+
+  return { pixelToPercent, percentToPixel };
+}
diff --git a/src/component/reducer/actions/MoleculeActions.ts b/src/component/reducer/actions/MoleculeActions.ts
@@ -19,6 +19,7 @@ import { DRAGGABLE_STRUCTURE_INITIAL_BOUNDING_REACT } from '../../../data/molecu
 import * as MoleculeManager from '../../../data/molecules/MoleculeManager.js';
 import { generateColor } from '../../../data/utilities/generateColor.js';
 import type { AssignmentContext } from '../../assignment/AssignmentsContext.js';
+import { convertPixelToPercent } from '../../hooks/useSVGUnitConverter.js';
 import type { State } from '../Reducer.js';
 import { MARGIN } from '../core/Constants.js';
 import type { ActionType } from '../types/ActionType.js';
@@ -346,7 +347,10 @@ function getFloatingMoleculeInitialPosition(id: string, draft: Draft<State>) {
   }
   const x = ((index + 1) % columns) * (width / columns) + left;
   const y = Math.floor(moleculeKeys.length / columns) * (height / rows) + top;
-  return { x, y };
+  return {
+    x: convertPixelToPercent(x, displayerWidth),
+    y: convertPixelToPercent(y, displayerHeight),
+  };
 }
 
 function floatMoleculeOverSpectrum(

diff --git a/src/data/molecules/Molecule.ts b/src/data/molecules/Molecule.ts
@@ -25,10 +25,10 @@ export interface MoleculeBoundingRect {
 
 export const DRAGGABLE_STRUCTURE_INITIAL_BOUNDING_REACT: MoleculeBoundingRect =
   {
-    x: 100,
-    y: 50,
-    width: 190,
-    height: 200,
+    x: 10,
+    y: 10,
+    width: 130,
+    height: 120,
   };
 
 export type MoleculesView = Record<string, MoleculeView>;

diff --git a/test-e2e/panels/structures.test.ts b/test-e2e/panels/structures.test.ts
@@ -419,15 +419,14 @@ test('molecules 1H spectrum', async ({ page, browserName }) => {
   });
   await test.step('Close float molecule', async () => {
     // Close float molecule draggable structure.
-    await nmrium.page.click(
-      '_react=DraggableStructure >> _react=ButtonDanger',
-      { force: true },
-    );
+    const structureLocator = nmrium.page.locator('_react=DraggableStructure');
+    await structureLocator.hover();
+    await nmrium.page
+      .locator('_react=ActionButton[tooltipProps.content *= "Hide molecule" i]')
+      .click();
     // Check floated molecule.
     await expect(nmrium.page.locator('#molSVG')).toBeHidden();
-    await expect(
-      nmrium.page.locator('_react=DraggableStructure '),
-    ).toBeHidden();
+    await expect(structureLocator).toBeHidden();
     // Check float molecule btn is off.
     await expect(
       nmrium.getToolbarLocatorByTitle('Float molecule', { active: true }),
@@ -665,8 +664,10 @@ test('check callbacks count on changing structures', async ({ page }) => {
     await expect(viewCount).toContainText(String(initialViewCount + 1));
   });
   await test.step('change float position molecule', async () => {
+    const structureLocator = nmrium.page.locator('_react=DraggableStructure');
+    await structureLocator.hover();
     await nmrium.page
-      .locator('_react=DraggableStructure >> _react=ButtonAction')
+      .locator('_react=ActionButton[tooltipProps.content *= "Move molecule" i]')
       .dragTo(nmrium.page.locator('_react=XAxis1D >> nth=1'), { force: true });
     await expect(dataCount).toContainText(String(initialDataCount + 1));
     await expect(viewCount).toContainText(String(initialViewCount + 2));