Skip to content

docs: Document sign-in widget localization#703

Open
marcelomendoncasoares wants to merge 3 commits into
serverpod:mainfrom
marcelomendoncasoares:docs/sign-in-localization
Open

docs: Document sign-in widget localization#703
marcelomendoncasoares wants to merge 3 commits into
serverpod:mainfrom
marcelomendoncasoares:docs/sign-in-localization

Conversation

@marcelomendoncasoares

@marcelomendoncasoares marcelomendoncasoares commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

SignInLocalizationProvider lets an app replace the English text of the authentication widgets, but nothing in the docs mentioned it.

Changes

  • Add a "Localization" section to the authentication UI components page. It is a top-level section because the provider applies to every authentication widget, not only SignInWidget.
  • List the text objects and what each one covers before the example.
  • Add one complete example translating the shared texts, the email flow, the password requirements, and every provider button with explicit English texts.
  • Explain the fallback: anything left out keeps the built-in English text, and defaults.copyWith covers partial translations.
  • State that the provider does not resolve Flutter's Locale, and that the app has to rebuild it when the locale changes.
  • Note that the Firebase provider ships a controller rather than a finished UI, so it is not covered by these text objects.
  • Fix the sentence case of the existing "Disabling providers" heading. The slug is unchanged.

Reference

Promote localization to its own section, since SignInLocalizationProvider
applies to every authentication widget and not only to SignInWidget. List
the text objects before the example so the reader can read the code, split
the partial translation and locale notes into their own subsections, and
keep the existing heading wording intact.
@marcelomendoncasoares
marcelomendoncasoares marked this pull request as ready for review July 21, 2026 19:43
@marcelomendoncasoares
marcelomendoncasoares requested a review from a team July 21, 2026 19:43
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Jul 22, 2026
@developerjamiu

Copy link
Copy Markdown
Contributor

The PR description says the example translates into Brazilian Portuguese, but all the strings in the diff are English. The English version reads well as an API reference, so maybe just update the description, or give the copyWith example one non-English string (e.g. signIn: 'Entrar') so the translation point shows.

@developerjamiu developerjamiu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changes looks good! Please check the added (minor) comment before merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants