Skip to content

Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

Sign up for GitHub

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
SokratisVidros merged 4 commits into from
Sep 28, 2023
Merged

Pre fill form fields in <SignIn/> and <SignUp/> #1701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e4e4ae
feat(types): Add initialValues prop to the SignIn/Up types
desiprisg Sep 11, 2023
144ce0e
feat(clerk-js): Prefill SignIn/Up components with initial values
desiprisg Sep 11, 2023
c7f0305
test(clerk-js): Add tests for the initialValues prop
desiprisg Sep 28, 2023
775100b
chore(clerk-js): Update changeset
desiprisg Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/fresh-papayas-cheat.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.
18 changes: 12 additions & 6 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
Resources,
SetActiveParams,
SignInProps,
SignInRedirectOptions,
SignInResource,
SignOut,
SignOutCallback,
SignOutOptions,
SignUpField,
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
UnsubscribeCallback,
UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
appendAsQueryParams,
appendUrlsAsQueryParams,
buildURL,
createBeforeUnloadTracker,
createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
}

public buildSignInUrl(options?: RedirectOptions): string {
public buildSignInUrl(options?: SignInRedirectOptions): string {
return this.#buildUrl('signInUrl', options);
}

public buildSignUpUrl(options?: RedirectOptions): string {
public buildSignUpUrl(options?: SignUpRedirectOptions): string {
return this.#buildUrl('signUpUrl', options);
}

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
return;
};

public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
if (inBrowser()) {
return this.navigate(this.buildSignInUrl(options));
}
return;
};

public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
if (inBrowser()) {
return this.navigate(this.buildSignUpUrl(options));
}
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
});
};

#buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
#buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
return '';
}
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
{ options: this.#options, displayConfig: this.#environment.displayConfig },
false,
);
return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

return this.buildUrlWithAuth(
appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.
);
};

assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
NOT_ALLOWED_ACCESS: 'not_allowed_access',
SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];
55 changes: 42 additions & 13 deletions packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
});

const identifierField = useFormControl('identifier', '', {
const ctxInitialValues = ctx.initialValues || {};
const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
() => ({
email_address: ctxInitialValues.emailAddress,
email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
username: ctxInitialValues.username,
phone_number: ctxInitialValues.phoneNumber,
}),
[ctx.initialValues],
);

const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.
const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
...currentIdentifier,
isRequired: true,
});

const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
...currentIdentifier,
isRequired: true,
});

const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

const identifierFieldRef = useRef<HTMLInputElement>(null);

const switchToNextIdentifier = () => {
setIdentifierAttribute(
i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
);
identifierField.setValue('');
setShouldAutofocus(true);
};

