Struct LaunchBuilder

pub struct LaunchBuilder { /* private fields */ }

A builder for a fullstack app.

Implementations

impl LaunchBuilder

pub fn new() -> LaunchBuilder

Create a new builder for your application. This will create a launch configuration for the current platform based on the features enabled on the dioxus crate.

pub fn web() -> LaunchBuilder

Launch your web application.

pub fn custom( launch_fn: fn(_: fn() -> Result<VNode, RenderError>, _: Vec<Box<dyn Fn() -> Box<dyn Any> + Send + Sync>>, _: Vec<Box<dyn Any>>), ) -> LaunchBuilder

Provide a custom launch function for your application.

Useful for third party renderers to tap into the launch builder API without having to reimplement it.

Example

use dioxus::prelude::*;
use std::any::Any;

#[derive(Default)]
struct Config;

fn my_custom_launcher(root: fn() -> Element, contexts: Vec<Box<dyn Fn() -> Box<dyn Any> + Send + Sync>>, cfg: Vec<Box<dyn Any>>) {
    println!("launching with root: {:?}", root());
    loop {
        println!("running...");
    }
}

fn app() -> Element {
    rsx! {
        div { "Hello, world!" }
    }
}

dioxus::LaunchBuilder::custom(my_custom_launcher).launch(app);

impl LaunchBuilder

pub fn with_context_provider( self, state: impl Fn() -> Box<dyn Any> + Send + Sync + 'static, ) -> LaunchBuilder

Inject state into the root component’s context that is created on the thread that the app is launched on.

pub fn with_context( self, state: impl Any + Clone + Send + Sync + 'static, ) -> LaunchBuilder

Inject state into the root component’s context.

impl LaunchBuilder

pub fn with_cfg(self, config: impl LaunchConfig) -> LaunchBuilder

Provide a platform-specific config to the builder.

pub fn launch(self, app: fn() -> Result<VNode, RenderError>)

Launch your application.