![\"Japanese](\"https://raw.githubusercontent.com/echamudi/japanese-toolkit/master/images/japanese-toolkit.svg\")
\n \n
![](\"https://github.com/echamudi/japanese-toolkit/workflows/Japanese%20Toolkit%20JS/badge.svg\"){kind=icon}
\n\nWith Kanji you can:\n\n- Get readings information of kanji characters.\n- Get kanji characters in an array based on categorization.\n- Get kanji composition tree.\n\n---\n\n\n \n
\n
\nThis package is part of Japanese Toolkit JS suite.
\n\n\n---\n\n## Demo\n\n\n![\"Try](\"https://raw.githubusercontent.com/echamudi/badges/master/try-now-replit-light%402x.png\")
\n\n\n## Usage as Module\n\n### Kanji Readings\n\nGet the readings of kanji\n\n```js\nconst kanji = require('kanji');\n\nkanji.readings('食')\n/* Result:\n{\n on: [ 'ショク', 'ジキ' ],\n kun: [ 'く.う', 'く.らう', 'た.べる', 'は.む' ],\n nanori: [ 'ぐい' ]\n}\n*/\n```\n\n### Kanji Collections\n\n```js\n// Kanji Kentei\nconsole.log(kanji.kanken.lv10());\nconsole.log(kanji.kanken.lv09());\nconsole.log(kanji.kanken.lv08());\nconsole.log(kanji.kanken.lv07());\nconsole.log(kanji.kanken.lv06());\nconsole.log(kanji.kanken.lv05());\nconsole.log(kanji.kanken.lv04());\nconsole.log(kanji.kanken.lv03());\nconsole.log(kanji.kanken.lv02pre());\nconsole.log(kanji.kanken.lv02());\nconsole.log(kanji.kanken.lv01pre());\nconsole.log(kanji.kanken.lv01());\n\n// Old JLPT\nconsole.log(kanji.jlpt.old4());\nconsole.log(kanji.jlpt.old3());\nconsole.log(kanji.jlpt.old2());\nconsole.log(kanji.jlpt.old1());\n\n// New JLPT\nconsole.log(kanji.jlpt.n5());\nconsole.log(kanji.jlpt.n4());\nconsole.log(kanji.jlpt.n3());\nconsole.log(kanji.jlpt.n2());\nconsole.log(kanji.jlpt.n1());\n\n// Kyouiku Kanji\nconsole.log(kanji.grade.g01());\nconsole.log(kanji.grade.g02());\nconsole.log(kanji.grade.g03());\nconsole.log(kanji.grade.g04());\nconsole.log(kanji.grade.g05());\nconsole.log(kanji.grade.g06());\nconsole.log(kanji.grade.g08()); // Remaining of Joyo Kanji\nconsole.log(kanji.grade.g09()); // Jinmeiyo Kanji\nconsole.log(kanji.grade.g10()); // Variant of Joyo Kanji\n\n// Frequency 1-2501 Kanji taken from KANJIDIC\n// The frequency list is made by Alexandre Girardi\nconsole.log(kanji.freq());\n\n// 13,108 kanji from KANJIDIC (JIS X 0208-1998, JIS X 0212-1990, JIS X 0213-2012())\nconsole.log(kanji.all());\n\n```\n\nThe kanji characters in the frequency list array are ordered from most popular to least popular.\nThe rest of arrays are not ordered.\n\n### Related Kanji\n\n```js\nconsole.log(kanji.related.antonyms());\nconsole.log(kanji.related.lookalikes());\nconsole.log(kanji.related.synonyms());\nconsole.log(kanji.related.variants());\n```\n\n### Kanji Composition Tree\n\n```js\nconst kanji = require('kanji');\n\nconsole.log(kanji.kanjiTree('国'));\n\n/* Result:\n{\n element: \"国\",\n g: [{\n element: \"囗\"\n },\n {\n element: \"玉\",\n g: [{\n element: \"王\"\n },\n {\n element: \"丶\"\n }\n ]\n },\n {\n element: \"囗\"\n }\n ]\n}\n*/\n```\n\n### Notes\n\nEverytime you call the functions above, it reads the json file from the data or dist folder.\nIf you call the same function frequently, please use memoization techniques to reduce file read.\n\n## Usage as CLI Tool\n\nInstall kanji tool\n```\nnpm install -g kanji\n```\n\n### Show kanji Tree\n\n```sh\nkanji-tree 焼き鳥\n```\n\nOutput\n```\n├─ 焼\n│ ├─ 火\n│ └─ 尭\n│ ├─ 卉\n│ │ ├─ 十\n│ │ └─ 廾\n│ │ ├─ 十\n│ │ ├─ 丿\n│ │ └─ 十\n│ └─ ？\n│ ├─ 兀\n│ │ └─ 一\n│ └─ 儿\n│ └─ 丿\n├─ ？\n└─ 鳥\n └─ 灬\n```\n\n## Development\n\n### Preparation\n\n```\nnpm install\nnpm run download-source\nnpm run extract-data\n```\n\n### Watch\n```\nnpm run watch\n```\n\n### Testing\n```\nnpm test\n```\n\n### Compile\n```\nnpm run compile\n```\n\n## Acknowledgment\n\nThe items are collected from following sources:\n\n- JLPT Study by Peter van der Woude https://jlptstudy.net\n- Jonathan Waller JLPT Kanji List http://www.tanos.co.uk/jlpt/\n- KANJIDIC Project http://www.edrdg.org/wiki/index.php/KANJIDIC_Project\n- 日本漢字能力検定級別漢字表 https://www.kanken.or.jp/kanken/outline/degree.html\n- KanjiVG by Ulrich Apel https://github.com/KanjiVG/kanjivg\n- Kanjium by Uros Ozvatic https://github.com/mifunetoshiro/kanjium\n\n## Authors\n\n* **Ezzat Chamudi** - [echamudi](https://github.com/echamudi)\n\nSee also the list of [contributors](https://github.com/echamudi/kanji/graphs/contributors) who participated in this project.\n\n## License\n\nCopyright © 2020 Ezzat Chamudi\n\nKanji code is licensed under [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/). Images, logos, docs, and articles in this project are released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).\n\nLibraries, dependencies, and tools used in this project are tied with their licenses.\n\n","readmeFilename":"README.md","homepage":"https://github.com/echamudi/japanese-toolkit/tree/master/packages/kanji#readme","repository":{"type":"git","url":"git+https://echamudi@github.com/echamudi/japanese-toolkit.git"},"bugs":{"url":"https://github.com/echamudi/japanese-toolkit/issues"}}