@scrabble-solver/scrabble-solver 2.13.6 → 2.13.8

package/src/components/Results/HeaderButton.tsx

@@ -6,45 +6,48 @@ import { SortDown, SortUp } from 'icons';
 import { resultsSlice, selectResultsSort, useTranslate, useTypedSelector } from 'state';
 import { SortDirection } from 'types';
 
-import { useTooltip } from '../Tooltip';
+import { Tooltip } from '../Tooltip';
 
 import styles from './Results.module.scss';
 import { Column } from './types';
 
 interface Props {
   column: Column;
+  sortable?: boolean;
 }
 
-const HeaderButton = ({ column }: Props): ReactElement => {
+const HeaderButton = ({ column, sortable }: Props): ReactElement => {
   const dispatch = useDispatch();
   const translate = useTranslate();
   const sort = useTypedSelector(selectResultsSort);
-  const triggerProps = useTooltip(translate(column.translationKey));
 
   const handleClick = useCallback(() => {
     dispatch(resultsSlice.actions.sort(column.id));
   }, [column.id, dispatch]);
 
   return (
-    <button
-      aria-label={translate(column.translationKey)}
-      className={classNames(styles.headerButton, column.className)}
-      key={column.id}
-      type="button"
-      onClick={handleClick}
-      {...triggerProps}
-    >
-      <span className={styles.cell}>
-        <span className={styles.headerButtonLabel}>{translate(column.translationKey)}</span>
-
-        {sort.column === column.id && (
-          <>
-            {sort.direction === SortDirection.Ascending && <SortUp className={styles.sortIcon} />}
-            {sort.direction === SortDirection.Descending && <SortDown className={styles.sortIcon} />}
-          </>
-        )}
-      </span>
-    </button>
+    <Tooltip tooltip={translate(column.translationKey)}>
+      <button
+        aria-label={translate(column.translationKey)}
+        className={classNames(styles.headerButton, column.className, {
+          [styles.sortable]: sortable,
+        })}
+        key={column.id}
+        type="button"
+        onClick={sortable ? handleClick : undefined}
+      >
+        <span className={styles.cell}>
+          <span className={styles.headerButtonLabel}>{translate(column.translationKey)}</span>
+
+          {sort.column === column.id && (
+            <>
+              {sort.direction === SortDirection.Ascending && <SortUp className={styles.sortIcon} />}
+              {sort.direction === SortDirection.Descending && <SortDown className={styles.sortIcon} />}
+            </>
+          )}
+        </span>
+      </button>
+    </Tooltip>
   );
 };
 

package/src/components/Results/Result.tsx

@@ -1,10 +1,16 @@
 import classNames from 'classnames';
-import { CSSProperties, FocusEventHandler, MouseEventHandler, ReactElement, useRef } from 'react';
+import { CSSProperties, FocusEventHandler, MouseEventHandler, ReactElement, useMemo, useRef } from 'react';
 import Highlighter from 'react-highlight-words';
 
 import { LOCALE_FEATURES } from 'i18n';
-import { noop } from 'lib';
-import { selectIsResultMatching, selectLocale, selectResultsQuery, useTypedSelector } from 'state';
+import { getCoordinates, noop } from 'lib';
+import {
+  selectIsResultMatching,
+  selectLocale,
+  selectResultsQuery,
+  selectShowCoordinates,
+  useTypedSelector,
+} from 'state';
 import { ResultColumn } from 'types';
 
 import Cell from './Cell';
@@ -31,12 +37,14 @@ const Result = ({ data, index, style }: Props): ReactElement => {
   const ref = useRef<HTMLButtonElement>(null);
   const columns = useColumns();
   const locale = useTypedSelector(selectLocale);
+  const showCoordinates = useTypedSelector(selectShowCoordinates);
   const query = useTypedSelector(selectResultsQuery);
   const { consonants, direction, separator, vowels } = LOCALE_FEATURES[locale];
   const result = results[index];
   const isMatching = useTypedSelector((state) => selectIsResultMatching(state, index));
   const words = direction === 'rtl' ? [...result.words].reverse() : result.words;
   const enabledColumns = Object.fromEntries(columns.map((column) => [column.id, true]));
+  const coordinates = useMemo(() => getCoordinates(result, showCoordinates), [result, showCoordinates]);
 
   const handleClick: MouseEventHandler = (event) => onClick(result, event);
   const handleMouseEnter: MouseEventHandler = (event) => onMouseEnter(result, event);
@@ -61,6 +69,10 @@ const Result = ({ data, index, style }: Props): ReactElement => {
       onMouseLeave={handleMouseLeave}
     >
       <span className={styles.resultContent}>
+        {enabledColumns[ResultColumn.Coordinates] && (
+          <Cell className={styles.coordinates} translationKey="settings.showCoordinates" value={coordinates} />
+        )}
+
         {enabledColumns[ResultColumn.Word] && (
           <Cell className={styles.word} translationKey="common.word" value={result.word}>
             <Highlighter highlightClassName={styles.highlight} searchWords={[query]} textToHighlight={result.word} />

package/src/components/Results/Results.module.scss

@@ -24,10 +24,7 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
 
 .listContainer {
   position: absolute;
-  top: 0;
-  left: 0;
-  right: 0;
-  bottom: 0;
+  inset: 0;
 }
 
 .list {
@@ -55,37 +52,29 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
 
 .headerButton {
   @include button-reset;
-  @include focus-effect;
 
-  cursor: pointer;
   text-transform: uppercase;
   transition: var(--transition);
   background-color: var(--color--background);
 
-  &:focus,
-  &:hover {
-    background-color: var(--color--primary);
-    color: var(--color--primary--opposite);
-  }
-
   &:first-child {
-    [dir='ltr'] & {
-      border-top-left-radius: inherit;
-    }
-
-    [dir='rtl'] & {
-      border-top-right-radius: inherit;
-    }
+    border-start-start-radius: inherit;
   }
 
   &:last-child {
-    [dir='ltr'] & {
-      border-top-right-radius: inherit;
-    }
+    border-start-end-radius: inherit;
+  }
+}
 
-    [dir='rtl'] & {
-      border-top-left-radius: inherit;
-    }
+.sortable {
+  @include focus-effect;
+
+  cursor: pointer;
+
+  &:focus,
+  &:hover {
+    background-color: var(--color--primary);
+    color: var(--color--primary--opposite);
   }
 }
 
@@ -93,11 +82,7 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
   @include ellipsis;
 
   flex: 0 1 auto;
-  text-align: left;
-
-  [dir='rtl'] & {
-    text-align: right;
-  }
+  text-align: start;
 }
 
 .result {
@@ -139,6 +124,7 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
 
   .word {
     @include ellipsis;
+    display: flex;
   }
 }
 
@@ -151,30 +137,20 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
   gap: var(--spacing--s);
   line-height: var(--results--item--height);
 
-  .result &:first-child,
-  .headerButton:first-child & {
+  &.word,
+  .headerButton.word & {
     justify-content: flex-start;
+  }
 
-    [dir='ltr'] & {
-      padding-left: $row-padding-horizontal;
-      text-align: left;
-    }
-
-    [dir='rtl'] & {
-      padding-right: $row-padding-horizontal;
-      text-align: right;
-    }
+  .result &:first-child,
+  .headerButton:first-child & {
+    text-align: start;
+    padding-inline-start: $row-padding-horizontal;
   }
 
   .result &:last-child,
   .headerButton:last-child & {
-    [dir='ltr'] & {
-      padding-right: $row-padding-horizontal;
-    }
-
-    [dir='rtl'] & {
-      padding-left: $row-padding-horizontal;
-    }
+    padding-inline-end: $row-padding-horizontal;
   }
 
   &:last-child {
@@ -203,6 +179,13 @@ $row-padding-horizontal: calc(var(--spacing--m) + var(--spacing--s));
   font-weight: bold;
 }
 
+.coordinates {
+  $width: 50px;
+
+  flex: 0 0 $width;
+  max-width: $width;
+}
+
 .solveButton {
   display: block;
   margin: var(--spacing--xl) auto 0;

package/src/components/Results/Results.tsx

@@ -69,7 +69,7 @@ const Results: FunctionComponent<Props> = ({ callbacks, className, highlightedIn
     <div className={classNames(styles.results, className)}>
       <div className={styles.header}>
         {columns.map((column) => (
-          <HeaderButton column={column} key={column.id} />
+          <HeaderButton column={column} key={column.id} sortable={column.sortable} />
         ))}
       </div>
 

package/src/components/Results/getCoordinatesColumn.ts

@@ -0,0 +1,15 @@
+import { ResultColumn } from 'types';
+
+import styles from './Results.module.scss';
+import { Column } from './types';
+
+const getCoordinatesColumn = (): Column => {
+  return {
+    className: styles.coordinates,
+    id: ResultColumn.Coordinates,
+    translationKey: 'settings.showCoordinates',
+    sortable: false,
+  };
+};
+
+export default getCoordinatesColumn;

package/src/components/Results/getLocaleColumns.ts

@@ -10,11 +10,13 @@ const getLocaleColumns = (options: { consonants: boolean; vowels: boolean }): Co
       className: styles.word,
       id: ResultColumn.Word,
       translationKey: 'common.word',
+      sortable: true,
     },
     {
       className: styles.stat,
       id: ResultColumn.TilesCount,
       translationKey: 'common.tiles',
+      sortable: true,
     },
   ];
 
@@ -23,6 +25,7 @@ const getLocaleColumns = (options: { consonants: boolean; vowels: boolean }): Co
       className: styles.stat,
       id: ResultColumn.ConsonantsCount,
       translationKey: 'common.consonants',
+      sortable: true,
     });
   }
 
@@ -31,6 +34,7 @@ const getLocaleColumns = (options: { consonants: boolean; vowels: boolean }): Co
       className: styles.stat,
       id: ResultColumn.VowelsCount,
       translationKey: 'common.vowels',
+      sortable: true,
     });
   }
 
@@ -39,16 +43,19 @@ const getLocaleColumns = (options: { consonants: boolean; vowels: boolean }): Co
       className: styles.stat,
       id: ResultColumn.BlanksCount,
       translationKey: 'common.blanks',
+      sortable: true,
     },
     {
       className: styles.stat,
       id: ResultColumn.WordsCount,
       translationKey: 'common.words',
+      sortable: true,
     },
     {
       className: styles.points,
       id: ResultColumn.Points,
       translationKey: 'common.points',
+      sortable: true,
     },
   );
 

