Skip to main content

Widget

Enum Widget 

Source
#[repr(C)]
pub enum Widget {
Show 34 variants Text { content: String, style: TextStyle, }, Image { source: String, shape: ImageShape, ratio: ImageRatio, }, Badge { label: String, tone: Tone, }, Avatar { source: String, status: Option<Tone>, }, PdfView { url: String, }, Video { url: String, id: String, playing: bool, seek_to_ms: i64, controls: bool, looping: bool, muted: bool, on_ended: Option<ActionToken>, }, Rating { value: u32, max: u8, on_rate: Option<Vec<ActionToken>>, }, ColorDot { color: ProjectColor, }, Divider, Progress { value: Option<f32>, }, Skeleton, Chart { series: Vec<ChartSeries>, labels: Vec<String>, style: ChartStyle, axis: bool, legend: bool, }, RegionChart { regions: Vec<ChartRegion>, ticks: Vec<ChartTick>, x_max: f32, y_max: f32, ref_lines: Vec<ChartRefLine>, bracket: Option<ChartBracket>, legend: Vec<ChartLegendItem>, }, Calendar { year: u32, month: u8, first_weekday: u8, selected: Option<u8>, on_day: Vec<ActionToken>, }, SwipeAction { child: Box<Widget>, actions: Vec<SwipeButton>, }, LazyList { children: Vec<Widget>, on_load_more: Option<ActionToken>, loading: bool, has_more: bool, on_refresh: Option<ActionToken>, refreshing: bool, }, Spacer { size: Spacing, }, Row { children: Vec<Widget>, }, Column { children: Vec<Widget>, }, Card { child: Box<Widget>, style: CardStyle, on_press: Option<ActionToken>, }, Box { children: Vec<Widget>, align: BoxAlign, scrim: bool, }, Grid { children: Vec<Widget>, }, Scroller { children: Vec<Widget>, }, Button { label: String, style: ButtonStyle, on_press: ActionToken, }, IconButton { icon: Icon, on_press: ActionToken, }, Chip { label: String, selected: bool, on_press: ActionToken, }, TextField { id: String, placeholder: String, value: String, kind: FieldKind, error: Option<String>, }, SearchField { id: String, placeholder: String, value: String, }, Segmented { segments: Vec<Segment>, }, Toggle { id: String, label: String, value: bool, }, Checkbox { id: String, label: String, value: bool, }, Slider { id: String, value: i32, max: i32, }, Stepper { value: i32, on_decrement: ActionToken, on_increment: ActionToken, }, Scaffold { title: String, body: Box<Widget>, tabs: Vec<Tab>, back: Option<ActionToken>, dark_mode: bool, theme: Option<Theme>, fab: Option<Fab>, sheet: Option<Sheet>, on_refresh: Option<ActionToken>, refreshing: bool, route: String, depth: u32, },
}
Expand description

The app-agnostic widget tree the shell renders. Fixed across all apps.

Variants§

§

Text

Fields

§content: String
§

Image

Fields

§source: String
§

Badge

Fields

§label: String
§tone: Tone
§

Avatar

A circular avatar image with an optional colored status dot.

Fields

§source: String
§status: Option<Tone>
§

PdfView

An in-app PDF viewer showing the document at url (a remote https URL or a local file URI). Each shell uses its native renderer — PDFKit on iOS, a paged PdfRenderer on Android, an <iframe> on web — so the app only supplies the URL (e.g. a backend-generated report). Fills its width; give it room (place in a sized container).

Fields

§

Video

An in-app native video player for the stream/file at url (MP4 everywhere; HLS .m3u8 on iOS/Android natively + Safari on web; or a local file URI). Native player per shell — AVPlayer (iOS), Media3/ExoPlayer (Android), a <video> element (web). Controllable: playing drives play/pause (app-owned, like a Toggle); set seek_to_ms to jump (the shell seeks when the value CHANGES; -1 = no seek). The shell reports the current position ~once/second via Action::Input { id, value: Int(position_ms) } (handle it in [MobilerApp::input]), and fires on_ended when the clip finishes. controls shows the native transport bar; looping restarts on end; muted starts muted (needed for reliable autoplay). Fills its width; give it room.

Fields

§playing: bool
§seek_to_ms: i64
§controls: bool
§looping: bool
§muted: bool
§

Rating

A star rating. value is in tenths (e.g. 48 = 4.8 of max stars). When on_rate is set (one token per star), the stars are tappable — star i fires on_rate[i].

Fields

§value: u32
§max: u8
§

ColorDot

Small non-interactive colored dot — a project/identity hint.

Fields

§

Divider

§

Progress

Progress indicator: value 0.0–1.0 for a determinate bar, None for an indeterminate spinner.

Fields

§value: Option<f32>
§

Skeleton

Shimmer placeholder shown while content loads.

§

Chart

A data chart drawing one or more named series in the given style (see ChartStyle). labels (optional) annotate the x-axis for cartesian styles. axis shows y gridlines + tick values (cartesian only); legend shows a series swatch+name row. Non-interactive.

