# hanzi-writer-miniprogram

**Repository Path**: jonasyans/hanzi-writer-miniprogram

## Basic Information

- **Project Name**: hanzi-writer-miniprogram
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-25
- **Last Updated**: 2023-10-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hanzi Writer Wechat Miniprogram Plugin (微信小程序组件)

[![CircleCI](https://img.shields.io/circleci/project/github/chanind/hanzi-writer-miniprogram/master.svg)](https://circleci.com/gh/chanind/hanzi-writer-miniprogram/tree/master)
[![npm](https://img.shields.io/npm/v/hanzi-writer-miniprogram.svg)](https://www.npmjs.com/package/hanzi-writer-miniprogram)

This component can be used in a Wechat miniprogram to add Hanzi Writer for character stroke animations and quizzing.

## Installation

```
npm install hanzi-writer-miniprogram
```

## Usage

In your `page.json`, first add the following to enable the `hanzi-writer-view` component:

```json
{
  "usingComponents": {
    "hanzi-writer-view": "hanzi-writer-miniprogram/hanzi-writer-view"
  }
}
```

Then, add a `hanzi-writer-view` component to your page. You must add an `id`, `width`, and `height`, like below:
```
<hanzi-writer-view id="hz-writer" width="300" height="300" />
```

Then in your page, you can control the view via `createHanziWriterContext(options)`, like below:

```javascript
import createHanziWriterContext from 'hanzi-writer-miniprogram';

Page({
  onLoad: function() {
    this.writerCtx = createHanziWriterContext({
      id: 'hz-writer',
      character: '你',
      page: this,
    });

    // You can call any normal HanziWriter method here
    this.writerCtx.loopCharacterAnimation();
  }
});
```

This method requires the `id` from the `hanzi-writer-view` component in wxml, and the current `page`.

By default, character data is loaded from the hanzi-writer CDN, so you'll need to add https://cdn.jsdelivr.net to your [list of approved domain names](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html). Otherwise, you can provide your own `charDataLoader` function and load character data however you like. You can [read more about loading character data here](https://chanind.github.io/hanzi-writer/docs.html#loading-character-data-link).

You can also pass any other normal Hanzi Writer options to `createHanziWriterContext`, except for `width` and `height` which are set in the `hanzi-writer-view` component. You can see a [full list of options here](https://chanind.github.io/hanzi-writer/docs.html#api-link).

## Further Documentations

For more info and docs on Hanzi Writer check out https://chanind.github.io/hanzi-writer

## Data source

The chinese character svg and stroke order data used by Hanzi Writer is derived from the [Make me a Hanzi](https://github.com/skishore/makemeahanzi) project with some slight tweaks. The data can be found in the [Hanzi Writer Data](https://github.com/chanind/hanzi-writer-data) repo. There's a visualizer for this data [here](https://chanind.github.io/hanzi-writer-data).

## Contributing

Pull requests are welcome! If you would like to contribute code, you'll need to be able to build the project locally. After cloning the Hanzi Writer repo, you can get it set up by running:

```
yarn install
```

## LICENSE

Hanzi Writer is released under an [MIT](https://raw.githubusercontent.com/chanind/hanzi-writer/master/LICENSE) license.

The Hanzi Writer data comes from the [Make Me A Hanzi](https://github.com/skishore/makemeahanzi) project, which extracted the data from fonts by [Arphic Technology](http://www.arphic.com/), a Taiwanese font forge that released their work under a permissive license in 1999. You can redistribute and/or modify this data under the terms of the Arphic Public License as published by Arphic Technology Co., Ltd. A copy of this license can be found in [ARPHICPL.TXT](https://raw.githubusercontent.com/chanind/hanzi-writer-data/master/ARPHICPL.TXT).