lenards/elm-ui-patternfly/4.0.1

NOTE: the latest version is 4.0.2

PF6.LoginPage

PF6 LoginPage component

A centered login form with brand text, username/password fields, optional "remember me" checkbox, and footer links. Use as a full-page layout.

See: https://www.patternfly.org/components/login-page

Definition

type LoginPage msg

Opaque LoginPage type

Constructor

Construct an empty LoginPage

Label modifiers

withTitle : String -> LoginPage msg -> LoginPage msg

Set the login form title

withSubtitle : String -> LoginPage msg -> LoginPage msg

Set an optional subtitle below the title

withBrandText : String -> LoginPage msg -> LoginPage msg

Set optional brand/product name displayed above the card

withUsernameLabel : String -> LoginPage msg -> LoginPage msg

Set the username field label

withPasswordLabel : String -> LoginPage msg -> LoginPage msg

Set the password field label

withRememberMeLabel : String -> LoginPage msg -> LoginPage msg

Set the remember-me checkbox label

withSubmitLabel : String -> LoginPage msg -> LoginPage msg

Set the submit button label

Value modifiers

withUsername : String -> LoginPage msg -> LoginPage msg

Set the current username value

withPassword : String -> LoginPage msg -> LoginPage msg

Set the current password value

withShowPassword : Bool -> LoginPage msg -> LoginPage msg

Show the password in plain text (True) or masked (False)

withRememberMe : Bool -> LoginPage msg -> LoginPage msg

Set the remember-me checkbox state

Event modifiers

withOnUsernameChange : (String -> msg) -> LoginPage msg -> LoginPage msg

Set the message sent when the username field changes

withOnPasswordChange : (String -> msg) -> LoginPage msg -> LoginPage msg

Set the message sent when the password field changes

Set the message sent when "show password" is toggled

withOnRememberMeToggle : (Bool -> msg) -> LoginPage msg -> LoginPage msg

Set the message sent when the remember-me checkbox is toggled

withOnSubmit : msg -> LoginPage msg -> LoginPage msg

Set the message sent when the submit button is clicked

Content modifiers

withHelperText : String -> LoginPage msg -> LoginPage msg

Set helper/error text displayed above the submit button

Rendering

toMarkup : Theme -> LoginPage msg -> Element msg

Render the LoginPage as an Element msg