@popperjs/core/lib/utils/computeAutoPlacement.js.flow

Tooltip and Popover Positioning Engine

// @flow
import type { State, Padding } from '../types';
import type {
  Placement,
  BasePlacement,
  VariationPlacement,
  Boundary,
  RootBoundary,
  ComputedPlacement,
} from '../enums';
import getVariation from './getVariation';
import { variationPlacements, basePlacements } from '../enums';
import detectOverflow from './detectOverflow';
import getBasePlacement from './getBasePlacement';

type Options = {
  placement: Placement,
  padding: Padding,
  boundary: Boundary,
  rootBoundary: RootBoundary,
  flipVariations: boolean,
};

type OverflowsMap = {
  [BasePlacement | VariationPlacement]: number,
};

export default function computeAutoPlacement(
  state: $Shape<State>,
  options: Options = {}
): Array<ComputedPlacement> {
  const {
    placement,
    boundary,
    rootBoundary,
    padding,
    flipVariations,
  } = options;

  const variation = getVariation(placement);

  const placements = variation
    ? flipVariations
      ? variationPlacements
      : variationPlacements.filter(
          placement => getVariation(placement) === variation
        )
    : basePlacements;

  // $FlowFixMe: Flow seems to have problems with two array unions...
  const overflows: OverflowsMap = placements.reduce((acc, placement) => {
    acc[placement] = detectOverflow(state, {
      placement,
      boundary,
      rootBoundary,
      padding,
    })[getBasePlacement(placement)];

    return acc;
  }, {});

  return Object.keys(overflows).sort((a, b) => overflows[a] - overflows[b]);
}