Fields

§labels: Vec<String>
§axis: bool
§legend: bool
§

RegionChart

A variable-width stacked-region (“Marimekko” / coverage-gap) chart: regions are arbitrary colored rectangles in the [0, x_max] × [0, y_max] plane (each with an in-cell label), ticks annotate the irregular x-axis, ref_lines are horizontal target/max lines with right-edge chips, bracket is an optional right-side range annotation, and legend names the colors. The app supplies all geometry; shells map domain→pixels. Non-interactive.

Fields

§regions: Vec<ChartRegion>
§x_max: f32
§y_max: f32
§ref_lines: Vec<ChartRefLine>
§

Calendar

An inline month calendar. first_weekday is the weekday of day 1 (0=Sun..6=Sat) so the shells render leading blanks without date math; on_day[d-1] fires when day d is tapped (length = days in the month). selected highlights a day.

Fields

§year: u32
§month: u8
§first_weekday: u8
§selected: Option<u8>
§

SwipeAction

A list row that reveals trailing actions on horizontal swipe (each tappable). On web the actions render inline as a trailing button row (no gesture).

Fields

§child: Box<Widget>
§actions: Vec<SwipeButton>
§

LazyList

A scrollable list for long/paged feeds, with shell-detected events at both ends: the bottom on_load_more fires when the user scrolls near the end (infinite scroll), the top on_refresh fires on pull-to-refresh. loading/refreshing/has_more are app-owned: set loading while a page loads (shell shows a spinner, stops firing), has_more=false when exhausted, and refreshing while a pull-refresh runs. The app appends to children on each load-more. on_refresh is set via with_refresh.

Fields

§children: Vec<Widget>
§on_load_more: Option<ActionToken>
§loading: bool
§has_more: bool
§on_refresh: Option<ActionToken>
§refreshing: bool
§

Spacer

Fields

§size: Spacing
§

Row

Fields

§children: Vec<Widget>
§

Column

Fields

§children: Vec<Widget>
§

Card

Card; tappable when on_press is set.

Fields

§child: Box<Widget>
§

Box

Z-stack: children layered back-to-front, positioned by align. With scrim, the first child is a background image, darkened for legibility, and the rest render on top in light content.

Fields

§children: Vec<Widget>
§align: BoxAlign
§scrim: bool
§

Grid

Fixed 2-column grid; children flow left-to-right, top-to-bottom.

Fields

§children: Vec<Widget>
§

Scroller

Horizontally scrolling row of children (a carousel / chip rail).

Fields

§children: Vec<Widget>
§

Button

Fields

§label: String
§on_press: ActionToken
§

IconButton

Fields

§icon: Icon
§on_press: ActionToken
§

Chip

Fields

§label: String
§selected: bool
§on_press: ActionToken
§

TextField

A text input. kind selects keyboard / secure entry / multiline (see FieldKind); error, when Some, shows an inline validation message below the field and marks it invalid. Emits Input { id, Text }.

Fields

§placeholder: String
§value: String
§

SearchField

A search input (leading magnifier, pill shape); emits Input { id, Text } like TextField.

Fields

§placeholder: String
§value: String
§

Segmented

A single-choice segmented control — exclusive options in a pill (e.g. Men/Women/Kids).

Fields

§segments: Vec<Segment>
§

Toggle

Fields

§label: String
§value: bool
§

Checkbox

Fields

§label: String
§value: bool
§

Slider

Continuous 0..=max slider; emits Input { id, Int }.

Fields

§value: i32
§max: i32
§

Stepper

Numeric stepper with −/+ controls carrying their own events.

Fields

§value: i32
§on_decrement: ActionToken
§on_increment: ActionToken
§

Scaffold

App shell: a top bar (title + optional back), a scrollable body, and bottom-nav tabs. dark_mode is theme-as-data — the shell themes the whole app from it.

route + depth drive navigation: the shell animates the body when route (the current screen’s identity) changes — slide for push/pop (direction from whether depth grew or shrank), crossfade for a lateral move at the same depth — and wires the system back button to back.

Fields

§title: String
§body: Box<Widget>
§tabs: Vec<Tab>
§dark_mode: bool
§theme: Option<Theme>

App branding (brand color, corner, density, font). None = framework defaults (no visual change) — theme-as-data, the visual twin of dark_mode.

§fab: Option<Fab>

Optional floating action button (raised primary action over the body).

§sheet: Option<Sheet>

Optional modal bottom sheet over the body (a scrim + a panel from the bottom).

§on_refresh: Option<ActionToken>

Pull-to-refresh: when set, the body is pull-refreshable and fires this event on pull. The app owns refreshing — set it true when the pull fires, clear it when the async reload completes (the shell shows a spinner while it’s true).

§refreshing: bool
§route: String
§depth: u32

Trait Implementations§

Source§

impl Clone for Widget

Source§

fn clone(&self) -> Widget

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Widget

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Widget

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'ʄ> Facet<'ʄ> for Widget

Source§

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else? Read more
Source§

impl Serialize for Widget

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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