Skip to content

chore(amplify_authenticator): add more detail to api docs for username #1403

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

Merged
Jordan-Nelson merged 2 commits into from
Feb 24, 2022
Merged

chore(amplify_authenticator): add more detail to api docs for username #1403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
428ad2a
add more detail to api docs for username
Jordan-Nelson Feb 24, 2022
0265753
move docs to SignUpFormField
Jordan-Nelson Feb 24, 2022
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
2 changes: 1 addition & 1 deletion packages/amplify_authenticator/lib/src/widgets/form_fields/confirm_sign_up_form_field.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ abstract class ConfirmSignUpFormField<FieldValue>
validator: validator,
);

/// Creates a username component.
/// {@macro amplify_authenticator.username_form_field}
static ConfirmSignUpFormField username({
Key? key,
FormFieldValidator<UsernameInput>? validator,
Expand Down
2 changes: 1 addition & 1 deletion packages/amplify_authenticator/lib/src/widgets/form_fields/sign_in_form_field.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ abstract class SignInFormField<FieldValue> extends AuthenticatorFormField<
requiredOverride: required,
);

/// Creates a username FormField for the sign in step.
/// {@macro amplify_authenticator.username_form_field}
static SignInFormField username({
Key? key,
FormFieldValidator<UsernameInput>? validator,
Expand Down
11 changes: 10 additions & 1 deletion packages/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 @@ -46,7 +46,16 @@ abstract class SignUpFormField<FieldValue> extends AuthenticatorFormField<
requiredOverride: required,
);

/// Creates a username component.
/// {@template amplify_authenticator.username_form_field}
/// Creates a username component based on your app's configuration.
///
/// The look and behavior of this widget will depend on your app's auth configuration.
/// The `usernameAttributes` will be used to determine if the field is a standard
/// username field, and email field, or a phone number field.
/// {@endtemplate}
///
/// If your app is configured to use email or phone, the value provided for this widget
/// will be saved as the user's email or phone number in addition to their username.
static SignUpFormField username({
Key? key,
FormFieldValidator<UsernameInput>? validator,
Expand Down