Skip to content

Latest commit

 

History

History
90 lines (76 loc) · 2.49 KB

README.md

File metadata and controls

90 lines (76 loc) · 2.49 KB
Raw

🧰 Dioxus Development Kit 🚀

A platform agnostic library for supercharging your productivity with Dioxus.

This library is still under development. Expect breaking changes!


dioxus-sdk is a development kit for Dioxus that provides abstractions for your Dioxus app. Abstractions included are notifications, clipboard, geolocation and storage with more to come!

Features

  • Geolocation - (Web, Windows)
  • Storage - (Web, Desktop)
  • Clipboard - (Desktop)
  • Notifications - (Desktop)
  • Color Scheme - (Web)
  • Utility Hooks
    • use_channel
    • use_window_size
    • use_interval
    • use_debounce
    • use_timeout
  • Camera
  • WiFi
  • Bluetooth

Geolocation example:

use dioxus_sdk::geolocation::{
    init_geolocator, use_geolocation, PowerMode
};

fn app() -> Element {
    let geolocator = init_geolocator(PowerMode::High).unwrap();
    let coords = use_geolocation();

    match coords {
      Ok(coords) => {
        rsx!( p { "Latitude: {coords.latitude} | Longitude: {coords.longitude}" } )
      }
      Err(Error::NotInitialized) => {
        rsx!( p { "Initializing..." } )
      }
      Err(e) => {
        rsx!( p { "An error occurred {e}" } )
      }
    }
}

Platform Support

Clipboard

On linux you need the x11 library to use the clipboard abstraction:

sudo apt-get install xorg-dev

Usage

You can add dioxus-sdk to your application by adding it to your dependencies.

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

License

This project is dual licensed under the MIT and Apache 2.0 licenses.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in dioxus-sdk by you, shall be licensed as MIT or Apache 2.0, without any additional terms or conditions.