freya-components 0.4.0

Components for Freya apps
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use freya_core::prelude::{
    Readable,
    use_try_consume,
};

/// Context that exposes whether the descendants are considered active.
///
/// Provided by [`Activable`](crate::activable::Activable) for user-controlled state
/// and by [`ActivableRoute`](crate::activable_route::ActivableRoute) for route-driven
/// state. Descendants read it via [`use_is_active`].
#[derive(Clone)]
pub struct ActivableContext(pub Readable<bool>);

impl ActivableContext {
    pub fn is_active(&self) -> bool {
        *self.0.read()
    }
}

/// Returns whether the closest ancestor [`ActivableContext`] provider is active.
///
/// Falls back to `false` when no provider is found in the tree.
pub fn use_is_active() -> bool {
    let ctx = use_try_consume::<ActivableContext>();

    if let Some(ctx) = ctx {
        ctx.is_active()
    } else {
        false
    }
}