Create checkboxesField' - correct version of checkboxesField

yesodweb · Aug 19, 2024 · 2e66ff9 · 2e66ff9
1 parent 7eb3c1e
commit 2e66ff9
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/yesod-form/ChangeLog.md b/yesod-form/ChangeLog.md
@@ -1,5 +1,9 @@
 # ChangeLog for yesod-form
 
+## 1.7.9
+
+* Added `checkboxesField'` for creating checkbox in more correct wat than original `checkboxesField`
+  Function `checkboxesField` marked as deprecated.
 
 ## 1.7.8
 

diff --git a/yesod-form/Yesod/Form/Fields.hs b/yesod-form/Yesod/Form/Fields.hs
@@ -52,6 +52,7 @@ module Yesod.Form.Fields
     , radioFieldList
     , withRadioField
     , checkboxesField
+    , checkboxesField'
     , checkboxesFieldList
     , multiSelectField
     , multiSelectFieldList
@@ -125,6 +126,7 @@ import Data.Monoid
 import Data.Char (isHexDigit)
 
 {-# DEPRECATED radioField "This function seems to have a bug (label could not be found with byLabel algorithm)" #-}
+{-# DEPRECATED checkboxesField "This function seems to have a bug (label could not be found with byLabel algorithm)" #-}
 
 defaultFormMessage :: FormMessage -> Text
 defaultFormMessage = englishFormMessage
@@ -533,6 +535,26 @@ checkboxesField ioptlist = (multiSelectField ioptlist)
                 |]
     }
 
+-- | Creates an input with @type="checkbox"@ for selecting multiple options.
+checkboxesField' :: Eq a
+                 => HandlerFor site (OptionList a)
+                 -> Field (HandlerFor site) [a]
+checkboxesField' ioptlist = (multiSelectField ioptlist)
+    { fieldView =
+        \theId name attrs val _isReq -> do
+            opts <- olOptions <$> handlerToWidget ioptlist
+            let optselected (Left _) _ = False
+                optselected (Right vals) opt = optionInternalValue opt `elem` vals
+            [whamlet|
+                <span ##{theId}>
+                    $forall opt <- opts
+                        <input id=#{theId}-#{optionExternalValue opt} type=checkbox name=#{name} value=#{optionExternalValue opt} *{attrs} :optselected val opt:checked>
+                        <label for=#{theId}-#{optionExternalValue opt}>
+                            #{optionDisplay opt}
+                |]
+    }
+
+
 -- | Creates an input with @type="radio"@ for selecting one option.
 radioField :: (Eq a, RenderMessage site FormMessage)
            => HandlerFor site (OptionList a)

diff --git a/yesod-form/yesod-form.cabal b/yesod-form/yesod-form.cabal
@@ -1,6 +1,6 @@
 cabal-version:   >= 1.10
 name:            yesod-form
-version:         1.7.8
+version:         1.7.9
 license:         MIT
 license-file:    LICENSE
 author:          Michael Snoyman <[email protected]>