EngageSoftware/elm-engage-common/8.1.0

NOTE: the latest version is 8.2.10

Engage.UI.Input

UI.Input

Text

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, requiredText : Maybe String
}
-> State
-> String
-> Html msg

Get a text view

{ namespace : Namespace
, id : String
, helpText : String
, labelText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, requiredText : Maybe String
}
-> State
-> String
-> Html msg

Get a text area view

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, requiredText : Maybe String
}
-> List (Attribute msg)
-> State
-> String
-> Html msg

Get a text with attributes view

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, size : Size
, requiredText : Maybe String
}
-> State
-> String
-> Html msg

Get a text with size view

Password

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, requiredText : Maybe String
, strengthMeter : Maybe (List String)
, hasFocus : Maybe (Bool -> msg)
}
-> State
-> String
-> Html msg

Get a password input

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, requiredText : Maybe String
, strengthMeter : Maybe (List String)
, hasFocus : Maybe (Bool -> msg)
}
-> List (Attribute msg)
-> State
-> String
-> Html msg

Get a password with attributes input

Numbers

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> Maybe Int -> msg
, status : Status
, maxValue : Maybe Int
, minValue : Maybe Int
, requiredText : Maybe String
}
-> State
-> Maybe Int
-> Html msg

Get a number input

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> Maybe Int -> msg
, status : Status
, maxValue : Maybe Int
, minValue : Maybe Int
, requiredText : Maybe String
}
-> State
-> Maybe Int
-> Html msg

Get a small number view

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : State -> String -> msg
, maxLength : Maybe Int
, status : Status
, requiredText : Maybe String
}
-> State
-> String
-> Html msg

Get a big number view

Checkboxes

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> Set String -> msg
, status : Status
, items :
List
{ id : String
, content : Html msg
}
, requiredText : Maybe String
}
-> State
-> Set String
-> Html msg

Get a checkbox list view

{ namespace : Namespace
, labelText : String
, helpText : String
, onCheck : { onlyStateChange : Bool } -> State -> Bool -> msg
, status : Status
, state : State
, requiredText : Maybe String
}
-> Bool
-> Html msg

Get a checkbox view

{ namespace : Namespace
, labelText : String
, helpText : String
, onCheck : { onlyStateChange : Bool } -> State -> Bool -> msg
, status : Status
, state : State
, requiredText : Maybe String
}
-> List (Attribute msg)
-> Bool
-> Html msg

Get a checkbox with attributes view

File

{ namespace : Namespace
, id : String
, labelText : String
, browseText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> FileInfo -> msg
, status : Status
, requiredText : Maybe String
}
-> State
-> FileInfo
-> Html msg

Get a file view

type alias FileInfo =
{ name : String
, fileType : String
, progressPercentage : Maybe Float
}

The FileInfo type

Phone

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange :
{ onlyStateChange : Bool }
-> PhoneState
-> PhoneNumber
-> Cmd msg
-> msg
, status : Status
, requiredText : Maybe String
}
-> PhoneState
-> PhoneNumber
-> Html msg

Get the phone view

type alias PhoneState =
{ message : State
, phoneInput : State
}

A PhoneState type

initialPhoneState : PhoneState

Get the initial PhoneState

Misc

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : { onlyStateChange : Bool } -> State -> String -> msg
, status : Status
, items :
List
{ id : String
, content : Html msg
}
, requiredText : Maybe String
}
-> State
-> String
-> Html msg

Get a radio list view

Reset the State

{ namespace : Namespace
, id : String
, labelText : String
, helpText : String
, onChange : State -> Maybe Date -> msg
, onFocusChange : Maybe (Bool -> msg)
, status : Status
, requiredText : Maybe String
}
-> State
-> Maybe Date
-> Html msg

Get the date input view

State

type State

A State type

Get the initial State