Struct SplitPane

Source
pub struct SplitPane<A = ()> { /* private fields */ }
Expand description

Two-child layout split on x or y with a draggable seam.

Columns split on x; rows split on y. The default seam is centered, both minimum extents are zero, the pane fills both axes, and position is held in component-local state unless Self::bind_position supplies a signal.

§Examples

use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("left"), Text::new("right"));
let _ = split;

Implementations§

Source§

impl<A: 'static> SplitPane<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> SplitPane<A>

Source

pub fn columns(start: impl IntoView<A>, end: impl IntoView<A>) -> Self

Creates left/right panes separated by an x-axis seam.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("left"), Text::new("right"));
let _ = split;
Source

pub fn rows(start: impl IntoView<A>, end: impl IntoView<A>) -> Self

Creates top/bottom panes separated by a y-axis seam.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::rows(Text::new("top"), Text::new("bottom"));
let _ = split;
Source

pub fn new( axis: ResizeAxis, start: impl IntoView<A>, end: impl IntoView<A>, ) -> Self

Creates a fill-sized split for an explicit axis and two required children.

§Examples
use ailloli_ui_widgets::{layout::{ResizeAxis, SplitPane}, text::Text};
let split: SplitPane<()> = SplitPane::new(ResizeAxis::X, Text::new("a"), Text::new("b"));
let _ = split;
Source

pub fn initial_position(self, position: f32) -> Self

Sets initial seam distance from the start edge in logical pixels.

Negative and NaN values become zero. A bound signal takes precedence, and the resolved value is clamped by pane minima on layout.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).initial_position(160.0);
let _ = split;
Source

pub fn initial_end_position(self, position: f32) -> Self

Sets initial end-pane extent in logical pixels.

The seam is resolved as available - position, floored at zero, then clamped by pane minima. Negative and NaN inputs become zero.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).initial_end_position(240.0);
let _ = split;
Source

pub fn bind_position(self, position: impl Into<Signal<f32>>) -> Self

Binds seam position, measured from the start edge, to shared state.

Binding has priority over initial and local positions and is updated synchronously during drag. Its value is clamped for layout but is not rewritten merely because constraints clamp it.

§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let position = State::new(120.0);
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).bind_position(position);
let _ = split;
Source

pub fn min_start(self, value: f32) -> Self

Sets the minimum start-pane main extent in logical pixels.

Negative and NaN inputs become zero. If both minima cannot fit, the start minimum wins and the end pane may collapse to zero.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).min_start(80.0);
let _ = split;
Source

pub fn min_end(self, value: f32) -> Self

Sets the minimum end-pane main extent in logical pixels.

Negative and NaN inputs become zero. Impossible combined minima use the start-minimum precedence described by Self::min_start.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).min_end(100.0);
let _ = split;
Source

pub fn split_pane_style(self, style: SplitPaneStyle) -> Self

Replaces all seam style values.

§Examples
use ailloli_ui_widgets::{layout::{SplitPane, SplitPaneStyle}, text::Text};
let style = SplitPaneStyle::default();
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).split_pane_style(style);
let _ = split;
Source

pub fn on_resize(self, f: impl Fn(SplitResizeEvent) -> A + 'static) -> Self

Maps each seam event into an application action.

§Examples
use ailloli_ui_widgets::{layout::{SplitPane, SplitResizeEvent}, text::Text};
enum Action { Resize(SplitResizeEvent) }
let split: SplitPane<Action> = SplitPane::columns(Text::new("a"), Text::new("b")).on_resize(Action::Resize);
let _ = split;
Source

pub fn on_resize_ctx( self, f: impl Fn(&mut EventCtx<A>, SplitResizeEvent) + 'static, ) -> Self

Handles seam events with mutable runtime event-context access.

§Examples
use ailloli_ui_widgets::{layout::SplitPane, text::Text};
let split: SplitPane<()> = SplitPane::columns(Text::new("a"), Text::new("b")).on_resize_ctx(|_ctx, _event| {});
let _ = split;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for SplitPane<A>

Converts the builder into a retained component and preserves flex metadata.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for SplitPane<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for SplitPane<A>

§

impl<A = ()> !RefUnwindSafe for SplitPane<A>

§

impl<A = ()> !Send for SplitPane<A>

§

impl<A = ()> !Sync for SplitPane<A>

§

impl<A> Unpin for SplitPane<A>

§

impl<A = ()> !UnwindSafe for SplitPane<A>

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, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
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<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.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,