|
| 1 | +//! # Dioxus SDK |
| 2 | +//! The Dioxus SDK is a group of platform agnostic crates for common apis and functionality. |
| 3 | +//! |
| 4 | +//! This crate, `dioxus-sdk`, acts as an entrypoint to explore the variety of crates in the SDK ecosystem. |
| 5 | +//! Individual crates from the SDK ecosystem can be used directly from `crates.io` or you can enable the |
| 6 | +//! corresponding feature for a crate here. |
| 7 | +//! |
| 8 | +//! SDK is growing, and not all functionality supports every platform. Platform support will be documented in |
| 9 | +//! each crate, and in the majority of cases a runtime `Err(Unsupported)` will be returned if you target an unsupported platform. |
| 10 | +//! |
| 11 | +//! ## Available Crates |
| 12 | +//! Below is a table of the crates in our ecosystem, a short description, and their corresponding feature flag. |
| 13 | +//! |
| 14 | +//! | Crate | Description | Feature | |
| 15 | +//! | ------------------------- | ------------------------------------- | ----------------- | |
| 16 | +//! | [`dioxus-geolocation`] | Access user location services. | `geolocation` | |
| 17 | +//! | [`dioxus-storage`] | Store local and persistent data. | `storage` | |
| 18 | +//! | [`dioxus-time`] | Common timing utilities. | `time` | |
| 19 | +//! | [`dioxus-window`] | Common window utilities. | `window` | |
| 20 | +//! | [`dioxus-notification`] | Send notifications. | `notification` | |
| 21 | +//! | [`dioxus-sync`] | Synchronization primities for Dioxus. | `sync` | |
| 22 | +//! |
| 23 | +//! [`dioxus-geolocation`]: https://dioxuslabs.com |
| 24 | +//! [`dioxus-storage`]: https://dioxuslabs.com |
| 25 | +//! [`dioxus-time`]: https://dioxuslabs.com |
| 26 | +//! [`dioxus-window`]: https://dioxuslabs.com |
| 27 | +//! [`dioxus-notification`]: https://dioxuslabs.com |
| 28 | +//! [`dioxus-sync`]: https://dioxuslabs.com |
| 29 | +
|
| 30 | +#[cfg(feature = "geolocation")] |
| 31 | +pub use dioxus_geolocation; |
| 32 | + |
| 33 | +#[cfg(feature = "notification")] |
| 34 | +pub use dioxus_notification; |
| 35 | + |
| 36 | +#[cfg(feature = "storage")] |
| 37 | +pub use dioxus_storage; |
| 38 | + |
| 39 | +#[cfg(feature = "sync")] |
| 40 | +pub use dioxus_sync; |
| 41 | + |
| 42 | +#[cfg(feature = "time")] |
| 43 | +pub use dioxus_time; |
| 44 | + |
| 45 | +#[cfg(feature = "window")] |
| 46 | +pub use dioxus_window; |
0 commit comments