Skip to content
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

Replace individual autofill buttons on name and ORCID with single button #205

Merged
merged 1 commit into from
Dec 3, 2024
+101 −112
Merged

Replace individual autofill buttons on name and ORCID with single button #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ export interface User {
orcid: string;
name: string;
is_admin: boolean;
email?: string | null;
}

interface SubmissionMetadataBase {
Expand Down
212 changes: 100 additions & 112 deletions src/components/StudyForm/StudyForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import React from "react";
import {
IonButton,
IonIcon,
IonInput,
IonItem,
IonLabel,
IonSelect,
IonSelectOption,
IonText,
Expand All @@ -13,7 +14,6 @@ import SectionHeader from "../SectionHeader/SectionHeader";
import { SubmissionMetadataCreate, TEMPLATES } from "../../api";
import { Controller, useForm } from "react-hook-form";
import { useStore } from "../../Store";
import { colorWand as autoFill } from "ionicons/icons";
import { StepType } from "@reactour/tour";
import styles from "./StudyForm.module.css";
import { useAppTour } from "../AppTourProvider/hooks";
Expand Down Expand Up @@ -87,6 +87,17 @@ const StudyForm: React.FC<StudyFormProps> = ({
disabled,
});

const handlePIAutoFill = () => {
if (loggedInUser === null) {
return;
}
setValue("metadata_submission.studyForm.piName", loggedInUser.name);
if (loggedInUser.email) {
eecavanna marked this conversation as resolved.
Show resolved Hide resolved
setValue("metadata_submission.studyForm.piEmail", loggedInUser.email);
}
setValue("metadata_submission.studyForm.piOrcid", loggedInUser.orcid);
};

return (
<form onSubmit={handleSubmit(onSave)}>
<div className="ion-padding">
Expand Down Expand Up @@ -153,112 +164,89 @@ const StudyForm: React.FC<StudyFormProps> = ({

<SectionHeader>Principal Investigator</SectionHeader>

<div className="ion-padding">
<Controller
name="metadata_submission.studyForm.piName"
control={control}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
label="Name"
helperText="The Principal Investigator who led the study and/or generated the data."
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
>
{/* If the user is logged in, show a button they can press to use their name. */}
{loggedInUser !== null ? (
<IonButton
fill={"clear"}
slot={"end"}
title={"Use my name"}
aria-label={"Use my name"}
onClick={() => setValue(field.name, loggedInUser.name)}
disabled={field.value === loggedInUser.name}
>
<IonIcon
slot={"icon-only"}
icon={autoFill}
color={"primary"}
aria-hidden={"true"}
/>
</IonButton>
) : null}
</IonInput>
)}
/>
<div className="ion-padding-bottom">
<div className="ion-padding-horizontal">
<Controller
name="metadata_submission.studyForm.piName"
control={control}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
label="Name"
helperText="The Principal Investigator who led the study and/or generated the data."
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
/>
)}
/>

<Controller
name="metadata_submission.studyForm.piEmail"
control={control}
rules={{
required: "This field is required",
validate: {
validEmail: (value: string) =>
EMAIL_REGEX.test(value) || "Not a valid email address",
},
}}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
helperText="An email address for the Principal Investigator."
errorText={fieldState.error?.message}
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
>
<div slot="label">
Email
<RequiredMark />
</div>
</IonInput>
)}
/>
<Controller
name="metadata_submission.studyForm.piEmail"
control={control}
rules={{
required: "This field is required",
validate: {
validEmail: (value: string) =>
EMAIL_REGEX.test(value) || "Not a valid email address",
},
}}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
helperText="An email address for the Principal Investigator."
errorText={fieldState.error?.message}
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
>
<div slot="label">
Email
<RequiredMark />
</div>
</IonInput>
)}
/>

<Controller
name="metadata_submission.studyForm.piOrcid"
control={control}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
label="ORCID iD"
helperText="ORCID iD of the Principal Investigator."
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
>
{/* If the user is logged in, show a button they can press to use their ORCID iD. */}
{loggedInUser !== null ? (
<IonButton
fill={"clear"}
slot={"end"}
title={"Use my ORCID iD"}
aria-label={"Use my ORCID iD"}
onClick={() => setValue(field.name, loggedInUser.orcid)}
disabled={field.value === loggedInUser.orcid}
>
<IonIcon
slot={"icon-only"}
icon={autoFill}
color={"primary"}
aria-hidden={"true"}
/>
</IonButton>
) : null}
</IonInput>
)}
/>
<Controller
name="metadata_submission.studyForm.piOrcid"
control={control}
render={({ field, fieldState }) => (
<IonInput
className={`${(fieldState.isTouched || formState.isSubmitted) && "ion-touched"} ${fieldState.invalid && "ion-invalid"}`}
label="ORCID iD"
helperText="ORCID iD of the Principal Investigator."
labelPlacement="floating"
type="text"
onIonBlur={field.onBlur}
onIonInput={field.onChange}
{...field}
/>
)}
/>
</div>
{loggedInUser !== null && (
<IonItem
button
detail={false}
type="button"
onClick={handlePIAutoFill}
tabIndex={-1}
>
<IonLabel color="primary">
<h3>I am the Study&apos;s Principal Investigator</h3>
</IonLabel>
</IonItem>
)}
</div>

<SectionHeader>Environment</SectionHeader>

<div className="ion-padding">
<div className="ion-padding-horizontal ion-padding-bottom">
<Controller
name="metadata_submission.packageName"
rules={{ required: "This field is required" }}
Expand Down Expand Up @@ -295,17 +283,17 @@ const StudyForm: React.FC<StudyFormProps> = ({
</>
)}
/>

<IonButton
data-tour={`${TourId.StudyForm}-3`}
expand="block"
className="ion-margin-top"
type="submit"
disabled={disabled || (formState.isDirty && !formState.isValid)}
>
{formState.isSubmitting ? "Saving" : "Save"}
</IonButton>
</div>

<IonButton
data-tour={`${TourId.StudyForm}-3`}
expand="block"
className="ion-padding-horizontal"
type="submit"
disabled={disabled || (formState.isDirty && !formState.isValid)}
>
{formState.isSubmitting ? "Saving" : "Save"}
</IonButton>
</form>
);
};
Expand Down
Loading