pub struct Ruby;Expand description
The <ruby> element - ruby annotation.
§Purpose
The <ruby> element represents a ruby annotation, which is used to show pronunciation
of East Asian characters. A ruby annotation consists of the base text and ruby text
(typically pronunciation), often displayed above or beside the base text.
§Content Categories
- Flow Content
- Phrasing Content
- Palpable Content
§Permitted Content Model
- Phrasing content and
<rt>,<rp>elements
§Common Use Cases
- Japanese furigana (hiragana pronunciation guides)
- Chinese pinyin
- Korean pronunciation guides
- Pronunciation annotations for any language
§Key Attributes
- Global attributes only
§Example
<ruby>
漢<rt>kan</rt>
字<rt>ji</rt>
</ruby>
<ruby>
東京<rp>(</rp><rt>とうきょう</rt><rp>)</rp>
</ruby>§Accessibility
- Screen readers may announce both base and ruby text
<rp>provides fallback for browsers without ruby support
§WHATWG Specification
Trait Implementations§
Source§impl HtmlElement for Ruby
impl HtmlElement for Ruby
impl CanContain<Rp> for Ruby
impl CanContain<Rt> for Ruby
impl<T: PhrasingContent> CanContain<T> for Ruby
impl FlowContent for Ruby
impl PalpableContent for Ruby
impl PhrasingContent for Ruby
Auto Trait Implementations§
impl Freeze for Ruby
impl RefUnwindSafe for Ruby
impl Send for Ruby
impl Sync for Ruby
impl Unpin for Ruby
impl UnwindSafe for Ruby
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more