repose-ui 0.25.2

UI widgets and libs for Repose
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! # Scroll model
//!
//! Repose separates visual scroll containers from scroll state.
//!
//! This file implements scroll composables (wrappers that attach scroll bindings
//! as modifiers). The actual scroll state types live in `repose_core::scroll`.
//!
//! Velocities are expressed in px/sec and integrated with dt,
//! so behavior is frame-rate independent.

pub use repose_core::scroll::{HorizontalScrollState, ScrollPhysics, ScrollState, ScrollStateXY};
use crate::ViewExt;
use repose_core::*;
use std::rc::Rc;

/// Remembered ScrollState (requires unique key).
pub fn remember_scroll_state(key: impl Into<String>) -> Rc<ScrollState> {
    repose_core::remember_with_key(key.into(), ScrollState::new)
}

pub fn remember_horizontal_scroll_state(key: impl Into<String>) -> Rc<HorizontalScrollState> {
    repose_core::remember_with_key(key.into(), HorizontalScrollState::new)
}

pub fn remember_scroll_state_xy(key: impl Into<String>) -> Rc<ScrollStateXY> {
    repose_core::remember_with_key(key.into(), ScrollStateXY::new)
}

/// Scroll container with inertia, like verticalScroll.
///
/// Content is wrapped so it:
/// - does not flex-shrink,
/// - is at least as wide/tall as the viewport,
/// - grows with content on the scroll axis.
///
/// Prefer a stable `remember_scroll_state(key)` and put `scope!` / `repaint_boundary`
/// around expensive list bodies.
pub fn ScrollArea(modifier: Modifier, state: Rc<ScrollState>, content: View) -> View {
    let binding = state.to_binding();
    let content = crate::Box(
        Modifier::new()
            .flex_shrink(0.0)
            // Fill viewport width so short content still spans the scroller;
            // height stays auto so content grows vertically.
            .fill_max_width(),
    )
    .child(content);

    View::new(0, ViewKind::Box)
        .modifier(modifier.vertical_scroll(match binding {
            ScrollBinding::Vertical(b) => b,
            _ => unreachable!(),
        }))
        .with_children(vec![content])
}

/// Horizontal scroll container with inertia.
///
/// Content is wrapped so it does not flex-shrink, is at least as tall as the
/// viewport, and grows with content horizontally.
pub fn HorizontalScrollArea(
    modifier: Modifier,
    state: Rc<HorizontalScrollState>,
    content: View,
) -> View {
    let binding = state.to_binding();
    let content = crate::Box(
        Modifier::new()
            .flex_shrink(0.0)
            // Fill viewport height so short content still spans the scroller;
            // width stays auto so content grows horizontally.
            .fill_max_height(),
    )
    .child(content);

    View::new(0, ViewKind::Box)
        .modifier(modifier.horizontal_scroll(match binding {
            ScrollBinding::Horizontal(b) => b,
            _ => unreachable!(),
        }))
        .with_children(vec![content])
}

/// Two-axis scroll container with inertia.
///
/// Content is wrapped so it does not flex-shrink and grows with content on
/// both axes.
pub fn ScrollAreaXY(modifier: Modifier, state: Rc<ScrollStateXY>, content: View) -> View {
    let binding = state.to_binding();
    let content = crate::Box(Modifier::new().flex_shrink(0.0)).child(content);

    View::new(0, ViewKind::Box)
        .modifier(modifier.scrollable(match binding {
            ScrollBinding::Both(b) => b,
            _ => unreachable!(),
        }))
        .with_children(vec![content])
}