Struct Ripple 

pub struct Ripple { /* private fields */ }

A container that shows a Material Design-style ripple effect when clicked.

The ripple expands from the click position and fades out.

fn app() -> impl IntoElement {
    Ripple::new().child(
        rect()
            .width(Size::px(200.))
            .height(Size::px(100.))
            .background((100, 100, 200))
            .center()
            .child("Click me!"),
    )
}

Implementations

impl Ripple

pub fn new() -> Self

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

Set the color of the ripple effect. Defaults to the theme’s primary color.

pub fn duration(self, duration: Duration) -> Self

Set the duration of the ripple animation. Default is 800ms.

Trait Implementations

impl ChildrenExt for Ripple

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

Returns a mutable reference to the internal children vector.

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

Extends the children with an iterable of [Element]s.

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 Clone for Ripple

fn clone(&self) -> Ripple

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Ripple

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for Ripple

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

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

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

Set the inner spacing between the element’s edges and its content. See [Gaps].

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

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

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

Set the minimum width the element can shrink to. See [Size].

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

Set the minimum height the element can shrink to. See [Size].

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

Set the maximum width the element can grow to. See [Size].

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

Set the maximum height the element can grow to. See [Size].

fn visible_width(self, visible_width: impl Into<VisibleSize>) -> Self

Set how much of the measured width is actually used in layout. See [VisibleSize].

fn visible_height(self, visible_height: impl Into<VisibleSize>) -> Self

Set how much of the measured height is actually used in layout. See [VisibleSize].

impl ContainerWithContentExt for Ripple

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

Set the axis children are stacked along. See [Direction].

fn main_align(self, main_align: Alignment) -> Self

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

fn cross_align(self, cross_align: Alignment) -> Self

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

fn spacing(self, spacing: impl Into<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: impl Into<f32>) -> Self

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

fn offset_y(self, offset_y: impl Into<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 Default for Ripple

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for Ripple

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

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

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

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl LayoutExt for Ripple

fn get_layout(&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 Ripple

fn eq(&self, other: &Ripple) -> 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 StructuralPartialEq for Ripple