Yesod.Form

Parse forms (and query strings).

Data types

data GForm sub y xml a

A generic form, allowing you to specifying the subsite datatype, master site datatype, a datatype for the form XML and the return type.

Instances

Monoid xml => Functor (GForm sub url xml)

Monoid xml => Applicative (GForm sub url xml)

data FormResult a

A form can produce three different results: there was no data available, the data was invalid, or there was a successful parse.

The Applicative instance will concatenate the failure messages in two FormResults.

Constructors

FormMissing

FormFailure [String]

FormSuccess a

Instances

Functor FormResult

Applicative FormResult

Show a => Show (FormResult a)

Monoid m => Monoid (FormResult m)

data Enctype

The encoding type required by a form. The Show instance produces values that can be inserted directly into HTML.

Constructors

UrlEncoded

Multipart

Instances

Bounded Enctype

Enum Enctype

Eq Enctype

Monoid Enctype

ToHtml Enctype

data FormFieldSettings

Constructors

FormFieldSettings

Fields

ffsLabel :: Html

ffsTooltip :: Html

ffsId :: Maybe String

ffsName :: Maybe String

Instances

IsString FormFieldSettings

newtype Textarea

A newtype wrapper around a String that converts newlines to HTML br-tags.

Constructors

Textarea

Fields

unTextarea :: String

Instances

Eq Textarea

Read Textarea

Show Textarea

ToHtml Textarea

PersistField Textarea

ToFormField Textarea y

ToFormField (Maybe Textarea) y

Type synonyms

type Form sub y = GForm sub y (GWidget sub y ())

type Formlet sub y a = Maybe a -> Form sub y a

type FormField sub y = GForm sub y [FieldInfo sub y]

type FormletField sub y a = Maybe a -> FormField sub y a

type FormInput sub y = GForm sub y [GWidget sub y ()]

Unwrapping functions

runFormGet :: GForm sub y xml a -> GHandler sub y (FormResult a, xml, Enctype)

Run a form against GET parameters.

runFormPost :: GForm sub y xml a -> GHandler sub y (FormResult a, xml, Enctype)

Run a form against POST parameters.

runFormGet' :: GForm sub y xml a -> GHandler sub y a

Run a form against GET parameters, disregarding the resulting HTML and returning an error response on invalid input.

runFormPost' :: GForm sub y xml a -> GHandler sub y a

Run a form against POST parameters, disregarding the resulting HTML and returning an error response on invalid input.

Field/form helpers

fieldsToTable :: FormField sub y a -> Form sub y a

Display the label, tooltip, input code and errors in a single row of a table.

fieldsToPlain :: FormField sub y a -> Form sub y a

Display only the actual input widget code, without any decoration.

checkForm :: (a -> FormResult b) -> GForm s m x a -> GForm s m x b

Template Haskell

mkToForm :: [EntityDef] -> Q [Dec]

Create ToForm instances for the entities given. In addition to regular EntityDef attributes understood by persistent, it also understands label= and tooltip=.

Re-exports

module Yesod.Form.Fields

module Yesod.Form.Class