Struct Config

pub struct Config { /* private fields */ }

The configuration for the desktop application.

Implementations

impl Config

pub fn new() -> Self

Initializes a new WindowBuilder with default values.

pub fn with_resource_directory(self, path: impl Into<PathBuf>) -> Self

set the directory from which assets will be searched in release mode

pub fn with_data_directory(self, path: impl Into<PathBuf>) -> Self

set the directory where data will be stored in release mode.

Note: This must be set when bundling on Windows.

pub fn with_disable_context_menu(self, disable: bool) -> Self

Set whether or not the right-click context menu should be disabled.

pub fn with_disable_drag_drop_handler(self, disable: bool) -> Self

Set whether or not the file drop handler should be disabled. On Windows the drop handler must be disabled for HTML drag and drop APIs to work.

pub fn with_prerendered(self, content: String) -> Self

Set the pre-rendered HTML content

pub fn with_event_loop(self, event_loop: EventLoop<UserWindowEvent>) -> Self

Set the event loop to be used

pub fn with_window(self, window: WindowBuilder) -> Self

Set the configuration for the window.

pub fn with_as_child_window(self) -> Self

Set the window as child

pub fn with_close_behaviour(self, behaviour: WindowCloseBehaviour) -> Self

Sets the behaviour of the application when the last window is closed.

pub fn with_custom_event_handler( self, f: impl FnMut(&Event<'_, UserWindowEvent>, &EventLoopWindowTarget<UserWindowEvent>) + 'static, ) -> Self

Sets a custom callback to run whenever the event pool receives an event.

pub fn with_custom_protocol<F>(self, name: impl ToString, handler: F) -> Self

where F: Fn(HttpRequest<Vec<u8>>) -> HttpResponse<Cow<'static, [u8]>> + 'static,

Set a custom protocol

pub fn with_asynchronous_custom_protocol<F>( self, name: impl ToString, handler: F, ) -> Self

where F: Fn(HttpRequest<Vec<u8>>, RequestAsyncResponder) + 'static,

Set an asynchronous custom protocol

Example Usage

let cfg = Config::new()
    .with_asynchronous_custom_protocol("asset", |request, responder| {
        tokio::spawn(async move {
            responder.respond(
                HTTPResponse::builder()
                    .status(404)
                    .body(Cow::Borrowed("404 - Not Found".as_bytes()))
                    .unwrap()
            );
        });
    });

note a key difference between Dioxus and Wry, the protocol name doesn’t explicitly need to be a String, but needs to implement ToString.

See wry for more details on implementation

pub fn with_icon(self, icon: Icon) -> Self

Set a custom icon for this application

pub fn with_custom_head(self, head: String) -> Self

Inject additional content into the document’s HEAD.

This is useful for loading CSS libraries, JS libraries, etc.

pub fn with_custom_index(self, index: String) -> Self

Use a custom index.html instead of the default Dioxus one.

Make sure your index.html is valid HTML.

Dioxus injects some loader code into the closing body tag. Your document must include a body element!

pub fn with_root_name(self, name: impl Into<String>) -> Self

Set the name of the element that Dioxus will use as the root.

This is akin to calling React.render() on the element with the specified name.

pub fn with_background_color(self, color: (u8, u8, u8, u8)) -> Self

Sets the background color of the WebView. This will be set before the HTML is rendered and can be used to prevent flashing when the page loads. Accepts a color in RGBA format

pub fn with_menu(self, menu: impl Into<Option<Menu>>) -> Self

Sets the menu the window will use. This will override the default menu bar.

Note: Menu will be hidden if with_decorations is set to false and passed into with_window

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl LaunchConfig for Config