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

ParameterDefaultType
AriaDescribedBy—string

Specifies the aria-describedby attribute value.
When set, this value is rendered as-is and overrides help and validation message ids generated by Field and Validation.
AriaInvalid—string

Specifies the aria-invalid attribute value.
When set, this value is rendered as-is and overrides the validation-derived aria-invalid state.
AriaLabelledBy—string

Specifies the aria-labelledby attribute value.
When set, this value is rendered as-is. Some non-labelable controls can otherwise derive it automatically from a parent FieldLabel or FieldsLabel.
AriaRequiredfalsebool

Specifies the aria-required attribute value.
When set, this value overrides the required-field state resolved from the parent Validation.
Autofocusfalsebool

Set's the focus to the component after the rendering is done.
BlockedPasswordsnullIEnumerable<string>

Specifies additional blocked passwords used during validation.
ChildContentnullRenderFragment

Specifies the content to be rendered inside this PasswordStrength.
ColorColor.DefaultColor

Defines the intent of the input.
Debouncenullbool?

If true, the entered value will be updated after a delay.
DebounceInterval300int?

Interval in milliseconds used to debounce the text update.
Disabledfalsebool

Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.
FeedbacknullRenderFragment

Placeholder for validation messages.
Immediatetruebool?

If true, the entered value will be updated after each key press.
InputAttributesnullDictionary<string, object>

Captures all the custom attributes that should be forwarded to the internal password input element.
IntentnullIntent

Defines the intent of the input.
MinimumLength15int

The minimum required password length. Defaults to 15 to align with current security recommendations for single-factor passwords.
OnScreenKeyboardfalsebool

Enables the on-screen keyboard for this input component. When not explicitly set, the global accessibility option is used.
When omitted, uses the global accessibility setting and enabled input types.
OnScreenKeyboardEnterKeyBehaviorInput-dependentOnScreenKeyboardEnterKeyBehavior

Specifies how the on-screen keyboard enter key should behave for this input component.
Possible values:DefaultNewLineSubmitHideKeyDown
When omitted, uses the cascading override, then the global option, then the input component's behavior.
OnScreenKeyboardLayoutInput-dependentOnScreenKeyboardLayout

Specifies the on-screen keyboard layout for this input component. When not explicitly set, the global accessibility option is used.
Possible values:TextNumericDecimalEmailUrlTelephone
When omitted, uses the global default layout, then the input component's layout.
OnScreenKeyboardShowModeFocusOnScreenKeyboardShowMode

Gets or sets how the on-screen keyboard is shown for this input.
Possible values:DefaultFocusManual
When omitted, uses the global show mode; Default resolves to Focus.
PasswordStrengthClassesnullPasswordStrengthClasses

Custom CSS class names for PasswordStrength component elements.
PasswordStrengthLocalizernullTextLocalizerHandler

Function used to handle custom localization that will override a default ITextLocalizer.
PasswordStrengthStylesnullPasswordStrengthStyles

Custom inline styles for PasswordStrength component elements.
Pattern—string

The pattern attribute specifies a regular expression that the input element's value is checked against on form validation.
Placeholder—string

Sets the placeholder for the empty text.
Plaintextfalsebool

Sets the class to remove the default form field styling and preserve the correct margin and padding.
ReadOnlyfalsebool

Add the readonly boolean attribute on an input to prevent modification of the input’s value.
RequireLowercasefalsebool

If true, requires at least one lowercase character.

Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.

RequireNotCompromisedPasswordtruebool

If true, validates the value against blocked passwords.
RequireNumberfalsebool

If true, requires at least one digit.

Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.

RequireSpecialCharacterfalsebool

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.

RequireUppercasefalsebool

If true, requires at least one uppercase character.

Disabled by default to follow modern guidance that favors longer passphrases over strict composition rules.

RuleSatisfiedColorSuccessTextColor

Specifies the color used for satisfied password rules.
RuleUnsatisfiedColorDefaultTextColor

Specifies the color used for unsatisfied password rules.
ShowPasswordButtonColorLightColor

Specifies the color for the password visibility toggle button.
ShowPasswordToggletruebool

Determines whether to show a toggle button for password visibility.
ShowRulestruebool

Determines whether to display the checklist of active rules.
ShowStrengthtruebool

Determines whether to display password strength details.
SizeDefaultSize?

Sets the size of the input control.
When omitted, uses the parent Addons size, then the theme input size, then Size.Default.
TabIndexnullint?

If defined, indicates that its element can be focused and can participates in sequential keyboard navigation.
UseDefaultBlockedPasswordListtruebool

If true, includes a small default list of commonly compromised passwords in blocked checks.
ValuenullTValue

Specifies the value inside the input field.
ValueExpressionnullExpression<Func<TValue>>

Specifies an expression that identifies the input value.

Events

EventType
BlurEventCallback<FocusEventArgs>

The blur event fires when an element has lost focus.
CustomValidationValueFunc<TValue>

Used to provide custom validation value on which the validation will be processed with the Validator handler.
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.
FocusInEventCallback<FocusEventArgs>

Notifies when the input box gains focus.
FocusOutEventCallback<FocusEventArgs>

Notifies when the input box loses focus.
KeyDownEventCallback<KeyboardEventArgs>

Notifies when a key is pressed down while the control has focus.
KeyPressEventCallback<KeyboardEventArgs>

Notifies when a key is pressed while the control has focus.
KeyUpEventCallback<KeyboardEventArgs>

Notifies when a key is released while the control has focus.
OnFocusEventCallback<FocusEventArgs>

Notifies when the input box gains or loses focus.
StrengthChangedEventCallback<PasswordStrengthChangedEventArgs>

Occurs after strength evaluation has changed.
ValueChangedEventCallback<TValue>

Occurs after value has changed.

Methods

MethodReturnParameters
SelectTaskbool focus

Select all text in the underline component.
ShowOnScreenKeyboardTaskbool focus

Shows the on-screen keyboard for this input.
FocusTaskbool scrollToElement

Sets the focus on the underline element.
RevalidateTask—

Forces the Validation (if any is used) to re-validate with the new custom or internal value.
On this page