OUI.TextField

A Text Field component

type TextField msg

A Text input component

type Datatype

= Text

| Multiline

| Email

| Password Bool

| NewPassword Bool

| Username

| Search

Data type of the field

type Type

= Filled

| Outlined

Text input can be filled or outlined

new : String -> (String -> msg) -> String -> TextField msg

Create a new text input

Texfield types

multiline : Bool -> TextField msg -> TextField msg

Enable multiline input.

search : TextField msg -> TextField msg

Change the datatype to 'Search'

username : TextField msg -> TextField msg

Change the datatype to 'Username'

email : TextField msg -> TextField msg

Change the datatype to 'Email'

password : Bool -> TextField msg -> TextField msg

Change the datatype to 'Password'

If the argument is 'True', the value is showed

newPassword : Bool -> TextField msg -> TextField msg

Change the datatype to 'NewPassword'

If the argument is 'True', the value is showed

Internal

Setters

withColor : Color -> TextField msg -> TextField msg

change the input main color

withType : Type -> TextField msg -> TextField msg

change the input type

withSupportingText : String -> TextField msg -> TextField msg

add a supporting text below the input

withFocused : Bool -> TextField msg -> TextField msg

set the 'focused' current state of the input

withLeadingIcon : Icon -> TextField msg -> TextField msg

set the leading icon

withTrailingIcon : Icon -> TextField msg -> TextField msg

set the trailing icon

withClickableTrailingIcon : msg -> Icon -> TextField msg -> TextField msg

add a clickable trailing icon

withErrorIcon : Icon -> TextField msg -> TextField msg

set the error icon

onFocusBlur : msg -> msg -> TextField msg -> TextField msg

set the onFocus / onLoseFocus events

Getters

getOnChange : TextField msg -> String -> msg

Get the on change msg

getDatatype : TextField msg -> Datatype

Get the datatype

getLabel : TextField msg -> String

Get the label

getSpellcheck : TextField msg -> Bool

Get the spellcheck bool

getColor : TextField msg -> Color

Get the color

getErrorIcon : TextField msg -> Maybe Icon

Get the error icon

getHasFocus : TextField msg -> Bool

Get the has-focus bool

getLeadingIcon : TextField msg -> Maybe Icon

Get the leading icon

getOnFocus : TextField msg -> Maybe msg

Get the on focus msg

getOnLoseFocus : TextField msg -> Maybe msg

Get the on lose focus msg

getOnTrailingIconClick : TextField msg -> Maybe msg

Get the on-trailing icon click msg

getSupportingText : TextField msg -> Maybe String

Get the supporting text

getTrailingIcon : TextField msg -> Maybe Icon

Get the trailing icon

getType : TextField msg -> Type

Get the type

getValue : TextField msg -> String

Get the value

orus-io/elm-orus-ui/1.0.0

OUI.TextField

Texfield types

Internal

Setters

Getters

Modules