Struct SurfaceArgs

Source

pub struct SurfaceArgs {Show 14 fields
    pub style: SurfaceStyle,
    pub hover_style: Option<SurfaceStyle>,
    pub shape: Shape,
    pub shadow: Option<ShadowProps>,
    pub padding: Dp,
    pub width: DimensionValue,
    pub height: DimensionValue,
    pub on_click: Option<Arc<dyn Fn() + Send + Sync>>,
    pub ripple_color: Color,
    pub block_input: bool,
    pub accessibility_role: Option<Role>,
    pub accessibility_label: Option<String>,
    pub accessibility_description: Option<String>,
    pub accessibility_focusable: bool,
}

Expand description

Arguments for the surface component.

Fields§

§style: SurfaceStyle

Defines the visual style of the surface (fill, outline, or both).

§hover_style: Option<SurfaceStyle>

Optional style to apply when the cursor is hovering over the surface. This is only active when on_click is also provided.

§shape: Shape

Geometric outline of the surface (rounded rectangle / ellipse / capsule variants).

§shadow: Option<ShadowProps>

Optional shadow/elevation style. When present it is passed through to the shape pipeline.

§padding: Dp

Internal padding applied symmetrically (left/right & top/bottom). Child content is positioned at (padding, padding). Also influences measured minimum size.

§width: DimensionValue

Explicit width constraint (Fixed / Wrap / Fill). Defaults to Wrap.

§height: DimensionValue

Explicit height constraint (Fixed / Wrap / Fill). Defaults to Wrap.

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

Optional click handler. Presence of this value makes the surface interactive:

Cursor changes to pointer when hovered
Press / release events are captured
Ripple animation starts on press if a RippleState is provided

§ripple_color: Color

Color of the ripple effect (if interactive & ripple state provided).

§block_input: bool

If true, all input events inside the surface bounds are blocked (stop propagation), after (optionally) handling its own click logic.

§accessibility_role: Option<Role>

Optional explicit accessibility role. Defaults to Role::Button when interactive.

§accessibility_label: Option<String>

Optional label read by assistive technologies.

§accessibility_description: Option<String>

Optional description read by assistive technologies.

§accessibility_focusable: bool

Whether this surface should be focusable even when not interactive.

Trait Implementations§

Source §

impl Clone for SurfaceArgs

Source §

fn clone(&self) -> SurfaceArgs

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Default for SurfaceArgs

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for SurfaceArgs

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

§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the concrete type as &dyn Any.

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

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

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§