From 5709040dcd50f527761fcf8921cdf377c1620180 Mon Sep 17 00:00:00 2001 From: Michael Snoyman Date: Mon, 1 Feb 2016 11:31:10 +0200 Subject: [PATCH] Add some docs for MassInput --- yesod-form/Yesod/Form/MassInput.hs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/yesod-form/Yesod/Form/MassInput.hs b/yesod-form/Yesod/Form/MassInput.hs index a2b434d4..24a0602d 100644 --- a/yesod-form/Yesod/Form/MassInput.hs +++ b/yesod-form/Yesod/Form/MassInput.hs @@ -3,6 +3,8 @@ {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE CPP#-} +-- | A module providing a means of creating multiple input forms, such as a +-- list of 0 or more recipients. module Yesod.Form.MassInput ( inputList , massDivs @@ -40,11 +42,19 @@ up i = do IntCons _ is' -> put is' >> newFormIdent >> return () up $ i - 1 +-- | Generate a form that accepts 0 or more values from the user, allowing the +-- user to specify that a new row is necessary. inputList :: (m ~ HandlerT site IO, xml ~ WidgetT site IO (), RenderMessage site FormMessage) => Html + -- ^ label for the form -> ([[FieldView site]] -> xml) + -- ^ how to display the rows, usually either 'massDivs' or 'massTable' -> (Maybe a -> AForm (HandlerT site IO) a) - -> (Maybe [a] -> AForm (HandlerT site IO) [a]) + -- ^ display a single row of the form, where @Maybe a@ gives the + -- previously submitted value + -> Maybe [a] + -- ^ default initial values for the form + -> AForm (HandlerT site IO) [a] inputList label fixXml single mdef = formToAForm $ do theId <- lift newIdent down 1