Skip to main content

Hyperlink

Struct Hyperlink 

Source
pub struct Hyperlink { /* private fields */ }
Expand description

A link as a widget of its own: accent colored text that underlines on hover, is reachable with Tab, and activates on release over it (or Enter and Space). A link that is longer than the line wraps, and every line fragment is clickable.

Showing a link only reports the click: Response::link_activation tells how it was activated, and the application decides what happens. Opening the address in the system browser is opt-in with Hyperlink::open_in_browser, and checks the scheme first.

if ui.hyperlink_to("Documentation", "https://example.com/docs").clicked() {
    // navigate, or open it yourself
}

Implementations§

Source

pub fn new(text: impl Into<String>) -> Self

Source

pub fn url(self, url: impl Into<String>) -> Self

Source

pub fn visited(self, visited: bool) -> Self

The application knows the link was followed; it gets the visited color.

Source

pub fn enabled(self, enabled: bool) -> Self

Source

pub fn tooltip(self, text: impl Into<String>) -> Self

Shown on hover. Without one the full address is shown, when there is one.

Source

pub fn underline(self, underline: Underline) -> Self

Source

pub fn id_source(self, source: impl Hash) -> Self

Source

pub fn style(self, style: HyperlinkStyle) -> Self

Source

pub fn open_in_browser(self) -> Self

Open the address with the system handler when the link is activated, after checking its scheme against the default allowlist (https, http, mailto). Without this the library never opens anything.

Source

pub fn open_with(self, policy: UrlPolicy) -> Self

Like Self::open_in_browser with an explicit allowlist.

Source

pub fn selectable(self, selectable: bool) -> Self

Let the pointer select the link’s text and copy it. Off by default: a link is a control, and a press on it must not start a selection.

Source

pub fn context_menu(self, menu: bool) -> Self

The Copy menu on a secondary click (on by default).

Source

pub fn text_style(self, style: TextStyle) -> Self

Theme text style; explicit builders below still win.

Source

pub fn typography(self, role: TypographyRole) -> Self

Source

pub fn size(self, size: f32) -> Self

Source

pub fn weight(self, weight: FontWeight) -> Self

Source

pub fn muted(self) -> Self

Source

pub fn monospace(self) -> Self

Set the text in the monospace family. Spaces and tabs are kept exactly.

Source

pub fn family(self, family: TextFamily) -> Self

Source

pub fn tabular_numbers(self, tabular: bool) -> Self

Source

pub fn tab_size(self, cells: u16) -> Self

Source

pub fn wrap(self, wrap: bool) -> Self

Break lines at the container width (default). Without it every line stays whole and the parent clips it.

Source

pub fn truncate(self, truncate: bool) -> Self

Keep one line and end it with an ellipsis when it does not fit. Selection and copy still use the whole text.

Source

pub fn max_lines(self, lines: usize) -> Self

At most lines visual lines, ending with an ellipsis when the text is longer.

Source

pub fn show(self, ui: &mut Ui<'_>) -> HyperlinkOutput

Show the link and get its activation and address.

Trait Implementations§

Source§

fn ui(self, ui: &mut Ui<'_>) -> Response

Source§

fn tooltip(self, text: impl Into<String>) -> TooltipWidget<Self>
where Self: Sized,

Show a tooltip while the widget is hovered, in the same expression: ui.add(Button::new("Save").tooltip("Write the file")).
Source§

fn context_menu(self, items: &[ContextMenuItem]) -> ContextMenuWidget<'_, Self>
where Self: Sized,

Open a context menu on secondary click. The chosen item is reported by Response::menu_selected on the pass it is picked.
Source§

fn accessible_label(self, label: impl Into<String>) -> Accessible<Self>
where Self: Sized,

The name a screen reader speaks for this widget, replacing the one it derives from its visible text. Required for controls without text: an icon button, a bare switch, a slider without a caption.
Source§

fn accessible_description( self, description: impl Into<String>, ) -> Accessible<Self>
where Self: Sized,

Extra detail a screen reader speaks after the name: a hint or the reason for an error.
Source§

fn accessible_role(self, role: AccessRole) -> Accessible<Self>
where Self: Sized,

Present this widget to assistive technology as role. A custom widget that does not describe itself becomes a node of this role with the response’s bounds.
Source§

fn accessibility_hidden(self) -> Accessible<Self>
where Self: Sized,

Leave this widget and everything in it out of the accessibility tree: decoration that says nothing a screen reader user needs.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more