Constructor - Rich Text

Authoritative source: ref/doc/iced/widget/fn.rich_text.html.

# Rustdoc summary

Creates a new Rich text widget with the provided spans.

# Verified signature

pub fn rich_text<'a, Link, Message, Theme, Renderer>(
    spans: impl AsRef<[Span<'a, Link, <Renderer as Renderer>::Font>]> + 'a,
) -> Rich<'a, Link, Message, Theme, Renderer>
where
    Link: Clone + 'static,
    Theme: Catalog + 'a,
    Renderer: Renderer,
    <Renderer as Renderer>::Font: 'a,

# When to use

Use this constructor/helper as the typed entrypoint for the widget or layout helper it creates.

# Why to use

It gives explicit widget construction with compile-time type checking and builder chaining.

# Example References

• TODO(api-verify): add canonical example mapping for this item.

# Inline Examples (from rustdoc)

use iced::font;
use iced::widget::{rich_text, span};
use iced::{color, never, Font};

#[derive(Debug, Clone)]
enum Message {
    LinkClicked(&'static str),
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    rich_text([
        span("I am red!").color(color!(0xff0000)),
        span(" "),
        span("And I am bold!").font(Font { weight: font::Weight::Bold, ..Font::default() }),
    ])
    .on_link_click(never)
    .size(20)
    .into()
}

# Related

• Constructors
• Elements

# Use this when...

• You want the canonical entrypoint for creating this widget/helper.
• You need concrete constructor arguments and builder chaining.
• You are wiring UI interactions into typed messages.

# Minimal example

// Call this constructor in `view`, then map events to Message variants.

# How it works

Constructors return typed widget values. You configure behavior via builder methods and emit Message values for update to handle.

# Common patterns

// Keep constructor calls close to their message mapping.
// Prefer small helper functions for repeated widget setups.

# Gotchas / tips

• Re-check argument order in the verified signature on this page.
• Keep side effects out of view; trigger them from update with Task.
• Use the related family page when deciding between module/element APIs.