Taro Ink

<div align="center">
  <img width="100" src="https://static.vdfor.top/taro-ink/logo.png">
</div>

<h1 align="center">Taro Ink</h1>

<div align='center'>

[![npm (scoped)](https://img.shields.io/npm/v/taro-ink.svg)](https://www.npmjs.com/package/taro-ink)
[![GitHub issues](https://img.shields.io/github/issues/vdfor/taro-ink)](https://github.com/vdfor/taro-ink/issues)
[![GitHub forks](https://img.shields.io/github/forks/vdfor/taro-ink)](https://github.com/vdfor/taro-ink/network)
[![GitHub stars](https://img.shields.io/github/stars/vdfor/taro-ink)](https://github.com/vdfor/taro-ink/stargazers)
[![GitHub license](https://img.shields.io/github/license/vdfor/taro-ink)](https://github.com/vdfor/taro-ink/blob/master/LICENSE)

</div>

## 前言

基于 [Taro](https://taro.zone) 框架开发的 [React](https://reactjs.org) 版本的多端 UI 组件库

[文档](https://docs.vdfor.top/taro-ink)

> `Taro Ink` 正处于开发阶段，可能会出现重大改动，请谨慎使用。

## 特性

- 基于 `Taro` 开发的 UI 组件
- `微信小程序` / `H5` 多端适配运行（`支付宝小程序` / `百度小程序` / `字节跳动小程序` 端未测试，`ReactNative` 端暂不支持）
- 支持按需引入
- 支持 `Typescript`

## 安装

```bash
# 使用 npm
npm i taro-ink

# 使用 yarn
yarn add taro-ink
```

## 使用

```tsx
import { Button } from 'taro-ink';
// 按需引入所用组件的样式文件
import 'taro-ink/dist/style/components/icon.scss';
import 'taro-ink/dist/style/components/loading.scss';
import 'taro-ink/dist/style/components/button.scss';
```

[开发计划](https://github.com/vdfor/taro-ink/milestones)