Struct Image 

pub struct Image { /* private fields */ }

A view that displays an image.

Example

Image::new("photo.png")
    .resizable()
    .frame_size(100.0, 100.0)

Implementations

impl Image

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

Create an image from a file path.

Examples found in repository

examples/storybook/stories/components.rs (line 490)

pub fn render_display_components_story() -> impl IntoElement {
    VStack::new()
        .spacing(16.0)
        .alignment(HorizontalAlignment::Leading)
        .child(Text::new("Divider").font(Font::headline()))
        .child(
            VStack::new()
                .spacing(8.0)
                .alignment(HorizontalAlignment::Leading)
                .child(Text::new("Item above"))
                .child(Divider::new())
                .child(Text::new("Item below"))
                .padding(16.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0)
                .frame_width(300.0),
        )
        .child(Text::new("Label").font(Font::headline()))
        .child(
            VStack::new()
                .spacing(8.0)
                .alignment(HorizontalAlignment::Leading)
                .child(Label::new("star.fill", "Favorites"))
                .child(Label::new("folder", "Documents"))
                .child(Label::new("gear", "Settings"))
                .padding(16.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
        .child(Text::new("Link").font(Font::headline()))
        .child(
            VStack::new()
                .spacing(8.0)
                .alignment(HorizontalAlignment::Leading)
                .child(Link::new("Visit Allui", || {
                    println!("Link clicked: Visit Allui");
                }))
                .child(Link::new("Documentation", || {
                    println!("Link clicked: Documentation");
                }))
                .padding(16.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
        .child(Text::new("ProgressView").font(Font::headline()))
        .child(
            VStack::new()
                .spacing(12.0)
                .alignment(HorizontalAlignment::Leading)
                .child(Text::new("Linear (determinate):").foreground_color(Color::gray()))
                .child(
                    ProgressView::new()
                        .progress_view_style(ProgressViewStyle::Linear)
                        .value(0.65)
                        .frame_width(200.0),
                )
                .child(Text::new("Circular (indeterminate):").foreground_color(Color::gray()))
                .child(ProgressView::new().progress_view_style(ProgressViewStyle::Circular))
                .padding(16.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
        .child(Text::new("Image").font(Font::headline()))
        .child(
            VStack::new()
                .spacing(8.0)
                .alignment(HorizontalAlignment::Leading)
                .child(
                    Text::new("Note: Image currently renders placeholder text.")
                        .foreground_color(Color::gray()),
                )
                .child(Image::new("photo.jpg").frame_size(100.0, 100.0))
                .padding(16.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
}

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

Create an image from a URL.

pub fn system_name(name: impl Into<String>) -> Self

Create a system icon (SF Symbol).

pub fn content_mode(self, mode: ContentMode) -> Self

Set the content mode (fit or fill).

pub fn resizable(self) -> Self

Set resizable behavior (fit mode).

pub fn scale_to_fill(self) -> Self

Scale to fill the frame.

pub fn scale_to_fit(self) -> Self

Scale to fit the frame.

Trait Implementations

impl IntoElement for Image

type Element = Component<Image>

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 Modifier for Image

fn padding(self, value: impl Into<Padding>) -> Modified<Self>

Add padding around the view.

fn padding_edges( self, top: f32, leading: f32, bottom: f32, trailing: f32, ) -> Modified<Self>

Add padding to specific edges.

fn frame(self, frame: Frame) -> Modified<Self>

Apply a frame with the specified configuration.

fn frame_size(self, width: f32, height: f32) -> Modified<Self>

Set fixed width and height. Shorthand for frame(Frame::size(w, h)).

fn frame_width(self, width: f32) -> Modified<Self>

Set fixed width only. Shorthand for frame(Frame::width(w)).

fn frame_height(self, height: f32) -> Modified<Self>

Set fixed height only. Shorthand for frame(Frame::height(h)).

fn fixed_size(self, horizontal: bool, vertical: bool) -> Modified<Self>

Prevent the view from expanding beyond its ideal size.

fn aspect_ratio(self, ratio: f32, content_mode: ContentMode) -> Modified<Self>

Constrain the view to a specific aspect ratio.

fn background(self, color: impl Into<Color>) -> Modified<Self>

Set the background color.

fn foreground_color(self, color: impl Into<Color>) -> Modified<Self>

Set the foreground (text) color.

fn tint(self, color: impl Into<Color>) -> Modified<Self>

Set the tint color for interactive elements.

fn corner_radius(self, radius: f32) -> Modified<Self>

Round the corners.

fn border(self, color: impl Into<Color>, width: f32) -> Modified<Self>

Add a border.

fn shadow(self, radius: f32) -> Modified<Self>

Add a shadow.

fn shadow_with( self, radius: f32, color: impl Into<Color>, x: f32, y: f32, ) -> Modified<Self>

Add a shadow with full configuration.

fn opacity(self, value: f32) -> Modified<Self>

Set the opacity.

fn hidden(self, is_hidden: bool) -> Modified<Self>

Hide the view.

fn disabled(self, is_disabled: bool) -> Modified<Self>

Disable interaction.

fn scale(self, value: f32) -> Modified<Self>

Apply a scale transform.

fn on_tap_gesture( self, id: impl Into<SharedString>, handler: impl Fn() + 'static, ) -> Tappable<Self>

Add a tap gesture handler.

fn on_tap_gesture_with( self, id: impl Into<SharedString>, handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static, ) -> Tappable<Self>

Add a tap gesture handler with access to the event.

impl RenderOnce for Image

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.