Freya Documentation

Freya Router is a fork of Dioxus Router optimized for the Freya ecosystem. The primary architectural differences are:

• Multiple Routers Support: Unlike Dioxus Router, which allows only one router per app, Freya Router allows multiple routers in the same component tree by providing the router context to children rather than injecting it at the root.
• Built-in ActivableRoute: A helper component (moved from freya-components) that informs child components if a specific route is currently active, without requiring those children to depend on freya-router directly.
• Built-in NativeRouter: Provides Freya-specific integration for mouse-based back and forward navigation (moved from freya-components).
• MemoryHistory: The router always uses MemoryHistory, removing the need for renderer-agnostic APIs.
• Reduced Dependencies: The html feature and WASM-splitting features have been removed to avoid pulling in dioxus-html and unnecessary overhead.

Use the following methods to handle conditional elements within the builder chain:

• .maybe(bool, |el| ...): Applies the callback only when the boolean condition is true.
• .map(Option<T>, |el, val| ...): Applies the callback when the Option is Some, passing the inner value to the callback.
• .maybe_child(Option<impl IntoElement>): Appends a child only when the provided Option is Some.

Best Practice: Prefer one outer .maybe or .map to wrap multiple conditional children rather than repeating the same condition across multiple .maybe_child calls. This keeps the gating logic in one place.

// Good: Single .maybe wraps all conditional children
rect()
    .maybe(show, |el| {
        el.child(Title::new("Hi"))
            .child(Content::new().child("Hello"))
            .child(Footer::new())
    })

// Bad: Same predicate repeated per child
rect()
    .maybe_child(show.then(|| Title::new("Hi")))
    .maybe_child(show.then(|| Content::new().child("Hello")))
    .maybe_child(show.then(|| Footer::new()))

Freya supports system tray icons with menus. You can define a tray icon using TrayIconBuilder and provide a handler function to respond to TrayEvent::Menu events. This allows you to run apps entirely from the tray or use the tray to control window visibility and lifecycle.

fn main() {
    let tray_icon = || {
        let tray_menu = Menu::new();
        let _ = tray_menu.append(&MenuItem::with_id("open", "Open", true, None));
        let _ = tray_menu.append(&MenuItem::with_id(
            "toggle-visibility", "Toggle Visibility", true, None,
        ));
        let _ = tray_menu.append(&MenuItem::with_id("exit", "Exit", true, None));
        TrayIconBuilder::new()
            .with_menu(Box::new(tray_menu))
            .with_tooltip("Freya Tray")
            .with_icon(LaunchConfig::tray_icon(ICON))
            .build()
            .unwrap()
    };

    let tray_handler = |ev, mut ctx: RendererContext| match ev {
        TrayEvent::Menu(MenuEvent { id }) if id == "open" => {
            ctx.launch_window(WindowConfig::new(app).with_size(500., 450.));
        }
        // ... handle the other menu items (toggle visibility, exit, ...)
        _ => {}
    };

    launch(LaunchConfig::new().with_tray(tray_icon, tray_handler))
}