From 7845fc5a62004b1575881881d922bbbfa04758be Mon Sep 17 00:00:00 2001
From: Michal Pokrywka <wolfmoon@o2.pl>
Date: Fri, 6 Nov 2026 22:12:06 +0100
Subject: [PATCH] feat: export StringValue and the other field values from form

---
 CHANGES.md                  |  4 ++++
 src/form/data/data_field.rs | 30 ++++++++++++++++++++++++++++++
 src/form/data/mod.rs        |  5 ++++-
 3 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/CHANGES.md b/CHANGES.md
index a8c31fe..e817a73 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -10,6 +10,10 @@
   a `<select multiple>`; `none_label` for a button which clears the selection, f. ex. "All"
   of a filter; and the CSS of the container and of the buttons, selected or not
 * `MultiSelect`: every button tells whether it is selected in `aria-pressed`
+* `StringValue`, `ListValue`, `DictValue`, `MultiValue` and `BoolValue` exported from `form`, so
+  a field can be built on a `Value` shared with something else, f. ex. a preview that follows
+  what is typed. They were public but out of reach, so only `TextAreaValue`, `ImageValue` and
+  `CustomValue` could be built by hand
 
 ### Changed
 
diff --git a/src/form/data/data_field.rs b/src/form/data/data_field.rs
index ea54d47..fb3e15c 100644
--- a/src/form/data/data_field.rs
+++ b/src/form/data/data_field.rs
@@ -46,12 +46,38 @@ impl DataFieldValue {
     }
 }
 
+/// Value of a [DataFieldValue::String] field.
+///
+/// Built by hand, a field can share its `Value` with something else, f. ex. a preview that
+/// follows what is typed. [DataSection::with_string_field](super::DataSection::with_string_field)
+/// creates a `Value` of its own instead.
+///
+/// ```rust
+/// use std::rc::Rc;
+/// use vertigo::{Value, transaction};
+/// use vertigo_forms::form::{DataFieldValue, DataSection, StringValue};
+///
+/// let title = Value::new("Draft".to_string());
+/// let section = DataSection::new("Title").add_field(
+///     "title",
+///     DataFieldValue::String(StringValue {
+///         value: title.clone(),
+///         original_value: Rc::new("Draft".to_string()),
+///     }),
+/// );
+///
+/// // Typing into the field changes `title` as well
+/// let DataFieldValue::String(field) = &section.fields[0].value else { unreachable!() };
+/// field.value.set("Final".to_string());
+/// assert_eq!(transaction(|ctx| title.get(ctx)), "Final");
+/// ```
 #[derive(Clone)]
 pub struct StringValue {
     pub value: Value<String>,
     pub original_value: Rc<String>,
 }
 
+/// Value of a [DataFieldValue::TextArea] field.
 #[derive(Clone)]
 pub struct TextAreaValue {
     pub value: Value<String>,
@@ -60,6 +86,7 @@ pub struct TextAreaValue {
     pub cols: Option<i32>,
 }
 
+/// Value of a [DataFieldValue::List] field.
 #[derive(Clone)]
 pub struct ListValue {
     pub value: Value<String>,
@@ -67,6 +94,7 @@ pub struct ListValue {
     pub options: Computed<Vec<String>>,
 }
 
+/// Value of a [DataFieldValue::Dict] field.
 #[derive(Clone)]
 pub struct DictValue {
     pub value: Value<i64>,
@@ -74,6 +102,7 @@ pub struct DictValue {
     pub options: Computed<Vec<(i64, String)>>,
 }
 
+/// Value of a [DataFieldValue::Multi] field.
 #[derive(Clone)]
 pub struct MultiValue {
     pub value: Value<Vec<Value<i64>>>,
@@ -82,6 +111,7 @@ pub struct MultiValue {
     pub add_label: Rc<String>,
 }
 
+/// Value of a [DataFieldValue::Bool] field.
 #[derive(Clone)]
 pub struct BoolValue {
     pub value: Value<bool>,
diff --git a/src/form/data/mod.rs b/src/form/data/mod.rs
index 454e19c..2b262a7 100644
--- a/src/form/data/mod.rs
+++ b/src/form/data/mod.rs
@@ -4,7 +4,10 @@ use vertigo::Value;
 use crate::ValidationErrors;
 
 mod data_field;
-pub use data_field::{CustomValue, DataFieldValue, ImageValue, TextAreaValue};
+pub use data_field::{
+    BoolValue, CustomValue, DataFieldValue, DictValue, ImageValue, ListValue, MultiValue,
+    StringValue, TextAreaValue,
+};
 
 mod form_export;
 pub use form_export::{FieldExport, FormExport};