jeromegrosse / furigana-react

an easy element to wrap text that contains kanji and add furigana

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

furigana-react | ふりがなレアクト

an easy element to wrap text that contains kanji 漢字を含むテキストを折り返すための簡単な要素

NPM JavaScript Style Guide

Install

npm install --save furigana-react

Usage

wrap the text you want to add furigana too in this components and add in the furigana for each kanji compound. ふりがなを追加するテキストもこのコンポーネントで囲み、各漢字化合物のふりがなを追加します。

大好 = だいす  🙆
大 = だい     🙅
import * as React from 'react'

import { Furigana } from 'furigana-react'

export default class App extends Component {
  render () {
    return (
      <div>
        {/* hatsuon maybe better prob name */}
        <Furigana furigana="わたし:だいす">
          私はクッキーが大好きです。
        </Furigana>
        <Furigana
          id="example2"
          furigana="こうそ:せいたい:お:かがくはんのう:たい:しょくばい:きのう:ぶんし:こうそ:しょくばい:はんのう:こうそてきはんのう"
          opacity={0.4} // default is 1
          spacingUnit={5} //default is 6
          >
          酵素とは、生体で起こる化学反応に対して触媒として機能する分子である。酵素によって触媒される反応を酵素的反応という。
        </Furigana>
      </div>
    )
  }
}

Result

example

License

MIT © stagfoo

About

an easy element to wrap text that contains kanji and add furigana


Languages

Language:JavaScript 90.6%Language:TypeScript 7.0%Language:CSS 1.7%Language:HTML 0.7%