# @hc-master/white-ink

> A processor that generates printed white ink for png and svg files

Latest version **0.1.6** (published 2024-06-06) · 0 weekly downloads

## Install

```sh
npm install @hc-master/white-ink
pnpm add @hc-master/white-ink
yarn add @hc-master/white-ink
bun add @hc-master/white-ink
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2024-06-06 |
| First published | 2023-12-14 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 463.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | rat1991 |
| Maintainers | rat1991 |
| Keywords | SVG, png, Color, parse, convertor, transform, white ink |

## Links

- npm: https://www.npmjs.com/package/@hc-master/white-ink
- npm.io page: https://npm.io/package/@hc-master/white-ink

## Dependencies (3)

- [css](https://npm.io/package/css.md) ^3.0.0
- [colord](https://npm.io/package/colord.md) ^2.9.3
- [xml-js](https://npm.io/package/xml-js.md) ^1.6.11

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.1.6 (latest) — 2024-06-06
- 0.1.5 — 2024-06-04
- 0.1.4 — 2024-01-03
- 0.1.3 — 2023-12-27
- 0.1.2 — 2023-12-14
- 0.1.1 — 2023-12-14
- 0.1.0 — 2023-12-14

## README

# 定制酒包装白墨处理

根据svg和png图片，生成对应白墨颜色的数据；

## 使用
### Installation
```bash
npm i @hc-master/white-ink
```

### Quick start
```js
import { whiteInkForSvg, whiteInkForPng } from '@hc-master/white-ink';
// 模块默认导出两个方法，分别处理svg与png的白墨生成
function App() {
  const handleInk = async function(type:'svg'|'png') {
    switch (type) {
      case 'svg':
        // whiteInkForSvg生成的数据为svg内容的字符串
        const svgStr = await whiteInkForSvg(demoSvg)
        break;
      case 'png':
        // whiteInkForPng生成的数据为图片base64的字符串
        const base64 = await whiteInkForPng(demPng, {
          // 输出格式（默认png）
          suffix: 'png',
          // 填充像素值时的执行回调，须返回一个rgba对象值
          // @param v - 当前像素的rgb对象值
          change(v) {
            return { r:0,g:0,b:0,a:1 }
          }
        })
        break;
    }
  }
  return (
    <>
      <div className="card">
        <button onClick={() => handleInk('svg')}>生产svg白墨</button>
        <button onClick={() => handleInk('png')}>生产png白墨</button>
      </div>
    </>
  )
}
```

---
_Source: https://npm.io/package/@hc-master/white-ink · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
