leptos_form_tool 0.4.1

A declarative way to create forms for leptos.
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

use super::{
    BuilderCxFn, BuilderFn, ControlBuilder, ControlData, VanityControlBuilder, VanityControlData,
};
use crate::{FormBuilder, FormToolData};
use leptos::prelude::{AnyView, RwSignal};
use std::sync::Arc;

impl<FD: FormToolData> FormBuilder<FD> {
    /// Builds a custom component and adds it to the form.
    pub fn custom<CC: ControlData<FD>, FDT: Clone + PartialEq + 'static>(
        mut self,
        control_data: CC,
        builder: impl BuilderFn<ControlBuilder<FD, CC, FDT>>,
    ) -> Self {
        let control_builder = ControlBuilder::new(control_data);
        let control = builder(control_builder);
        self.add_control(control);
        self
    }

    /// Builds a custom component using the form's context and adds it to the
    /// form.
    pub fn custom_cx<CC: ControlData<FD>, FDT: Clone + PartialEq + 'static>(
        mut self,
        control_data: CC,
        builder: impl BuilderCxFn<ControlBuilder<FD, CC, FDT>, FD::Context>,
    ) -> Self {
        let control_builder = ControlBuilder::new(control_data);
        let control = builder(control_builder, self.cx.clone());
        self.add_control(control);
        self
    }

    /// Builds a custom vanity component and adds it to the form.
    pub fn custom_vanity<CC: VanityControlData<FD>>(
        mut self,
        control_data: CC,
        builder: impl BuilderFn<VanityControlBuilder<FD, CC>>,
    ) -> Self {
        let control_builder = VanityControlBuilder::new(control_data);
        let control = builder(control_builder);
        self.add_vanity(control);
        self
    }

    /// Builds a custom vanity component using the form's context and adds it
    /// to the form.
    pub fn custom_vanity_cx<CC: VanityControlData<FD>>(
        mut self,
        control_data: CC,
        builder: impl BuilderCxFn<VanityControlBuilder<FD, CC>, FD::Context>,
    ) -> Self {
        let control_builder = VanityControlBuilder::new(control_data);
        let control = builder(control_builder, self.cx.clone());
        self.add_vanity(control);
        self
    }

    /// Add a raw view to the form.
    ///
    /// This gives you access to everything you might need when rendering a
    /// read-only view.
    ///
    /// This can be helpful for rendering a custom visual component, but is
    /// often times not needed.
    ///
    /// This method does not give you any access to the validation system
    /// so you should not add controls to the form with this method.
    /// consider defining a custom component for this purpose.
    pub fn raw_view(
        mut self,
        render_fn: impl Fn(Arc<FD::Style>, RwSignal<FD>, Arc<FD::Context>) -> AnyView + 'static,
    ) -> Self {
        let cx = self.cx.clone();
        let render_fn = move |fs: Arc<FD::Style>, fd: RwSignal<FD>| {
            let view = render_fn(fs, fd, cx);
            (view, None)
        };

        self.render_fns.push(Box::new(render_fn));
        self
    }
}