Login page

A login page allows a user to gain access to an application by entering their username and password or by authenticating using a social media login.

Examples

Basic

Show/hide password

Customizing the header utilities

headerUtilities is a prop that can be customized to allow components to be placed into the header of the login page, likely for the user to take an action. The following example demonstrates the use of a Select component to display a list a languages.

With header utilities

Props

LoginPage

*required
Name	Type	Default	Description
loginTitlerequired	string		Title for the login main body header of the login page
backgroundImgSrc	string	''	Attribute that specifies the URL of the background image for the login page
brandImgAlt	string	''	Attribute that specifies the alt text of the brand image for the login page
brandImgSrc	string	''	Attribute that specifies the URL of the brand image for the login page
children	React.ReactNode	null	Anything that can be rendered inside of the login page (e.g. <LoginPageForm>)
className	string	''	Additional classes added to the login page
footerListItems	React.ReactNode	null	Items rendered inside of the footer list component of the login page
footerListVariants	ListVariant.inline		Adds list variant styles for the footer list component of the login page. The only current value is'inline'
forgotCredentials	React.ReactNode	null	Content rendered inside of login main footer band to display a forgot credentials link.
headerUtilities	React.ReactNode		Header utilities for the login main body header of the login page
loginSubtitle	string		Subtitle for the login main body header of the login page
signUpForAccountMessage	React.ReactNode	null	Content rendered inside of login main footer band to display a sign up for account message
socialMediaLoginAriaLabel	string		Adds an accessible name to the social media login list.
socialMediaLoginContent	React.ReactNode	null	Content rendered inside of social media login footer section
textContent	string	''	Content rendered inside of the text component of the login page

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the main section of the login layout
className	string	''	Additional classes added to the login layout
footer	React.ReactNode	null	Footer component (e.g. <LoginFooter />)
header	React.ReactNode	null	Header component (e.g. <LoginHeader />)

LoginForm

