@atlaskit/portal

中文文档
7.1.0发布于 2026/10/23Apache-2.0TypeScriptESM + CJS近 30 天下载 70万

A wrapper for rendering components in React portals.

原始使用文档
文档目录3 节
  1. Deprecated
  2. Installation
  3. Usage

Portal

A wrapper for rendering components in React portals.

Deprecated

This package is deprecated. Do not add new usages. The browser top layer renders layered UI above the page without a portal. Use a design system layer component (for example Popup, Tooltip or Modal dialog), or Popover and Dialog from @atlaskit/top-layer. Content portalled to document.body renders below every open top-layer surface. Design system components still use Portal on their platform-dst-top-layer gate-off path. A ratchet blocks new imports; existing imports stay until the top-layer rollout is cleaned up.

Installation

yarn add @atlaskit/portal

Usage

View documentation.

版本与发布记录

@atlaskit/portal 共发布 141 个版本,首次发布于 2018/07/26;过去 12 个月发布了 29 个版本。

版本发布日期距今
7.1.0latest2026/10/2315 天前
7.0.22026/09/241 个月前
7.0.12026/09/171 个月前
7.0.02026/09/161 个月前
6.4.12026/09/151 个月前
6.4.02026/08/302 个月前

其他发布通道:design-system-lite-mode → 4.1.0,next → 4.3.2。

关于 @atlaskit/portal 的常见问题

@atlaskit/portal 是什么?

A wrapper for rendering components in React portals.

如何安装 @atlaskit/portal?

在项目目录运行 npm install @atlaskit/portal,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.2.0)、react-dom(^18.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@atlaskit/portal 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@atlaskit/portal 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@atlaskit/portal 可以商用吗?

@atlaskit/portal 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@atlaskit/portal 的下载量有多少?

根据 npm 官方下载统计,@atlaskit/portal 在 2026/10/07 – 2026/11/05 这 30 天内被下载 699,837 次,日均约 23,328 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@atlaskit/portal 还在维护吗?

最新版本 7.1.0 发布于 2026/10/23(15 天前);至今共发布 141 个版本,其中过去 12 个月发布了 29 个;首次发布于 2018/07/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。