Struct Icon

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

Declarative icon widget (Lucide, Devicon, or custom SVG).

For font glyphs, tint replaces the mask color. For full-color SVGs, use Color::WHITE to preserve native colors. The defaults are a 16-logical-pixel square, white tint, interactive tinting, and zero rotation.

§Examples

use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Close).size(20.0);
let _ = icon;

Implementations§

Source§

impl Icon

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).width(24.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).height(24.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_width(12.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_width(32.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_height(12.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_height(32.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).margin(4.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).padding(4.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_basis(20.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::{style::AlignItems, IconId};
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).align_self(AlignItems::Center);
let _ = widget;
Source§

impl Icon

Source

pub fn new(source: impl Into<IconId>) -> Self

Creates a default icon from any [IconId]-compatible source.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Check);
let _ = icon;
Source

pub fn lucide(icon: LucideIcon) -> Self

Creates a Lucide font-glyph icon.

§Examples
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::lucide(lucide_icons::Icon::Plus);
let _ = icon;
Source

pub fn devicon(ch: char) -> Self

Creates a Devicon font glyph from its Unicode scalar.

The glyph is not checked against the bundled font at construction.

§Examples
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::devicon('\u{e7a8}');
let _ = icon;
Source

pub fn svg_static(bytes: &'static [u8]) -> Self

Creates an SVG icon borrowing compile-time-static bytes.

Bytes are retained and validated only by a renderer/cache when used.

§Examples
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::svg_static(b"<svg/>");
let _ = icon;
Source

pub fn svg_bytes(bytes: impl Into<Arc<[u8]>>) -> Self

Creates an SVG icon from shared owned bytes.

§Examples
use std::sync::Arc;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::svg_bytes(Arc::<[u8]>::from(&b"<svg/>"[..]));
let _ = icon;
Source

pub fn svg_str(s: impl Into<Arc<str>>) -> Self

Creates an SVG icon from shared UTF-8 markup.

§Examples
use std::sync::Arc;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::svg_str(Arc::<str>::from("<svg/>"));
let _ = icon;
Source

pub fn tint(self, color: Color) -> Self

Replaces the render tint.

Use [Color::WHITE] to preserve a full-color SVG.

§Examples
use ailloli_ui_core::{Color, IconId};
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Close).tint(Color::rgba(255, 0, 0, 1.0));
let _ = icon;
Source

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

Sets the square extent in logical pixels, clamped to at least zero.

Non-finite values follow f32::max; a NaN therefore resolves to zero while positive infinity remains unbounded for later constraints.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Close).size(-4.0);
let _ = icon;
Source

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

Enables or disables automatic hover/pressed tint adjustments.

Disable this for full-color brand artwork.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Close).interactive_tint(false);
let _ = icon;
Source

pub fn rotation_rad(self, radians: f32) -> Self

Sets clockwise renderer rotation in radians.

NaN and either infinity are replaced with zero; finite angles are not normalized and may exceed one full turn.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let icon = Icon::new(IconId::Close).rotation_rad(std::f32::consts::FRAC_PI_2);
let _ = icon;

Trait Implementations§

Source§

impl From<IconId> for Icon

Converts an icon identifier with the same defaults as Icon::new.

Source§

fn from(source: IconId) -> Self

Converts to this type from the input type.
Source§

impl<A: 'static> IntoView<A> for Icon

Converts the builder into a leaf retained widget.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl LayoutExt for Icon

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl Freeze for Icon

§

impl RefUnwindSafe for Icon

§

impl Send for Icon

§

impl Sync for Icon

§

impl Unpin for Icon

§

impl UnwindSafe for Icon

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<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,