Struct ImageViewer 

pub struct ImageViewer { /* private fields */ }

Image viewer component.

Handles async loading, caching, and error states for images. See ImageSource for all supported image sources.

Example

fn app() -> impl IntoElement {
    let source: ImageSource = (
        "rust-logo",
        include_bytes!("../../../examples/rust_logo.png"),
    )
        .into();

    ImageViewer::new(source)
}

See the interactive components demo.

Implementations

impl ImageViewer

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

impl ImageViewer

pub fn loading_placeholder(self, placeholder: impl Into<Element>) -> Self

Custom element rendered while loading.

pub fn decode_mode(self, decode_mode: DecodeMode) -> Self

Pick how the image is decoded. See DecodeMode.

pub fn asset_age(self, asset_age: impl Into<AssetAge>) -> Self

Customize how long the image will remain cached after no longer being used.

Defaults to AssetAge::default (1h).

pub fn error_renderer( self, renderer: impl Into<Callback<String, Element>>, ) -> Self

Custom element rendered when the image fails to load.

Trait Implementations

impl AccessibilityExt for ImageViewer

fn accessibility_data_mut(&mut self) -> &mut AccessibilityData

Returns a mutable reference to the element’s accessibility data.

fn accessibility(self, accessibility: AccessibilityData) -> Self

Replace all of the element’s accessibility data at once. See AccessibilityData.

fn a11y_id(self, a11y_id: impl Into<Option<NodeId>>) -> Self

Set an explicit accessibility id instead of an autogenerated one. See AccessibilityId.

fn a11y_enabled(self, enabled: impl Into<bool>) -> Self

Set whether the element is enabled for assistive technology.

fn a11y_focusable(self, a11y_focusable: impl Into<Focusable>) -> Self

Set whether the element can receive keyboard focus. See Focusable.

fn a11y_auto_focus(self, a11y_auto_focus: impl Into<bool>) -> Self

Request that the element be focused automatically when it is mounted.

fn a11y_member_of(self, a11y_member_of: impl Into<NodeId>) -> Self

Mark the element as a member of the group identified by the given AccessibilityId.

fn a11y_role(self, a11y_role: impl Into<Role>) -> Self

Set the accessibility role exposed in the accessibility tree. See AccessibilityRole.

fn a11y_alt(self, value: impl Into<String>) -> Self

Set the text label that describes the element in the accessibility tree.

fn a11y_builder(self, with: impl FnOnce(&mut Node)) -> Self

Edit the underlying accesskit node directly for advanced accessibility properties.

impl ChildrenExt for ImageViewer

fn children_mut(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

Extends the children with an iterable of anything that implements IntoElement.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Component for ImageViewer

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerPositionExt for ImageViewer

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See Position.

fn margin(self, margin: impl Into<Gaps>) -> Self

Set the outer spacing between the element’s edges and its surroundings. See Gaps.

impl ContainerSizeExt for ImageViewer

fn width(self, width: impl Into<Size>) -> Self

Set the element’s width. See Size.

fn height(self, height: impl Into<Size>) -> Self

Set the element’s height. See Size.

fn expanded(self) -> Self

Expand both width and height using Size::fill().

impl ContainerWithContentExt for ImageViewer

fn direction(self, direction: Direction) -> Self

Set the axis children are stacked along. See Direction.

fn main_align(self, main_align: impl Into<Alignment>) -> Self

Set how children are aligned along the direction axis. See Alignment.

fn cross_align(self, cross_align: impl Into<Alignment>) -> Self

Set how children are aligned across the direction axis. See Alignment.

fn spacing(self, spacing: f32) -> Self

Set the gap inserted between adjacent children, in pixels.

fn content(self, content: Content) -> Self

Set how children share the available space along the direction axis. See Content.

fn center(self) -> Self

Center children on both axes. Shorthand for main_align and cross_align set to Alignment::Center.

fn offset_x(self, offset_x: f32) -> Self

Shift the element’s children horizontally by the given pixels.

fn offset_y(self, offset_y: f32) -> Self

Shift the element’s children vertically by the given pixels.

fn vertical(self) -> Self

Stack children vertically. Shorthand for direction set to Direction::Vertical.

fn horizontal(self) -> Self

Stack children horizontally. Shorthand for direction set to Direction::Horizontal.

impl DecorationExt for ImageViewer

fn border(self, border: impl Into<Option<Border>>) -> Self

Add an outline around the element. See Border.

fn shadow(self, shadow: impl Into<Shadow>) -> Self

Add a shadow cast by the element. See Shadow.

fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

Round the element’s corners. See CornerRadius.

impl EffectExt for ImageViewer

fn effect_mut(&mut self) -> &mut EffectData

Returns a mutable reference to the element’s effect data.

fn cursor(self, cursor: impl Into<Option<CursorIcon>>) -> Self

Set the CursorIcon shown while the element is hovered.

fn cursor_visible(self, visible: impl Into<Option<bool>>) -> Self

Show or hide the mouse cursor while the element is hovered.

fn effect(self, effect: EffectData) -> Self

Replace all of the element’s effect data at once. See EffectData.

fn overflow(self, overflow: impl Into<Overflow>) -> Self

Set whether content overflowing the element’s bounds is clipped. See Overflow.

fn backdrop_blur(self, blur: f32) -> Self

Apply a Gaussian blur of the given radius to the backdrop behind the element.

fn rotation(self, rotation: f32) -> Self

Rotate the element by the given angle in degrees.

fn opacity(self, opacity: f32) -> Self

Set the element’s opacity, from 0.0 (transparent) to 1.0 (opaque).

fn scale(self, scale: impl Into<Scale>) -> Self

Scale the element. See Scale.

fn transform_origin(self, transform_origin: impl Into<TransformOrigin>) -> Self

Set the point that the scale and rotation effects pivot around.

impl ImageExt for ImageViewer

fn image_data_mut(&mut self) -> &mut ImageData

Returns a mutable reference to the element’s image data.

fn image_data(self, image_data: ImageData) -> Self

Replace all of the element’s image data at once. See ImageData.

fn sampling_mode(self, sampling_mode: SamplingMode) -> Self

Set the filtering used when the image is scaled. See SamplingMode.

fn aspect_ratio(self, aspect_ratio: AspectRatio) -> Self

Set how the image is scaled to fit its bounds. See AspectRatio.

fn image_cover(self, image_cover: ImageCover) -> Self

Set how the image is positioned within its bounds. See ImageCover.

fn snap_to_grid(self, snap_to_grid: bool) -> Self

Snap the image to the pixels grid. Defaults to false, but SvgViewer enables it.

fn blur(self, blur: f32) -> Self

Apply a Gaussian blur of the given radius to the image.

impl KeyExt for ImageViewer

fn key_mut(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

where Self: 'static,

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists. The key is scoped to the element’s type, so the same value used on different element or component types never collides.

impl LayoutExt for ImageViewer

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

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See LayoutData.

impl PartialEq for ImageViewer

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ImageViewer

impl StyleExt for ImageViewer

fn style_mut(&mut self) -> &mut StyleState

Returns a mutable reference to the element’s style data.

fn style(self, style: StyleState) -> Self

Replace all of the element’s style data at once. See StyleState.