Ruby

Struct Ruby 

Source
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

Source§

const TAG: &'static str = "ruby"

The HTML tag name (e.g., “div”, “span”, “img”).
Source§

const VOID: bool = false

Whether this is a void element (self-closing, no children allowed).
Source§

impl CanContain<Rp> for Ruby

Source§

impl CanContain<Rt> for Ruby

Source§

impl<T: PhrasingContent> CanContain<T> for Ruby

Source§

impl FlowContent for Ruby

Source§

impl PalpableContent for Ruby

Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.