Struct Callout 

pub struct Callout { /* private fields */ }

A callout component for displaying important information that requires user attention.

Usage Example

use ui::prelude::*;
use ui::{Button, Callout, IconName, Label, Severity};

let callout = Callout::new()
    .severity(Severity::Warning)
    .icon(IconName::Warning)
    .title("Be aware of your subscription!")
    .description("Your subscription is about to expire. Renew now!")
    .actions_slot(Button::new("renew", "Renew Now"));

Implementations

impl Callout

pub fn new() -> Self

Creates a new Callout component with default styling.

pub fn severity(self, severity: Severity) -> Self

Sets the severity of the callout.

pub fn icon(self, icon: IconName) -> Self

Sets the icon to display in the callout.

pub fn title(self, title: impl Into<SharedString>) -> Self

Sets the title of the callout.

pub fn description(self, description: impl Into<SharedString>) -> Self

Sets the description of the callout. The description can be single or multi-line text.

pub fn description_slot(self, description: impl IntoElement) -> Self

Allows for any element—like markdown elements—to fill the description slot of the callout. This method wins over description if both happen to be set.

pub fn actions_slot(self, action: impl IntoElement) -> Self

Sets the primary call-to-action button.

pub fn dismiss_action(self, action: impl IntoElement) -> Self

Sets an optional dismiss button, which is usually an icon button with a close icon. This button is always rendered as the last one to the far right.

pub fn line_height(self, line_height: Pixels) -> Self

Sets a custom line height for the callout content.

pub fn border_position(self, border_position: BorderPosition) -> Self

Sets the border position in the callout.

Trait Implementations

impl Component for Callout

fn scope() -> ComponentScope

Returns the scope of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl IntoElement for Callout

type Element = Component<Callout>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Callout

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.