Struct RhythmDropCap 

pub struct RhythmDropCap { /* private fields */ }

Available on crate feature gpui only.

A drop cap bound to the grid: the cap face at the size solved by FontRhythm::drop_cap, plus the inset anchoring its baseline. Apply with RhythmStyled::rhythm_drop_cap; for wrap-around text, measure the letter with shape_line (see drop_cap_paragraph in the recipes example).

Examples

use gpui::{div, font, prelude::*, px, FontWeight, TextSystem};
use rhythm_gpui::{RhythmDropCap, RhythmFont, RhythmGrid, RhythmStyled};

fn drop_cap_block(text_system: &TextSystem) -> impl IntoElement {
    let grid = RhythmGrid::new(px(8.));
    let body = RhythmFont::resolve(text_system, font("Georgia"), px(16.), 3, grid);
    let mut bold = font("Georgia");
    bold.weight = FontWeight::BOLD;
    let cap = RhythmDropCap::resolve(text_system, bold, &body, 3);

    div()
        .flex()
        .items_start()
        .gap(px(12.))
        .child(div().rhythm_drop_cap(&cap).child("W"))
        .child(div().flex_1().min_w_0().rhythm_font(&body).child("hen…"))
}

Implementations

impl RhythmDropCap

pub fn resolve( text_system: &TextSystem, font: Font, body: &RhythmFont, lines: u32, ) -> Self

Resolve font as a drop cap sunk lines lines deep into body text.

The solved size spans the capital from the first line’s cap top down to the lines-th baseline. The baseline anchor is exact even when a missing cap height falls back to the 0.7 em approximation; the fallback only affects the visual top. See FontRhythm::drop_cap for the math.

Panics

Panics when lines is zero or lines × body.metrics().line_rhythms() overflows u32.

pub const fn font(&self) -> &RhythmFont

The cap face at the solved size; its line box spans the sunk lines.

pub const fn top(&self) -> Pixels

Relative top inset landing the cap’s baseline on the last sunk line’s baseline. An inset rather than a margin on purpose: cap-heavy faces (cap height exceeding ascent − descent, e.g. Merriweather) need a downward shift, and a positive margin would grow the flex row’s cross size and push everything below off the grid.

Trait Implementations

impl Clone for RhythmDropCap

fn clone(&self) -> RhythmDropCap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RhythmDropCap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.