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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use super::{
    BuilderCxFn, BuilderFn, ControlBuilder, ControlData, ControlRenderData, UpdateEvent,
    ValidatedControlData, ValidationState,
};
use crate::{form::FormToolData, form_builder::FormBuilder, styles::FormStyle};
use leptos::{
    prelude::{AnyView, RwSignal, Signal},
    reactive::wrappers::write::SignalSetter,
};

/// Data used for the text input control.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TextInputData {
    pub name: String,
    pub label: Option<String>,
    pub placeholder: Option<String>,
    pub input_type: &'static str,
    pub update_event: UpdateEvent,
}

impl Default for TextInputData {
    fn default() -> Self {
        TextInputData {
            name: String::new(),
            placeholder: None,
            label: None,
            input_type: "input",
            update_event: UpdateEvent::default(),
        }
    }
}

impl<FD: FormToolData> ControlData<FD> for TextInputData {
    type ReturnType = String;

    fn render_control<FS: FormStyle>(
        fs: &FS,
        _fd: RwSignal<FD>,
        control: ControlRenderData<FS, Self>,
        value_getter: Signal<Self::ReturnType>,
        value_setter: SignalSetter<Self::ReturnType>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView {
        fs.text_input(control, value_getter, value_setter, validation_state)
    }
}
impl<FD: FormToolData> ValidatedControlData<FD> for TextInputData {}

impl<FD: FormToolData> FormBuilder<FD> {
    /// Builds a text input control and adds it to the form.
    pub fn text_input<FDT: Clone + PartialEq + 'static>(
        self,
        builder: impl BuilderFn<ControlBuilder<FD, TextInputData, FDT>>,
    ) -> Self {
        self.new_control(builder)
    }

    /// Builds a text input control using the form's context and adds it to
    /// the form.
    pub fn text_input_cx<FDT: Clone + PartialEq + 'static>(
        self,
        builder: impl BuilderCxFn<ControlBuilder<FD, TextInputData, FDT>, FD::Context>,
    ) -> Self {
        self.new_control_cx(builder)
    }
}

impl<FD: FormToolData, FDT> ControlBuilder<FD, TextInputData, FDT> {
    /// Sets the name of the text input.
    ///
    /// This is used for the html element's "name" attribute.
    /// In forms, the name attribute is the key that the data is sent
    /// with.
    pub fn named(mut self, control_name: impl ToString) -> Self {
        self.data.name = control_name.to_string();
        self
    }

    /// Sets the label for the text input.
    pub fn labeled(mut self, label: impl ToString) -> Self {
        self.data.label = Some(label.to_string());
        self
    }

    /// Sets the placeholder for the text input.
    pub fn placeholder(mut self, placeholder: impl ToString) -> Self {
        self.data.placeholder = Some(placeholder.to_string());
        self
    }

    /// Sets the text input to be the "password" type.
    pub fn password(mut self) -> Self {
        self.data.input_type = "password";
        self
    }

    /// Sets the text input to be the "date" type.
    pub fn date(mut self) -> Self {
        self.data.input_type = "date";
        self
    }

    /// Sets the text input to be the specified type.
    pub fn input_type(mut self, input_type: &'static str) -> Self {
        self.data.input_type = input_type;
        self
    }

    /// Sets the event that is used to update the form data.
    pub fn update_on(mut self, event: UpdateEvent) -> Self {
        self.data.update_event = event;
        self
    }
}