logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
5.25.4
  • CSS in v6
  • 👀 Visual Regression Testing
  • Why is it so hard to disable the date?
  • HOC Aggregate FieldItem
  • Line Ellipsis Calculation
  • 📢 v4 surpassed maintenance period
  • Type Util
  • A build ghost
  • Ant Design meets CSS Variables
  • Historical Debt of API
  • Stacked Notification
  • Color Models and Color Picker
  • Extends Theme
  • Virtual Table is here!
  • Happy Work Theme
  • Where is the dynamic style?
  • Suspense breaks styles
  • Bundle Size Optimization
  • Hi, GitHub Actions
  • To be what you see
  • Pain of static methods
  • SSR Static style export
  • Dependency troubleshooting
  • Contributor development maintenance guide
  • Repost: How to submit a riddle
  • Tooltip align update
  • Unnecessary Rerender
  • How to Grow as a Collaborator
  • Funny Modal hook BUG
  • about antd test library migration
  • Tree's check conduction
  • Some change on getContainer
  • Component-level CSS-in-JS

Funny Modal hook BUG

2022-12-21
@zombieJ

Articles are included in the column:

antd

Ant Design

A UI design system
Go to discuss
antd

Ant Design

Ant Design official column
Go to discuss
antd

Ant Design

Juejin logoAnt Design Open Source Column
Juejin logoGo to discuss
contributors
  • How to Grow as a Collaboratorabout antd test library migration

    Resources

    Ant Design X
    Ant Design Charts
    Ant Design Pro
    Pro Components
    Ant Design Mobile
    Ant Design Mini
    Ant Design Web3
    Ant Design Landing-Landing Templates
    Scaffolds-Scaffold Market
    Umi-React Application Framework
    dumi-Component doc generator
    qiankun-Micro-Frontends Framework
    Ant Motion-Motion Solution
    China Mirror 🇨🇳

    Community

    Awesome Ant Design
    Medium
    Twitter
    yuque logoAnt Design in YuQue
    Ant Design in Zhihu
    Experience Cloud Blog
    seeconf logoSEE Conf-Experience Tech Conference

    Help

    GitHub
    Change Log
    FAQ
    Bug Report
    Issues
    Discussions
    StackOverflow
    SegmentFault

    Ant XTech logoMore Products

    yuque logoYuQue-Document Collaboration Platform
    AntV logoAntV-Data Visualization
    Egg logoEgg-Enterprise Node.js Framework
    Kitchen logoKitchen-Sketch Toolkit
    Galacean logoGalacean-Interactive Graphics Solution
    xtech logoAnt Financial Experience Tech
    Theme Editor
    Made with ❤ by
    Ant Group and Ant Design Community

    Recently we encountered an issue, saying that when contextHolder of Modal.useModal is placed in different positions, modal.confirm popup location will be different:

    tsx
    import React from 'react';
    import { Button, Modal } from 'antd';
    export default () => {
    const [modal, contextHolder] = Modal.useModal();
    return (
    <div>
    <Modal open>
    <Button
    onClick={() => {
    modal.confirm({ title: 'Hello World' });
    }}
    >
    Confirm
    </Button>
    {/* 🚨 BUG when put here */}
    {contextHolder}
    </Modal>
    {/* ✅ Work as expect when put here */}
    {/* {contextHolder} */}
    </div>
    );
    };

    Workable version:

    Normal

    Bug version:

    BUG

    From the figure above, we can see that when contextHolder is placed inside Modal, the pop-up position of the hooks call is incorrect.

    Why?

    antd's Modal internal calls the rc-dialog component library, which accepts a mousePosition attribute to control the pop-up position(Dialog/Content/index.tsx):

    tsx
    // pseudocode
    const elementOffset = offset(dialogElement);
    const transformOrigin = `${mousePosition.x - elementOffset.left}px ${
    mousePosition.y - elementOffset.top
    }px`;

    The offset method is used to obtain the coordinate position of the form itself(util.ts):

    tsx
    // pseudocode
    function offset(el: Element) {
    const { left, top } = el.getBoundingClientRect();
    return { left, top };
    }

    Through breakpoint debugging, we can find that the value of mousePosition is correct, but the value of rect obtained in offset is wrong:

    json
    {
    "left": 0,
    "top": 0,
    "width": 0,
    "height": 0
    }

    This value obviously means that the form component has not been added to the DOM tree at the animation start node, so we need to check the logic added by Dialog.

    createPortal

    rc-dialog creates a node in the document through rc-portal, and then renders the component to this node through ReactDOM.createPortal. For the different positions of contextHolder and different interactive, it can be speculated that there must be a problem with the timing of creating nodes in the document, so we can take a closer look at the part of adding nodes by default in rc-portal(useDom.tsx):

    tsx
    // pseudocode
    function append() {
    // This is not real world code, just for explain
    document.body.appendChild(document.createElement('div'));
    }
    useLayoutEffect(() => {
    if (queueCreate) {
    queueCreate(append);
    } else {
    append();
    }
    }, []);

    Among them, queueCreate is obtained through context, the purpose is to prevent the situation that the child element is created before the parent element under the nesting level:

    tsx
    <Modal title="Hello 1" open>
    <Modal title="Hello 2" open>
    <Modal>
    <Modal>
    html
    <!-- Child `useLayoutEffect` is run before parent. Which makes inject DOM before parent -->
    <div data-title="Hello 2"></div>
    <div data-title="Hello 1"></div>

    Use queueCreate to add the append of the child element to the queue, and then use useLayoutEffect to execute:

    tsx
    // pseudocode
    const [queue, setQueue] = useState<VoidFunction[]>([]);
    function queueCreate(appendFn: VoidFunction) {
    setQueue((origin) => {
    const newQueue = [appendFn, ...origin];
    return newQueue;
    });
    }
    useLayoutEffect(() => {
    if (queue.length) {
    queue.forEach((appendFn) => appendFn());
    setQueue([]);
    }
    }, [queue]);

    Resolution

    Due to the above queue operation, the DOM of the portal will be triggered in the next useLayoutEffect under nesting. This causes the useLayoutEffect timing of the animation to start in rc-dialog after the node behavior is added, resulting in the element not being in the document and unable to obtain the correct coordinate information.

    Since Modal is already enabled, it does not need to be executed asynchronously through queue, so we only need to add a judgment if it is enabled, and execute append directly:

    tsx
    // pseudocode
    const appendedRef = useRef(false);
    const queueCreate = !appendedRef.current
    ? (appendFn: VoidFunction) => {
    // same code
    }
    : undefined;
    function append() {
    // This is not real world code, just for explain
    document.body.appendChild(document.createElement('div'));
    appendedRef.current = true;
    }
    // ...
    return <PortalContext value={queueCreate}>{children}</PortalContext>;

    That's all.