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

use leptos_dom::IntoView;
use leptos_macro::component;
use leptos_reactive::Scope;
use std::hash::Hash;

/// Iterates over children and displays them, keyed by the `key` function given.
///
/// This is much more efficient than naively iterating over nodes with `.iter().map(|n| view! { cx,  ... })...`,
/// as it avoids re-creating DOM nodes that are not being changed.
///
/// ```
/// # use leptos::*;
///
/// #[derive(Copy, Clone, Debug, PartialEq, Eq)]
/// struct Counter {
///   id: usize,
///   count: RwSignal<i32>
/// }
///
/// #[component]
/// fn Counters(cx: Scope) -> impl IntoView {
///   let (counters, set_counters) = create_signal::<Vec<Counter>>(cx, vec![]);
///
///   view! {
///     cx,
///     <div>
///       <For
///         // a function that returns the items we're iterating over; a signal is fine
///         each=counters
///         // a unique key for each item
///         key=|counter| counter.id
///         // renders each item to a view
///         view=move |cx, counter: Counter| {
///           view! {
///             cx,
///             <button>"Value: " {move || counter.count.get()}</button>
///           }
///         }
///       />
///     </div>
///   }
/// }
/// ```
#[component(transparent)]
pub fn For<IF, I, T, EF, N, KF, K>(
    cx: Scope,
    /// Items over which the component should iterate.
    each: IF,
    /// A key function that will be applied to each item.
    key: KF,
    /// The view that will be displayed for each item.
    view: EF,
) -> impl IntoView
where
    IF: Fn() -> I + 'static,
    I: IntoIterator<Item = T>,
    EF: Fn(Scope, T) -> N + 'static,
    N: IntoView,
    KF: Fn(&T) -> K + 'static,
    K: Eq + Hash + 'static,
    T: 'static,
{
    leptos_dom::Each::new(each, key, view).into_view(cx)
}