Type Alias: RenderMode

RenderMode = "hangul-only" | "hangul-hanja-parens" | "hanja-hangul-parens" | "ruby-on-hangul" | "ruby-on-hanja" | "original"

Controls how the renderer expands each converted hanja annotation into output text or markup. Corresponds to Rust RenderMode.

  • "hangul-only" — Emit only the hangul reading. When homophone or require_hanja is set on an annotation the reading is followed by the original hanja in parentheses: 한글(漢字). Corresponds to Rust RenderMode::HangulOnly.
  • "hangul-hanja-parens" — Always emit 한글(漢字). Corresponds to Rust RenderMode::HangulHanjaParens.
  • "hanja-hangul-parens" — Always emit 漢字(한글). Useful for academic and historical-document styles. Corresponds to Rust RenderMode::HanjaHangulParens.
  • "ruby-on-hangul" — Emit <ruby>한글<rt>漢字</rt></ruby>. Falls back to parentheses when the current scope does not permit inline markup (e.g., inside <pre>). Corresponds to Rust RenderMode::Ruby(RubyBase::OnHangul).
  • "ruby-on-hanja" — Emit <ruby>漢字<rt>한글</rt></ruby>. Corresponds to Rust RenderMode::Ruby(RubyBase::OnHanja).
  • "original" — Keep the original mixed-script form; only annotations with require_hangul or a user directive receive a hangul gloss, which appears either in parentheses or as a ruby element depending on GukhanmunOptions.originalGloss. Corresponds to Rust RenderMode::Original.