@endiliey/react-ideal-image

中文文档
0.0.11发布于 2019/11/24MITTypeScriptCommonJS零依赖近 30 天下载 2.3万

适应图像组件

中文使用文档
文档目录21 节
  1. 问题
  2. 这个解决方案
  3. 目录
  4. 安装
  5. 使用量
  6. 道具
  7. 获取Icon
  8. 获取信息
  9. 获取Url
  10. 高度
  11. 图标
  12. 装填器
  13. 占位符
  14. 自动下载
  15. 字符串
  16. 主题
  17. 阈值
  18. 宽度
  19. 其他解决方案
  20. 贡献者
  21. 自由主义

反应-理想图像

适应图像组件


Build Status Code Coverage version downloads MIT License

All Contributors PRs Welcome Code of Conduct

Watch on GitHub Star on GitHub Tweet

问题

我需要反应组件来同步加载图像,它会基于网络来适应,这样用户就可以控制,哪个图像可以加载.

这个解决方案

读取 导言。 。 。 .

目录

安装

此模块通过 无 与 节点 财务报告和审定财务报表 应安装为您的项目之一 dependencies数字 :

npm install react-ideal-image --save

此软件包还取决于 react, (中文(简体) ), prop-types,以及 react-waypoint。 。 。 . 请确保你也有这些安装.

使用量

基于创建- react- app (宏需要 v2) 的项目示例

import React from 'react'
import lqip from 'lqip.macro'
import IdealImage from 'react-ideal-image'

import image from './images/doggo.jpg'
const lqip = lqip('./images/doggo.jpg')

const App = () => (
  <IdealImage
    placeholder={{lqip}}
    srcSet={[{src: image, width: 3500}]}
    alt="doggo"
    width={3500}
    height={2095}
  />
)

道具

这是需要传递到组件的道具列表.

获取Icon

function(state: object) qq 可选, 默认图标基于状态对象提供

此函数根据组件的当前状态决定要显示的图标 .

获取信息

function(icon: string, state: object) qq 可选的,默认的信息是基于图标和状态对象提供的.

此函数根据图标( 从 getIcon proc返回) 和组件当前状态决定要显示的信息 .

获取Url

function({}) qq 可选, 无有用的默认值

此功能在组件进入视图端口后立即调用, 并用于根据宽度和格式生成 URLs, 如果 props.srcSet 不提供src场.

高度

number 所需时间

Px中图像的高度.

图标

object 所需时间

这提供了图标的地图. 默认情况下,组件使用来自材料设计的图标,作为带有SVG元素的回放组件被执行. 您可以自定义图标

const icons = {
  load: DownloadIcon,
  //...
}

装填器

string qq 可选, 默认为 “ xhr ”

这个道具需要两个选项之一, xhr 财务报告和审定财务报表 image。 更多信息 这里。 。 。 .

占位符

object 所需时间

这需要两个对象中的一个

// To add a solid color placeholder
{
  color: ''
}

或者说

/**
 * To add a low quality image
 * [Low Quality Image Placeholder](https://github.com/zouhir/lqip)
 * [SVG-Based Image Placeholder](https://github.com/technopagan/sqip)
 * base64 encoded image of low quality
 */
{
  lqip: ''
}

更多关于它的内容 这里。 。 。 .

自动下载

function({}) 提供了基于设备网络决定的可选的默认函数.

此函数决定是否自动下载图像 。 默认函数返回 false (单位:千美元) 2g 网络, (单位:千美元) 3g 它根据 props.threshold 用于 4g 它返回的网络 true 默认.

字符串

array[srcType: object] 所需时间

这提供了图像不同格式和大小的一系列来源. 更多关于它的内容 这里。 。 。 . 这个 srcType 结构以下

srcType = {
  width: number, // required
  src: string,
  size: number,
  format: string, // one of the 'jpeg' or 'webp'
}

主题

object 所需时间

这为该部分提供了一个主题。 默认情况下,组件使用内置样式,但也有可能使用CSS模块并覆盖所有样式.

const theme = {
  placeholder: {
    backgroundSize: 'cover',
    backgroundRepeat: 'no-repeat',
    position: 'relative',
  },
  // ...
}

阈值

number 备选

说明要等待多少以毫秒计,直到认为下载慢.

宽度

number 所需时间

Px中图像的宽度.

其他解决方案

贡献者

感谢这些人emoji 密钥:


立体振动器

💻 📖 🚇 ⚠️

伊万·巴贝克

📖

阿伦·库马尔

📖

安德鲁·利索夫斯基

💻

蒂莫西·弗农

⚠️

维哈尔申德

📖

埃夫格尼·库马乔夫

📖

约翰·穆恩

💻

本项目遵循 全部贡献者 规格. 任何捐款都欢迎!

自由主义

代码 - MIT

图标 - Apache 许可证 2.0

版本与发布记录

@endiliey/react-ideal-image 共发布 6 个版本,首次发布于 2019/11/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.11latest2019/11/246 年前
0.0.102019/11/196 年前
0.0.92019/11/196 年前
0.0.82019/11/137 年前
0.0.72019/11/137 年前
0.0.62019/11/137 年前

关于 @endiliey/react-ideal-image 的常见问题

@endiliey/react-ideal-image 是什么?

适应图像组件

如何安装 @endiliey/react-ideal-image?

在项目目录运行 npm install @endiliey/react-ideal-image,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:prop-types(>=15)、react(>=0.14.x)、react-waypoint(>=9.0.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@endiliey/react-ideal-image 支持 TypeScript 吗?

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

@endiliey/react-ideal-image 支持 ESM 还是 CommonJS?

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

@endiliey/react-ideal-image 需要什么版本的 Node.js?

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

@endiliey/react-ideal-image 可以商用吗?

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

@endiliey/react-ideal-image 的下载量有多少?

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

@endiliey/react-ideal-image 还在维护吗?

最新版本 0.0.11 发布于 2019/11/24(6 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/11/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。