# @chakra-ui/react-env 中文文档

规范地址：https://npmcn.com/package/%40chakra-ui/react-env/

版本：3\.1\.0
npm 元数据更新时间：2025-08-25T12:25:07.246Z
中文译文更新时间：2026-11-09T09:50:53.712Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chakra-ui/react-env
原文对照：https://npmcn.com/package/%40chakra-ui/react-env/?lang=original
项目主页：https://github.com/chakra-ui/chakra-ui#readme
源码仓库：https://github.com/chakra-ui/chakra-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.8 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=18
- 首次发布：2021-03-31T14:08:13.323Z
- 最新版本发布：2023-07-18T23:00:44.590Z
- 近 30 天下载量：1442996（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：210（近 12 个月 0 个）

## 中文简介

Iframe 或 ssr 环境中处理窗口和文档对象的组件和钩子

## 安装

```sh
npm install @chakra-ui/react-env
```

也可以使用：`pnpm add @chakra-ui/react-env`、`yarn add @chakra-ui/react-env`、`bun add @chakra-ui/react-env`

## README

# @chakra-ui/反应-env

在 iframe 中处理窗口和文档对象的响应组件和钩子 ssr 环境

> 这是内部用途,并非供公众使用.

## 安装

```sh
yarn add @chakra-ui/react-env
# or
npm i @chakra-ui/react-env
```

## 使用量

要让它工作,你需要包装你的应用程序 `EnvironmentProvider` 打电话 页:1 `useEnvironment` 在应用程序的任何地方勾钩 以获取正确的 `window` 财务报告和审定财务报表 `document`。 。 。 .

```jsx
import { EnvironmentProvider } from "@chakra-ui/react-env"

// in your App
const App = ({ children }) => {
  return <EnvironmentProvider>{children}</EnvironmentProvider>
}

// read the environment
const WindowSize = () => {
  const { window } = useEnvironment()
  return (
    <pre>
      {JSON.stringify({
        w: window.innerWidth,
        h: window.innerHeight,
      })}
    </pre>
  )
}
```

如果您将您的应用程序的特定方面包在一个 `iframe`你需要包装 框中的内容 `EnvironmentProvider` 提供正确的 `window` 财务报告和审定财务报表 `document` 它的内容.

```jsx
// in your app
const EmbeddedIFrame = () => {
  return (
    <Frame>
      <EnvironmentProvider>
        <WindowSize />
      </EnvironmentProvider>
    </Frame>
  )
}
```

## 捐款

是的,请! 见 [提供指南](https://github.com/chakra-ui/chakra-ui/blob/master/CONTRIBUTING.md) 详细情况.

## 许可证

本项目的许可条件如下: [麻省理工学院许可证](https://github.com/chakra-ui/chakra-ui/blob/master/LICENSE)。 。 。 .

## 常见问题

### @chakra-ui/react-env 是什么？

Iframe 或 ssr 环境中处理窗口和文档对象的组件和钩子

### 如何安装 @chakra-ui/react-env？

在项目目录运行 npm install @chakra-ui/react-env，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chakra-ui/react-env 支持 TypeScript 吗？

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

### @chakra-ui/react-env 支持 ESM 还是 CommonJS？

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

### @chakra-ui/react-env 可以商用吗？

@chakra-ui/react-env 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chakra-ui/react-env 的下载量有多少？

根据 npm 官方下载统计，@chakra-ui/react-env 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,442,996 次，日均约 48,100 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chakra-ui/react-env 还在维护吗？

最新版本 3\.1\.0 发布于 2023/07/19（3 年前）；至今共发布 210 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/03/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

