Safe Haskell | None |
---|---|
Language | Haskell98 |
Field functions allow you to easily create and validate forms, cleanly handling the uncertainty of parsing user input.
When possible, the field functions use a specific input type (e.g. "number"), allowing supporting browsers to validate the input before form submission. Browsers can also improve usability with this information; for example, mobile browsers might present a specialized keyboard for an input of type "email" or "number".
See the Yesod book chapter on forms for a broader overview of forms in Yesod.
- data FormMessage
- = MsgInvalidInteger Text
- | MsgInvalidNumber Text
- | MsgInvalidEntry Text
- | MsgInvalidUrl Text
- | MsgInvalidEmail Text
- | MsgInvalidTimeFormat
- | MsgInvalidHour Text
- | MsgInvalidMinute Text
- | MsgInvalidSecond Text
- | MsgInvalidDay
- | MsgCsrfWarning
- | MsgValueRequired
- | MsgInputNotFound Text
- | MsgSelectNone
- | MsgInvalidBool Text
- | MsgBoolYes
- | MsgBoolNo
- | MsgDelete
- defaultFormMessage :: FormMessage -> Text
- textField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text
- passwordField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text
- textareaField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Textarea
- hiddenField :: (Monad m, PathPiece p, RenderMessage (HandlerSite m) FormMessage) => Field m p
- intField :: (Monad m, Integral i, RenderMessage (HandlerSite m) FormMessage) => Field m i
- dayField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Day
- timeField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay
- timeFieldTypeTime :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay
- timeFieldTypeText :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay
- htmlField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Html
- emailField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text
- multiEmailField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m [Text]
- searchField :: Monad m => RenderMessage (HandlerSite m) FormMessage => AutoFocus -> Field m Text
- type AutoFocus = Bool
- urlField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text
- doubleField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Double
- parseDate :: String -> Either FormMessage Day
- parseTime :: Text -> Either FormMessage TimeOfDay
- newtype Textarea = Textarea {
- unTextarea :: Text
- boolField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Bool
- checkBoxField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Bool
- fileField :: (Monad m, RenderMessage (HandlerSite m) FormMessage) => Field m FileInfo
- fileAFormReq :: (MonadHandler m, RenderMessage (HandlerSite m) FormMessage) => FieldSettings (HandlerSite m) -> AForm m FileInfo
- fileAFormOpt :: MonadHandler m => RenderMessage (HandlerSite m) FormMessage => FieldSettings (HandlerSite m) -> AForm m (Maybe FileInfo)
- selectField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) a
- selectFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) a
- radioField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) a
- radioFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) a
- checkboxesFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) [a]
- checkboxesField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) [a]
- multiSelectField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) [a]
- multiSelectFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) [a]
- data Option a = Option {}
- data OptionList a = OptionList {
- olOptions :: [Option a]
- olReadExternal :: Text -> Maybe a
- mkOptionList :: [Option a] -> OptionList a
- optionsPersist :: (YesodPersist site, PersistEntity a, PersistQuery (PersistEntityBackend a), PathPiece (Key a), RenderMessage site msg, YesodPersistBackend site ~ PersistEntityBackend a) => [Filter a] -> [SelectOpt a] -> (a -> msg) -> HandlerT site IO (OptionList (Entity a))
- optionsPersistKey :: (YesodPersist site, PersistEntity a, PersistQuery (PersistEntityBackend a), PathPiece (Key a), RenderMessage site msg, YesodPersistBackend site ~ PersistEntityBackend a) => [Filter a] -> [SelectOpt a] -> (a -> msg) -> HandlerT site IO (OptionList (Key a))
- optionsPairs :: (MonadHandler m, RenderMessage (HandlerSite m) msg) => [(msg, a)] -> m (OptionList a)
- optionsEnum :: (MonadHandler m, Show a, Enum a, Bounded a) => m (OptionList a)
i18n
data FormMessage Source
Fields
textField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text Source
Creates a input with type="text"
.
passwordField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text Source
Creates an input with type="password"
.
textareaField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Textarea Source
hiddenField :: (Monad m, PathPiece p, RenderMessage (HandlerSite m) FormMessage) => Field m p Source
Creates an input with type="hidden"
; you can use this to store information in a form that users shouldn't see (for example, Yesod stores CSRF tokens in a hidden field).
intField :: (Monad m, Integral i, RenderMessage (HandlerSite m) FormMessage) => Field m i Source
Creates a input with type="number"
and step=1
.
dayField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Day Source
Creates an input with type="date"
, validating the input using the parseDate
function.
Add the time
package and import the Data.Time.Calendar module to use this function.
timeField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay Source
Deprecated: timeField
currently defaults to an input of type="text". In the next major release, it will default to type="time". To opt in to the new functionality, use timeFieldTypeTime
. To keep the existing behavior, use timeFieldTypeText
. See 'https://github.com/yesodweb/yesod/pull/874' for details.
An alias for timeFieldTypeText
.
timeFieldTypeTime :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay Source
Creates an input with type="time"
. Browsers not supporting this type will fallback to a text field, and Yesod will parse the time as described in timeFieldTypeText
.
Add the time
package and import the Data.Time.LocalTime module to use this function.
Since 1.4.2
timeFieldTypeText :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m TimeOfDay Source
Creates an input with type="text"
, parsing the time from an [H]H:MM[:SS] format, with an optional AM or PM (if not given, AM is assumed for compatibility with the 24 hour clock system).
Add the time
package and import the Data.Time.LocalTime module to use this function.
Since 1.4.2
htmlField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Html Source
Creates a <textarea>
tag whose input is sanitized to prevent XSS attacks and is validated for having balanced tags.
emailField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text Source
Creates an input with type="email"
. Yesod will validate the email's correctness according to RFC5322 and canonicalize it by removing comments and whitespace (see Text.Email.Validate).
multiEmailField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m [Text] Source
Creates an input with type="email"
with the multiple attribute; browsers might implement this as taking a comma separated list of emails. Each email address is validated as described in emailField
.
Since 1.3.7
searchField :: Monad m => RenderMessage (HandlerSite m) FormMessage => AutoFocus -> Field m Text Source
Creates an input with type="search"
. For browsers without autofocus support, a JS fallback is used if AutoFocus
is true.
urlField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Text Source
Creates an input with type="url"
, validating the URL according to RFC3986.
doubleField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Double Source
Creates a input with type="number"
and step=any
.
A newtype wrapper around a Text
whose ToMarkup
instance converts newlines to HTML <br>
tags.
(When text is entered into a <textarea>
, newline characters are used to separate lines.
If this text is then placed verbatim into HTML, the lines won't be separated, thus the need for replacing with <br>
tags).
If you don't need this functionality, simply use unTextarea
to access the raw text.
boolField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Bool Source
Creates a group of radio buttons to answer the question given in the message. Radio buttons are used to allow differentiating between an empty response (Nothing
) and a no response (Just False
). Consider using the simpler checkBoxField
if you don't need to make this distinction.
If this field is optional, the first radio button is labeled "<None>", the second "Yes" and the third "No".
If this field is required, the first radio button is labeled "Yes" and the second "No".
(Exact label titles will depend on localization).
checkBoxField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Bool Source
Creates an input with type="checkbox"
.
While the default
implements a radio button so you
can differentiate between an empty response (boolField
Nothing
) and a no
response (Just False
), this simpler checkbox field returns an empty
response as Just False
.
Note that this makes the field always optional.
fileField :: (Monad m, RenderMessage (HandlerSite m) FormMessage) => Field m FileInfo Source
Creates an input with type="file"
.
File AForm
s
fileAFormReq :: (MonadHandler m, RenderMessage (HandlerSite m) FormMessage) => FieldSettings (HandlerSite m) -> AForm m FileInfo Source
fileAFormOpt :: MonadHandler m => RenderMessage (HandlerSite m) FormMessage => FieldSettings (HandlerSite m) -> AForm m (Maybe FileInfo) Source
Options
selectField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) a Source
selectFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) a Source
radioField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) a Source
radioFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) a Source
checkboxesFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) [a] Source
checkboxesField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) [a] Source
multiSelectField :: (Eq a, RenderMessage site FormMessage) => HandlerT site IO (OptionList a) -> Field (HandlerT site IO) [a] Source
multiSelectFieldList :: (Eq a, RenderMessage site FormMessage, RenderMessage site msg) => [(msg, a)] -> Field (HandlerT site IO) [a] Source
data OptionList a Source
OptionList | |
|
mkOptionList :: [Option a] -> OptionList a Source
optionsPersist :: (YesodPersist site, PersistEntity a, PersistQuery (PersistEntityBackend a), PathPiece (Key a), RenderMessage site msg, YesodPersistBackend site ~ PersistEntityBackend a) => [Filter a] -> [SelectOpt a] -> (a -> msg) -> HandlerT site IO (OptionList (Entity a)) Source
optionsPersistKey :: (YesodPersist site, PersistEntity a, PersistQuery (PersistEntityBackend a), PathPiece (Key a), RenderMessage site msg, YesodPersistBackend site ~ PersistEntityBackend a) => [Filter a] -> [SelectOpt a] -> (a -> msg) -> HandlerT site IO (OptionList (Key a)) Source
An alternative to optionsPersist
which returns just the Key
instead of
the entire Entity
.
Since 1.3.2
optionsPairs :: (MonadHandler m, RenderMessage (HandlerSite m) msg) => [(msg, a)] -> m (OptionList a) Source
optionsEnum :: (MonadHandler m, Show a, Enum a, Bounded a) => m (OptionList a) Source