(root: Component, props: P, cfg: Config)
// iOS panics if we create a window before the event loop is started
let props = Rc::new(Cell::new(Some(props)));
let cfg = Rc::new(Cell::new(Some(cfg)));
+ let mut is_visible_before_start = true;
event_loop.run(move |window_event, event_loop, control_flow| {
*control_flow = ControlFlow::Wait;
@@ -210,6 +211,8 @@ pub fn launch_with_props(root: Component, props: P, cfg: Config)
// Create a dom
let dom = VirtualDom::new_with_props(root, props);
+ is_visible_before_start = cfg.window.window.visible;
+
let handler = create_new_window(
cfg,
event_loop,
@@ -323,6 +326,10 @@ pub fn launch_with_props(root: Component, props: P, cfg: Config)
EventData::Ipc(msg) if msg.method() == "initialize" => {
let view = webviews.get_mut(&event.1).unwrap();
send_edits(view.dom.rebuild(), &view.desktop_context.webview);
+ view.desktop_context
+ .webview
+ .window()
+ .set_visible(is_visible_before_start);
}
EventData::Ipc(msg) if msg.method() == "browser_open" => {
diff --git a/packages/desktop/src/protocol.rs b/packages/desktop/src/protocol.rs
index 53652f82f..2f660b7a2 100644
--- a/packages/desktop/src/protocol.rs
+++ b/packages/desktop/src/protocol.rs
@@ -153,7 +153,7 @@ fn get_asset_root() -> Option {
/// Get the mime type from a path-like string
fn get_mime_from_path(trimmed: &Path) -> Result<&'static str> {
- if trimmed.ends_with(".svg") {
+ if trimmed.extension().is_some_and(|ext| ext == "svg") {
return Ok("image/svg+xml");
}
diff --git a/packages/desktop/src/webview.rs b/packages/desktop/src/webview.rs
index 469aa8068..6e6d26b17 100644
--- a/packages/desktop/src/webview.rs
+++ b/packages/desktop/src/webview.rs
@@ -13,7 +13,7 @@ pub fn build(
proxy: EventLoopProxy,
) -> (WebView, WebContext) {
let builder = cfg.window.clone();
- let window = builder.build(event_loop).unwrap();
+ let window = builder.with_visible(false).build(event_loop).unwrap();
let file_handler = cfg.file_drop_handler.take();
let custom_head = cfg.custom_head.clone();
let index_file = cfg.custom_index.clone();
diff --git a/packages/dioxus-tui/Cargo.toml b/packages/dioxus-tui/Cargo.toml
index 0d0bb59f4..47ff3f536 100644
--- a/packages/dioxus-tui/Cargo.toml
+++ b/packages/dioxus-tui/Cargo.toml
@@ -10,7 +10,6 @@ keywords = ["dom", "ui", "gui", "react", "terminal"]
license = "MIT OR Apache-2.0"
[dependencies]
-dioxus = { workspace = true }
dioxus-core = { workspace = true, features = ["serialize"] }
dioxus-html = { workspace = true }
dioxus-native-core = { workspace = true, features = ["dioxus"] }
diff --git a/packages/dioxus-tui/src/lib.rs b/packages/dioxus-tui/src/lib.rs
index fd5b63501..ca0f0a07d 100644
--- a/packages/dioxus-tui/src/lib.rs
+++ b/packages/dioxus-tui/src/lib.rs
@@ -1,3 +1,7 @@
+#![doc = include_str!("../README.md")]
+#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
+#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]
+
mod element;
use std::{
diff --git a/packages/dioxus/src/lib.rs b/packages/dioxus/src/lib.rs
index bc2cd76e6..6256e96d7 100644
--- a/packages/dioxus/src/lib.rs
+++ b/packages/dioxus/src/lib.rs
@@ -1,3 +1,7 @@
+#![doc = include_str!("../README.md")]
+#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
+#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]
+
pub use dioxus_core as core;
#[cfg(feature = "hooks")]
diff --git a/packages/fermi/src/callback.rs b/packages/fermi/src/callback.rs
index a7ca9155f..bb9f61bf2 100644
--- a/packages/fermi/src/callback.rs
+++ b/packages/fermi/src/callback.rs
@@ -28,6 +28,7 @@ impl CallbackApi {
}
}
+#[must_use]
pub fn use_atom_context(cx: &ScopeState) -> &CallbackApi {
todo!()
}
diff --git a/packages/fermi/src/hooks/atom_ref.rs b/packages/fermi/src/hooks/atom_ref.rs
index 74dd9268b..8dbeb2c4d 100644
--- a/packages/fermi/src/hooks/atom_ref.rs
+++ b/packages/fermi/src/hooks/atom_ref.rs
@@ -13,6 +13,7 @@ use std::{
///
///
///
+#[must_use]
pub fn use_atom_ref<'a, T: 'static>(
cx: &'a ScopeState,
atom: &'static AtomRef,
diff --git a/packages/fermi/src/hooks/atom_root.rs b/packages/fermi/src/hooks/atom_root.rs
index 24fd70093..468f5f980 100644
--- a/packages/fermi/src/hooks/atom_root.rs
+++ b/packages/fermi/src/hooks/atom_root.rs
@@ -7,6 +7,6 @@ use dioxus_core::ScopeState;
pub fn use_atom_root(cx: &ScopeState) -> &Rc {
cx.use_hook(|| match cx.consume_context::>() {
Some(root) => root,
- None => panic!("No atom root found in context. Did you forget place an AtomRoot component at the top of your app?"),
+ None => panic!("No atom root found in context. Did you forget to call use_init_atom_root at the top of your app?"),
})
}
diff --git a/packages/fermi/src/hooks/read.rs b/packages/fermi/src/hooks/read.rs
index 57a544e93..c2538c74d 100644
--- a/packages/fermi/src/hooks/read.rs
+++ b/packages/fermi/src/hooks/read.rs
@@ -2,10 +2,12 @@ use crate::{use_atom_root, AtomId, AtomRoot, Readable};
use dioxus_core::{ScopeId, ScopeState};
use std::rc::Rc;
+#[must_use]
pub fn use_read(cx: &ScopeState, f: impl Readable) -> &V {
use_read_rc(cx, f).as_ref()
}
+#[must_use]
pub fn use_read_rc(cx: &ScopeState, f: impl Readable) -> &Rc {
let root = use_atom_root(cx);
diff --git a/packages/fermi/src/hooks/set.rs b/packages/fermi/src/hooks/set.rs
index 5e5141227..89fe48b0f 100644
--- a/packages/fermi/src/hooks/set.rs
+++ b/packages/fermi/src/hooks/set.rs
@@ -2,6 +2,7 @@ use crate::{use_atom_root, Writable};
use dioxus_core::ScopeState;
use std::rc::Rc;
+#[must_use]
pub fn use_set(cx: &ScopeState, f: impl Writable) -> &Rc {
let root = use_atom_root(cx);
cx.use_hook(|| {
diff --git a/packages/fermi/src/hooks/state.rs b/packages/fermi/src/hooks/state.rs
index 071b18059..7d473588a 100644
--- a/packages/fermi/src/hooks/state.rs
+++ b/packages/fermi/src/hooks/state.rs
@@ -30,6 +30,7 @@ use std::{
/// ))
/// }
/// ```
+#[must_use]
pub fn use_atom_state(cx: &ScopeState, f: impl Writable) -> &AtomState {
let root = crate::use_atom_root(cx);
@@ -85,7 +86,9 @@ impl AtomState {
/// ```
#[must_use]
pub fn current(&self) -> Rc {
- self.value.as_ref().unwrap().clone()
+ let atoms = self.root.atoms.borrow();
+ let slot = atoms.get(&self.id).unwrap();
+ slot.value.clone().downcast().unwrap()
}
/// Get the `setter` function directly without the `AtomState` wrapper.
diff --git a/packages/fermi/src/lib.rs b/packages/fermi/src/lib.rs
index 4943e38a3..52bf4cd09 100644
--- a/packages/fermi/src/lib.rs
+++ b/packages/fermi/src/lib.rs
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")]
+#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
+#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]
pub mod prelude {
pub use crate::*;
diff --git a/packages/fullstack/Cargo.toml b/packages/fullstack/Cargo.toml
index 8ab213e78..8de27a9b1 100644
--- a/packages/fullstack/Cargo.toml
+++ b/packages/fullstack/Cargo.toml
@@ -11,7 +11,7 @@ keywords = ["ui", "gui", "react", "ssr", "fullstack"]
[dependencies]
# server functions
-server_fn = { version = "0.4.6", default-features = false }
+server_fn = { version = "0.5.2", default-features = false }
dioxus_server_macro = { workspace = true }
# warp
diff --git a/packages/fullstack/src/hooks/server_future.rs b/packages/fullstack/src/hooks/server_future.rs
index e4d89480e..f8eaef963 100644
--- a/packages/fullstack/src/hooks/server_future.rs
+++ b/packages/fullstack/src/hooks/server_future.rs
@@ -22,6 +22,7 @@ use std::sync::Arc;
/// will be allowed to continue
///
/// - dependencies: a tuple of references to values that are PartialEq + Clone
+#[must_use = "Consider using `cx.spawn` to run a future without reading its value"]
pub fn use_server_future(
cx: &ScopeState,
dependencies: D,
diff --git a/packages/fullstack/src/launch.rs b/packages/fullstack/src/launch.rs
index c982a1c90..bd145f363 100644
--- a/packages/fullstack/src/launch.rs
+++ b/packages/fullstack/src/launch.rs
@@ -121,8 +121,15 @@ impl for DioxusServerFnRegistry {
}
}
- fn register(
- url: &'static str,
- server_function: ServerFunction,
- encoding: server_fn::Encoding,
- ) -> Result<(), Self::Error> {
- Self::register_explicit("", url, server_function, encoding)
- }
-
/// Returns the server function registered at the given URL, or `None` if no function is registered at that URL.
fn get(url: &str) -> Option> {
REGISTERED_SERVER_FUNCTIONS
diff --git a/packages/generational-box/README.md b/packages/generational-box/README.md
index 5ab7926ba..7d3088eda 100644
--- a/packages/generational-box/README.md
+++ b/packages/generational-box/README.md
@@ -31,4 +31,4 @@ let store = Store::default();
## How it works
-Internally
\ No newline at end of file
+Internally, `generational-box` creates an arena of generational RefCell's that are recyled when the owner is dropped. You can think of the cells as something like `&'static RefCell>` with a generational check to make recyling a cell easier to debug. Then GenerationalBox's are `Copy` because the `&'static` pointer is `Copy`
diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs
index 60bd41419..4be383b4f 100644
--- a/packages/generational-box/src/lib.rs
+++ b/packages/generational-box/src/lib.rs
@@ -184,7 +184,7 @@ impl GenerationalBox {
}
/// Try to read the value. Returns None if the value is no longer valid.
- pub fn try_read(&self) -> Option> {
+ pub fn try_read(&self) -> Option> {
self.validate()
.then(|| {
Ref::filter_map(self.raw.data.borrow(), |any| {
@@ -196,12 +196,12 @@ impl GenerationalBox {
}
/// Read the value. Panics if the value is no longer valid.
- pub fn read(&self) -> Ref<'_, T> {
+ pub fn read(&self) -> Ref<'static, T> {
self.try_read().unwrap()
}
/// Try to write the value. Returns None if the value is no longer valid.
- pub fn try_write(&self) -> Option> {
+ pub fn try_write(&self) -> Option> {
self.validate()
.then(|| {
RefMut::filter_map(self.raw.data.borrow_mut(), |any| {
@@ -213,7 +213,7 @@ impl GenerationalBox {
}
/// Write the value. Panics if the value is no longer valid.
- pub fn write(&self) -> RefMut<'_, T> {
+ pub fn write(&self) -> RefMut<'static, T> {
self.try_write().unwrap()
}
diff --git a/packages/hooks/src/computed.rs b/packages/hooks/src/computed.rs
index 3369d6832..dbea75d73 100644
--- a/packages/hooks/src/computed.rs
+++ b/packages/hooks/src/computed.rs
@@ -37,6 +37,7 @@ use std::{
/// }
/// }
/// ```
+#[must_use]
pub fn use_tracked_state(cx: &ScopeState, init: impl FnOnce() -> T) -> &Tracked {
cx.use_hook(|| {
let init = init();
@@ -160,6 +161,7 @@ impl Drop for Tracker {
}
}
+#[must_use = "Consider using the `use_effect` hook to rerun an effect whenever the tracked state changes if you don't need the result of the computation"]
pub fn use_selector(
cx: &ScopeState,
tracked: &Tracked,
diff --git a/packages/hooks/src/lib.rs b/packages/hooks/src/lib.rs
index 6d7ab6f53..a5b92a036 100644
--- a/packages/hooks/src/lib.rs
+++ b/packages/hooks/src/lib.rs
@@ -1,7 +1,10 @@
+#![doc = include_str!("../README.md")]
+#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
+#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]
#![cfg_attr(feature = "nightly-features", feature(debug_refcell))]
#[macro_export]
-/// A helper macro for using hooks and properties in async environements.
+/// A helper macro for using hooks and properties in async environments.
///
/// # Usage
///
@@ -54,35 +57,37 @@ macro_rules! to_owned {
pub mod computed;
-mod use_on_unmount;
-pub use use_on_unmount::*;
+mod use_on_destroy;
+pub use use_on_destroy::*;
-mod usecontext;
-pub use usecontext::*;
+mod use_context;
+pub use use_context::*;
-mod usestate;
-pub use usestate::{use_state, UseState};
+mod use_state;
+pub use use_state::{use_state, UseState};
-mod useref;
-pub use useref::*;
+mod use_ref;
+pub use use_ref::*;
mod use_shared_state;
pub use use_shared_state::*;
-mod usecoroutine;
-pub use usecoroutine::*;
+mod use_coroutine;
+pub use use_coroutine::*;
-mod usefuture;
-pub use usefuture::*;
+mod use_future;
+pub use use_future::*;
-mod useeffect;
-pub use useeffect::*;
+mod use_effect;
+pub use use_effect::*;
-mod usecallback;
-pub use usecallback::*;
+mod use_callback;
+pub use use_callback::*;
-mod usememo;
-pub use usememo::*;
+mod use_memo;
+pub use use_memo::*;
-mod userootcontext;
-pub use userootcontext::*;
+mod use_on_create;
+pub use use_on_create::*;
+mod use_root_context;
+pub use use_root_context::*;
diff --git a/packages/hooks/src/usecallback.rs b/packages/hooks/src/use_callback.rs
similarity index 99%
rename from packages/hooks/src/usecallback.rs
rename to packages/hooks/src/use_callback.rs
index 3f223b581..52e592f6b 100644
--- a/packages/hooks/src/usecallback.rs
+++ b/packages/hooks/src/use_callback.rs
@@ -24,6 +24,7 @@ macro_rules! use_callback {
)
};
}
+
pub fn use_callback(cx: &ScopeState, make: impl FnOnce() -> R) -> impl FnMut(T) + '_
where
R: FnMut(T) -> F + 'static,
diff --git a/packages/hooks/src/usecollection.rs b/packages/hooks/src/use_collection.rs
similarity index 100%
rename from packages/hooks/src/usecollection.rs
rename to packages/hooks/src/use_collection.rs
diff --git a/packages/hooks/src/usecontext.rs b/packages/hooks/src/use_context.rs
similarity index 98%
rename from packages/hooks/src/usecontext.rs
rename to packages/hooks/src/use_context.rs
index fdf363252..0d94492f6 100644
--- a/packages/hooks/src/usecontext.rs
+++ b/packages/hooks/src/use_context.rs
@@ -3,6 +3,7 @@ use dioxus_core::ScopeState;
/// Consume some context in the tree, providing a sharable handle to the value
///
/// Does not regenerate the value if the value is changed at the parent.
+#[must_use]
pub fn use_context(cx: &ScopeState) -> Option<&T> {
cx.use_hook(|| cx.consume_context::()).as_ref()
}
diff --git a/packages/hooks/src/usecoroutine.rs b/packages/hooks/src/use_coroutine.rs
similarity index 99%
rename from packages/hooks/src/usecoroutine.rs
rename to packages/hooks/src/use_coroutine.rs
index e5563d793..f2577b90c 100644
--- a/packages/hooks/src/usecoroutine.rs
+++ b/packages/hooks/src/use_coroutine.rs
@@ -79,6 +79,7 @@ where
/// Get a handle to a coroutine higher in the tree
///
/// See the docs for [`use_coroutine`] for more details.
+#[must_use]
pub fn use_coroutine_handle(cx: &ScopeState) -> Option<&Coroutine> {
cx.use_hook(|| cx.consume_context::>())
.as_ref()
diff --git a/packages/hooks/src/useeffect.rs b/packages/hooks/src/use_effect.rs
similarity index 87%
rename from packages/hooks/src/useeffect.rs
rename to packages/hooks/src/use_effect.rs
index 76a3f5245..e72afe27f 100644
--- a/packages/hooks/src/useeffect.rs
+++ b/packages/hooks/src/use_effect.rs
@@ -3,13 +3,18 @@ use std::{any::Any, cell::Cell, future::Future};
use crate::UseFutureDep;
-/// A hook that provides a future that executes after the hooks have been applied
+/// A hook that provides a future that executes after the hooks have been applied.
///
/// Whenever the hooks dependencies change, the future will be re-evaluated.
/// If a future is pending when the dependencies change, the previous future
-/// will be allowed to continue
+/// will be allowed to continue.
///
-/// - dependencies: a tuple of references to values that are `PartialEq` + `Clone`
+/// **Note:** If your dependency list is always empty, use [`use_on_create`](crate::use_on_create).
+///
+/// ## Arguments
+///
+/// - `dependencies`: a tuple of references to values that are `PartialEq` + `Clone`.
+/// - `future`: a closure that takes the `dependencies` as arguments and returns a `'static` future.
///
/// ## Examples
///
diff --git a/packages/hooks/src/usefuture.rs b/packages/hooks/src/use_future.rs
similarity index 100%
rename from packages/hooks/src/usefuture.rs
rename to packages/hooks/src/use_future.rs
diff --git a/packages/hooks/src/usememo.rs b/packages/hooks/src/use_memo.rs
similarity index 93%
rename from packages/hooks/src/usememo.rs
rename to packages/hooks/src/use_memo.rs
index 3181d57b8..be61b8d53 100644
--- a/packages/hooks/src/usememo.rs
+++ b/packages/hooks/src/use_memo.rs
@@ -28,6 +28,7 @@ use crate::UseFutureDep;
/// render!(Calculator { number: 0 })
/// }
/// ```
+#[must_use = "Consider using `use_effect` to run rerun a callback when dependencies change"]
pub fn use_memo(cx: &ScopeState, dependencies: D, callback: impl FnOnce(D::Out) -> T) -> &T
where
T: 'static,
diff --git a/packages/hooks/src/usemodel.rs b/packages/hooks/src/use_model.rs
similarity index 100%
rename from packages/hooks/src/usemodel.rs
rename to packages/hooks/src/use_model.rs
diff --git a/packages/hooks/src/use_on_create.rs b/packages/hooks/src/use_on_create.rs
new file mode 100644
index 000000000..28f7bcd6f
--- /dev/null
+++ b/packages/hooks/src/use_on_create.rs
@@ -0,0 +1,27 @@
+use dioxus_core::ScopeState;
+use std::cell::Cell;
+use std::future::Future;
+
+/// A hook that runs a future when the component is mounted.
+///
+/// This is just [`use_effect`](crate::use_effect), but with no dependencies.
+/// If you have no dependencies, it's recommended to use this, not just because it's more readable,
+/// but also because it's a tiny bit more efficient.
+pub fn use_on_create(cx: &ScopeState, future: impl FnOnce() -> F)
+where
+ T: 'static,
+ F: Future