orus-io/elm-orus-ui/1.0.1

Formerly cdevienne/elm-orus-ui. Search finds this package by either name.

OUI.TextField

A Text Field component

type TextField msg

A Text input component

= 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.

Change the datatype to 'Username'

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

change the input main color

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

set the leading icon

set the trailing icon

add a clickable trailing icon

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

Get the datatype

getLabel : TextField msg -> String

Get the label

getSpellcheck : TextField msg -> Bool

Get the spellcheck bool

Get the color

getErrorIcon : TextField msg -> Maybe Icon

Get the error icon

getHasFocus : TextField msg -> Bool

Get the has-focus bool

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

Get the on-trailing icon click msg

getSupportingText : TextField msg -> Maybe String

Get the supporting text

Get the trailing icon

Get the type

getValue : TextField msg -> String

Get the value