dioxus/packages/hooks/README.md

54 lines
1.8 KiB
Markdown
Raw Normal View History

2022-12-29 21:17:03 +00:00
# Dioxus Hooks
2021-07-09 15:54:07 +00:00
2022-12-29 21:17:03 +00:00
[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]
[![Discord chat][discord-badge]][discord-url]
[crates-badge]: https://img.shields.io/crates/v/dioxus-hooks.svg
[crates-url]: https://crates.io/crates/dioxus-hooks
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
[actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
[actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
[discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
[discord-url]: https://discord.gg/XgGxMSkvUM
[Website](https://dioxuslabs.com) |
2023-09-16 17:03:27 +00:00
[Guides](https://dioxuslabs.com/learn/0.4/) |
[API Docs](https://docs.rs/dioxus-hooks/latest/dioxus_hooks) |
2022-12-29 21:17:03 +00:00
[Chat](https://discord.gg/XgGxMSkvUM)
## Overview
`dioxus-hooks` includes some basic useful hooks for dioxus:
2021-07-09 15:54:07 +00:00
- use_state
- use_ref
2021-12-30 02:28:28 +00:00
- use_future
- use_coroutine
2022-12-29 21:17:03 +00:00
- 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
2021-07-09 15:54:07 +00:00
2022-12-29 21:17:03 +00:00
- Report issues on our [issue tracker](https://github.com/dioxuslabs/dioxus/issues).
- Join the discord and ask questions!
2021-07-09 15:54:07 +00:00
2022-12-29 21:17:03 +00:00
## License
2023-09-16 17:03:27 +00:00
2022-12-29 21:17:03 +00:00
This project is licensed under the [MIT license].
2021-07-09 15:54:07 +00:00
2022-12-29 21:17:03 +00:00
[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
2021-07-09 15:54:07 +00:00
2022-12-29 21:17:03 +00:00
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Dioxus by you shall be licensed as MIT without any additional
2022-12-29 21:17:03 +00:00
terms or conditions.