Blazorise Password Strength API

Explore the Blazorise Password Strength API reference for parameters, events, methods, and related types.

For examples and usage guidance, see the Password Strength documentation.

API

Parameters

Parameter	Description	Type	Default
`AriaDescribedBy`	Specifies the aria-describedby attribute value. Remarks When set, this value is rendered as-is and overrides help and validation message ids generated by Field and Validation.	`string`
`AriaInvalid`	Specifies the aria-invalid attribute value. Remarks When set, this value is rendered as-is and overrides the validation-derived aria-invalid state.	`string`
`AriaLabelledBy`	Specifies the aria-labelledby attribute value. Remarks When set, this value is rendered as-is. Some non-labelable controls can otherwise derive it automatically from a parent FieldLabel or FieldsLabel.	`string`
`AriaRequired`	Specifies the aria-required attribute value. Remarks When set, this value overrides the required-field state resolved from the parent Validation.	`bool`	`false`
`Autofocus`	Set's the focus to the component after the rendering is done.	`bool`	`false`
`BlockedPasswords`	Specifies additional blocked passwords used during validation.	`IEnumerable<string>`	`null`
`ChildContent`	Specifies the content to be rendered inside this PasswordStrength.	`RenderFragment`	`null`
`Color`	Sets the input text color.	`Color`	`Color.Default`
`Debounce`	If true, the entered value will be updated after a delay.	`bool?`	`null`
`DebounceInterval`	Interval in milliseconds used to debounce the text update.	`int?`	`300`
`Disabled`	Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.	`bool`	`false`
`Feedback`	Placeholder for validation messages.	`RenderFragment`	`null`
`Immediate`	If true, the entered value will be updated after each key press.	`bool?`	`true`
`InputAttributes`	Captures all the custom attributes that should be forwarded to the internal password input element.	`Dictionary<string, object>`	`null`
`Intent`	Sets the input text intent.	`Intent`	`null`
`MinimumLength`	The minimum required password length. Defaults to 15 to align with current security recommendations for single-factor passwords.	`int`	`15`
`OnScreenKeyboard`	Enables the on-screen keyboard for this input component. When not explicitly set, the global accessibility option is used.	`bool`	`false`
`OnScreenKeyboardEnterKeyBehavior`	Specifies how the on-screen keyboard enter key should behave for this input component. Possible values:`Default`, `NewLine`, `Submit`, `Hide`, `KeyDown`	`OnScreenKeyboardEnterKeyBehavior`	`OnScreenKeyboardEnterKeyBehavior.Default`
`OnScreenKeyboardLayout`	Specifies the on-screen keyboard layout for this input component. When not explicitly set, the global accessibility option is used. Possible values:`Text`, `Numeric`, `Decimal`, `Email`, `Url`, `Telephone`	`OnScreenKeyboardLayout`	`OnScreenKeyboardLayout.Text`
`OnScreenKeyboardShowMode`	Gets or sets how the on-screen keyboard is shown for this input. Possible values:`Default`, `Focus`, `Manual`	`OnScreenKeyboardShowMode`	`OnScreenKeyboardShowMode.Default`
`PasswordStrengthClasses`	Custom CSS class names for PasswordStrength component elements.	`PasswordStrengthClasses`	`null`
`PasswordStrengthLocalizer`	Function used to handle custom localization that will override a default ITextLocalizer.	`TextLocalizerHandler`	`null`
`PasswordStrengthStyles`	Custom inline styles for PasswordStrength component elements.	`PasswordStrengthStyles`	`null`
`Pattern`	The pattern attribute specifies a regular expression that the input element's value is checked against on form validation.	`string`
`Placeholder`	Sets the placeholder for the empty text.	`string`
`Plaintext`	Sets the class to remove the default form field styling and preserve the correct margin and padding.	`bool`	`false`
`ReadOnly`	Add the readonly boolean attribute on an input to prevent modification of the input’s value.	`bool`	`false`
`RequireLowercase`	If true, requires at least one lowercase character. Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.	`bool`	`false`
`RequireNotCompromisedPassword`	If true, validates the value against blocked passwords.	`bool`	`true`
`RequireNumber`	If true, requires at least one digit. Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.	`bool`	`false`
`RequireSpecialCharacter`	If true, requires at least one symbol or punctuation character. Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.	`bool`	`false`
`RequireUppercase`	If true, requires at least one uppercase character. Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.	`bool`	`false`
`RuleSatisfiedColor`	Specifies the color used for satisfied password rules.	`TextColor`	`Success`
`RuleUnsatisfiedColor`	Specifies the color used for unsatisfied password rules.	`TextColor`	`Default`
`ShowPasswordButtonColor`	Specifies the color for the password visibility toggle button.	`Color`	`Light`
`ShowPasswordToggle`	Determines whether to show a toggle button for password visibility.	`bool`	`true`
`ShowRules`	Determines whether to display the checklist of active rules.	`bool`	`true`
`ShowStrength`	Determines whether to display password strength details.	`bool`	`true`
`Size`	Sets the size of the input control.	`Size?`	`null`
`TabIndex`	If defined, indicates that its element can be focused and can participates in sequential keyboard navigation.	`int?`	`null`
`UseDefaultBlockedPasswordList`	If true, includes a small default list of commonly compromised passwords in blocked checks.	`bool`	`true`
`Value`	Specifies the value inside the input field.	`TValue`	`null`
`ValueExpression`	Specifies an expression that identifies the input value.	`Expression<Func<TValue>>`	`null`

Events

Event	Description	Type
`Blur`	The blur event fires when an element has lost focus.	`EventCallback<FocusEventArgs>`
`CustomValidationValue`	Used to provide custom validation value on which the validation will be processed with the Validator handler. Remarks Should be used carefully as it's only meant for some special cases when input is used in a wrapper component, like Autocomplete or SelectList.	`Func<TValue>`
`FocusIn`	Notifies when the input box gains focus.	`EventCallback<FocusEventArgs>`
`FocusOut`	Notifies when the input box loses focus.	`EventCallback<FocusEventArgs>`
`KeyDown`	Notifies when a key is pressed down while the control has focus.	`EventCallback<KeyboardEventArgs>`
`KeyPress`	Notifies when a key is pressed while the control has focus.	`EventCallback<KeyboardEventArgs>`
`KeyUp`	Notifies when a key is released while the control has focus.	`EventCallback<KeyboardEventArgs>`
`OnFocus`	Notifies when the input box gains or loses focus.	`EventCallback<FocusEventArgs>`
`StrengthChanged`	Occurs after strength evaluation has changed.	`EventCallback<PasswordStrengthChangedEventArgs>`
`ValueChanged`	Occurs after value has changed.	`EventCallback<TValue>`

Methods

Method	Description	Return	Parameters
`Select`	Select all text in the underline component.	`Task`	`bool focus`
`ShowOnScreenKeyboard`	Shows the on-screen keyboard for this input.	`Task`	`bool focus`
`Focus`	Sets the focus on the underline element.	`Task`	`bool scrollToElement`
`Revalidate`	Forces the Validation (if any is used) to re-validate with the new custom or internal value.	`Task`

Blazorise Password Strength API

API

Parameters

Events

Methods

On this page