Struct InteractiveText 

pub struct InteractiveText { /* private fields */ }

A StyledText that reports clicks, hovers, and tooltips for character ranges.

Give it an ID, so that GPUI can track the mouse between frames. Then attach the behavior you need: InteractiveText::on_click for ranges of text, InteractiveText::on_hover for the character under the mouse, and InteractiveText::tooltip for a tooltip per character.

Examples

InteractiveText::new(
    "terms",
    StyledText::new("Read the terms or skip"),
)
.on_click(vec![9..14], |_range_index, _window, _cx| {
    // Open the terms here.
})

Implementations

impl InteractiveText

pub fn new(id: impl Into<ElementId>, text: StyledText) -> Self

Creates an interactive text element with the given ID and styled text.

The ID must be unique among siblings. It keys the mouse state that survives between frames.

pub fn on_click( self, ranges: Vec<Range<usize>>, listener: impl Fn(usize, &mut Window, &mut App) + 'static, ) -> Self

Calls listener when the user presses and releases the mouse inside one of ranges.

The listener receives the index in ranges of the matching range. The press and the release must both fall inside the same range. A press in one range and a release in another calls nothing. If the ranges overlap, the listener runs once for each range that contains both points.

pub fn on_hover( self, listener: impl Fn(Option<usize>, MouseMoveEvent, &mut Window, &mut App) + 'static, ) -> Self

Calls listener as the mouse moves over the text.

The listener receives the byte index of the character under the mouse, or None when the mouse is over the element but not over a character. It runs only when that value changes, and not when the mouse leaves the element. It also receives the MouseMoveEvent.

pub fn tooltip( self, builder: impl Fn(usize, &mut Window, &mut App) -> Option<AnyView> + 'static, ) -> Self

Sets a tooltip for each character, as chosen by builder.

builder receives the byte index of the character under the mouse. It returns the view to show as the tooltip, or None for no tooltip at that character.

Trait Implementations

impl Element for InteractiveText

type RequestLayoutState = ()

The state that Element::request_layout returns for the later phases.

type PrepaintState = Hitbox

The state that Element::prepaint returns for Element::paint.

fn id(&self) -> Option<ElementId>

Returns the element’s identity, or None if it has none.

fn source_location(&self) -> Option<&'static Location<'static>>

Returns where this element was created, for the inspector and debug output.

fn a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None have no accessibility node unless Element::is_a11y_hidden returns true.

fn write_a11y_info(&self, node: &mut Node)

Write accessibility properties to the given node. GPUI calls this only when Element::a11y_role returns Some or Element::is_a11y_hidden returns true.

fn request_layout( &mut self, _id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Requests a layout node from Taffy, and returns it with the state the later phases need.

fn prepaint( &mut self, global_id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, bounds: Bounds<Pixels>, state: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, ) -> Hitbox

Runs once the element’s bounds are known, and returns the state that paint needs.

fn paint( &mut self, global_id: Option<&GlobalElementId>, inspector_id: Option<&InspectorElementId>, bounds: Bounds<Pixels>, _: &mut Self::RequestLayoutState, hitbox: &mut Hitbox, window: &mut Window, cx: &mut App, )

Draws the element. Runs after prepaint, once per frame.

fn is_a11y_hidden(&self) -> bool

Whether assistive technology should ignore this element and its descendants.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element. The element must have an .id(). It must also have a .role() or return true from Element::is_a11y_hidden.

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for InteractiveText

type Element = InteractiveText

The element type that this type converts into.

fn into_element(self) -> Self::Element

Converts self into an Element.

fn into_any_element(self) -> AnyElement

Converts self into an AnyElement, with its concrete type erased.