hub / github.com/WaniKani/WanaKana

github.com/WaniKani/WanaKana @5.3.1

Chat with this repo

repository ↗ · DeepWiki ↗ · release 5.3.1 ↗ · + Follow

121 symbols 374 edges 93 files 33 documented · 27% 3 cross-repo links

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

ワナカナ <--> WanaKana <--> わなかな

Javascript utility library for detecting and transliterating Hiragana, Katakana, and Romaji

Demo

Visit the website to see WanaKana in action.

Usage

In the browser without a build step, use the minified (UMD) bundle (with browser polyfills)

https://unpkg.com/wanakana

<head>
  <meta charset="UTF-8">
  <script src="https://unpkg.com/wanakana"></script>
</head>
<body>
  <input type="text" id="wanakana-input" />
  <script>
    var textInput = document.getElementById('wanakana-input');
    wanakana.bind(textInput, /* options */); // uses IMEMode with toKana() as default
    // to remove event listeners: wanakana.unbind(textInput);
  </script>
</body>

ES Modules or Node

Install

npm install wanakana

ES Modules

import * as wanakana from 'wanakana';
// or
import { toKana, isRomaji } from 'wanakana';

Node (>=12 supported)

const wanakana = require('wanakana');

Documentation

Extended API reference

Quick Reference

/*** DOM HELPERS ***/
// Automatically converts text using an eventListener on input
// Sets option: { IMEMode: true } with toKana() as converter by default
wanakana.bind(domElement [, options]);

// Removes event listener
wanakana.unbind(domElement);

/*** TEXT CHECKING UTILITIES ***/
wanakana.isJapanese('泣き虫。！〜２￥ｚｅｎｋａｋｕ')
// => true

wanakana.isKana('あーア')
// => true

wanakana.isHiragana('すげー')
// => true

wanakana.isKatakana('ゲーム')
// => true

wanakana.isKanji('切腹')
// => true
wanakana.isKanji('勢い')
// => false

wanakana.isRomaji('Tōkyō and Ōsaka')
// => true

wanakana.toKana('ONAJI buttsuuji')
// => 'オナジ ぶっつうじ'
wanakana.toKana('座禅‘zazen’スタイル')
// => '座禅「ざぜん」スタイル'
wanakana.toKana('batsuge-mu')
// => 'ばつげーむ'
wanakana.toKana('wanakana', { customKanaMapping: { na: 'に', ka: 'bana' }) });
// => 'わにbanaに'

wanakana.toHiragana('toukyou, オオサカ')
// => 'とうきょう、 おおさか'
wanakana.toHiragana('only カナ', { passRomaji: true })
// => 'only かな'
wanakana.toHiragana('wi', { useObsoleteKana: true })
// => 'ゐ'

wanakana.toKatakana('toukyou, おおさか')
// => 'トウキョウ、 オオサカ'
wanakana.toKatakana('only かな', { passRomaji: true })
// => 'only カナ'
wanakana.toKatakana('wi', { useObsoleteKana: true })
// => 'ヰ'

wanakana.toRomaji('ひらがな　カタカナ')
// => 'hiragana katakana'
wanakana.toRomaji('ひらがな　カタカナ', { upcaseKatakana: true })
// => 'hiragana KATAKANA'
wanakana.toRomaji('つじぎり', { customRomajiMapping: { じ: 'zi', つ: 'tu', り: 'li' }) };
// => 'tuzigili'

/*** EXTRA UTILITIES ***/
wanakana.stripOkurigana('お祝い')
// => 'お祝'
wanakana.stripOkurigana('踏み込む')
// => '踏み込'
wanakana.stripOkurigana('お腹', { leading: true });
// => '腹'
wanakana.stripOkurigana('ふみこむ', { matchKanji: '踏み込む' });
// => 'ふみこ'
wanakana.stripOkurigana('おみまい', { matchKanji: 'お祝い', leading: true });
// => 'みまい'

wanakana.tokenize('ふふフフ')
// => ['ふふ', 'フフ']
wanakana.tokenize('hello 田中さん')
// => ['hello', ' ', '田中', 'さん']
wanakana.tokenize('I said 私はすごく悲しい', { compact: true })
// => [ 'I said ', '私はすごく悲しい']

Important

Only the browser build via unpkg or the root wanakana.min.js includes polyfills for older browsers.

Contributing

Please see CONTRIBUTING.md

Contributors

Mims H. Wright – Author
Duncan Bay – Author
Geggles – Contributor
James McNamee – Contributor

Credits

Project sponsored by Tofugu & WaniKani

Ports

The following ports have been created by the community:

Python (Starwort/wanakana-py) on PyPI as wanakana-python
Java (MasterKale/WanaKanaJava)
Rust (PSeitz/wana_kana_rust)
Swift (profburke/WanaKanaSwift)
Kotlin (esnaultdev/wanakana-kt)
C# (kmoroz/WanaKanaShaapu)
Go (deelawn/wanakana)

Core symbols most depended-on inside this repo

Shape

Function 121

Languages

TypeScript100%

Modules by API surface

gh-pages/assets/js/rainbow.min.js17 symbols

src/utils/dom.js10 symbols

src/utils/kanaMapping.js9 symbols

src/utils/romajiToKanaMap.js8 symbols

src/utils/logInputEvents.js6 symbols

src/utils/kanaToRomajiMap.js6 symbols

src/tokenize.js6 symbols

scripts/util.js5 symbols

src/utils/katakanaToHiragana.js4 symbols

src/stripOkurigana.js4 symbols

gh-pages/assets/js/jquery.autosize.min.js4 symbols

src/toRomaji.js2 symbols

Used by 3 indexed graphs manifest dependencies, hub-wide

github.com/lingdojo/kana-dojo

github.com/misskey-dev/misskey

github.com/poooi/poi

For agents

$ claude mcp add WanaKana \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact