Skip to content

chore(clerk-js): Replace text and email fields with Form.PlainInput #2036

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
panteliselef merged 2 commits into from
Nov 6, 2023
Merged

chore(clerk-js): Replace text and email fields with Form.PlainInput #2036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e96b015
chore(clerk-js): Replace text and email fields with Form.PlainInput
panteliselef Nov 3, 2023
92bfed2
chore(clerk-js): Localize the placeholder of the confirmation field w…
panteliselef Nov 3, 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
5 changes: 5 additions & 0 deletions .changeset/metal-cougars-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Replace Form.Control with Form.PlainInput for text and email inputs.
7 changes: 7 additions & 0 deletions .changeset/pretty-months-greet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Localize placeholder of confirmation field when deleting a user account from `<UserProfile/>`.
16 changes: 8 additions & 8 deletions packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,21 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
onAvatarRemove={file ? onAvatarRemove : null}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.Control
sx={{ flexBasis: '80%' }}
autoFocus
<Form.PlainInput
{...nameField.props}
sx={{ flexBasis: '80%' }}
onChange={onChangeName}
required
isRequired
autoFocus
/>
</Form.ControlRow>
<Form.ControlRow elementId={slugField.id}>
<Form.Control
sx={{ flexBasis: '80%' }}
<Form.PlainInput
{...slugField.props}
onChange={onChangeSlug}
sx={{ flexBasis: '80%' }}
icon={QuestionMark}
required
onChange={onChangeSlug}
isRequired
/>
</Form.ControlRow>
<FormButtonContainer>
Expand Down
5 changes: 1 addition & 4 deletions packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP
<Text localizationKey={actionDescription} />

<Form.ControlRow elementId={confirmationField.id}>
<Form.Control
{...confirmationField.props}
required
/>
<Form.PlainInput {...confirmationField.props} />

@anagstef anagstef Nov 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ Shouldn't this have the isRequired property?

@panteliselef panteliselef Nov 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

the hook above is defined as

  const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
...
    isRequired: true,
...
  });

so we are good

</Form.ControlRow>

