Skip to main content

GridLayoutProps

Struct GridLayoutProps 

Source
pub struct GridLayoutProps {
    pub layout: Signal<Vec<LayoutItem>>,
    pub cols: i32,
    pub row_height: f32,
    pub margin: (i32, i32),
    pub compaction: CompactionType,
    pub render_item: fn(LayoutItem) -> Element,
    pub on_layout_change: Option<EventHandler<Vec<LayoutItem>>>,
    pub container_padding: (i32, i32),
    pub collision_strategy: CollisionStrategy,
    pub on_layout_event: Option<EventHandler<LayoutEvent>>,
    pub emit_interaction_updates: bool,
    pub keyboard_cell_nudge: bool,
}
Expand description

Props for the GridLayout component.

Fields§

§layout: Signal<Vec<LayoutItem>>

Reactive signal containing the current arrangement of items.

§cols: i32

Fixed number of columns for the grid. Change this to trigger a re-render and re-compaction of the layout.

§row_height: f32

Base height for a single grid row.

§margin: (i32, i32)

Spacing between items (horizontal, vertical).

§compaction: CompactionType

Strategy for compacting items (Gravity or FreePlacement).

§render_item: fn(LayoutItem) -> Element

Render function for the visual content of each item.

§on_layout_change: Option<EventHandler<Vec<LayoutItem>>>

Optional event handler triggered after an item is moved or resized.

§container_padding: (i32, i32)

Padding inside the container around the grid content (px), for visual alignment with CSS.

§collision_strategy: CollisionStrategy

Collision policy while dragging/resizing.

§on_layout_event: Option<EventHandler<LayoutEvent>>

Structured lifecycle events (start/stop/update).

§emit_interaction_updates: bool

When true and on_layout_event is set, emit InteractionPhase::Update on every pointer move.

§keyboard_cell_nudge: bool

When true, arrow keys move the focused widget by one grid cell (focus the widget body first).

Implementations§

Source§

impl GridLayoutProps

Source

pub fn builder() -> GridLayoutPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building GridLayoutProps. On the builder, call .layout(...), .cols(...), .row_height(...), .margin(...), .compaction(...), .render_item(...), .on_layout_change(...)(optional), .container_padding(...)(optional), .collision_strategy(...)(optional), .on_layout_event(...)(optional), .emit_interaction_updates(...)(optional), .keyboard_cell_nudge(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GridLayoutProps.

Trait Implementations§

Source§

impl Clone for GridLayoutProps

Source§

fn clone(&self) -> GridLayoutProps

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 PartialEq for GridLayoutProps

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Properties for GridLayoutProps
where Self: Clone,

Source§

type Builder = GridLayoutPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.
Source§

fn builder() -> Self::Builder

Create a builder for this component.
Source§

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.
Source§

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent
where M: 'static,

Create a component from the props.
Source§

impl StructuralPartialEq for GridLayoutProps

Auto Trait Implementations§

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
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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,