@exhuma/readable-color

中文文档
1.0.0发布于 2024/05/20MITTypeScriptES Module零依赖近 30 天下载 2431

确定给定后端的可读文本颜色

中文使用文档

可读颜色

该项目提供了一种功能,用以确定一种颜色----根据 已建立算法 - 在特定背景上应易于读取.

示例使用大小写: 您要在未知的图形用户界面元素上显示文本 背景颜色 f.ex. 如果用户可以选择颜色或者颜色是 从其他数值中生成.

该项目披露了四种算法/方法:

见演示 https://codepen.io/米歇尔-阿尔伯特/pen/eYxrXeG

库会将背景颜色的"光"转换为可读 找到值。 如果找不到,它就会停在"全黑"或 "全白"("全白"). 后一种“ 断接” 可能导致仍然无法读取的颜色 根据所选方法,在边缘情况下.

注:迄今为止,通过《公约》,取得了最佳成果 W3C 财务报告和审定财务报表 WCAG 方法。 。 。 其余的仍然在场,以进行反向兼容和 参考文献.

示例

import { getReadableColor } from "@exhuma/readable-color";

// Get a readable color with the default method.
const readableColor = getReadableColor("#123456");

// example using another method.
const anotherColor = getReadableColor("#123456", "WCAG");

const theElement = document.getElementById("my-element");
theElement.style.color = readableColor;

发展

要安装依赖性 :

npm install

为建设:

npm run build

运行 dev 服务器 :

npm run dev

然后访问:http://localhost:5173/src/index.html

版本与发布记录

@exhuma/readable-color 共发布 6 个版本,首次发布于 2023/11/24;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2024/05/202 年前
1.0.0-beta.22023/12/242 年前
1.0.0-beta.12023/12/242 年前
1.0.0-alpha.3beta2023/11/242 年前
1.0.0-alpha.22023/11/242 年前
1.0.0-alpha.12023/11/242 年前

关于 @exhuma/readable-color 的常见问题

@exhuma/readable-color 是什么?

确定给定后端的可读文本颜色

如何安装 @exhuma/readable-color?

在项目目录运行 npm install @exhuma/readable-color,或使用 pnpm add / yarn add / bun add。

@exhuma/readable-color 支持 TypeScript 吗?

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

@exhuma/readable-color 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@exhuma/readable-color 可以商用吗?

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

@exhuma/readable-color 的下载量有多少?

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

@exhuma/readable-color 还在维护吗?

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