Struct ImageProps 

pub struct ImageProps {
    pub source: ImageSource,
    pub alt: String,
    pub aspect_ratio: Option<String>,
    pub placeholder_label: Option<String>,
}

Props for an Component::Image component.

source is a flattened ImageSource — the wire format carries either "src" (URL variant) or "svg" (inline-SVG variant) directly at the top level, with no wrapping "source" key. alt is required on both variants (compile-enforced accessibility for the SVG branch).

Fields

source: ImageSource

Image source — URL or server-constructed inline SVG.

Flattened into the parent JSON object: the src or svg field appears directly on ImageProps in the wire format.

alt: String

Required alt text for accessibility. HTML-escaped on both source variants.

aspect_ratio: Option<String>

Optional CSS aspect ratio (e.g. "16/9"). Applied to both variants.

placeholder_label: Option<String>

Optional label shown in a skeleton placeholder that sits behind the image in the URL variant. When the <img> fails to load (or is still being generated), the element is hidden via onerror and the placeholder remains visible. Not rendered for the InlineSvg variant.

Implementations

impl ImageProps

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

Construct an ImageProps backed by an external URL.

Both src and alt accept impl Into<String> for ergonomic call sites. aspect_ratio and placeholder_label default to None — set them explicitly on the returned struct if needed.

pub fn inline_svg(svg: impl Into<String>, alt: impl Into<String>) -> Self

Construct an ImageProps backed by a server-constructed inline SVG.

Safety

svg is emitted verbatim without HTML escaping. Intended for server-constructed SVG (charts, sparklines, icons). Not suitable for user-supplied strings. Callers that incorporate user data into svg are responsible for sanitization before calling this constructor. See ImageSource::InlineSvg for the full contract.

Trait Implementations

impl Clone for ImageProps

fn clone(&self) -> ImageProps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageProps

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageProps

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ImageProps

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ImageProps

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ImageProps

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ImageProps

impl StructuralPartialEq for ImageProps