Evan Almloff
0127501dbf
Improve inline docs * improve incorrect event handler return error message * Improve event handler docs * document the eval functions * document spawn and common spawn errors * fix event handler docs * add notes about how you use attributes and elements in rsx * add doc aliases for attributes and events we rename * add some more aliases for common search terms * don't doc ignore any public examples in core * don't ignore public doc examples in ssr * don't ignore examples in the dioxus package readme * add a warning when you launch without a renderer enabled * fix some outdated element docs * add a bunch of examples to resource * add notes about desktop events * add more docs for use_resource * add on_unimplemented hint to Dependency * fix some unresolved links * add examples to each of the router traits * add not implemented errors for router traits * add an example to the routable trait * expand rsx macro docs * improve memo docs * update the dioxus readme * mention dioxus crate features in the docs * fix a bunch of doc tests * fix html doc tests * fix router doc tests * fix dioxus signals doc tests * fix dioxus ssr doc tests * fix use_future example in the hooks cheat sheet * add a javascript alias for eval * fix hook explanation values * remove unused embed-doc-image dependency
68 lines
2.4 KiB
Rust
68 lines
2.4 KiB
Rust
use dioxus_core::{
|
|
prelude::{consume_context, provide_context, try_consume_context},
|
|
use_hook,
|
|
};
|
|
|
|
/// 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.
|
|
#[doc = include_str!("../docs/rules_of_hooks.md")]
|
|
#[doc = include_str!("../docs/moving_state_around.md")]
|
|
#[must_use]
|
|
pub fn try_use_context<T: 'static + Clone>() -> Option<T> {
|
|
use_hook(|| try_consume_context::<T>())
|
|
}
|
|
|
|
/// 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.
|
|
/// ```rust
|
|
/// # use dioxus::prelude::*;
|
|
/// # #[derive(Clone, Copy, PartialEq, Debug)]
|
|
/// # enum Theme { Dark, Light }
|
|
/// fn Parent() -> Element {
|
|
/// use_context_provider(|| Theme::Dark);
|
|
/// rsx! { Child {} }
|
|
/// }
|
|
/// #[component]
|
|
/// fn Child() -> Element {
|
|
/// //gets context provided by parent element with use_context_provider
|
|
/// let user_theme = use_context::<Theme>();
|
|
/// rsx! { "user using dark mode: {user_theme == Theme::Dark}" }
|
|
/// }
|
|
/// ```
|
|
#[doc = include_str!("../docs/rules_of_hooks.md")]
|
|
#[doc = include_str!("../docs/moving_state_around.md")]
|
|
#[must_use]
|
|
pub fn use_context<T: 'static + Clone>() -> T {
|
|
use_hook(|| consume_context::<T>())
|
|
}
|
|
|
|
/// Provide some context via the tree and return a reference to it
|
|
///
|
|
/// Once the context has been provided, it is immutable. Mutations should be done via interior mutability.
|
|
/// Context can be read by any child components of the context provider, and is a solution to prop
|
|
/// drilling, using a context provider with a Signal inside is a good way to provide global/shared
|
|
/// state in your app:
|
|
/// ```rust
|
|
/// # use dioxus::prelude::*;
|
|
///fn app() -> Element {
|
|
/// use_context_provider(|| Signal::new(0));
|
|
/// rsx! { Child {} }
|
|
///}
|
|
/// // This component does read from the signal, so when the signal changes it will rerun
|
|
///#[component]
|
|
///fn Child() -> Element {
|
|
/// let mut signal: Signal<i32> = use_context();
|
|
/// rsx! {
|
|
/// button { onclick: move |_| signal += 1, "increment context" }
|
|
/// p {"{signal}"}
|
|
/// }
|
|
///}
|
|
/// ```
|
|
#[doc = include_str!("../docs/rules_of_hooks.md")]
|
|
#[doc = include_str!("../docs/moving_state_around.md")]
|
|
pub fn use_context_provider<T: 'static + Clone>(f: impl FnOnce() -> T) -> T {
|
|
use_hook(|| provide_context(f()))
|
|
}
|