package/src/components/Results/types.ts

@@ -7,6 +7,7 @@ export interface Column {
   className: string;
   id: ResultColumn;
   translationKey: TranslationKey;
+  sortable?: boolean;
 }
 
 export interface ResultCallbacks {

package/src/components/Results/useColumns.ts

@@ -1,12 +1,13 @@
 import { useMediaQueries } from 'hooks';
 import { LOCALE_FEATURES } from 'i18n';
-import { selectLocale, useTypedSelector } from 'state';
+import { selectLocale, selectShowCoordinates, useTypedSelector } from 'state';
 import { ResultColumn } from 'types';
 
+import getCoordinatesColumn from './getCoordinatesColumn';
 import getLocaleColumns from './getLocaleColumns';
 import { Column } from './types';
 
-const COLUMNS_XS = [ResultColumn.Word, ResultColumn.Points];
+const COLUMNS_XS = [ResultColumn.Coordinates, ResultColumn.Word, ResultColumn.Points];
 
 const COLUMNS_S = [...COLUMNS_XS, ResultColumn.BlanksCount, ResultColumn.WordsCount];
 
@@ -17,25 +18,27 @@ const COLUMNS_L = [...COLUMNS_XS];
 const useColumns = (): Column[] => {
   const locale = useTypedSelector(selectLocale);
   const localeColumns = getLocaleColumns(LOCALE_FEATURES[locale]);
+  const showCoordinates = useTypedSelector(selectShowCoordinates);
+  const columns = showCoordinates === 'hidden' ? localeColumns : [getCoordinatesColumn(), ...localeColumns];
   const { isLessThanXs, isLessThanS, isLessThanM, isLessThanL } = useMediaQueries();
 
   if (isLessThanXs) {
-    return localeColumns.filter((column) => COLUMNS_XS.includes(column.id));
+    return columns.filter((column) => COLUMNS_XS.includes(column.id));
   }
 
   if (isLessThanS) {
-    return localeColumns.filter((column) => COLUMNS_S.includes(column.id));
+    return columns.filter((column) => COLUMNS_S.includes(column.id));
   }
 
   if (isLessThanM) {
-    return localeColumns.filter((column) => COLUMNS_M.includes(column.id));
+    return columns.filter((column) => COLUMNS_M.includes(column.id));
   }
 
   if (isLessThanL) {
-    return localeColumns.filter((column) => COLUMNS_L.includes(column.id));
+    return columns.filter((column) => COLUMNS_L.includes(column.id));
   }
 
-  return localeColumns;
+  return columns;
 };
 
 export default useColumns;

package/src/components/Solver/components/ResultCandidatePicker/ResultCandidatePicker.module.scss

@@ -82,23 +82,11 @@
 .points {
   flex: 0 0 auto;
   font-weight: bold;
+  border-inline-end: var(--border);
 
-  [dir='ltr'] & {
-    border-right: var(--border);
-
-    @include media('<xs') {
-      border-right: none;
-      padding-right: var(--spacing--xs);
-    }
-  }
-
-  [dir='rtl'] & {
-    border-left: var(--border);
-
-    @include media('<xs') {
-      border-left: none;
-      padding-left: var(--spacing--xs);
-    }
+  @include media('<xs') {
+    border-inline-end: none;
+    padding-inline-end: var(--spacing--xs);
   }
 }
 
@@ -110,40 +98,21 @@
   text-align: center;
   white-space: pre-wrap;
 
-  [dir='ltr'] & {
-    @include media('<xs') {
-      padding: var(--spacing--m);
-      text-align: left;
-    }
-  }
-
-  [dir='rtl'] & {
-    @include media('<xs') {
-      padding: var(--spacing--m);
-      text-align: right;
-    }
+  @include media('<xs') {
+    padding: var(--spacing--m);
+    text-align: start;
   }
 }
 
 .iconContainer {
   flex: 0 0 auto;
   display: flex;
-
-  [dir='ltr'] & {
-    padding-right: var(--spacing--l);
-  }
-
-  [dir='rtl'] & {
-    padding-left: var(--spacing--l);
-  }
+  padding-inline-end: var(--spacing--l);
 }
 
 .spinnerContainer {
   position: absolute;
-  top: 0;
-  right: 0;
-  bottom: 0;
-  left: 0;
+  inset: 0;
   display: flex;
   align-items: center;
   justify-content: center;

package/src/components/Tile/Tile.module.scss

@@ -76,10 +76,7 @@
 
 .input {
   position: absolute;
-  top: 0;
-  right: 0;
-  bottom: 0;
-  left: 0;
+  inset: 0;
   width: 100%;
   height: 100%;
   border: none;
@@ -98,6 +95,8 @@
   @include text-stroke(var(--background-color), 1px);
 
   position: absolute;
+  inset-block-end: 1%;
+  inset-inline-end: 9%;
   font-weight: bold;
   user-select: none;
   pointer-events: none;
@@ -106,16 +105,6 @@
   @include media('<xs') {
     display: none;
   }
-
-  [dir='ltr'] & {
-    bottom: 1%;
-    right: 9%;
-  }
-
-  [dir='rtl'] & {
-    top: 1%;
-    left: 9%;
-  }
 }
 
 .alert {
@@ -124,6 +113,9 @@
   position: absolute;
   width: var(--size);
   height: var(--size);
+  inset-block-start: 0;
+  inset-inline-end: 0;
+  border-start-end-radius: inherit;
   background: radial-gradient(
     var(--color--error--opposite),
     var(--color--error--opposite) 85%,
@@ -132,16 +124,4 @@
   );
   color: var(--color--error);
   pointer-events: none;
-
-  [dir='ltr'] & {
-    top: 0;
-    right: 0;
-    border-top-right-radius: inherit;
-  }
-
-  [dir='rtl'] & {
-    top: 0;
-    left: 0;
-    border-top-left-radius: inherit;
-  }
 }

package/src/components/Tooltip/Tooltip.tsx

@@ -0,0 +1,28 @@
+import type { Placement } from '@floating-ui/react';
+import { FunctionComponent, ReactNode } from 'react';
+
+import { TooltipContext } from './context';
+import { TooltipContent } from './TooltipContent';
+import { TooltipTrigger } from './TooltipTrigger';
+import { useTooltip } from './useTooltip';
+
+interface Props {
+  children: ReactNode;
+  placement?: Placement;
+  tooltip?: ReactNode;
+}
+
+export const Tooltip: FunctionComponent<Props> = ({ children, placement, tooltip }) => {
+  const state = useTooltip({ placement });
+
+  if (!tooltip) {
+    return children;
+  }
+
+  return (
+    <TooltipContext.Provider value={state}>
+      <TooltipTrigger>{children}</TooltipTrigger>
+      <TooltipContent>{tooltip}</TooltipContent>
+    </TooltipContext.Provider>
+  );
+};

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';