Skip to content
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.

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

feat(ui_auth): export localizedErrorText #189

Merged
merged 2 commits into from
Nov 30, 2023

Conversation

lesnitsky
Copy link
Member

When ErrorText.localizeError is used, it becomes a single source of truth. This means all error messages should be localized by developer. A subset of errors is already localized by Firebase UI, so localizedErrorText that is used internally is now public and could be used inside ErrorText.localizeError.

Example:

ErrorText.localizeError = (BuildContext context, FirebaseAuthException e) {
  if (e.code == "user-not-found" || e.code == "wrong-password") return "Wrong credentials";

  final defaultLabels = FirebaseUILocalizations.labelsOf(context);
  return localizedErrorText(e.code, defaultLabels);
}

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • All unit tests pass (melos run test:unit:all doesn't fail).
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

When `ErrorText.localizeError` is used, it becomes a single source of truth.
This means all error messages should be localized by developer.
A subset of errors is already localized by Firebase UI, so `localizedErrorText` that is
used internally is now public and could be used inside `ErrorText.localizeError`.

Example:

```dart
ErrorText.localizeError = (BuildContext context, FirebaseAuthException e) {
  if (e.code == "user-not-found" || e.code == "wrong-password") return "Wrong credentials";

  final defaultLabels = FirebaseUILocalizations.labelsOf(context);
  return localizedErrorText(e.code, defaultLabels);
}
```
@lesnitsky lesnitsky merged commit ab89f5c into main Nov 30, 2023
12 of 13 checks passed
@lesnitsky lesnitsky deleted the feat/export-localized-error-text branch November 30, 2023 12:42
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.

2 participants