discourse/app/assets/javascripts/float-kit/addon/lib/update-position.js
Kelv 0005565fb3
DEV: allow floatkit components to accept autoPlacement as a placement strategy (#33783)
`flip` and `autoPlacement` are [mutually exclusive
middleware](https://floating-ui.com/docs/autoplacement#conflict-with-flip)
dealing with placement. While our current Floatkit design uses `flip` by
default, there may be use cases where we want to specify using
`autoPlacement` instead.

Terming this as a choice of `visibilityOptimizer` which borrows from
floating-ui terminology of middleware that deals with `visibility
optimization`, while deconflicting with an existing `placementStrategy`
option in select-kit that is unrelated to this.
2025-07-24 11:04:51 +08:00

137 lines
3.3 KiB
JavaScript
Vendored

import {
arrow,
autoPlacement,
computePosition,
flip,
hide,
inline,
limitShift,
offset,
shift,
} from "@floating-ui/dom";
import domFromString from "discourse/lib/dom-from-string";
import { isTesting } from "discourse/lib/environment";
import { iconHTML } from "discourse/lib/icon-library";
import { headerOffset } from "discourse/lib/offset-calculator";
import {
FLOAT_UI_PLACEMENTS,
VISIBILITY_OPTIMIZERS,
} from "float-kit/lib/constants";
const centerOffset = offset(({ rects }) => {
return -rects.reference.height / 2 - rects.floating.height / 2;
});
export async function updatePosition(trigger, content, options) {
const padding = options.padding ?? {
top: headerOffset(),
left: 10,
right: 10,
bottom: 10,
};
const detectOverflowOptions = {
padding: isTesting() ? 0 : padding,
boundary: options.boundary,
};
// Determine which visibility optimizer middleware to use
const visibilityOptimizer =
options.visibilityOptimizer ?? VISIBILITY_OPTIMIZERS.FLIP;
const visibilityOptimizerMiddleware =
visibilityOptimizer === VISIBILITY_OPTIMIZERS.AUTO_PLACEMENT
? autoPlacement({
allowedPlacements: options.allowedPlacements ?? FLOAT_UI_PLACEMENTS,
...detectOverflowOptions,
})
: flip({
fallbackPlacements: options.fallbackPlacements ?? FLOAT_UI_PLACEMENTS,
...detectOverflowOptions,
});
const middleware = [];
const isCentered = options.placement === "center";
if (isCentered) {
middleware.push(centerOffset);
} else {
middleware.push(offset(options.offset ?? 10));
if (options.inline) {
middleware.push(inline());
}
middleware.push(visibilityOptimizerMiddleware);
let limiter;
if (options.limitShift) {
limiter = limitShift(options.limitShift);
}
middleware.push(
shift({
padding: detectOverflowOptions.padding,
limiter,
crossAxis: true,
})
);
}
let arrowElement;
if (options.arrow) {
arrowElement = content.querySelector(".arrow");
if (!arrowElement) {
arrowElement = domFromString(
iconHTML("tippy-rounded-arrow", { class: "arrow" })
)[0];
content.appendChild(arrowElement);
}
middleware.push(arrow({ element: arrowElement }));
}
if (options.hide) {
middleware.push(hide({ padding: detectOverflowOptions.padding }));
}
content.dataset.strategy = options.strategy || "absolute";
const { x, y, placement, middlewareData } = await computePosition(
trigger,
content,
{
placement: isCentered ? "bottom" : options.placement,
strategy: options.strategy || "absolute",
middleware,
}
);
if (options.computePosition) {
options.computePosition(content, {
x,
y,
placement,
middlewareData,
arrowElement,
});
} else {
content.dataset.placement = placement;
Object.assign(content.style, {
left: `${x}px`,
top: `${y}px`,
visibility: middlewareData.hide?.referenceHidden ? "hidden" : "visible",
});
if (middlewareData.arrow && arrowElement) {
const arrowX = middlewareData.arrow.x;
const arrowY = middlewareData.arrow.y;
Object.assign(arrowElement.style, {
left: arrowX != null ? `${arrowX}px` : "",
top: arrowY != null ? `${arrowY}px` : "",
});
}
}
}