# zh-hant

> 🔤 简繁体中文互转工具，支持浏览器环境、框架无关，极简无依赖

[![NPM Version](https://img.shields.io/npm/v/zh-hant)](https://www.npmjs.com/package/zh-hant)
[![License](https://img.shields.io/npm/l/zh-hant)](./LICENSE)

---

## ✨ 功能特性

* ✅ 简体转繁体、繁体转简体
* ✅ 支持 DOM 全局转换（带 MutationObserver 自动监听）
* ✅ 支持 Vue / React / 原生 JS / 任意框架
* ✅ 无依赖，轻量高性能

---

## 📦 安装

```bash
npm install zh-hant
# or
pnpm add zh-hant
# or
yarn add zh-hant
```

---

## 📝 使用示例

### 手动转换

```ts
import { toTrad, toSimp } from 'zh-hant'

console.log(toTrad('简体转繁体测试')) // 簡體轉繁體測試（转为繁体）
console.log(toSimp('簡體轉繁體測試')) // 简体转繁体测试（转为简体）
```

### 自动全局转换

```ts
import { initLang } from 'zh-hant'

initLang({
  mode: 'zh-s', // 'zh-s'（简转繁，默认） | 'zh-t'（繁转简）
  include: ['你好'], // 可选，包含的文本关键词（支持筛选）
  exclude: ['不转换这段'] // 可选，排除的文本关键词
})
```

---

## 🛠 API 文档

| 方法                | 说明             | 示例                             |
| ------------------- | ---------------- | -------------------------------- |
| `toTrad()`          | 简体转繁体       | `toTrad('你好')`                 |
| `toSimp()`          | 繁体转简体       | `toSimp('你好')`                 |
| `initLang()`    | 初始化全局转换   | `initLang({ mode: 'zh-s' })` |
| `pauseObserver()`   | 暂停全局转换监听 | `pauseObserver()`                |
| `restartObserver()` | 重新启动监听     | `restartObserver()`              |

---

## 📄 License

[MIT](./LICENSE)

---

## 💬 欢迎交流

> 本项目长期维护，欢迎提 issue、PR

---

```ts
import { toTrad, initLang } from 'zh-hant'

console.log(toTrad('簡體轉繁體測試'))

initLang()
```

---