patternfly / patternfly/patternfly-react

Bug - Popover/Modal - Modals and popover do not render properly when Fullscreen API is used

Open
#11,919 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Stale
Dominant language
TypeScript
Stars
862
Forks
392
Avg merge
4d 8h
Merged PRs (30d)
9

Description

Describe the problem
A clear and concise description of the problem. Which components are affected?

When the fullscreen API is used, the browser does not render the entire document tree. Popovers and modals, which append to document.body by default might not be included in the scope of the fullscreen element.

How do you reproduce the problem?
Provide steps to reproduce. A codesandbox demonstrating the problem is appreciated.

adapted from https://www.patternfly.org/components/modal#basic-modals:

import * as React from 'react';
import { Button, Modal, ModalBody, ModalFooter, ModalHeader } from '@patternfly/react-core';

export const useFullscreen = () => {
  /_* The element that will be toggled to fullscreen _/
  const fullscreenRef = React.useRef(null);

  /_* Toggle currently displayed content to/from fullscreen _/
  const toggleFullscreen = React.useCallback(() => {
    if (fullscreenRef.current) {
      if (!document.fullscreenElement) {
        fullscreenRef.current.requestFullscreen();
      } else {
        document.exitFullscreen();
      }
    }
  }, []);

  return [fullscreenRef, toggleFullscreen];
};

export const ModalBasic: React.FunctionComponent = () => {
  const [isModalOpen, setIsModalOpen] = React.useState(false);
  const [fullscreenRef, toggleFullscreen] = useFullscreen();

  const handleModalToggle = (_event: KeyboardEvent | React.MouseEvent) => {
    setIsModalOpen(!isModalOpen);
  };

  return (
    [div ref={fullscreenRef}]
    [Button onClick={toggleFullscreen}]toggle fullscreen[/Button]
      [Button variant="primary" onClick={handleModalToggle} ouiaId="ShowBasicModal"]
        Show basic modal
      [/Button]
      [Modal
        isOpen={isModalOpen}
        onClose={handleModalToggle}
        ouiaId="BasicModal"
        aria-labelledby="basic-modal-title"
        aria-describedby="modal-box-body-basic"
      ]
        [ModalHeader title="Basic modal" labelId="basic-modal-title" /]
        [ModalBody id="modal-box-body-basic"]
          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
          consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
          est laborum.
        [/ModalBody]
        [ModalFooter]
          [Button key="confirm" variant="primary" onClick={handleModalToggle}]
            Confirm
          [/Button]
          [Button key="cancel" variant="link" onClick={handleModalToggle}]
            Cancel
          [/Button]
        [/ModalFooter]
      [/Modal]
      [/div]
  );
};

Expected behavior
A clear and concise description of the expected behavior.

The modal appends to the fullscreenElement when the browser is fullscreen

Is this issue blocking you?
List the workaround if there is one.

Sort of..? This is causing issues in #15254 and my workaround is to simply disable any elements that generate popovers when the browser is fullscreened

Screenshots
If applicable, add screenshots to help explain the issue.

What is your environment?

Firefox 140.0-1.fc42

What is your product and what release date are you targeting?

OCP console 4.20

Any other information?

We can update the default value of appendTo to be () => document.fullscreenElement ?? document.body which will probably fix this. We will need to update the value of appendTo dynamically when the user exit and enters fullscreen however


Jira Issue: PF-2357

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Modal and popover appendTo handling, then reproduce the provided CodeSandbox while entering and exiting fullscreen. Verify that the modal is rendered within document.fullscreenElement during fullscreen and returns to document.body afterward, including transitions in both directions.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
54/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.