-
Notifications
You must be signed in to change notification settings - Fork 460
Support for <GoogleOneTap/>
#3409
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
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
7699847
fix(clerk-js): Reprompt google one tap only when user id changes (#3198)
panteliselef 534ce72
feat(clerk-js): Handle PSU and MFA flows for `<GoogleOneTap/>` (#3250)
panteliselef 38122c3
feat(clerk-js,clerk-react): Replace mount with open for GoogleOneTap …
panteliselef 2af4d6f
feat(clerk-js,clerk-react,nextjs,types): Drop experimental tag from G…
panteliselef 8dfc2f4
chore(clerk-js): Fix issues after conflicts
panteliselef 6558d19
feat(clerk-js): Come back to where the flow started
panteliselef 84176ca
chore(*): Add changelog
panteliselef deb84f4
fix(clerk-js): Use the correct returnBack url when GoogleOneTap remai…
panteliselef a9d2c6f
chore(types): Add changelog
panteliselef 3d91d13
chore(chrome-extension): Add changelog
panteliselef c1e8dc3
chore(clerk-js): Add changelog
panteliselef 3895193
chore(clerk-react,nextjs): Add changelog
panteliselef File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| '@clerk/nextjs': minor | ||
| '@clerk/clerk-react': minor | ||
| --- | ||
|
|
||
| Add support for GoogleOneTap | ||
| ### React component | ||
| - `<GoogleOneTap/>` | ||
|
|
||
| Customize the UX of the prompt | ||
|
|
||
| ```tsx | ||
| <GoogleOneTap cancelOnTapOutside={false} itpSupport={false} fedCmSupport={false}/> | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| '@clerk/clerk-js': minor | ||
| --- | ||
|
|
||
| ### Use the Google One Tap component from with Vanilla JS | ||
| - `Clerk.openGoogleOneTap({ cancelOnTapOutside: false, fedCmSupport: false, itpSupport: false })` | ||
| - `Clerk.closeGoogleOneTap()` | ||
| ### Low level APIs for custom flows | ||
| - `await Clerk.authenticateWithGoogleOneTap({ token: 'xxxx'})` | ||
| - `await Clerk.handleGoogleOneTapCallback()` | ||
|
|
||
|
|
||
| We recommend using this two methods together in order and let Clerk perform the correct redirections. | ||
| ```tsx | ||
| google.accounts.id.initialize({ | ||
| callback: async response => { | ||
| const signInOrUp = await Clerk.authenticateWithGoogleOneTap({ token: response.credential}) | ||
| await Clerk.handleGoogleOneTapCallback(signInOrUp, { | ||
| afterSignInUrl: window.location.href, | ||
| }) | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| In case you want to handle the redirection and session management yourself you can do so like this | ||
| ```tsx | ||
| google.accounts.id.initialize({ | ||
| callback: async response => { | ||
| const signInOrUp = await Clerk.authenticateWithGoogleOneTap({ token: response.credential}) | ||
| if(signInOrUp.status === 'complete') { | ||
| await Clerk.setActive({ | ||
| session: signInOrUp.createdSessionId | ||
| }) | ||
| } | ||
| }, | ||
| }); | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@clerk/chrome-extension': minor | ||
| --- | ||
|
|
||
| Update export snapshot tests to include `GoogleOneTap`. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| '@clerk/types': minor | ||
| --- | ||
|
|
||
| Added the following types | ||
| ```tsx | ||
| interface Clerk { | ||
| ... | ||
| openGoogleOneTap: (props?: GoogleOneTapProps) => void; | ||
| closeGoogleOneTap: () => void; | ||
| authenticateWithGoogleOneTap: (params: AuthenticateWithGoogleOneTapParams) => Promise<SignInResource | SignUpResource>; | ||
| handleGoogleOneTapCallback: ( | ||
| signInOrUp: SignInResource | SignUpResource, | ||
| params: HandleOAuthCallbackParams, | ||
| customNavigate?: (to: string) => Promise<unknown>, | ||
| ) => Promise<unknown>; | ||
| ... | ||
| } | ||
|
|
||
| type GoogleOneTapStrategy = 'google_one_tap' | ||
| ``` |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@panteliselef I think I've mentioned this before, but I'm double-checking that this
signUp.createwill trigger a Captcha functionality, and if the user has selected the "Smart" option it will try to find theclerk-captchain the DOM. Thankfully, it won't break, because we fallback to "Invisible", but the fallback mechanism may change in the future, we should not depend on it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK