From 20bbf959797f4d6ebdc2e76e2b61ddba2cbfd147 Mon Sep 17 00:00:00 2001
From: ealmloff <evanalmloff@gmail.com>
Date: Tue, 14 Nov 2023 10:45:53 -0600
Subject: [PATCH] document parsed_values and FormValue

---
 packages/html/src/events/form.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/packages/html/src/events/form.rs b/packages/html/src/events/form.rs
index d48c20370..1f8127f3b 100644
--- a/packages/html/src/events/form.rs
+++ b/packages/html/src/events/form.rs
@@ -5,9 +5,10 @@ use serde::{Deserialize, Serialize};
 
 pub type FormEvent = Event<FormData>;
 
+/// A form value that may either be a list of values or a single value
 #[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 #[serde(untagged)] // this will serialize Text(String) -> String and VecText(Vec<String>) to Vec<String>
-pub enum ValueType {
+pub enum FormValue {
     Text(String),
     VecText(Vec<String>),
 }
@@ -18,7 +19,7 @@ pub enum ValueType {
 pub struct FormData {
     pub value: String,
 
-    pub values: HashMap<String, ValueType>,
+    pub values: HashMap<String, FormValue>,
 
     #[cfg_attr(
         feature = "serialize",
@@ -40,6 +41,7 @@ where
 }
 
 impl FormData {
+    /// Parse the values into a struct with one field per value
     pub fn parsed_values<T>(&self) -> Result<T, serde_json::Error>
     where
         T: serde::de::DeserializeOwned,