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.

Macros

• to_owned
  A helper macro for using hooks and properties in async environments.

Structs

• Coroutine
• Resource
• UnboundedReceiver
  The receiving end of an unbounded mpsc channel.
• UnboundedSender
  The transmission end of an unbounded mpsc channel.
• UseCallback
  This callback is not generic over a return type so you can hold a bunch of callbacks at once
• UseFuture

Enums

• UseFutureState
  A signal that represents the state of a future
• UseResourceState
  A signal that represents the state of a future

Traits

• Dep
  A dependency is a trait that can be used to determine if a effect or selector should be re-run.
• Dependency
  A dependency is a trait that can be used to determine if a effect or selector should be re-run.

Functions

• try_use_context
  Consume some context in the tree, providing a sharable handle to the value
• use_callback
  A callback that’s always current
• 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
  Create a new effect. The effect will be run immediately and whenever any signal it reads changes. The signal will be owned by the current component and will be dropped when the component is dropped.
• use_future
  A hook that allows you to spawn a future
• use_hook_did_run
  A hook that uses before/after lifecycle hooks to determine if the hook was run
• use_maybe_sync_memo
  Creates a new Selector that may be sync. The selector will be run immediately and whenever any signal it reads changes.
• use_maybe_sync_memo_with_dependencies
  Creates a new Selector that may be sync with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes
• use_memo
  Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes.
• use_memo_with_dependencies
  Creates a new unsync Selector with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes
• use_on_unmountDeprecated
• use_resource
  A memo that resolve to a value asynchronously.
• use_root_context
• use_signal
  Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking.
• use_signal_sync
  Creates a new `Send + Sync`` Signal. Signals are a Copy state management solution with automatic dependency tracking.