在 React 中创建可复用的模态框组件

Beginner

This tutorial is from open-source community. Access the source code

简介

在本实验中,我们将探索如何在 React 中创建一个可以通过事件控制的模态框(Modal)组件。该模态框组件将有一个关闭按钮,并且将使用键盘事件监听器在按下 Esc 键时关闭模态框。在本实验结束时,你将很好地理解如何创建一个可重复使用的模态框组件,该组件可以轻松集成到任何 React 项目中。

模态对话框

虚拟机中已经提供了index.htmlscript.js。一般来说,你只需要在script.jsstyle.css中添加代码。

这段代码渲染了一个可以通过事件控制的模态框(Modal)组件。要使用该组件,你可以导入一次Modal,然后通过向isVisible属性传递一个布尔值来显示它。

模态框组件具有以下特性:

  • 它定义了一个keydownHandler函数,该函数处理所有键盘事件,并在按下Esc键时调用onClose
  • 它使用useEffect()钩子向Document添加或移除keydown事件监听器,为每个事件调用keydownHandler
  • 它添加了一个样式化的<span>元素作为关闭按钮,点击时调用onClose
  • 它使用从父组件传递下来的isVisible属性来确定是否应该显示模态框。
  • 它包含一个 CSS 文件,用于设置模态框组件的样式。
const Modal = ({ isVisible = false, title, content, footer, onClose }) => {
  const keydownHandler = ({ key }) => {
    switch (key) {
      case "Escape":
        onClose();
        break;
      default:
    }
  };

  React.useEffect(() => {
    document.addEventListener("keydown", keydownHandler);
    return () => document.removeEventListener("keydown", keydownHandler);
  });

  return !isVisible ? null : (
    <div className="modal" onClick={onClose}>
      <div className="modal-dialog" onClick={(e) => e.stopPropagation()}>
        <div className="modal-header">
          <h3 className="modal-title">{title}</h3>
          <span className="modal-close" onClick={onClose}>
            &times;
          </span>
        </div>
        <div className="modal-body">
          <div className="modal-content">{content}</div>
        </div>
        {footer && <div className="modal-footer">{footer}</div>}
      </div>
    </div>
  );
};
.modal {
  position: fixed;
  top: 0;
  bottom: 0;
  left: 0;
  right: 0;
  width: 100%;
  z-index: 9999;
  display: flex;
  align-items: center;
  justify-content: center;
  background-color: rgba(0, 0, 0, 0.25);
  animation-name: appear;
  animation-duration: 300ms;
}

.modal-dialog {
  width: 100%;
  max-width: 550px;
  background: white;
  position: relative;
  margin: 0 20px;
  max-height: calc(100vh - 40px);
  text-align: left;
  display: flex;
  flex-direction: column;
  overflow: hidden;
  box-shadow:
    0 4px 8px 0 rgba(0, 0, 0, 0.2),
    0 6px 20px 0 rgba(0, 0, 0, 0.19);
  -webkit-animation-name: animatetop;
  -webkit-animation-duration: 0.4s;
  animation-name: slide-in;
  animation-duration: 0.5s;
}

.modal-header,
.modal-footer {
  display: flex;
  align-items: center;
  padding: 1rem;
}

.modal-header {
  border-bottom: 1px solid #dbdbdb;
  justify-content: space-between;
}

.modal-footer {
  border-top: 1px solid #dbdbdb;
  justify-content: flex-end;
}

.modal-close {
  cursor: pointer;
  padding: 1rem;
  margin: -1rem -1rem -1rem auto;
}

.modal-body {
  overflow: auto;
}

.modal-content {
  padding: 1rem;
}

@keyframes appear {
  from {
    opacity: 0;
  }
  to {
    opacity: 1;
  }
}

@keyframes slide-in {
  from {
    transform: translateY(-150px);
  }
  to {
    transform: translateY(0);
  }
}
const App = () => {
  const [isModal, setModal] = React.useState(false);
  return (
    <>
      <button onClick={() => setModal(true)}>Click Here</button>
      <Modal
        isVisible={isModal}
        title="Modal Title"
        content={<p>Add your content here</p>}
        footer={<button>Cancel</button>}
        onClose={() => setModal(false)}
      />
    </>
  );
};

ReactDOM.createRoot(document.getElementById("root")).render(<App />);

请点击右下角的“Go Live”在端口 8080 上运行 Web 服务。然后,你可以刷新Web 8080标签页来预览网页。

总结

恭喜你!你已经完成了模态对话框实验。你可以在 LabEx 中练习更多实验来提升你的技能。