Crate dioxus_hooks

Dioxus Hooks

Website | Guides | API Docs | Chat

Overview

dioxus-hooks includes some basic useful hooks for dioxus:

• use_state
• use_ref
• use_future
• use_coroutine
• use_callback

Unlike React, none of these hooks are foundational since they all build off the primitive cx.use_hook.

This crate also provides a few helpful macros to get around some Rust lifetime management issues in async.

• to_owned![]
• use_future!()
• use_callback!()

Contributing

• Report issues on our issue tracker.
• Join the discord and ask questions!

License

This project is licensed under the MIT license.

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

Modules

• computed
  Tracked and computed state in Dioxus
• error

Macros

• debug_location
• to_owned
  A helper macro for using hooks and properties in async environments.
• use_callback
• use_future
  A helper macro that merges uses the closure syntax to elaborate the dependency array

Structs

• BorrowError
  An error returned by [RefCell::try_borrow].
• BorrowMutError
  An error returned by [RefCell::try_borrow_mut].
• Coroutine
• Ref
  Wraps a borrowed reference to a value in a RefCell box. A wrapper type for an immutably borrowed value from a RefCell<T>.
• RefCell
  A clone of the standard library’s RefCell type.
• RefMut
  A wrapper type for a mutably borrowed value from a RefCell<T>.
• UnboundedReceiver
  The receiving end of an unbounded mpsc channel.
• UnboundedSender
  The transmission end of an unbounded mpsc channel.
• UseFuture
• UseRef
  A type created by the use_ref hook. See its documentation for more details.
• UseSharedState
  State that is shared between components through the context system
• UseState

Enums

• FutureState
• UseFutureState

Traits

• Dep
• UseFutureDep

Functions

• use_callback
• use_context
  Consume some context in the tree, providing a sharable handle to the value
• use_context_provider
  Provide some context via the tree and return a reference to it
• use_coroutine
  Maintain a handle over a future that can be paused, resumed, and canceled.
• use_coroutine_handle
  Get a handle to a coroutine higher in the tree
• use_effect
  A hook that provides a future that executes after the hooks have been applied.
• use_future
  A future that resolves to a value.
• use_memo
  A hook that provides a callback that executes if the dependencies change. This is useful to avoid running computation-expensive calculations even when the data doesn’t change.
• use_on_create
  A hook that runs a future when the component is mounted.
• use_on_destroy
  Creates a callback that will be run before the component is removed. This can be used to clean up side effects from the component (created with use_effect).
• use_on_unmountDeprecated
• use_ref
  use_ref is a key foundational hook for storing state in Dioxus.
• use_root_context
• use_shared_state
  This hook provides some relatively light ergonomics around shared state.
• use_shared_state_provider
  Provide some state for components down the hierarchy to consume without having to drill props. See use_shared_state to consume the state
• use_state
  Store state between component renders.