# @custom-react-hooks/use-media-query 中文文档

规范地址：https://npmcn.com/package/%40custom-react-hooks/use-media-query/

版本：1\.5\.1
npm 元数据更新时间：2024-08-18T11:20:29.939Z
中文译文更新时间：2026-11-11T05:16:57.375Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40custom-react-hooks/use-media-query
原文对照：https://npmcn.com/package/%40custom-react-hooks/use-media-query/?lang=original
项目主页：https://custom-react-hooks-live.vercel.app/
源码仓库：https://github.com/djkepa/custom-react-hooks

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

- 包体积（解压后）：6.6 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16
- 首次发布：2023-12-01T23:50:13.713Z
- 最新版本发布：2024-08-18T11:20:29.754Z
- 近 30 天下载量：12710（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

这个 `useMediaQuery` 钩被设计为React应用中的响应设计. 它使组件能够适应不同的屏幕大小或者响应媒体查询的变化.

## 安装

```sh
npm install @custom-react-hooks/use-media-query
```

也可以使用：`pnpm add @custom-react-hooks/use-media-query`、`yarn add @custom-react-hooks/use-media-query`、`bun add @custom-react-hooks/use-media-query`

## README

# 使用媒体查询钩

这个 `useMediaQuery` 钩被设计为React应用中的响应设计. 它使组件能够适应不同的屏幕大小或者响应媒体查询的变化.

## 特征

-   **动态媒体查询 :** 接受任何有效的 CSS 媒体查询字符串 .
-   **SSR 兼容性 :** 服务器侧渲染的安全性,因为它检查是否有可用性 `window` 对象.
-   **高效和优化:** 只有媒体查询匹配状态变化时更新组件状态.

## 安装

### 只安装当前钩

```bash
npm install @custom-react-hooks/use-media-query
```

或者说

```bash
yarn add @custom-react-hooks/use-media-query
```

### 安装全部钩

```sh
npm install @custom-react-hooks/all
```

或者说

```sh
yarn add @custom-react-hooks/all
```

## 导入虎克

这个 `useMediaQuery` 钩必须使用下列命名的导入方式导入:

**已命名的导入 :**

```javascript
import { useMediaQuery } from '@custom-react-hooks/use-media-query';
```

这种方法确保了钩子无缝地融入到您的项目中,在您如何使用我们的包时保持一致性和可预测性.

## 使用量

导入和使用 `useMediaQuery` 在您的反应组件中钩入 :

```typescript
import { useMediaQuery } from '@custom-react-hooks/all';

const MediaQueryComponent = () => {
  const isWide = useMediaQuery('(min-width: 600px)');

  return (
    <div>
      {isWide ? 'Wide viewport detected' : 'Narrow viewport detected'}
      <br />
      <span>
        <i>Resize to see the effect</i>
      </span>
    </div>
  );
};

export default MediaQueryComponent;
```

## API 参考

### 参数

-   `query`: 代表要评价的媒体查询的字符串.

## 使用大小写

-   **响应设计**:根据取景口大小动态地调整布局或功能.
-   **暗模式切换**:根据用户的系统偏好在光和暗主题之间切换.
-   **适应性渲染**:基于媒体查询匹配的不同组件或内容渲染.
-   **性能优化**: 有条件地根据媒体查询(例如用于移动的图像)加载资源.

## 捐款

为加强《公约》 `useMediaQuery` 钩子是欢迎。 请随意向存储处提交问题或调取请求.

## 常见问题

### @custom-react-hooks/use-media-query 是什么？

这个 useMediaQuery 钩被设计为React应用中的响应设计\. 它使组件能够适应不同的屏幕大小或者响应媒体查询的变化\.

### 如何安装 @custom-react-hooks/use-media-query？

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

### @custom-react-hooks/use-media-query 支持 TypeScript 吗？

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

### @custom-react-hooks/use-media-query 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @custom-react-hooks/use-media-query 可以商用吗？

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

### @custom-react-hooks/use-media-query 的下载量有多少？

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

### @custom-react-hooks/use-media-query 还在维护吗？

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