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.

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

refactor: use react hook form in edit file form #1531

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 1 addition & 7 deletions src/components/item/edit/EditModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,7 @@ const EditModal = ({ item, onClose, open }: Props): JSX.Element => {
return <DocumentForm setChanges={setChanges} item={item} />;
case ItemType.LOCAL_FILE:
case ItemType.S3_FILE:
return (
<FileForm
updatedProperties={updatedItem}
setChanges={setChanges}
item={item}
/>
);
return <FileForm setChanges={setChanges} item={item} />;
case ItemType.SHORTCUT:
return (
<NameForm
Expand Down
122 changes: 76 additions & 46 deletions src/components/item/form/FileForm.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
import { useEffect } from 'react';
import { useForm } from 'react-hook-form';

import { TextField } from '@mui/material';

import { FileItemProperties, ItemType, MimeTypes } from '@graasp/sdk';
import {
DescriptionPlacementType,
DiscriminatedItem,
ItemType,
LocalFileItemExtra,
LocalFileItemType,
MimeTypes,
S3FileItemExtra,
S3FileItemType,
} from '@graasp/sdk';

import { useBuilderTranslation } from '@/config/i18n';
import { ITEM_FORM_IMAGE_ALT_TEXT_EDIT_FIELD_ID } from '@/config/selectors';
Expand All @@ -11,71 +23,89 @@ import type { EditModalContentPropType } from '../edit/EditModal';
import DescriptionForm from './DescriptionForm';
import NameForm from './NameForm';

const FileForm = (props: EditModalContentPropType): JSX.Element | null => {
const { item, setChanges, updatedProperties } = props;
type Inputs = {
name: string;
altText: string;
description: string;
descriptionPlacement: DescriptionPlacementType;
};

const FileForm = ({
item,
setChanges,
}: {
item: DiscriminatedItem;
setChanges: EditModalContentPropType['setChanges'];
}): JSX.Element | null => {
const { t: translateBuilder } = useBuilderTranslation();
const { register, watch, setValue } = useForm<Inputs>();
const altText = watch('altText');
const description = watch('description');
const descriptionPlacement = watch('descriptionPlacement');
const name = watch('name');

if (!item) {
return null;
}
useEffect(() => {
let newExtra: S3FileItemExtra | LocalFileItemExtra | undefined;

if (item.type === ItemType.S3_FILE) {
newExtra = {
[ItemType.S3_FILE]: {
...item.extra[ItemType.S3_FILE],
altText,
},
};
} else if (item.type === ItemType.LOCAL_FILE) {
newExtra = {
[ItemType.LOCAL_FILE]: {
...item.extra[ItemType.LOCAL_FILE],
altText,
},
};
}

setChanges({
name,
description,
settings: { descriptionPlacement },
extra: newExtra,
} as S3FileItemType | LocalFileItemType);

// eslint-disable-next-line react-hooks/exhaustive-deps
}, [altText, description, descriptionPlacement, name, setChanges]);

if (
item &&
(item.type === ItemType.LOCAL_FILE || item.type === ItemType.S3_FILE) &&
(updatedProperties.type === ItemType.LOCAL_FILE ||
updatedProperties.type === ItemType.S3_FILE)
) {
if (item) {
const itemExtra = getExtraFromPartial(item);
const { mimetype, altText } = itemExtra;
const updatedExtra = updatedProperties.extra
? getExtraFromPartial(updatedProperties)
: {};
const { mimetype, altText: previousAltText } = itemExtra;
return (
<>
<NameForm
setChanges={setChanges}
name={updatedProperties?.name ?? item?.name}
/>
<NameForm nameForm={register('name', { value: item.name })} />
{mimetype && MimeTypes.isImage(mimetype) && (
<TextField
variant="standard"
id={ITEM_FORM_IMAGE_ALT_TEXT_EDIT_FIELD_ID}
label={translateBuilder(BUILDER.EDIT_ITEM_IMAGE_ALT_TEXT_LABEL)}
value={updatedExtra?.altText ?? altText}
onChange={(e) => {
const newExtra = {
...itemExtra,
...updatedExtra,
altText: e.target.value,
} as FileItemProperties;

setChanges(
item.type === ItemType.S3_FILE
? {
extra: {
[ItemType.S3_FILE]: newExtra,
},
}
: {
extra: { [ItemType.LOCAL_FILE]: newExtra },
},
);
}}
// always shrink because setting name from defined app does not shrink automatically
InputLabelProps={{ shrink: true }}
sx={{ width: '50%', my: 1 }}
multiline
{...register('altText', { value: previousAltText })}
/>
)}
<DescriptionForm
setChanges={setChanges}
description={
updatedProperties?.description ?? item?.description ?? ''
}
setChanges={(v) => {
if (v.description) {
setValue('description', v.description);
}
if (v.settings?.descriptionPlacement) {
setValue(
'descriptionPlacement',
v.settings?.descriptionPlacement,
);
}
}}
description={description ?? item?.description ?? ''}
descriptionPlacement={
updatedProperties?.settings?.descriptionPlacement ??
item?.settings?.descriptionPlacement
descriptionPlacement ?? item?.settings?.descriptionPlacement
}
/>
</>
Expand Down
2 changes: 1 addition & 1 deletion src/components/item/form/FolderForm.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const FolderForm = ({
setValue('description', v.description);
}
if (v.settings?.descriptionPlacement) {
setValue('description', v.settings?.descriptionPlacement);
setValue('descriptionPlacement', v.settings?.descriptionPlacement);
}
}}
showPlacement={false}
Expand Down