@scrabble-solver/scrabble-solver 2.13.6 → 2.13.7

package/src/components/Tooltip/TooltipContent.tsx

@@ -0,0 +1,53 @@
+import { FloatingArrow, FloatingPortal, useDelayGroup, useMergeRefs, useTransitionStyles } from '@floating-ui/react';
+import { forwardRef, HTMLProps } from 'react';
+
+import { TOOLTIP_DURATION } from 'parameters';
+
+import { useTooltipContext } from './context';
+import styles from './Tooltip.module.scss';
+
+type Props = HTMLProps<HTMLDivElement>;
+
+const INSTANT_DURATION = 0;
+
+export const TooltipContent = forwardRef<HTMLDivElement, Props>((props, ref) => {
+  const state = useTooltipContext();
+  const { context } = state;
+  const { isInstantPhase, currentId } = useDelayGroup(context, { id: context.floatingId });
+  const finalRef = useMergeRefs([state.refs.setFloating, ref]);
+
+  const instantPhaseDuration = {
+    open: INSTANT_DURATION,
+    close: currentId === context.floatingId ? TOOLTIP_DURATION : INSTANT_DURATION,
+  };
+
+  const { isMounted, styles: transitionStyles } = useTransitionStyles(context, {
+    duration: isInstantPhase ? instantPhaseDuration : TOOLTIP_DURATION,
+    initial: {
+      opacity: 0,
+    },
+  });
+
+  if (!isMounted) {
+    return null;
+  }
+
+  return (
+    <FloatingPortal>
+      <div
+        className={styles.tooltip}
+        ref={finalRef}
+        style={{
+          ...state.floatingStyles,
+          ...props.style,
+          ...transitionStyles,
+        }}
+        {...state.getFloatingProps(props)}
+      >
+        <div>{props.children}</div>
+
+        <FloatingArrow className={styles.arrow} context={context} ref={state.arrowRef} />
+      </div>
+    </FloatingPortal>
+  );
+});

package/src/components/Tooltip/TooltipTrigger.tsx

@@ -0,0 +1,26 @@
+import { useMergeRefs } from '@floating-ui/react';
+import { HTMLProps, cloneElement, forwardRef, isValidElement } from 'react';
+
+import { useTooltipContext } from './context';
+
+type Props = HTMLProps<HTMLElement>;
+
+export const TooltipTrigger = forwardRef<HTMLElement, Props>(({ children, ...props }, ref) => {
+  const state = useTooltipContext();
+  const childrenElement = children as any; // eslint-disable-line @typescript-eslint/no-explicit-any
+  const finalRef = useMergeRefs([state.refs.setReference, ref, childrenElement.ref]);
+
+  if (!isValidElement(children)) {
+    throw new Error("TooltipTrigger's children are not a valid element");
+  }
+
+  return cloneElement(
+    children,
+    state.getReferenceProps({
+      ref: finalRef,
+      ...props,
+      ...children.props,
+      'data-state': state.open ? 'open' : 'closed',
+    }),
+  );
+});

package/src/components/Tooltip/context.ts

@@ -0,0 +1,17 @@
+import { createContext, useContext } from 'react';
+
+import { useTooltip } from './useTooltip';
+
+type TooltipContextType = ReturnType<typeof useTooltip> | null;
+
+export const TooltipContext = createContext<TooltipContextType>(null);
+
+export const useTooltipContext = () => {
+  const context = useContext(TooltipContext);
+
+  if (context === null) {
+    throw new Error('Tooltip components must be wrapped in <Tooltip />');
+  }
+
+  return context;
+};

package/src/components/Tooltip/index.ts

@@ -1 +1 @@
-export { default as useTooltip } from './useTooltip';
+export { Tooltip } from './Tooltip';

package/src/components/Tooltip/useTooltip.ts

@@ -0,0 +1,54 @@
+import {
+  Placement,
+  arrow,
+  autoUpdate,
+  flip,
+  offset,
+  shift,
+  useDelayGroup,
+  useDismiss,
+  useFloating,
+  useFocus,
+  useHover,
+  useInteractions,
+  useRole,
+} from '@floating-ui/react';
+import { useMemo, useRef, useState } from 'react';
+
+const ARROW_SIZE = 7;
+const ARROW_GAP = 3;
+const PADDING = 10;
+
+interface TooltipOptions {
+  placement?: Placement;
+}
+
+export const useTooltip = ({ placement = 'top' }: TooltipOptions = {}) => {
+  const [isOpen, setIsOpen] = useState(false);
+  const arrowRef = useRef(null);
+  const data = useFloating({
+    placement,
+    open: isOpen,
+    onOpenChange: setIsOpen,
+    whileElementsMounted: autoUpdate,
+    middleware: [flip(), shift({ padding: PADDING }), offset(ARROW_SIZE + ARROW_GAP), arrow({ element: arrowRef })],
+  });
+  const { context } = data;
+  const { delay } = useDelayGroup(context);
+  const hover = useHover(context, { move: false, delay });
+  const focus = useFocus(context);
+  const dismiss = useDismiss(context);
+  const role = useRole(context, { role: 'tooltip' });
+  const interactions = useInteractions([hover, focus, dismiss, role]);
+
+  return useMemo(
+    () => ({
+      arrowRef,
+      open: isOpen,
+      setOpen: setIsOpen,
+      ...interactions,
+      ...data,
+    }),
+    [arrowRef, isOpen, setIsOpen, interactions, data],
+  );
+};

package/src/components/index.ts

@@ -23,4 +23,4 @@ export { default as SeoMessage } from './SeoMessage';
 export { default as Solver } from './Solver';
 export { default as Spinner } from './Spinner';
 export { default as Tile } from './Tile';
-export { useTooltip } from './Tooltip';
+export * from './Tooltip';

package/src/hooks/index.ts

@@ -9,5 +9,4 @@ export { default as useMedia } from './useMedia';
 export { default as useMediaQueries } from './useMediaQueries';
 export { default as useMediaQuery } from './useMediaQuery';
 export { default as useOnWindowResize } from './useOnWindowResize';
-export { default as usePortal } from './usePortal';
 export { default as useViewportSize } from './useViewportSize';

package/src/lib/getCoordinates.ts

@@ -0,0 +1,18 @@
+import { Result, ShowCoordinates } from '@scrabble-solver/types';
+
+import getCoordinate from './getCoordinate';
+
+const getCoordinates = (result: Result, showCoordinates: ShowCoordinates): string => {
+  if (showCoordinates === 'hidden') {
+    return '';
+  }
+
+  const firstCell = result.cells[0];
+  const isHorizontal = firstCell.x !== result.cells[1].x;
+  const x = getCoordinate(firstCell.x, showCoordinates === 'original' ? 'letter' : 'number');
+  const y = getCoordinate(firstCell.y, showCoordinates === 'original' ? 'number' : 'letter');
+
+  return isHorizontal ? `${y}${x}` : `${x}${y}`;
+};
+
+export default getCoordinates;

package/src/lib/groupResults.ts

@@ -18,18 +18,23 @@ const groupResults = (
     return results;
   }
 
+  const regExp = createRegExp(query);
+
   return results.reduce<GroupedResults>(
-    ({ matching, other }, result) => {
-      const matchesQuery = createRegExp(query).test(result.word);
-      const matchesCellFilter = cellFilter.every(({ x, y }) => {
-        return result.cells.some((cell) => cell.x === x && cell.y === y);
-      });
-      const isMatching = matchesQuery && matchesCellFilter;
-
-      return {
-        matching: isMatching ? [...matching, result] : matching,
-        other: isMatching ? other : [...other, result],
-      };
+    (groupedResults, result) => {
+      const matchesQuery = () => regExp.test(result.word);
+      const matchesCellFilter = () =>
+        cellFilter.every(({ x, y }) => {
+          return result.cells.some((cell) => cell.x === x && cell.y === y);
+        });
+
+      if (matchesCellFilter() && matchesQuery()) {
+        groupedResults.matching.push(result);
+      } else {
+        groupedResults.other.push(result);
+      }
+
+      return groupedResults;
     },
     { matching: [], other: [] },
   );

package/src/lib/index.ts

@@ -1,5 +1,4 @@
 export { default as arrayEquals } from './arrayEquals';
-export { default as canUseDom } from './canUseDom';
 export { default as createArray } from './createArray';
 export { default as createComparator } from './createComparator';
 export { default as createGridOf } from './createGridOf';
@@ -15,6 +14,8 @@ export { default as extractCharactersByCase } from './extractCharactersByCase';
 export { default as extractInputValue } from './extractInputValue';
 export { default as findCell } from './findCell';
 export { default as getCellSize } from './getCellSize';
+export { default as getCoordinate } from './getCoordinate';
+export { default as getCoordinates } from './getCoordinates';
 export { default as getRemainingTiles } from './getRemainingTiles';
 export { default as getRemainingTilesCount } from './getRemainingTilesCount';
 export { default as getRemainingTilesGroups } from './getRemainingTilesGroups';

package/src/lib/sortResults.ts

@@ -8,6 +8,7 @@ import reverseComparator from './reverseComparator';
 const comparators: Record<ResultColumn, (locale: string) => Comparator<Result>> = {
   [ResultColumn.BlanksCount]: (locale: string) => createKeyComparator('blanksCount', locale),
   [ResultColumn.ConsonantsCount]: (locale: string) => createKeyComparator('consonantsCount', locale),
+  [ResultColumn.Coordinates]: () => () => 0,
   [ResultColumn.Points]: (locale: string) => createKeyComparator('points', locale),
   [ResultColumn.TilesCount]: (locale: string) => createKeyComparator('tilesCount', locale),
   [ResultColumn.VowelsCount]: (locale: string) => createKeyComparator('vowelsCount', locale),

package/src/pages/_app.tsx

@@ -1,3 +1,4 @@
+import { FloatingDelayGroup } from '@floating-ui/react';
 import { AppProps } from 'next/app';
 import Head from 'next/head';
 import { FunctionComponent } from 'react';
@@ -64,7 +65,10 @@ const App: FunctionComponent<AppProps> = ({ Component, pageProps }) => (
 
     <Provider store={store}>
       <SeoMessage />
-      <Component {...pageProps} />
+
+      <FloatingDelayGroup delay={0}>
+        <Component {...pageProps} />
+      </FloatingDelayGroup>
     </Provider>
   </>
 );

package/src/parameters/index.ts

@@ -90,6 +90,7 @@ export const MODAL_HEADER_HEIGHT = 45;
 export const NAV_PADDING = SPACING_L;
 
 export const TILE_SIZE = 80;
+export const TOOLTIP_DURATION = TRANSITION_DURATION;
 
 export const PLAIN_TILES_COLOR_DEFAULT = COLOR_GREEN;
 export const PLAIN_TILES_PADDING_HORIZONTAL = 0;

package/src/types/index.ts

@@ -40,6 +40,7 @@ export interface RemainingTilesGroup {
 export enum ResultColumn {
   BlanksCount = 'blanks-count',
   ConsonantsCount = 'consonants-count',
+  Coordinates = 'coordinates',
   Points = 'points',
   TilesCount = 'tiles-count',
   VowelsCount = 'vowels-count',