kanji-writer-data-jp

0.0.1 • Public • Published

Hanzi Writer Japanese Data

About

This is the character data used by Hanzi Writer for Japanese. NOTE: This is currently experimental

This data is published in a separate repo from Hanzi Writer for the following reasons:

  • This data is licensed separately from the Hanzi Writer source code.
  • This allows users who wish to import character data in NPM to do so without forcing everyone to download the character data along with Hanzi Writer.
  • Publishing on NPM makes this data available on the jsdelivr CDN, so data can be loaded via, for instance, https://cdn.jsdelivr.net/npm/hanzi-writer-data-jp@latest/私.json.

Check out chanind.github.io/hanzi-writer for more info about Hanzi Writer.

Usage

Until this is supported directly in Hanzi Writer, you'll need to use a custom charDataLoader function to use this data in Hanzi Writer. An example of how you can do that using fetch and the content on jsDelivr is shown below:

HanziWriter.create('target-div', '私', {
  width: 400,
  height: 400,
  charDataLoader: (char, onLoad, onError) => {
    fetch(`https://cdn.jsdelivr.net/gh/krmanik/hanzi-writer-data-jp@latest/data/${char}.json`)
      .then(res => res.json())
      .then(onLoad)
      .catch(onError);
  }
})

Update

Added kana json from ailectra/kana-json

Current limitations compared with the Chinese data

  • This data does not support radicals yet
  • This data does not have capped strokes, so there are sharp edges where strokes intersect

License

This data comes from animCJK and the Make Me A Hanzi project, which extracted the data from fonts by Arphic Technology, 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.

AnimCJK's data is licensed under LGPL. You can redistribute and/or modify these files under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version. You should have received a copy of this license (the file "LGPL.txt") along with these files; if not, see http://www.gnu.org/licenses/.

Readme

Keywords

none

Package Sidebar

Install

npm i kanji-writer-data-jp

Weekly Downloads

0

Version

0.0.1

License

SEE LICENSE IN license FOLDER

Unpacked Size

9.6 MB

Total Files

3171

Last publish

Collaborators

  • krmanik