Skip to content

Commit

Permalink
Fix Flex stacking context bug
Browse files Browse the repository at this point in the history
've proposed an upstream fix for this at Rich-Harris/stacking-order#4

For now, this commit inlines that dependency and applies the fix
  • Loading branch information
bvaughn committed Feb 14, 2024
1 parent cd9ff01 commit bf52644
Show file tree
Hide file tree
Showing 5 changed files with 316 additions and 16 deletions.
4 changes: 0 additions & 4 deletions declaration.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@ declare module "*.module.css" {
const content: Record<string, string>;
export default content;
}

declare module "stacking-order" {
export function compare(a: Element, b: Element): number;
}
3 changes: 0 additions & 3 deletions packages/react-resizable-panels/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,6 @@
"test:watch": "jest --config=jest.config.js --watch",
"watch": "parcel watch --port=2345"
},
"dependencies": {
"stacking-order": "^1"
},
"devDependencies": {
"@babel/plugin-proposal-nullish-coalescing-operator": "7.18.6",
"@babel/plugin-proposal-optional-chaining": "7.21.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { compare } from "stacking-order";
import { Direction, ResizeEvent } from "./types";
import { resetGlobalCursorStyle, setGlobalCursorStyle } from "./utils/cursor";
import { getResizeEventCoordinates } from "./utils/events/getResizeEventCoordinates";
import { getInputType } from "./utils/getInputType";
import { intersects } from "./utils/rects/intersects";
import { compare } from "./vendor/stacking-order";

export type ResizeHandlerAction = "down" | "move" | "up";
export type SetResizeHandlerState = (
Expand Down
130 changes: 130 additions & 0 deletions packages/react-resizable-panels/src/vendor/stacking-order.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
// Forked from NPM stacking-order@2.0.0
// Background at https://github.com/Rich-Harris/stacking-order/issues/3

import assert from "assert";

/**
* Determine which of two nodes appears in front of the other —
* if `a` is in front, returns 1, otherwise returns -1
* @param {HTMLElement} a
* @param {HTMLElement} b
*/
export function compare(a: HTMLElement, b: HTMLElement): number {
if (a === b) throw new Error("Cannot compare node with itself");

const ancestors = {
a: get_ancestors(a),
b: get_ancestors(b),
};

let common_ancestor;

// remove shared ancestors
while (ancestors.a.at(-1) === ancestors.b.at(-1)) {
a = ancestors.a.pop() as HTMLElement;
b = ancestors.b.pop() as HTMLElement;

common_ancestor = a;
}

assert(common_ancestor);

const z_indexes = {
a: get_z_index(find_stacking_context(ancestors.a)),
b: get_z_index(find_stacking_context(ancestors.b)),
};

if (z_indexes.a === z_indexes.b) {
const children = common_ancestor.childNodes;

const furthest_ancestors = {
a: ancestors.a.at(-1),
b: ancestors.b.at(-1),
};

let i = children.length;
while (i--) {
const child = children[i];
if (child === furthest_ancestors.a) return 1;
if (child === furthest_ancestors.b) return -1;
}
}

return Math.sign(z_indexes.a - z_indexes.b);
}

const props =
/\b(?:position|zIndex|opacity|transform|webkitTransform|mixBlendMode|filter|webkitFilter|isolation)\b/;

/** @param {HTMLElement} node */
function is_flex_item(node: HTMLElement) {
const display = getComputedStyle(get_parent(node)).display;
return display === "flex" || display === "inline-flex";
}

/** @param {HTMLElement} node */
function creates_stacking_context(node: HTMLElement) {
const style = getComputedStyle(node);

// https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Positioning/Understanding_z_index/The_stacking_context
if (style.position === "fixed") return true;
// Forked to fix upstream bug https://github.com/Rich-Harris/stacking-order/issues/3
// if (
// (style.zIndex !== "auto" && style.position !== "static") ||
// is_flex_item(node)
// )
if (
style.zIndex !== "auto" &&
(style.position !== "static" || is_flex_item(node))
)
return true;
if (+style.opacity < 1) return true;
if ("transform" in style && style.transform !== "none") return true;
if ("webkitTransform" in style && style.webkitTransform !== "none")
return true;
if ("mixBlendMode" in style && style.mixBlendMode !== "normal") return true;
if ("filter" in style && style.filter !== "none") return true;
if ("webkitFilter" in style && style.webkitFilter !== "none") return true;
if ("isolation" in style && style.isolation === "isolate") return true;
if (props.test(style.willChange)) return true;
// @ts-expect-error
if (style.webkitOverflowScrolling === "touch") return true;

return false;
}

/** @param {HTMLElement[]} nodes */
function find_stacking_context(nodes: HTMLElement[]) {
let i = nodes.length;

while (i--) {
const node = nodes[i];
assert(node);
if (creates_stacking_context(node)) return node;
}

return null;
}

/** @param {HTMLElement} node */
function get_z_index(node: HTMLElement | null) {
return (node && Number(getComputedStyle(node).zIndex)) || 0;
}

/** @param {HTMLElement} node */
function get_ancestors(node: HTMLElement) {
const ancestors = [];

while (node) {
ancestors.push(node);
node = get_parent(node);
}

return ancestors; // [ node, ... <body>, <html>, document ]
}

/** @param {HTMLElement} node */
function get_parent(node: HTMLElement) {
// @ts-ignore
return node.parentNode?.host || node.parentNode;
}
Loading

0 comments on commit bf52644

Please sign in to comment.