yew_side_effect/lib.rs
1#![deny(clippy::all)]
2#![deny(unsafe_code)]
3#![deny(non_snake_case)]
4//! Reconcile Side Effects in Yew Applications
5//!
6//! This library is inspired by [react-side-effect](https://github.com/gaearon/react-side-effect)
7//! and [react-helmet](https://github.com/nfl/react-helmet).
8//!
9//! # Usage
10//!
11//! 1. Define a SideEffectType
12//!
13//! Each side effect needs to have a different type(struct).
14//!
15//! 2. Define a Side Effects Context Provider using [`SideEffectProvider<T>`]
16//!
17//! 3. Set Side Effects with [`SideEffect<SideEffectType>`]
18//!
19//! All side effects will be collected at component's creation order.
20//!
21//! Please refer to source code of [`title`] for a complete example.
22
23mod collections;
24mod comps;
25mod hooks;
26mod store;
27pub mod title;
28mod utils;
29
30pub use comps::{SideEffect, SideEffectProvider};
31pub use hooks::use_side_effects;
32
33pub use collections::SideEffects;