SCM-Manager/scm-ui/ui-components/src/usePortalRootElement.ts

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import { useEffect, useState } from "react";

const createElement = (id: string) => {
  const element = document.createElement("div");
  element.setAttribute("id", id);
  return element;
};

const appendRootElement = (rootElement: HTMLElement) => {
  document.body.appendChild(rootElement);
};

const usePortalRootElement = (id: string) => {
  const [rootElement, setRootElement] = useState<HTMLElement>();
  useEffect(() => {
    let element = document.getElementById(id);
    if (!element) {
      element = createElement(id);
      appendRootElement(element);
    }
    setRootElement(element);
    return () => {
      if (element) {
        element.remove();
      }
      setRootElement(undefined);
    };
  }, [id]);

  return rootElement;
};

export default usePortalRootElement;