const switchToPhoneInput = (value?: string) => {
const switchToPhoneInput = () => {
setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.
};

// switch to the phone input (if available) if a "+" is entered
// (either by the browser or the user)
// this does not work in chrome as it does not fire the change event and the value is
// not available via js
React.useLayoutEffect(() => {
useLayoutEffect(() => {
if (
identifierField.value.startsWith('+') &&
identifierAttributes.includes('phone_number') &&
identifierAttribute !== 'phone_number' &&
!hasSwitchedByAutofill
) {
switchToPhoneInput(identifierField.value);
switchToPhoneInput();
// do not switch automatically on subsequent autofills
// by the browser to avoid a switch loop
setHasSwitchedByAutofill(true);
}
}, [identifierField.value, identifierAttributes]);

React.useEffect(() => {
useLayoutEffect(() => {
if (identifierAttribute === 'phone_number' && identifierField.value) {
//value should be kept as we have auto-switched to the phone input
return;
}

identifierField.setValue(initialValues[identifierAttribute] || '');
}, [identifierAttribute]);

useEffect(() => {
if (!organizationTicket) {
return;
}
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
});
}, []);

React.useEffect(() => {
useEffect(() => {
async function handleOauthError() {
const error = signIn?.firstFactorVerification?.error;
if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
return <LoadingCard />;
}

const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

return (
<Flow.Part part='start'>
<Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
<Form.Root onSubmit={handleFirstPartySubmit}>
<Form.ControlRow elementId={identifierField.id}>
<Form.Control
ref={identifierFieldRef}
actionLabel={nextIdentifier?.action}
onActionClicked={switchToNextIdentifier}
{...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
const ref = useRef<HTMLInputElement>(null);

// show password if it's autofilled by the browser
React.useLayoutEffect(() => {
useLayoutEffect(() => {
const intervalId = setInterval(() => {
if (ref?.current) {
const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down
32 changes: 32 additions & 0 deletions packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
});
});

describe('initialValues', () => {
it('prefills the emailAddress field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withEmailAddress();
});
props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

render(<SignInStart />, { wrapper });
screen.getByDisplayValue(/foo@clerk.com/i);
});

it('prefills the phoneNumber field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withPhoneNumber();
});
props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

render(<SignInStart />, { wrapper });
screen.getByDisplayValue(/691 1111111/i);
});

it('prefills the username field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withUsername();
});

props.setProps({ initialValues: { username: 'foo' } });
render(<SignInStart />, { wrapper });
screen.getByDisplayValue(/foo/i);
});
});
});
12 changes: 6 additions & 6 deletions packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
const { navigate } = useRouter();
const { displayConfig, userSettings } = useEnvironment();
const { attributes } = userSettings;
const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
const signUp = useCoreSignUp();
const isProgressiveSignUp = userSettings.signUp.progressive;
const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

// TODO: This form should be shared between SignUpStart and SignUpContinue
const formState = {
firstName: useFormControl('firstName', '', {
firstName: useFormControl('firstName', initialValues.firstName || '', {
type: 'text',
label: localizationKeys('formFieldLabel__firstName'),
placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
}),
lastName: useFormControl('lastName', '', {
lastName: useFormControl('lastName', initialValues.lastName || '', {
type: 'text',
label: localizationKeys('formFieldLabel__lastName'),
placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
}),
emailAddress: useFormControl('emailAddress', '', {
emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
type: 'email',
label: localizationKeys('formFieldLabel__emailAddress'),
placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
}),
username: useFormControl('username', '', {
username: useFormControl('username', initialValues.username || '', {
type: 'text',
label: localizationKeys('formFieldLabel__username'),
placeholder: localizationKeys('formFieldInputPlaceholder__username'),
}),
phoneNumber: useFormControl('phoneNumber', '', {
phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
type: 'tel',
label: localizationKeys('formFieldLabel__phoneNumber'),
placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
);
const { t, locale } = useLocalizations();
const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.

const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
const { failedValidationsText } = usePasswordComplexity(passwordSettings);

const formState = {
firstName: useFormControl('firstName', signUp.firstName || '', {
firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
type: 'text',
label: localizationKeys('formFieldLabel__firstName'),
placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
}),
lastName: useFormControl('lastName', signUp.lastName || '', {
lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
type: 'text',
label: localizationKeys('formFieldLabel__lastName'),
placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
}),
emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
type: 'email',
label: localizationKeys('formFieldLabel__emailAddress'),
placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
}),
username: useFormControl('username', signUp.username || '', {
username: useFormControl('username', signUp.username || initialValues.username || '', {
type: 'text',
label: localizationKeys('formFieldLabel__username'),
placeholder: localizationKeys('formFieldInputPlaceholder__username'),
}),
phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
type: 'tel',
label: localizationKeys('formFieldLabel__phoneNumber'),
placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down
32 changes: 32 additions & 0 deletions packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
});
});

describe('initialValues', () => {
it('prefills the emailAddress field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withEmailAddress();
});
props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

render(<SignUpStart />, { wrapper });
screen.getByDisplayValue(/foo@clerk.com/i);
});

it('prefills the phoneNumber field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withPhoneNumber();
});
props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

render(<SignUpStart />, { wrapper });
screen.getByDisplayValue(/691 1111111/i);
});

it('prefills the username field with the correct initial value', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withUsername();
});

props.setProps({ initialValues: { username: 'foo' } });
render(<SignUpStart />, { wrapper });
screen.getByDisplayValue(/foo/i);
});
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Pre fill form fields in <SignIn/> and <SignUp/> by desiprisg · Pull Request #1701 · clerk/javascript · GitHub
Skip to content
Pre fill form fields in <SignIn/> and <SignUp/>#1701

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.

 Sign up for GitHub

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

