The HTML Ruby Base (<rb>
) element is used to delimit the base text component of a <ruby>
annotation, i.e. the text that is being annotated. One <rb>
element should wrap each separate atomic segment of the base text.
The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.
Content categories | None. |
---|---|
Permitted content | As a child of a <ruby> element. |
Tag omission | The end tag can be omitted if the element is immediately followed by an <rt> , <rtc> , or <rp> element or another <rb> element, or if there is no more content in the parent element. |
Permitted parents | A <ruby> element. |
Permitted ARIA roles | Any |
DOM interface | HTMLElement |
Attributes
This element only includes the global attributes.
Usage notes
- Ruby annotations are for showing pronunciation of East Asian characters, like using Japanese furigana or Taiwanese bopomofo characters. The
<rb>
element is used to separate out each segment of the ruby base text. - Even though
<rb>
is not an empty element, it is common to just include the opening tag of each element in the source code, so that the ruby markup is less complex and easier to read. The browser can then fill in the full element in the rendered version. - You need to include one
<rt>
element for each base segment/<rb>
element that you want to annotate.
Examples
In this example, we provide an annotation for the original character equivalent of "Kanji":
<ruby> <rb>漢<rb>字 <rp>(</rp><rt>kan<rt>ji<rp>)</rp> </ruby>
Note how we've included two <rb>
elements, to delimit the two separate parts of the ruby base text. The annotation on the other hand is delimited by two <rt>
elements.
Note that we could also write this example with the two base text parts annotated completely separately. In this case we don't need to include <rb>
elements:
<ruby> 漢 <rp>(</rp><rt>Kan</rt><rp>)</rp> 字 <rp>(</rp><rt>ji</rt><rp>)</rp> </ruby>
<ruby> <rb>漢<rb>字 <rp>(</rp><rt>kan<rt>ji<rp>)</rp> </ruby>
body { font-size: 22px; }
The output looks like so:
The HTML above might look something like this when rendered by a browser without ruby support:
漢字 (kan ji)
body { font-size: 22px; }
Note: See the article about the <ruby>
element for further examples.
Specifications
Specification | Status | Comment |
---|---|---|
HTML5 The definition of '<rb>' in that specification. |
Recommendation |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
rb | Chrome Full support 5 | Edge Full support 79 | Firefox Full support 38 | IE Full support 5 | Opera Full support 15 | Safari Full support 5 | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 38 | Opera Android Full support 14 | Safari iOS Full support Yes | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support