Struct Icon 

pub struct Icon { /* private fields */ }

A GPUI component that renders a typed Phosphor icon through GPUI’s svg() element.

The component defaults to the first enabled weight, a 16px square, and the current GPUI text color. Use Icon::try_new or Icon::try_with_weight when a disabled weight should be reported before the component is rendered.

Implementations

impl Icon

pub fn new(name: IconName) -> Self

Create an icon using the first enabled weight.

Examples found in repository

examples/showcase.rs (line 19)

    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div()
            .flex()
            .gap_4()
            .size_full()
            .justify_center()
            .items_center()
            .bg(rgb(0x17171b))
            .child(
                Icon::new(IconName::Heart)
                    .size(px(48.0))
                    .color(rgb(0xf472b6)),
            )
            .child(
                Icon::new(IconName::Star)
                    .size(px(48.0))
                    .color(rgb(0xfacc15)),
            )
            .child(
                Icon::new(IconName::Rocket)
                    .weight(Weight::Regular)
                    .size(px(48.0))
                    .color(rgb(0x60a5fa)),
            )
            .child(
                Icon::new(IconName::Pulse)
                    .size(px(48.0))
                    .color(rgb(0x34d399)),
            )
    }

pub fn try_new(name: IconName, weight: Weight) -> Result<Self, IconError>

Create an icon and validate that its weight is enabled.

pub const fn name(&self) -> IconName

Return the typed icon name.

pub const fn icon_weight(&self) -> Weight

Return the selected visual weight.

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

Set the visual weight without validating its feature flag.

Use Icon::try_with_weight when invalid feature configuration should be handled as a Result.

Examples found in repository

examples/showcase.rs (line 30)

    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div()
            .flex()
            .gap_4()
            .size_full()
            .justify_center()
            .items_center()
            .bg(rgb(0x17171b))
            .child(
                Icon::new(IconName::Heart)
                    .size(px(48.0))
                    .color(rgb(0xf472b6)),
            )
            .child(
                Icon::new(IconName::Star)
                    .size(px(48.0))
                    .color(rgb(0xfacc15)),
            )
            .child(
                Icon::new(IconName::Rocket)
                    .weight(Weight::Regular)
                    .size(px(48.0))
                    .color(rgb(0x60a5fa)),
            )
            .child(
                Icon::new(IconName::Pulse)
                    .size(px(48.0))
                    .color(rgb(0x34d399)),
            )
    }

pub fn try_with_weight(self, weight: Weight) -> Result<Self, IconError>

Set the visual weight and validate that it is enabled.

pub fn size(self, size: impl Into<Pixels>) -> Self

Set the rendered square size.

Examples found in repository

examples/showcase.rs (line 20)

    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div()
            .flex()
            .gap_4()
            .size_full()
            .justify_center()
            .items_center()
            .bg(rgb(0x17171b))
            .child(
                Icon::new(IconName::Heart)
                    .size(px(48.0))
                    .color(rgb(0xf472b6)),
            )
            .child(
                Icon::new(IconName::Star)
                    .size(px(48.0))
                    .color(rgb(0xfacc15)),
            )
            .child(
                Icon::new(IconName::Rocket)
                    .weight(Weight::Regular)
                    .size(px(48.0))
                    .color(rgb(0x60a5fa)),
            )
            .child(
                Icon::new(IconName::Pulse)
                    .size(px(48.0))
                    .color(rgb(0x34d399)),
            )
    }

pub fn with_size(self, size: impl Into<Pixels>) -> Self

Set the rendered square size.

pub const fn icon_size(&self) -> Pixels

Return the configured square size.

pub fn color(self, color: impl Into<Hsla>) -> Self

Set the SVG’s color. If omitted, GPUI’s current text color is used.

Examples found in repository

examples/showcase.rs (line 21)

    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div()
            .flex()
            .gap_4()
            .size_full()
            .justify_center()
            .items_center()
            .bg(rgb(0x17171b))
            .child(
                Icon::new(IconName::Heart)
                    .size(px(48.0))
                    .color(rgb(0xf472b6)),
            )
            .child(
                Icon::new(IconName::Star)
                    .size(px(48.0))
                    .color(rgb(0xfacc15)),
            )
            .child(
                Icon::new(IconName::Rocket)
                    .weight(Weight::Regular)
                    .size(px(48.0))
                    .color(rgb(0x60a5fa)),
            )
            .child(
                Icon::new(IconName::Pulse)
                    .size(px(48.0))
                    .color(rgb(0x34d399)),
            )
    }

pub fn text_color(self, color: impl Into<Hsla>) -> Self

Set the SVG’s color. This is an alias for Icon::color.

pub const fn icon_color(&self) -> Option<Hsla>

Return the explicitly configured color, if there is one.

pub fn path(&self) -> Result<SharedString, IconError>

Resolve the selected icon to its namespaced GPUI asset path.

Trait Implementations

impl Clone for Icon

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Icon

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

Formats the value using the given formatter.

impl IntoElement for Icon

type Element = Component<Icon>

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 Icon

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.