SokratisVidros
merged 4 commits into

from

Sep 28, 2023
 Merged


Pre fill form fields in <SignIn/> and <SignUp/>
#1701
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5e4e4ae

feat(types): Add initialValues prop to the SignIn/Up types


desiprisg Sep 11, 2023
144ce0e

feat(clerk-js): Prefill SignIn/Up components with initial values


desiprisg Sep 11, 2023
c7f0305

test(clerk-js): Add tests for the initialValues prop


desiprisg Sep 28, 2023
775100b

chore(clerk-js): Update changeset


desiprisg Sep 28, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/fresh-papayas-cheat.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

`<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`, `<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and `clerk.redirectToSignUp()` now accept the `initialValues` option, which will prefill the appropriate form fields with the values provided.

18 changes: 12 additions & 6 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,12 +41,14 @@ import type {
 Resources,
 SetActiveParams,
 SignInProps,
 SignInRedirectOptions,
 SignInResource,
 SignOut,
 SignOutCallback,
 SignOutOptions,
 SignUpField,
 SignUpProps,
 SignUpRedirectOptions,
 SignUpResource,
 UnsubscribeCallback,
 UserButtonProps,
Expand All@@ -58,6 +60,7 @@ import type { MountComponentRenderer } from '../ui/Components';
import { completeSignUpFlow } from '../ui/components/SignUp/util';
import {
 appendAsQueryParams,
 appendUrlsAsQueryParams,
 buildURL,
 createBeforeUnloadTracker,
 createCookieHandler,
Expand DownExpand Up@@ -694,11 +697,11 @@ export default class Clerk implements ClerkInterface {
 return setDevBrowserJWTInURL(toURL, devBrowserJwt, asQueryParam).href;
 }

 public buildSignInUrl(options?: RedirectOptions): string {
 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', options);
 }

 public buildSignUpUrl(options?: RedirectOptions): string {
 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', options);
 }

Expand DownExpand Up@@ -757,14 +760,14 @@ export default class Clerk implements ClerkInterface {
 return;
 };

 public redirectToSignIn = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignIn = async (options?: SignInRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignInUrl(options));
 }
 return;
 };

 public redirectToSignUp = async (options?: RedirectOptions): Promise<unknown> => {
 public redirectToSignUp = async (options?: SignUpRedirectOptions): Promise<unknown> => {
 if (inBrowser()) {
 return this.navigate(this.buildSignUpUrl(options));
 }
Expand DownExpand Up@@ -1456,7 +1459,7 @@ export default class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: RedirectOptions): string => {
 #buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
 if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
Expand All@@ -1472,7 +1475,10 @@ export default class Clerk implements ClerkInterface {
 { options: this.#options, displayConfig: this.#environment.displayConfig },
 false,
 );
 return this.buildUrlWithAuth(appendAsQueryParams(signInOrUpUrl, opts));

 return this.buildUrlWithAuth(
 appendUrlsAsQueryParams(appendAsQueryParams(signInOrUpUrl, options?.initialValues || {}), opts),
Comment thread
desiprisg marked this conversation as resolved.

 );
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,3 +17,6 @@ export const ERROR_CODES = {
 NOT_ALLOWED_ACCESS: 'not_allowed_access',
 SAML_USER_ATTRIBUTE_MISSING: 'saml_user_attribute_missing',
};

export const SIGN_IN_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username'];
export const SIGN_UP_INITIAL_VALUE_KEYS = ['email_address', 'phone_number', 'username', 'first_name', 'last_name'];

55 changes: 42 additions & 13 deletions
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { ClerkAPIError, SignInCreateParams } from '@clerk/types';
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';

import { ERROR_CODES } from '../../../core/constants';
import { clerkInvalidFAPIResponse } from '../../../core/errors';
Expand DownExpand Up@@ -64,42 +64,73 @@ export function _SignInStart(): JSX.Element {
 placeholder: localizationKeys('formFieldInputPlaceholder__password') as any,
 });

 const identifierField = useFormControl('identifier', '', {
 const ctxInitialValues = ctx.initialValues || {};
 const initialValues: Record<SignInStartIdentifier, string | undefined> = useMemo(
 () => ({
 email_address: ctxInitialValues.emailAddress,
 email_address_username: ctxInitialValues.emailAddress || ctxInitialValues.username,
 username: ctxInitialValues.username,
 phone_number: ctxInitialValues.phoneNumber,
 }),
 [ctx.initialValues],
 );

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const [shouldAutofocus, setShouldAutofocus] = useState(!isMobileDevice() && !hasSocialOrWeb3Buttons);
Comment thread
desiprisg marked this conversation as resolved.

 const textIdentifierField = useFormControl('identifier', initialValues[identifierAttribute] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const phoneIdentifierField = useFormControl('identifier', initialValues['phone_number'] || '', {
 ...currentIdentifier,
 isRequired: true,
 });

 const identifierField = identifierAttribute === 'phone_number' ? phoneIdentifierField : textIdentifierField;

 const identifierFieldRef = useRef<HTMLInputElement>(null);

 const switchToNextIdentifier = () => {
 setIdentifierAttribute(
 i => identifierAttributes[(identifierAttributes.indexOf(i) + 1) % identifierAttributes.length],
 );
identifierField.setValue('');
setShouldAutofocus(true);
 };

 const switchToPhoneInput = (value?: string) => {
 const switchToPhoneInput = () => {
 setIdentifierAttribute('phone_number');
identifierField.setValue(value || '');
setShouldAutofocus(true);
Comment thread
desiprisg marked this conversation as resolved.

 };

 // switch to the phone input (if available) if a "+" is entered
 // (either by the browser or the user)
 // this does not work in chrome as it does not fire the change event and the value is
 // not available via js
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 if (
 identifierField.value.startsWith('+') &&
 identifierAttributes.includes('phone_number') &&
 identifierAttribute !== 'phone_number' &&
 !hasSwitchedByAutofill
 ) {
 switchToPhoneInput(identifierField.value);
 switchToPhoneInput();
 // do not switch automatically on subsequent autofills
 // by the browser to avoid a switch loop
 setHasSwitchedByAutofill(true);
 }
 }, [identifierField.value, identifierAttributes]);

 React.useEffect(() => {
 useLayoutEffect(() => {
 if (identifierAttribute === 'phone_number' && identifierField.value) {
 //value should be kept as we have auto-switched to the phone input
 return;
 }

 identifierField.setValue(initialValues[identifierAttribute] || '');
 }, [identifierAttribute]);

 useEffect(() => {
 if (!organizationTicket) {
 return;
 }
Expand DownExpand Up@@ -137,7 +168,7 @@ export function _SignInStart(): JSX.Element {
 });
 }, []);

React.useEffect(() => {
 useEffect(() => {
 async function handleOauthError() {
 const error = signIn?.firstFactorVerification?.error;
 if (error) {
Expand DownExpand Up@@ -244,9 +275,6 @@ export function _SignInStart(): JSX.Element {
 return <LoadingCard />;
 }

 const hasSocialOrWeb3Buttons = !!authenticatableSocialStrategies.length || !!web3FirstFactors.length;
 const shouldAutofocus = !isMobileDevice() && !hasSocialOrWeb3Buttons;

 return (
 <Flow.Part part='start'>
 <Card>
Expand All@@ -271,6 +299,7 @@ export function _SignInStart(): JSX.Element {
 <Form.Root onSubmit={handleFirstPartySubmit}>
 <Form.ControlRow elementId={identifierField.id}>
 <Form.Control
 ref={identifierFieldRef}
 actionLabel={nextIdentifier?.action}
 onActionClicked={switchToNextIdentifier}
 {...identifierField.props}
Expand DownExpand Up@@ -303,7 +332,7 @@ const InstantPasswordRow = ({ field }: { field?: FormControlState<'password'> })
 const ref = useRef<HTMLInputElement>(null);

 // show password if it's autofilled by the browser
React.useLayoutEffect(() => {
 useLayoutEffect(() => {
 const intervalId = setInterval(() => {
 if (ref?.current) {
 const autofilled = window.getComputedStyle(ref.current, ':autofill').animationName === 'onAutoFillStart';
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,4 +222,36 @@ describe('SignInStart', () => {
 expect(screen.getByRole('textbox', { name: /phone number/i })).toHaveAttribute('type', 'tel');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignInStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});

12 changes: 6 additions & 6 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpContinue.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ function _SignUpContinue() {
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { attributes } = userSettings;
 const { navigateAfterSignUp, signInUrl, unsafeMetadata } = useSignUpContext();
 const { navigateAfterSignUp, signInUrl, unsafeMetadata, initialValues = {} } = useSignUpContext();
 const signUp = useCoreSignUp();
 const isProgressiveSignUp = userSettings.signUp.progressive;
 const [activeCommIdentifierType, setActiveCommIdentifierType] = React.useState<ActiveIdentifier>(
Expand All@@ -47,27 +47,27 @@ function _SignUpContinue() {

 // TODO: This form should be shared between SignUpStart and SignUpContinue
 const formState = {
 firstName: useFormControl('firstName', '', {
 firstName: useFormControl('firstName', initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', '', {
 lastName: useFormControl('lastName', initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', '', {
 emailAddress: useFormControl('emailAddress', initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', '', {
 username: useFormControl('username', initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', '', {
 phoneNumber: useFormControl('phoneNumber', initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

11 changes: 6 additions & 5 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ function _SignUpStart(): JSX.Element {
 getInitialActiveIdentifier(attributes, userSettings.signUp.progressive),
 );
 const { t, locale } = useLocalizations();
 const initialValues = ctx.initialValues || {};
Comment thread
desiprisg marked this conversation as resolved.


 const [missingRequirementsWithTicket, setMissingRequirementsWithTicket] = React.useState(false);

Expand All@@ -51,27 +52,27 @@ function _SignUpStart(): JSX.Element {
 const { failedValidationsText } = usePasswordComplexity(passwordSettings);

 const formState = {
 firstName: useFormControl('firstName', signUp.firstName || '', {
 firstName: useFormControl('firstName', signUp.firstName || initialValues.firstName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__firstName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
 }),
 lastName: useFormControl('lastName', signUp.lastName || '', {
 lastName: useFormControl('lastName', signUp.lastName || initialValues.lastName || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__lastName'),
 placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
 }),
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || '', {
 emailAddress: useFormControl('emailAddress', signUp.emailAddress || initialValues.emailAddress || '', {
 type: 'email',
 label: localizationKeys('formFieldLabel__emailAddress'),
 placeholder: localizationKeys('formFieldInputPlaceholder__emailAddress'),
 }),
 username: useFormControl('username', signUp.username || '', {
 username: useFormControl('username', signUp.username || initialValues.username || '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__username'),
 placeholder: localizationKeys('formFieldInputPlaceholder__username'),
 }),
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || '', {
 phoneNumber: useFormControl('phoneNumber', signUp.phoneNumber || initialValues.phoneNumber || '', {
 type: 'tel',
 label: localizationKeys('formFieldLabel__phoneNumber'),
 placeholder: localizationKeys('formFieldInputPlaceholder__phoneNumber'),
Expand Down

32 changes: 32 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/__tests__/SignUpStart.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,4 +167,36 @@ describe('SignUpStart', () => {
 expect(screen.getByRole('textbox', { name: 'Phone number' })).toHaveValue('(123) 456-789');
 });
 });

 describe('initialValues', () => {
 it('prefills the emailAddress field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withEmailAddress();
 });
 props.setProps({ initialValues: { emailAddress: 'foo@clerk.com' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo@clerk.com/i);
 });

 it('prefills the phoneNumber field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withPhoneNumber();
 });
 props.setProps({ initialValues: { phoneNumber: '+306911111111' } });

 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/691 1111111/i);
 });

 it('prefills the username field with the correct initial value', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withUsername();
 });

 props.setProps({ initialValues: { username: 'foo' } });
 render(<SignUpStart />, { wrapper });
 screen.getByDisplayValue(/foo/i);
 });
 });
});
Loading