Skip to content

Display the password policy on signup form #3687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Display the password policy on signup form #3687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/authenticator/amplify_authenticator/lib/src/widgets/form.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ class SignUpForm extends AuthenticatorForm {
SignUpForm({
super.key,
}) : _includeDefaultFields = true,
passwordPolicyWidget = null,
super._(
fields: [
SignUpFormField.username(),
Expand All @@ -234,6 +235,7 @@ class SignUpForm extends AuthenticatorForm {
const SignUpForm.custom({
super.key,
required List<SignUpFormField> super.fields,
this.passwordPolicyWidget,
}) : _includeDefaultFields = false,
super._(
actions: const [
Expand All @@ -245,6 +247,11 @@ class SignUpForm extends AuthenticatorForm {
/// the Auth plugin configuration.
final bool _includeDefaultFields;

/// Widget to show for displaying a password policy.
///
/// Typically a [TextBox]
final Widget? passwordPolicyWidget;

@override
AuthenticatorFormState<SignUpForm> createState() => _SignUpFormState();
}
Expand Down
69 changes: 59 additions & 10 deletions ...s/authenticator/amplify_authenticator/lib/src/widgets/form_fields/sign_up_form_field.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ abstract class SignUpFormField<FieldValue extends Object>
FormFieldValidator<String>? validator,
Iterable<String>? autofillHints,
}) =>
_SignUpTextField(
_SignUpPasswordField(
key: key ?? keyPasswordSignUpFormField,
titleKey: InputResolverKey.passwordTitle,
hintTextKey: InputResolverKey.passwordHint,
Expand Down Expand Up @@ -508,8 +508,6 @@ class _SignUpTextFieldState extends _SignUpFormFieldState<String>
switch (widget.field) {
case SignUpField.username:
return state.username;
case SignUpField.password:
return state.password;
case SignUpField.passwordConfirmation:
return state.passwordConfirmation;
case SignUpField.address:
Expand All @@ -535,8 +533,6 @@ class _SignUpTextFieldState extends _SignUpFormFieldState<String>
switch (widget.field) {
case SignUpField.username:
return (v) => state.username = v;
case SignUpField.password:
return (v) => state.password = v;
case SignUpField.passwordConfirmation:
return (v) => state.passwordConfirmation = v;
case SignUpField.address:
Expand Down Expand Up @@ -585,11 +581,6 @@ class _SignUpTextFieldState extends _SignUpFormFieldState<String>
),
isOptional: isOptional,
);
case SignUpField.password:
return validateNewPassword(
amplifyConfig: config.amplifyConfig,
inputResolver: stringResolver.inputs,
)(context);
case SignUpField.passwordConfirmation:
return validatePasswordConfirmation(
() => state.password,
Expand Down Expand Up @@ -789,3 +780,61 @@ class _SignUpDateFieldState extends _SignUpFormFieldState<String>
);
}
}

class _SignUpPasswordField extends SignUpFormField<String> {
const _SignUpPasswordField({
super.key,
required super.field,
super.titleKey,
super.hintTextKey,
CognitoUserAttributeKey? attributeKey,
super.validator,
super.required,
super.autofillHints,
}) : super._(
customAttributeKey: attributeKey,
);

@override
_SignUpPasswordFieldState createState() => _SignUpPasswordFieldState();
}

class _SignUpPasswordFieldState extends _SignUpTextFieldState {
@override
String? get initialValue {
return state.password;
}

@override
ValueChanged<String> get onChanged {
return (v) => state.password = v;
}

@override
Widget? get companionWidget {
final policyWidget =
InheritedForms.of(context).signUpForm.passwordPolicyWidget;
if (policyWidget != null) {
return policyWidget;
}

if (state.password.isEmpty) {
return null;
}

final validatorResult = validator(state.password);
if (validatorResult == null) {
return null;
}

return Text(validatorResult);
}

@override
FormFieldValidator<String> get validator {
return validateNewPassword(
amplifyConfig: config.amplifyConfig,
inputResolver: stringResolver.inputs,
)(context);
}
}