*required
Name	Type	Default	Description
className	string	''	Additional classes added to the login main body's form
helperText	React.ReactNode	null	Content displayed in the helper text component *
helperTextIcon	React.ReactNode	null	Icon displayed to the left in the helper text
hidePasswordAriaLabel	string	'Hide password'	Accessible label for the hide password button
isLoginButtonDisabled	boolean	false	Flag indicating if the login button is disabled
isRememberMeChecked	boolean	false	Flag indicating if the remember me checkbox is checked.
isShowPasswordEnabled	boolean	false	Flag indicating if the user can toggle hiding the password
isValidPassword	boolean	true	Flag indicating if the password is valid
isValidUsername	boolean	true	Flag indicating if the username is valid
loginButtonLabel	string	'Log In'	Label for the log in button input
noAutoFocus	boolean	false	Flag to indicate if the first dropdown item should not gain initial focus
onChangePassword	(event: React.FormEvent<HTMLInputElement>, value: string) => void	() => undefined as any	Function that handles the onChange event for the password
onChangeRememberMe	(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void	() => undefined as any	Function that handles the onChange event for the remember me checkbox
onChangeUsername	(event: React.FormEvent<HTMLInputElement>, value: string) => void	() => undefined as any	Function that handles the onChange event for the username
onLoginButtonClick	(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void	() => undefined as any	Function that is called when the login button is clicked
passwordLabel	string	'Password'	Label for the password input field
passwordValue	string	''	Value for the password
rememberMeLabel	string	''	Label for the remember me checkbox that indicates the user should be kept logged in. If the label is not provided, the checkbox will not show.
showHelperText	boolean	false	Flag indicating the helper text is visible *
showPasswordAriaLabel	string	'Show password'	Accessible label for the show password button
usernameLabel	string	'Username'	Label for the username input field
usernameValue	string	''	Value for the username

LoginMainBody

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the login main body
className	string	''	Additional classes added to the login main body

LoginMainHeader

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the login main header
className	string	''	Additional classes added to the login main header
headerUtilities	React.ReactNode	null	Actions that render for the login main header
subtitle	string	''	Subtitle that contains the text, URL, and URL text for the login main header
title	string	''	Title for the login main header

LoginHeader

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the header of the login layout
className	string	''	Additional classes added to the login header
headerBrand	React.ReactNode	null	Header brand component (e.g. <LoginHeader />)

LoginFooter

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the footer of the login layout
className	string	''	Additional props are spread to the container <footer>

LoginMainFooter

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the login main footer
className	string	''	Additional classes added to the login main footer
forgotCredentials	React.ReactNode	null	Content rendered inside of login main footer band do display a forgot credentials link*
signUpForAccountMessage	React.ReactNode	null	Content rendered inside of login main footer band to display a sign up for account message
socialMediaLoginAriaLabel	string		Adds an accessible name to the social media login list.
socialMediaLoginContent	React.ReactNode	null	Content rendered inside the login main footer as social media links

LoginFooterItem

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the footer link item
className	string		Additional classes added to the footer link item
href	string	'#'	The URL of the footer link item
target	string	'_blank'	Specifies where to open the linked document

LoginMainFooterBandItem

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the footer link item
className	string	''	Additional classes added to the footer link item

LoginMainFooterLinksItem

*required
Name	Type	Default	Description
children	React.ReactNode	null	Content rendered inside the footer link item
className	string	''	Additional classes added to the footer link item
href	string	''	HREF for footer link item
linkComponent	React.ReactNode	'a'	Component used to render the footer link item
linkComponentProps	any		Props for the LinkComponent
target	string		Target for footer link item

CSS variables

Expand or collapse column	Selector	Variable	Value
	.pf-v5-c-login__footer	--pf-v5-global--Color--100	#fff
--pf-v5-global--Color--100 --pf-v5-global--Color--light-100 $pf-v5-global--Color--light-100 $pf-v5-color-white #fff
	.pf-v5-c-login__footer	--pf-v5-global--Color--200	#f0f0f0
--pf-v5-global--Color--200 --pf-v5-global--Color--light-200 $pf-v5-global--Color--light-200 $pf-v5-color-black-200 #f0f0f0
	.pf-v5-c-login__footer	--pf-v5-global--BorderColor--100	#b8bbbe
--pf-v5-global--BorderColor--100 --pf-v5-global--BorderColor--light-100 $pf-v5-global--BorderColor--light-100 $pf-v5-color-black-400 #b8bbbe
	.pf-v5-c-login__footer	--pf-v5-global--primary-color--100	#73bcf7
--pf-v5-global--primary-color--100 --pf-v5-global--primary-color--light-100 $pf-v5-global--primary-color--light-100 $pf-v5-color-blue-200 #73bcf7
	.pf-v5-c-login__footer	--pf-v5-global--link--Color	#2b9af3
--pf-v5-global--link--Color --pf-v5-global--link--Color--light $pf-v5-global--link--Color--light $pf-v5-global--active-color--300 $pf-v5-color-blue-300 #2b9af3
	.pf-v5-c-login__footer	--pf-v5-global--link--Color--hover	#2b9af3
--pf-v5-global--link--Color--hover --pf-v5-global--link--Color--light $pf-v5-global--link--Color--light $pf-v5-global--active-color--300 $pf-v5-color-blue-300 #2b9af3
	.pf-v5-c-login__footer	--pf-v5-global--BackgroundColor--100	#151515
--pf-v5-global--BackgroundColor--100 --pf-v5-global--BackgroundColor--dark-100 $pf-v5-global--BackgroundColor--dark-100 $pf-v5-color-black-900 #151515
	.pf-v5-c-login__footer	--pf-v5-global--icon--Color--light	#f0f0f0
--pf-v5-global--icon--Color--light --pf-v5-global--icon--Color--light--light $pf-v5-global--icon--Color--light--light $pf-v5-color-black-200 #f0f0f0
	.pf-v5-c-login__footer	--pf-v5-global--icon--Color--dark	#fff
--pf-v5-global--icon--Color--dark --pf-v5-global--icon--Color--dark--light $pf-v5-global--icon--Color--dark--light $pf-v5-color-white #fff
	.pf-v5-c-login__footer .pf-v5-c-button	--pf-v5-c-button--m-primary--BackgroundColor	#06c
--pf-v5-c-button--m-primary--BackgroundColor --pf-v5-global--primary-color--dark-100 $pf-v5-global--primary-color--dark-100 $pf-v5-color-blue-400 #06c
	.pf-v5-c-login	--pf-v5-c-login--PaddingTop	1.5rem
--pf-v5-c-login--PaddingTop --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login--PaddingBottom	1.5rem
--pf-v5-c-login--PaddingBottom --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__container--xl--GridColumnGap	4rem
--pf-v5-c-login__container--xl--GridColumnGap --pf-v5-global--spacer--3xl $pf-v5-global--spacer--3xl pf-size-prem(64px) 4rem
	.pf-v5-c-login	--pf-v5-c-login__container--MaxWidth	31.25rem
	.pf-v5-c-login	--pf-v5-c-login__container--xl--MaxWidth	none
	.pf-v5-c-login	--pf-v5-c-login__container--PaddingLeft	6.125rem
	.pf-v5-c-login	--pf-v5-c-login__container--PaddingRight	6.125rem
	.pf-v5-c-login	--pf-v5-c-login__container--xl--GridTemplateColumns	34rem minmax(auto, 34rem)
	.pf-v5-c-login	--pf-v5-c-login__header--MarginBottom	1rem
--pf-v5-c-login__header--MarginBottom --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__header--PaddingLeft	1rem
--pf-v5-c-login__header--PaddingLeft --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__header--PaddingRight	1rem
--pf-v5-c-login__header--PaddingRight --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__header--xl--MarginBottom	3rem
--pf-v5-c-login__header--xl--MarginBottom --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__header--xl--MarginTop	4rem
--pf-v5-c-login__header--xl--MarginTop --pf-v5-global--spacer--3xl $pf-v5-global--spacer--3xl pf-size-prem(64px) 4rem
	.pf-v5-c-login	--pf-v5-c-login__header--c-brand--MarginBottom	1.5rem
--pf-v5-c-login__header--c-brand--MarginBottom --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__header--c-brand--xl--MarginBottom	3rem
--pf-v5-c-login__header--c-brand--xl--MarginBottom --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main--BackgroundColor	#fff
--pf-v5-c-login__main--BackgroundColor --pf-v5-global--BackgroundColor--light-100 $pf-v5-global--BackgroundColor--light-100 $pf-v5-color-white #fff
	.pf-v5-c-login	--pf-v5-c-login__main--MarginBottom	1.5rem
--pf-v5-c-login__main--MarginBottom --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__main--BoxShadow	0 1rem 2rem 0 rgba(3, 3, 3, 0.16), 0 0 0.5rem 0 rgba(3, 3, 3, 0.1)
--pf-v5-c-login__main--BoxShadow --pf-v5-global--BoxShadow--xl $pf-v5-global--BoxShadow--xl 0 pf-size-prem(16px) pf-size-prem(32px) 0 rgba($pf-v5-color-black-1000, .16), 0 0 pf-size-prem(8px) 0 rgba($pf-v5-color-black-1000, .1) 0 pf-size-prem(16px) pf-size-prem(32px) 0 rgba(#030303, .16), 0 0 pf-size-prem(8px) 0 rgba(#030303, .1) 0 1rem 2rem 0 rgba(3, 3, 3, 0.16), 0 0 0.5rem 0 rgba(3, 3, 3, 0.1)
	.pf-v5-c-login	--pf-v5-c-login__main-header--PaddingTop	3rem
--pf-v5-c-login__main-header--PaddingTop --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--PaddingRight	2rem
--pf-v5-c-login__main-header--PaddingRight --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--PaddingBottom	1rem
--pf-v5-c-login__main-header--PaddingBottom --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--PaddingLeft	2rem
--pf-v5-c-login__main-header--PaddingLeft --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--md--PaddingRight	3rem
--pf-v5-c-login__main-header--md--PaddingRight --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--md--PaddingLeft	3rem
--pf-v5-c-login__main-header--md--PaddingLeft --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--ColumnGap	1rem
--pf-v5-c-login__main-header--ColumnGap --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-header--RowGap	1rem
--pf-v5-c-login__main-header--RowGap --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-header-desc--MarginBottom	0.5rem
--pf-v5-c-login__main-header-desc--MarginBottom --pf-v5-global--spacer--sm $pf-v5-global--spacer--sm pf-size-prem(8px) 0.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-header-desc--md--MarginBottom	0
	.pf-v5-c-login	--pf-v5-c-login__main-header-desc--FontSize	0.875rem
--pf-v5-c-login__main-header-desc--FontSize --pf-v5-global--FontSize--sm $pf-v5-global--FontSize--sm pf-font-prem(14px) 0.875rem
	.pf-v5-c-login	--pf-v5-c-login__main-body--PaddingRight	2rem
--pf-v5-c-login__main-body--PaddingRight --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-body--PaddingBottom	2rem
--pf-v5-c-login__main-body--PaddingBottom --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-body--PaddingLeft	2rem
--pf-v5-c-login__main-body--PaddingLeft --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-body--md--PaddingRight	3rem
--pf-v5-c-login__main-body--md--PaddingRight --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main-body--md--PaddingLeft	3rem
--pf-v5-c-login__main-body--md--PaddingLeft --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer--PaddingBottom	4rem
--pf-v5-c-login__main-footer--PaddingBottom --pf-v5-global--spacer--3xl $pf-v5-global--spacer--3xl pf-size-prem(64px) 4rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer--c-title--MarginBottom	1rem
--pf-v5-c-login__main-footer--c-title--MarginBottom --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links--PaddingTop	0.5rem
--pf-v5-c-login__main-footer-links--PaddingTop --pf-v5-global--spacer--sm $pf-v5-global--spacer--sm pf-size-prem(8px) 0.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links--PaddingRight	4rem
--pf-v5-c-login__main-footer-links--PaddingRight --pf-v5-global--spacer--3xl $pf-v5-global--spacer--3xl pf-size-prem(64px) 4rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links--PaddingBottom	2rem
--pf-v5-c-login__main-footer-links--PaddingBottom --pf-v5-global--spacer--xl $pf-v5-global--spacer--xl pf-size-prem(32px) 2rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links--PaddingLeft	4rem
--pf-v5-c-login__main-footer-links--PaddingLeft --pf-v5-global--spacer--3xl $pf-v5-global--spacer--3xl pf-size-prem(64px) 4rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item--PaddingRight	1rem
--pf-v5-c-login__main-footer-links-item--PaddingRight --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item--PaddingLeft	1rem
--pf-v5-c-login__main-footer-links-item--PaddingLeft --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item--MarginBottom	0.5rem
--pf-v5-c-login__main-footer-links-item--MarginBottom --pf-v5-global--spacer--sm $pf-v5-global--spacer--sm pf-size-prem(8px) 0.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item-link-svg--Fill	#6a6e73
--pf-v5-c-login__main-footer-links-item-link-svg--Fill --pf-v5-global--icon--Color--light $pf-v5-global--icon--Color--light $pf-v5-color-black-600 #6a6e73
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item-link-svg--Width	1.5rem
--pf-v5-c-login__main-footer-links-item-link-svg--Width --pf-v5-global--icon--FontSize--lg $pf-v5-global--icon--FontSize--lg pf-font-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item-link-svg--Height	1.5rem
--pf-v5-c-login__main-footer-links-item-link-svg--Height --pf-v5-global--icon--FontSize--lg $pf-v5-global--icon--FontSize--lg pf-font-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-links-item-link-svg--hover--Fill	#151515
--pf-v5-c-login__main-footer-links-item-link-svg--hover--Fill --pf-v5-global--icon--Color--dark $pf-v5-global--icon--Color--dark $pf-v5-color-black-900 #151515
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--PaddingTop	1.5rem
--pf-v5-c-login__main-footer-band--PaddingTop --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--PaddingRight	1rem
--pf-v5-c-login__main-footer-band--PaddingRight --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--PaddingBottom	1.5rem
--pf-v5-c-login__main-footer-band--PaddingBottom --pf-v5-global--spacer--lg $pf-v5-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--PaddingLeft	1rem
--pf-v5-c-login__main-footer-band--PaddingLeft --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--BorderTopColor	#d2d2d2
--pf-v5-c-login__main-footer-band--BorderTopColor --pf-v5-global--BorderColor--100 $pf-v5-global--BorderColor--100 $pf-v5-color-black-300 #d2d2d2
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band--BorderTopWidth	1px
--pf-v5-c-login__main-footer-band--BorderTopWidth --pf-v5-global--BorderWidth--sm $pf-v5-global--BorderWidth--sm 1px
	.pf-v5-c-login	--pf-v5-c-login__main-footer-band-item--PaddingTop	1rem
--pf-v5-c-login__main-footer-band-item--PaddingTop --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__footer--PaddingLeft	1rem
--pf-v5-c-login__footer--PaddingLeft --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__footer--PaddingRight	1rem
--pf-v5-c-login__footer--PaddingRight --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__footer--c-list--PaddingTop	1rem
--pf-v5-c-login__footer--c-list--PaddingTop --pf-v5-global--spacer--md $pf-v5-global--spacer--md pf-size-prem(16px) 1rem
	.pf-v5-c-login	--pf-v5-c-login__footer--c-list--xl--PaddingTop	3rem
--pf-v5-c-login__footer--c-list--xl--PaddingTop --pf-v5-global--spacer--2xl $pf-v5-global--spacer--2xl pf-size-prem(48px) 3rem

View source on GitHub