Reference
/element
import { … } from "@johnmorrisdotca/hikidashi/element";5.4 kB minified and gzipped, with everything it imports (measured with esbuild)
Exports
| Name | Kind | What it is |
|---|---|---|
defineEra | function | Defines an era-year tag once, optionally under a host's name. |
defineFurigana | function | Defines a furigana tag once, optionally under a host's name. |
defineNumerals | function | Defines a numeral tag once, optionally under a host's name. |
HIKIDASHI_EMBED_OPTION_KEYS | constant | Host options checked by the builder's coverage contract. |
HikidashiElementOptions | type | Host callbacks for a text-tool element. |
HikidashiEra | class | Displays a Japanese era year from a date, a western year or an era year. |
HikidashiFurigana | class | Displays a word with its reading shared over its kanji as native ruby markup. |
HikidashiNumerals | class | Writes, reads aloud or parses a Japanese numeral using the package's number tools. |
HikidashiResult | type | The structured result of a text-tool element, or null when its input cannot be read. |