docs: Add note about uiLocales limitation with third-party identity p… #3270
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…roviders - Document that uiLocales parameter is not passed to third-party identity providers - Add JSDoc comments to LoginOptions type properties - Update login method documentation to clarify the limitation This addresses a documentation gap identified by the Developer Support team where the uiLocales parameter behavior with third-party providers was not documented.
Contributor
|
We detected some changes in |
Contributor
|
Oxygen deployed a preview of your
Learn more about Hydrogen's GitHub integration. |
- Reword uiLocales note to lead with user impact first
- Use more conversational language ('might not' vs 'may not', 'That's because')
- Apply consistent wording across both JSDoc locations
Based on feedback from shopify-dev PR review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation about uiLocales parameter limitation with third-party identity providers.
When using third-party identity providers with headless storefronts, the
uiLocalesparameter is not passed to the identity provider during authentication callbacks. This means the third-party login interface may not automatically reflect the customer's preferred language setting.This change addresses a documentation gap identified by the Developer Support team.
Context
uiLocalesparameter doesn't get passed to third-party identity providers, leading to confusion when the third-party login UI doesn't reflect the expected languageTesting
This is a documentation-only change. The changes can be verified by:
this page should have the listed change
https://shopify-dev.shop.dev/docs/api/hydrogen/latest/utilities/createcustomeraccountclient (check for uiLocales note)