<ruby>: The Ruby Annotation element #
::: section-content
The <ruby>
HTML element represents small annotations that
are rendered above, below, or next to base text, usually used for
showing the pronunciation of East Asian characters. It can also be used
for annotating other kinds of text, but this usage is less common.
The term ruby originated as a unit of measurement used by typesetters{target="_blank"}, representing the smallest size that text can be printed on newsprint while remaining legible. :::
Try it #
::: section-content ::: iframe ::: {.output-header .border-rounded-top}
HTML Demo: <ruby> #
Reset :::
::: {#warning-no-script .warning-container} ::: warning The interactive example cannot be shown because JavaScript is disabled. ::: :::
::: {#warning-mathml-not-supported .warning-container .hidden} ::: warning The interactive example cannot be shown because MathML is not supported by your browser. ::: :::
::: {#editor-container .editor-container .tabbed-shorter .hidden .border-rounded-bottom editor-type=“tabbed”} ::: {#tab-container .section .tabs} ::: {#tablist .tab-list role=“tablist”} HTML
CSS
JavaScript :::
::: {#html-panel .section .hidden tabindex=“0” role=“tabpanel” aria-labelledby=“html” aria-hidden=“true”} ::: {#html-editor} 明日 ::: :::
::: {#css-panel .section .hidden tabindex=“0” role=“tabpanel” aria-labelledby=“css” aria-hidden=“true”} ::: {#css-editor} ruby { font-size: 2em; } ::: :::
::: {#js-panel .section .hidden tabindex=“0” role=“tabpanel” aria-labelledby=“js” aria-hidden=“true”} ::: {#js-editor} ::: ::: :::
::: {#output .output-container}
Output #
::: :::
::: {.section .console-container .hidden aria-hidden=“true”}
Console Output #
![] clear console
::: {#console .console} ::: :::
::: {#html-output .output .editor-tabbed} %html-content% ::: :::
| Content categories | Flow content, phrasing content, palpable content. |
|---|---|
| Permitted content | Phrasing content. |
| Tag omission | None, both the starting and ending tag are mandatory. |
| Permitted parents | Any element that accepts phrasing content. |
| Implicit ARIA role | No corresponding role |
| Permitted ARIA roles | Any |
| DOM interface | HTMLElement |
Attributes #
::: section-content This element only includes the global attributes. :::
Examples #
Example 1: Character #
::: section-content ::: code-example [html]{.language-name}
<ruby>
æ¼¢ <rp>(</rp><rt>Kan</rt><rp>)</rp> å— <rp>(</rp><rt>ji</rt><rp>)</rp>
</ruby>
:::
Result #
::: {#sect1 .code-example} ::: iframe ::: ::: :::
Example 2: Word #
::: section-content ::: code-example [html]{.language-name}
<ruby> 明日 <rp>(</rp><rt>Ashita</rt><rp>)</rp> </ruby>
:::
Result #
::: {#sect2 .code-example} ::: iframe ::: ::: :::
Specifications #
::: _table #
Specification #
HTML Standard
[#
the-ruby-element]{.small}
:::
Browser compatibility #
::: _table Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
ruby 5 12 38 5 15 5 4.4 18 38 14 4.2 1.0
:::
See also #
::: section-content
<rt><rp><rb><rtc>text-transform: full-size-kana :::
::: _attribution
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5
or later.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ruby{._attribution-link}
:::