# @approximant/next-progress 中文文档

规范地址：https://npmcn.com/package/%40approximant/next-progress/

版本：0\.1\.0
npm 元数据更新时间：2023-04-19T03:22:54.899Z
中文译文更新时间：2026-11-06T12:24:11.046Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：18.5 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：next \>= 6\.0\.0，react \>= 16\.0\.0
- 首次发布：2023-04-19T03:22:54.499Z
- 最新版本发布：2023-04-19T03:22:54.730Z
- 近 30 天下载量：3571（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

NProgress 组件用于 Next.js app.

## 安装

```sh
npm install @approximant/next-progress
```

也可以使用：`pnpm add @approximant/next-progress`、`yarn add @approximant/next-progress`、`bun add @approximant/next-progress`

## README

# 下一个.js 进度栏

> **说明** 这是叉子 [下一个js- 进度栏](https://github.com/apal21/nextjs-progressbar) 以 [议会21](https://github.com/apal21)。它在进度栏中增加了一个可选的解跳来防止它在页面快速加载时闪烁.

使用简单的 Next.js 进度栏组件 [进展](http://ricostacruz.com/nprogress/)。 。 。 .

## 使用量

安装软件包后导入 `NextProgress` 在你身边 `pages/_app.tsx` 文件并添加 `<NextProgress />` 切换函数在 `App`数字 :

```js
import NextProgress from '@approximant/next-progress';

export default function App({ Component, pageProps }) {
  return (
    <>
      <NextProgress />
      <Component {...pageProps} />;
    </>
  );
}
```

### 默认配置

如果没有道具传递给 `<NextProgress />`,则应用了默认配置.

```jsx
// Default config
<NextProgress 
  debounce={300}
  color="#29D"
  startPosition={0.3}
  stopDelayMs={200}
  height={3}
  showOnShallow={true}  
  />
```

-   **`debounce`: 暂停时间 `ms`。如果页面加载时间少于本次,则不会显示进度栏.**
-   `color`: 更改进度栏的默认颜色。 您还可以使用 `rgb(,,)` 或者说 `rgba(,,,)`。 。 。 .
-   `startPosition`:设置默认起始位置: `0.3 = 30%`。 。 。 .
-   `stopDelayMs`: 延迟停止进度栏的时间 `ms`。 。 。 .
-   `height`: 进度栏的高度 `px`。 。 。 .
-   `showOnShallow`:如果使用浅路由,您可以选择是否要显示进度栏 。 它需要一个布尔。 了解更多浅道 [在下一个.js 文档中](https://nextjs.org/docs/routing/shallow-routing)。 。 。 .

### 高级配置

#### 添加非单曲

我们用内部的cs在这个包。 如果您使用 Csp , 您可以在 `<style>` 通过提供标记 `nonce` 向 `<NextProgress />` 组件.

```jsx
<NextProgress nonce="my-nonce" />
```

#### 自定义 CSS

你用得着 `transformCSS` 通过自定义 cs. **说明:** 你一定要回来 `JSX.Element` 从功能.

```jsx
NextProgress<
  transformCSS={(css) => {
    // css is the default css string. You can modify it and return it or return your own css.
    return <style>{css}</style>;
  }}
/>
```

#### 其他配置

你用得着 [其他配置](https://github.com/rstacruz/nprogress#configuration) 通过在 `options` 道具来.

```jsx
<NextProgress options={{ easing: 'ease', speed: 500 }} />
```

## 常见问题

### @approximant/next-progress 是什么？

NProgress 组件用于 Next\.js app\.

### 如何安装 @approximant/next-progress？

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

### @approximant/next-progress 支持 TypeScript 吗？

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

### @approximant/next-progress 支持 ESM 还是 CommonJS？

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

### @approximant/next-progress 可以商用吗？

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

### @approximant/next-progress 的下载量有多少？

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

### @approximant/next-progress 还在维护吗？

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