Struct Icon 

pub struct Icon { /* private fields */ }

One icon, drawn as a GPUI svg() (HeroGPUI extension).

Sized DEFAULT_ICON_SIZE and painted in the theme’s foreground unless told otherwise — gpui’s svg() does not inherit the surrounding text colour, so an icon on an accent or danger fill needs .color(..). The icon is decorative and reports no accessibility node, as lucide-react marks its <svg> aria-hidden when it is given no label: name the control that holds it instead.

Implementations

impl Icon

pub fn new(icon: IconName) -> Self

An embedded Lucide icon.

pub fn from_path(path: impl Into<SharedString>) -> Self

Any SVG the registered asset source serves: one of the icons chrome paths, or an application’s own.

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

The width and height of the square the icon draws in: a pixel length or an IconSize step (also through Sizable).

pub fn stroke_width(self, width: f32) -> Self

Lucide’s strokeWidth: the stroke width in the icon’s 24-unit viewBox (default DEFAULT_STROKE_WIDTH), so it scales with the icon. Lucide icons only; see the module docs.

pub fn absolute_stroke_width(self, absolute: bool) -> Self

Lucide’s absoluteStrokeWidth: keep the stroke stroke_width pixels wide at any size, as Lucide does by scaling it by 24 / size.

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

The paint colour (default: the theme’s foreground).

Trait Implementations

impl From<IconName> for Icon

fn from(icon: IconName) -> Self

Converts to this type from the input type.

impl IntoElement for Icon

type Element = ViewElement<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.

impl Sizable for Icon

type Size = IconSize

The size scale this component accepts.

fn size(self, size: IconSize) -> Self

size — the component’s size step.