leptos_form_tool 0.4.1

mod grid_form;

use crate::controls::{
    button::ButtonData, checkbox::CheckboxData, heading::HeadingData, hidden::HiddenData,
    output::OutputData, radio_buttons::RadioButtonsData, select::SelectData, slider::SliderData,
    spacer::SpacerData, stepper::StepperData, submit::SubmitData, text_area::TextAreaData,
    text_input::TextInputData, ControlRenderData, ValidationState,
};
pub use grid_form::{GFStyleAttr, GridFormStyle};
use leptos::{
    prelude::{AnyView, Signal},
    reactive::wrappers::write::SignalSetter,
};

/// Defines a way to style a form.
///
/// Provides methods for rendering all the controls.
/// This provider is in charge of figuring out what html elements should be
/// rendered and how they should be styled.
pub trait FormStyle: Send + Sync + 'static {
    /// The type of styling attributes that this [`FormStyle`] takes.
    ///
    /// These styling attributes can be applied to any of the controls.
    type StylingAttributes: Send + Sync + Clone;

    /// Render any containing components for the form.
    ///
    /// This allows you to wrap all the form components
    /// in another component if neccisary.
    ///
    /// Do NOT wrap it in an actual `form` element; any
    /// wrapping should be done with `div` or similar elements.
    fn form_frame(&self, form: ControlRenderData<Self, AnyView>) -> AnyView;

    /// Wraps the view of a custom component.
    ///
    /// The rendering of the custom component is given by the `inner` view.
    /// Here the styler has a chance wrap the view with other components, or
    /// applying the styling attributes.
    ///
    /// This method does not need to be called by the custom component, but
    /// the custom component may make use of this method for the
    /// aforementioned reasons.
    fn custom_component(&self, style: &[Self::StylingAttributes], inner: AnyView) -> AnyView;

    /// Renders a group.
    ///
    /// The inner view for the group's components is provided.
    /// This method should wrap the group in any visual grouping elements,
    /// and apply the styles.
    fn group(&self, group: ControlRenderData<Self, AnyView>) -> AnyView;

    /// Renders a spacer.
    ///
    /// See [`SpacerData`].
    fn spacer(&self, control: ControlRenderData<Self, SpacerData>) -> AnyView;

    /// Renders a heading for a section of the form.
    fn heading(
        &self,
        control: ControlRenderData<Self, HeadingData>,
        value_getter: Option<Signal<String>>,
    ) -> AnyView;

    /// Renders a submit button.
    ///
    /// See [`SubmitData`].
    fn submit(
        &self,
        control: ControlRenderData<Self, SubmitData>,
        value_getter: Option<Signal<String>>,
    ) -> AnyView;

    /// Renders a button.
    ///
    /// See [`ButtonData`]
    fn button(
        &self,
        control: ControlRenderData<Self, ButtonData>,
        value_getter: Option<Signal<String>>,
    ) -> AnyView;

    /// Renders some output text.
    ///
    /// See [`OutputData`].
    fn output(
        &self,
        control: ControlRenderData<Self, OutputData>,
        value_getter: Option<Signal<String>>,
    ) -> AnyView;

    /// Renders a input control that should be hidden from the user.
    ///
    /// See [`HiddenData`].
    fn hidden(
        &self,
        control: ControlRenderData<Self, HiddenData>,
        value_getter: Option<Signal<String>>,
    ) -> AnyView;

    /// Renders a text input control.
    ///
    /// See [`TextInputData`].
    fn text_input(
        &self,
        control: ControlRenderData<Self, TextInputData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;

    /// Renders a text area control.
    ///
    /// See [`TextAreaData`].
    fn text_area(
        &self,
        control: ControlRenderData<Self, TextAreaData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;

    /// Renders a group of radio buttons.
    ///
    /// See [`RadioButtonsData`].
    fn radio_buttons(
        &self,
        control: ControlRenderData<Self, RadioButtonsData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;

    /// Renders a select (or dropdown) control.
    ///
    /// See [`SelectData`].
    fn select(
        &self,
        control: ControlRenderData<Self, SelectData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;

    /// Renders a checkbox control.
    ///
    /// See [`CheckboxData`].
    fn checkbox(
        &self,
        control: ControlRenderData<Self, CheckboxData>,
        value_getter: Signal<bool>,
        value_setter: SignalSetter<bool>,
    ) -> AnyView;

    /// Renders a stepper control.
    ///
    /// See [`StepperData`].
    fn stepper(
        &self,
        control: ControlRenderData<Self, StepperData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;

    /// Renders a slider control.
    ///
    /// See [`SliderData`].
    fn slider(
        &self,
        control: ControlRenderData<Self, SliderData>,
        value_getter: Signal<String>,
        value_setter: SignalSetter<String>,
        validation_state: Signal<ValidationState>,
    ) -> AnyView;
}