Struct SurfaceArgs

pub struct SurfaceArgs {
    pub color: Color,
    pub hover_color: Option<Color>,
    pub shape: Shape,
    pub shadow: Option<ShadowProps>,
    pub padding: Dp,
    pub width: Option<DimensionValue>,
    pub height: Option<DimensionValue>,
    pub border_width: f32,
    pub border_color: Option<Color>,
    pub on_click: Option<Arc<dyn Fn() + Send + Sync>>,
    pub ripple_color: Color,
    pub block_input: bool,
}

Arguments for the surface component.

This struct defines the configurable properties for the surface container, which provides a background, optional shadow, border, shape, and interactive ripple effect. The surface is commonly used to wrap content and visually separate it from the background or other UI elements.

Fields

• color: The fill color of the surface (RGBA). Defaults to a blue-gray.
• hover_color: The color displayed when the surface is hovered. If None, no hover effect is applied.
• shape: The geometric shape of the surface (e.g., rounded rectangle, ellipse).
• shadow: Optional shadow properties for elevation effects.
• padding: Padding inside the surface, applied to all sides.
• width: Optional explicit width constraint. If None, wraps content.
• height: Optional explicit height constraint. If None, wraps content.
• border_width: Width of the border. If greater than 0, an outline is drawn.
• border_color: Optional color for the border. If None and border_width > 0, uses color.
• on_click: Optional callback for click events. If set, the surface becomes interactive and shows a ripple effect.
• ripple_color: The color of the ripple effect for interactive surfaces.

Example

use std::sync::Arc;
use tessera_ui::{Color, Dp};
use tessera_ui_basic_components::{
    pipelines::ShadowProps,
    ripple_state::RippleState,
    surface::{surface, SurfaceArgs},
};

let ripple_state = Arc::new(RippleState::new());
surface(
    SurfaceArgs {
        color: Color::from_rgb(0.95, 0.95, 1.0),
        shadow: Some(ShadowProps::default()),
        padding: Dp(16.0),
        border_width: 1.0,
        border_color: Some(Color::from_rgb(0.7, 0.7, 0.9)),
        ..Default::default()
    },
    Some(ripple_state.clone()),
    || {},
);

Fields

color: Color

The fill color of the surface (RGBA).

hover_color: Option<Color>

The hover color of the surface (RGBA). If None, no hover effect is applied.

shape: Shape

The shape of the surface (e.g., rounded rectangle, ellipse).

shadow: Option<ShadowProps>

The shadow properties of the surface.

padding: Dp

The padding inside the surface.

width: Option<DimensionValue>

Optional explicit width behavior for the surface. Defaults to Wrap {min: None, max: None} if None.

height: Option<DimensionValue>

Optional explicit height behavior for the surface. Defaults to Wrap {min: None, max: None} if None.

border_width: f32

Width of the border. If > 0, an outline will be drawn.

border_color: Option<Color>

Optional color for the border (RGBA). If None and border_width > 0, color will be used.

on_click: Option<Arc<dyn Fn() + Send + Sync>>

Optional click callback function. If provided, surface becomes interactive with ripple effect.

ripple_color: Color

The ripple color (RGB) for interactive surfaces.

block_input: bool

Whether the surface should block all input events.

Trait Implementations

impl Clone for SurfaceArgs

fn clone(&self) -> SurfaceArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SurfaceArgs

fn default() -> Self

Returns the “default value” for a type.