Texts

`TextBox` ¶

TextBox allows you to add a text type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.TextBox("text")

EmailField allows you to add an email type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.EmailField("email")

HiddenField allows you to add a hidden type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`initial`	`str`	An initial value.	required

ar.HiddenField("hidden", initial="foo")

PasswordField allows you to add a password type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.PasswordField("password")

SearchField allows you to add a search type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.SearchField("search")

TelephoneField allows you to add a tel type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.TelephoneField("tel")

URLField allows you to add a url type input.

Parameters:

Name	Type	Description	Default
`name`	`BlockId`	A name.	required
`help_`	`str \| None`	A help text. Defaults to None.	`None`
`initial`	`str \| None`	An initial value. Defaults to None.	`None`
`label`	`str \| None`	A label. Defaults to None.	`None`
`required`	`bool \| None`	Whether it's required or not. Defaults to None.	`None`
`validation`	`str \| None`	A formkit validation in addition to required. Defaults to None.	`None`

ar.URLField("url")