<FormButtonContainer>
Expand Down
8 changes: 3 additions & 5 deletions packages/clerk-js/src/ui/components/OrganizationProfile/ProfileSettingsPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ export const ProfileSettingsPage = withCardStateProvider(() => {
const dataChanged = organization.name !== nameField.value || organization.slug !== slugField.value;
const canSubmit = (dataChanged || avatarChanged) && slugField.feedbackType !== 'error';

// eslint-disable-next-line @typescript-eslint/require-await
const onSubmit = async (e: React.FormEvent) => {
e.preventDefault();
return (dataChanged ? organization.update({ name: nameField.value, slug: slugField.value }) : Promise.resolve())
Expand Down Expand Up @@ -90,17 +89,16 @@ export const ProfileSettingsPage = withCardStateProvider(() => {
onAvatarRemove={isDefaultImage(organization.imageUrl) ? null : onAvatarRemove}
/>
<Form.ControlRow elementId={nameField.id}>
<Form.Control
<Form.PlainInput
{...nameField.props}
autoFocus
required
isRequired
/>
</Form.ControlRow>
<Form.ControlRow elementId={slugField.id}>
<Form.Control
<Form.PlainInput

@anagstef anagstef Nov 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ This was required before, right?

@panteliselef panteliselef Nov 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

with the previous implementation of FormControl required would be overriden with required={isRequired} which in this situation is false. After checking the tests we had for ProfileSettings and the signature of organization.update i decided to remove this completely.

{...slugField.props}
onChange={onChangeSlug}
required
/>
</Form.ControlRow>
<FormButtons isDisabled={!canSubmit} />
Expand Down
7 changes: 2 additions & 5 deletions packages/clerk-js/src/ui/components/UserProfile/DeletePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export const DeletePage = withCardStateProvider(() => {
type: 'text',
label: localizationKeys('formFieldLabel__confirmDeletion'),
isRequired: true,
placeholder: 'Delete account',
placeholder: localizationKeys('formFieldInputPlaceholder__confirmDeletionUserAccount'),
});

const canSubmit = confirmationField.value === 'Delete account';
Expand All @@ -45,10 +45,7 @@ export const DeletePage = withCardStateProvider(() => {
<Text localizationKey={localizationKeys('userProfile.deletePage.actionDescription')} />

<Form.ControlRow elementId={confirmationField.id}>
<Form.Control
{...confirmationField.props}
required
/>
<Form.PlainInput {...confirmationField.props} />

@anagstef anagstef Nov 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ Same question about required.

@panteliselef panteliselef Nov 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

isRequired is defined above in the hook, we should be good.

</Form.ControlRow>
<FormButtons
submitLabel={localizationKeys('userProfile.deletePage.confirm')}
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/components/UserProfile/EmailPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ export const EmailPage = withCardStateProvider(() => {

const canSubmit = emailField.value.length > 1 && user.username !== emailField.value;

// eslint-disable-next-line @typescript-eslint/require-await
const addEmail = async (e: React.FormEvent) => {
e.preventDefault();
return user
Expand All @@ -57,9 +56,8 @@ export const EmailPage = withCardStateProvider(() => {
>
<Form.Root onSubmit={addEmail}>
<Form.ControlRow elementId={emailField.id}>
<Form.Control
<Form.PlainInput

@anagstef anagstef Nov 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ required?

@panteliselef panteliselef Nov 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

prop is coming from the hook

{...emailField.props}
required
autoFocus
/>
</Form.ControlRow>
Expand Down
11 changes: 5 additions & 6 deletions packages/clerk-js/src/ui/components/UserProfile/ProfilePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@ export const ProfilePage = withCardStateProvider(() => {
type: 'text',
label: localizationKeys('formFieldLabel__firstName'),
placeholder: localizationKeys('formFieldInputPlaceholder__firstName'),
isRequired: last_name.required,
});
const lastNameField = useFormControl('lastName', user.lastName || '', {
type: 'text',
label: localizationKeys('formFieldLabel__lastName'),
placeholder: localizationKeys('formFieldInputPlaceholder__lastName'),
isRequired: last_name.required,
});

const userInfoChanged =
Expand All @@ -51,7 +53,6 @@ export const ProfilePage = withCardStateProvider(() => {

const nameEditDisabled = user.samlAccounts.some(sa => sa.active);

// eslint-disable-next-line @typescript-eslint/require-await
const onSubmit = async (e: React.FormEvent) => {
e.preventDefault();

Expand Down Expand Up @@ -104,19 +105,17 @@ export const ProfilePage = withCardStateProvider(() => {
/>
{showFirstName && (
<Form.ControlRow elementId={firstNameField.id}>
<Form.Control
autoFocus
<Form.PlainInput
{...firstNameField.props}
required={first_name.required}
isDisabled={nameEditDisabled}
autoFocus
/>
</Form.ControlRow>
)}
{showLastName && (
<Form.ControlRow elementId={lastNameField.id}>
<Form.Control
<Form.PlainInput
{...lastNameField.props}
required={last_name.required}
isDisabled={nameEditDisabled}
/>
</Form.ControlRow>
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export const enUS: LocalizationResource = {
formFieldInputPlaceholder__organizationSlug: '',
formFieldInputPlaceholder__organizationDomain: '',
formFieldInputPlaceholder__organizationDomainEmailAddress: '',
formFieldInputPlaceholder__confirmDeletionUserAccount: 'Delete account',
formFieldError__notMatchingPasswords: `Passwords don't match.`,
formFieldError__matchingPasswords: 'Passwords match.',
formFieldError__verificationLinkExpired: 'The verification link expired. Please request a new link.',
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/localization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ type _LocalizationResource = {
formFieldInputPlaceholder__organizationSlug: LocalizationValue;
formFieldInputPlaceholder__organizationDomain: LocalizationValue;
formFieldInputPlaceholder__organizationDomainEmailAddress: LocalizationValue;
formFieldInputPlaceholder__confirmDeletionUserAccount: LocalizationValue;
formFieldError__notMatchingPasswords: LocalizationValue;
formFieldError__matchingPasswords: LocalizationValue;
formFieldError__verificationLinkExpired: LocalizationValue;
Expand Down