# @candlefinance/faster-image 中文文档

规范地址：https://npmcn.com/package/%40candlefinance/faster-image/

版本：1\.7\.2
npm 元数据更新时间：2024-11-06T14:12:08.307Z
中文译文更新时间：2026-11-09T00:53:06.018Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：562 kB，92 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- peer 依赖：react \*，react-native \*
- 首次发布：2023-03-26T17:52:23.792Z
- 最新版本发布：2024-11-06T14:12:08.078Z
- 近 30 天下载量：7241（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

测试

## 安装

```sh
npm install @candlefinance/faster-image
```

也可以使用：`pnpm add @candlefinance/faster-image`、`yarn add @candlefinance/faster-image`、`bun add @candlefinance/faster-image`

## README

  

 [![npm downloads](https://img.shields.io/npm/dm/@candlefinance%2Ffaster-image)](https://www.npmjs.com/package/@candlefinance%2Ffaster-image)[![discord users online](https://img.shields.io/discord/986610142768406548?label=Discord&logo=discord&logoColor=white&cacheSeconds=3600)](https://discord.gg/qnAgjxhg6n)

  

[https://github.com/candlefinance/faster-image/assets/12258850/ede91008-4dca-417c-a2ca-4d2177066316 互联网档案馆的存檔,存档日期2014-12-02](https://github.com/candlefinance/faster-image/assets/12258850/ede91008-4dca-417c-a2ca-4d2177066316)

以速度和内存使用为重点,在React Introduct中渲染图像的表演方式. 电源 [纽克](https://github.com/kean/nuke),用于 iOS 和 macOS 的最小且最能表现的图像加载库 [锅](https://github.com/coil-kt/coil) 安卓号.

> 框架为精度,在2秒1以内编译. 纽克拥有一个自动测试套房,2x大小相当于密码库本身,确保了极佳的可靠性. 每个特性都经过精心设计和优化以达到性能.

> Coil 进行一些优化,包括内存和磁盘缓存,对内存中的图像进行下取样,自动延后/取消请求,等等.

## 特征

-   [x] 支持愿景OS
-   [x] 快速装入图像
-   [x] 内存和磁盘缓存
-   [x] 占位符支持 :
    -   [x] [模糊](https://github.com/woltapp/blurhash) (iOS & Android) (英语)
    -   [x] [缩略图](https://github.com/evanw/thumbhash) (仅iOS)
    -   [x] Base64 编码图像
-   [x] 动画过渡
-   [x] 失败的图像
-   [x] 字体支持
-   [x] 以 Swift/ Kotlin 写

## 待补

-   [ ] GIF 支持

## 安装

```sh
yarn add @candlefinance/faster-image
```

## 使用量

```js
import { FasterImageView, clearCache, prefetch } from '@candlefinance/faster-image';

<FasterImageView
  style={styles.image}
  onSuccess={(event) => {
    console.log(event.nativeEvent);
  }}
  onError={(event) => console.warn(event.nativeEvent.error)}
  source={{
    transitionDuration: 0.3,
    borderRadius: 50,
    cachePolicy: 'discWithCacheControl',
    showActivityIndicator: true,
    url: 'https://picsum.photos/200/200?random=1',
  }}
/>;

// Clear memory and disk cache
await clearCache();

// Prefetch
await prefetch(['https://picsum.photos/200/200?random=0'])

```

## 道具

| Prop | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| url 密码 | 字符串 |  | 图像的 URL |
| 样式 | 对象 |  | 图像的样式 |
| 调整模式大小 | 字符串 | 包含 | 图像的大小调整模式 |
| 缩略图 | 字符串 |  | 作为 Base64 编码字符串的图像缩略图在装入时显示( Android 未测试) |
| 模糊 | 字符串 |  | 装入时要显示的图像模糊度( 只有iOS) |
| 显示活动指标 | 布尔 | 虚假( 仅iOS) | 图像装入时是否显示 UI 活动指示器View 指示器 |
| 活动颜色 | 颜色值 | 未定义( 仅iOS) | 活动指示颜色。 已更改默认活动指标颜色 。 仅支持十六进制 |
| 基数64 定位符 | 字符串 |  | 装入图像时要显示的 Base64 编码占位符图像 |
| 缓存政策 | 字符串 | 内存 | 图像的缓存策略 |
| 过渡期限 | 编号 | 0.75 (iOS) Android (100) (英语) | 图像的过渡期 |
| 边框拉迪乌斯 | 编号 | 0 个 | 图像的边框半径 |
| 边框TopleftRadius | 编号 | 0 个 | 图像左上边框半径 |
| 边框右侧Radius | 编号 | 0 个 | 图像的右上边框半径 |
| 边框 Bottom Left Radius | 编号 | 0 个 | 图像左下边框半径 |
| 边框右侧Radius | 编号 | 0 个 | 图像的右下边框半径 |
| 失败图像 | 字符串 |  | 如果图像无法下载, 将设定此选项( blurhash, 拇指, base64) |
| 已启动 | 布尔 | 虚假 | 逐步加载图像( 仅iOS) |
| 错误 | 函数 |  | 当错误发生时调用函数 。 错误被传递为函数的第一个参数 |
| 成功时 | 函数 |  | 成功装入图像时调用功能 |
| 灰度图 | 编号 | 0 个 | 将图像转换成灰色(0-1)的阴影的过滤器或转换器. |
| 颜色Matrix | 编号 \[ \] |  | 用于图像的颜色矩阵 |
| 忽略 QueryParamsForCacheKey 键 | 布尔 | 虚假 | 在缓存密钥中忽略 URL 查询参数 |
| 允许硬件 | 布尔 | 真实 | 允许硬件渲染( 只有Android) |
| 页眉 | 记录<字符串,字符串> | 未定义 | 信头通过 |
| 访问标签 | 字符串 | 未定义 | 无障碍标签 |
| 无障碍 | 布尔 | 未定义 | 可访问 |

## 捐款

见 [贡献指南](https://npmcn.com/package/%40candlefinance/faster-image/CONTRIBUTING.md) 学习如何为储存库和发展工作流程作出贡献.

## 许可证

麻省理工学院

## 常见问题

### @candlefinance/faster-image 是什么？

测试

### 如何安装 @candlefinance/faster-image？

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

### @candlefinance/faster-image 支持 TypeScript 吗？

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

### @candlefinance/faster-image 支持 ESM 还是 CommonJS？

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

### @candlefinance/faster-image 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @candlefinance/faster-image 可以商用吗？

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

### @candlefinance/faster-image 的下载量有多少？

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

### @candlefinance/faster-image 还在维护吗？

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

