Dioxus Development Kit (SDK)

The dioxus-sdk-window package provides utilities for interacting with window-level properties in Dioxus applications. Currently supported features include:

• Theme: Utilities for managing or responding to application themes.
• Window Size: Utilities for monitoring or managing the dimensions of the application window.

The dioxus-sdk-geolocation package currently supports the following platforms:

• Web
• Windows

The dioxus-sdk crate provides access to various cross-platform APIs via feature flags. The available modules include:

• dioxus-sdk-storage: Persistent storage.
• dioxus-sdk-geolocation: Geolocation services (Web & Windows).
• dioxus-sdk-notifications: Desktop notifications.
• dioxus-sdk-window: Window management (includes Theme support for Web, Windows, Mac, and Window Size).
• dioxus-sdk-time: Time-based utilities (Sleep, Intervals, Debounce, Timeouts).
• dioxus-sdk-sync: Synchronization primitives (Channels).
• dioxus-sdk-util: Utility hooks (e.g., use_root_scroll).

Planned features include Camera, WiFi, and Bluetooth.

To use local and persistent storage utilities in your Dioxus project, add dioxus_sdk_storage to your Cargo.toml dependencies.

[dependencies]
dioxus_sdk_storage = "0.1"

To use the Dioxus SDK in your project, add dioxus-sdk to your Cargo.toml dependencies. The SDK is modular; you must enable specific feature flags to access different sub-crates (e.g., storage, geolocation, notifications, etc.).

Note: The crates are under active development and may undergo breaking changes.

[dependencies]
dioxus-sdk = { version = "0.6", features = [] }

To use geolocation utilities in your Dioxus project, add dioxus-sdk-geolocation to your Cargo.toml dependencies.

[dependencies]
dioxus-sdk-geolocation = "0.1"

The dioxus-sdk-time package provides specialized hooks for managing time-based logic within Dioxus applications. This example demonstrates the usage of two primary hooks:

1. use_interval: Executes a callback function at a regular, specified interval.
2. use_debounce: Delays the execution of a callback function until a specified period of inactivity has passed, useful for reducing the frequency of expensive operations like API calls during user input.

dx serve

To use window utilities like Theme and Window Size in your Dioxus project, add dioxus-sdk-window to your Cargo.toml dependencies.

[dependencies]
dioxus-sdk-window = "0.1"

To run the scroll example, use the Dioxus CLI (dx) and specify the target platform.

# For Web platform
dx serve --platform web

# For Desktop platform
dx serve --platform desktop

To use notifications in your Dioxus application, add dioxus-sdk-notification to your Cargo.toml dependencies.

[dependencies]
dioxus-sdk-notification = "0.1"

To explore how to create data that persists across sessions using the use_persistent hook, you can run the storage example on different platforms using the Dioxus CLI (dx).

# For Desktop
dx serve --platform desktop

# For Web
dx serve --platform web

# For Fullstack (Web)
dx serve --platform web --fullstack --features fullstack

# For Fullstack (Desktop)
dx serve --platform desktop --fullstack --features fullstack