Struct floem_ui_kit::theme::Theme

pub struct Theme {
    pub accent_color: RwSignal<AccentColor>,
    pub horizontal_window_margin: f32,
}

Allows you to create any of the widgets supported by Floem UI Kit. The Theme struct contains any settings that will apply across the entire UI.

use floem_ui_kit::accents::AccentColor;
use floem_ui_kit::theme::Theme;

let theme = Theme {
    ..Default::default()
};

Fields

accent_color: RwSignal<AccentColor>

Controls color variations of the theme. Wrapped in a signal so your UI may change appearance without restarting.

horizontal_window_margin: f32

UI elements generally shouldn’t stick to the edge of the window, but exceptions are sometimes necessary for decorative elements. To cover your use cases, you can set a horizontal window margin here. It does not do anything by default. You may however:

• Make use of the padded_container function to wrap your layout in an amount of padding equal to the target window margin.
• Read the value of this field in your own code whenever you prefer to manually insert horizontal window margin.

Decorative UI elements containing text (such as Floem UI Kit’s own header) may hook in to this field to keep different parts of the window layout aligned.

Implementations

impl Theme

pub fn button<S: Display + 'static>( self, label_func: impl Fn() -> S + 'static, variant: ButtonVariant ) -> impl View

Instantiates a button widget.

impl Theme

pub fn labeled_checkbox<S: Display + 'static>( self, read_signal: ReadSignal<bool>, label_render_func: impl Fn() -> S + 'static ) -> impl View

Instantiates a checkbox widget controlling a boolean with a text label next to it.

impl Theme

pub fn simple_header(self, title: &str) -> impl View

Instantiates a minimalistic decorative element containing a title.

impl Theme

pub fn label<S: Display + 'static>( self, render_func: impl Fn() -> S + 'static, variant: LabelVariant ) -> impl View

Instantiates a plain text label that sources its contents from a dynamic rendering function.

impl Theme

pub fn integer_input<T>( self, int_signal: RwSignal<T>, step: T, min_value: Option<T>, max_value: Option<T> ) -> impl View

where T: Integer + Clone + Copy + Display + FromStr + SubAssign + AddAssign + 'static,

Instantiates an input field that only accepts integer numeric input. Comes with up/down arrows allowing the user to increment/decrement the value in steps. If min_value and/or max_value are set, input is restricted to the given bounds.

impl Theme

pub fn padded_container<V: View + 'static>(self, child: V) -> impl View

Wraps a stack of UI elements in the theme’s configured horizontal window margin, and applies a padding of the same amount in vertical direction for symmetry purposes. You’d ordinarily do this to prevent form widgets from sticking to the side of the window.

impl Theme

pub fn radio_button<T>( self, variant_to_render: T, read_signal: ReadSignal<T>, write_signal: WriteSignal<T> ) -> impl View

where T: IntoEnumIterator + 'static + Copy + Clone + PartialEq + Display,

Instantiates one option in a radio group widget. For most use cases you’ll want Self::radio_group instead. Use Self::radio_button to implement special accommodations such as non-standard layouts or to render certain options as disabled.

pub fn radio_group<T>( self, read_signal: ReadSignal<T>, write_signal: WriteSignal<T>, gap_between_items: f32, variant: RadioGroupVariant ) -> impl View

where T: IntoEnumIterator + Copy + Clone + PartialEq + Eq + Display + Hash + 'static,

Instantiates a radio group widget for given enum T. For the display of labels, we rely on the Display trait. We ask that your enum derives EnumIter so the radio group may list all available options. Options can be laid out horizontally or vertically. A configurable gap is inserted between items.

impl Theme

pub fn root_view<V: View + 'static>(self, child: V) -> impl View

Instantiates a container that applies Floem UI Kit’s theme. Always use this as the foundation of your layout.

impl Theme

pub fn text_input(self, rw_signal: RwSignal<String>) -> impl View

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Theme

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Theme