Skip to content

Conversation

@Jordan-Nelson
Copy link
Member

Issue #, if available: #1398

Description of changes:

  • Add clarification to username API docs

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@Jordan-Nelson Jordan-Nelson requested a review from a team as a code owner February 24, 2022 19:39
@Jordan-Nelson Jordan-Nelson changed the title add more detail to api docs for username chore(amplify_authenticator): add more detail to api docs for username Feb 24, 2022
/// 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}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this get applied to AuthenticatorFormField?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh it does. I thought if there was a gap it got ignored. TIL.

I moved it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, no worries. I didn't know for sure either.

@codecov-commenter
Copy link

codecov-commenter commented Feb 24, 2022

Codecov Report

Merging #1403 (428ad2a) into main (ee088c0) will not change coverage.
The diff coverage is n/a.

❗ Current head 428ad2a differs from pull request most recent head 0265753. Consider uploading reports for the commit 0265753 to get more accurate results

@@           Coverage Diff           @@
##             main    #1403   +/-   ##
=======================================
  Coverage   54.39%   54.39%           
=======================================
  Files         264      264           
  Lines       12011    12011           
=======================================
  Hits         6533     6533           
  Misses       5478     5478           
Flag Coverage Δ
android-unit-tests ∅ <ø> (∅)
flutter-unit-tests 36.64% <ø> (ø)
ios-unit-tests 90.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...lify_authenticator/lib/src/widgets/form_field.dart 44.87% <ø> (ø)
...idgets/form_fields/confirm_sign_up_form_field.dart 16.12% <ø> (ø)
...ib/src/widgets/form_fields/sign_in_form_field.dart 86.66% <ø> (ø)
...ib/src/widgets/form_fields/sign_up_form_field.dart 4.49% <ø> (ø)

@Jordan-Nelson Jordan-Nelson merged commit 3725958 into aws-amplify:main Feb 24, 2022
@Jordan-Nelson Jordan-Nelson deleted the authenticator/username-api-docs branch February 24, 2022 21:46
HuiSF added a commit that referenced this pull request Mar 11, 2022
* chore: Update issue template to GH form (#1387)

* chore: Update issue template to GH form

* Add N/A for placeholders

* Minor updates

* Minor fixes

* fix(amplify_authenticator): remove use of onInverseSurface to support older flutter versions (#1385)

* remove use of onInverseSurface

* set min flutter version to 2.0.0

* update fallback color

* chore(amplify_authenticator): run unit tests for amplify_authenticator in CI (#1389)

* fix(core): Implement Result in AtomicResult (#1393)

* fix(core): Implement Result in AtomicResult

* Fix AtomicResultTest

* chore: Small QOS additions to bug report template (#1394)

* fix(amplify_authenticator): allow multiple custom attributes in custom forms (#1377)

* add initial category for ui customization

* remove AuthState from the public API

* remove auth bloc from public api

* clean up public api, add docs

* update for consistency, fix typos

* change category name, fix typo

* update install docs

* update package description

* update example project dir

* uncomment example app imports

* update template names

* empty commit to trigger CI

* update how runtime and custom fields are handled

* move runtime fields to SignUpForm

* fix signout button

* Apply suggestions from code review

Co-authored-by: Dillon Nys <[email protected]>

* rename includeDefaultFields, update sort

* Update packages/amplify_authenticator/lib/src/widgets/form.dart

Co-authored-by: Dillon Nys <[email protected]>

* make _includeDefaultFields private

Co-authored-by: Dillon Nys <[email protected]>

* chore: authenticator v0.1.0 (#1402)

* chore: authenticator v0.1.0

* Update packages/amplify_authenticator/pubspec.yaml

Co-authored-by: Dillon Nys <[email protected]>

Co-authored-by: Dillon Nys <[email protected]>

* chore: adds API for auth integ tests + minor fixes (#1302)

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

* add more detail to api docs for username

* move docs to SignUpFormField

* fix overflow in custom loyout example (#1401)

* chore: rename docs dir to doc (#1406)

* chore(amplify_api): clean up some code to limit analysis infos (#1404)

* fix(datastore): delete default predicate causes deletion failure (#1409)

* fix(datastore): delete default predicate causes deletion failure

* fix save integration test

* Release 4.0.1 version bump (#1418)

* Version bump

* fix changelog 0.4.0 entry

* Add PR #s

* chore: add pub analysis to CI (#1408)

* add pana to ci

* add missing colon

* add install_melos step

* move scope arg

* move exec command to config

* remove pana from melos

* add remaining packages

* address issue in authenticator package

* disable failing packages

* revert change to melos.yaml

* add threshold

* add quotes

* escape quotes

* escape << >>

* escape <<<

* update variable parsing

* update parsing

* remove trailing quote

* add remaining packages

* update variable name, add desc

* adjust thresholds

* decrease api threshold

* chore: remove obsolete integration test driver files (#1395)

* fix(amplify_api): model helpers query predicates correctly translates… (#1417)

* chore(amplify_auth_cognito) federated plugin (#1349)

* chore(auth): fix pubspec urls (#1424)

Co-authored-by: Dillon Nys <[email protected]>
Co-authored-by: Jordan Nelson <[email protected]>
Co-authored-by: Travis Sheppard <[email protected]>
Co-authored-by: Jordan Nelson <[email protected]>
Co-authored-by: Dustin Noyes <[email protected]>
Co-authored-by: Kyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants