Skip to content

(feat): O3-3685: Enable Deleting or Clearing Files in File Picker Component in Edit Mode #453

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+110 −5
Open

(feat): O3-3685: Enable Deleting or Clearing Files in File Picker Component in Edit Mode #453

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
50 changes: 49 additions & 1 deletion src/components/inputs/file/file.component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import { FileUploader, Button } from '@carbon/react';
import { useTranslation } from 'react-i18next';
import { isTrue } from '../../../utils/boolean-utils';
import Camera from './camera/camera.component';
import { Close, DocumentPdf } from '@carbon/react/icons';
import { Close, DocumentPdf, TrashCan } from '@carbon/react/icons';
import styles from './file.scss';
import { type FormFieldInputProps } from '../../../types';
import { useFormProviderContext } from '../../../provider/form-provider';
import { isViewMode } from '../../../utils/common-utils';
import FieldValueView from '../../value/view/field-value-view.component';
import FieldLabel from '../../field-label/field-label.component';
import { deleteAttachmentPermanently, showSnackbar, useAbortController } from '@openmrs/esm-framework';

type DataSourceType = 'filePicker' | 'camera' | null;

Expand All @@ -20,6 +21,34 @@ const File: React.FC<FormFieldInputProps> = ({ field, value, setFieldValue }) =>
const [dataSource, setDataSource] = useState<DataSourceType>(null);
const { sessionMode } = useFormProviderContext();

const abortController = useAbortController();

const handleDeleteAttachment = useCallback(() => {
if (value && value.id) {
deleteAttachmentPermanently(value.id, abortController)
.then(() => {
setFieldValue(null);
showSnackbar({
title: t('fileDeleted', 'File deleted'),
subtitle: t('successfullyDeleted', 'File successfully deleted'),
kind: 'success',
isLowContrast: true,
});
})
.catch((error) => {
if (error.name !== 'AbortError') {
showSnackbar({
title: t('error', 'Error'),
subtitle: t('failedDeleting', "File couldn't be deleted"),
kind: 'error',
});
}
});
} else {
setFieldValue(null);
}
}, [value, setFieldValue, t, abortController]);

const labelDescription = useMemo(() => {
return field.questionOptions.allowedFileTypes
? t(
Expand Down Expand Up @@ -87,6 +116,25 @@ const File: React.FC<FormFieldInputProps> = ({ field, value, setFieldValue }) =>
{t('cameraCapture', 'Camera capture')}
</Button>
</div>
{value && !isViewMode(sessionMode) && (
<div className={styles.attachmentContainer}>
{(Array.isArray(value) ? value : [value]).map((file, index) => (
<div key={index} className={styles.attachmentPreview}>
{file.bytesContentFamily === 'PDF' ? (
<div className={styles.pdfThumbnail}>
<DocumentPdf size={24} />
</div>
) : (
file.src && <img src={file.src} alt="Preview" width="200px" />
)}
<div className={styles.trashCanContainer}>
<span className={styles.trashTooltip}>{t('clearFile', 'Clear file')}</span>
<TrashCan className={styles.trashIcon} onClick={handleDeleteAttachment} size={20} />
</div>
</div>
))}
</div>
)}
Comment on lines +119 to +137
Copy link

Choose a reason for hiding this comment

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

Hi @lucyjemutai as @samuelmale has mentioned there is dual rendering of the images that are being uploaded one in the attachmentContainer (with the trash can icon) other in editModeImage (as a preview), in my suggestion it would be better to have the editModeImage removed and modify the attachmentContainer post this the discussion on the UX-design channel can made in the channel.

Suggested change
{value && !isViewMode(sessionMode) && (
<div className={styles.attachmentContainer}>
{(Array.isArray(value) ? value : [value]).map((file, index) => (
<div key={index} className={styles.attachmentPreview}>
{file.bytesContentFamily === 'PDF' ? (
<div className={styles.pdfThumbnail}>
<DocumentPdf size={24} />
</div>
) : (
file.src && <img src={file.src} alt="Preview" width="200px" />
)}
<div className={styles.trashCanContainer}>
<span className={styles.trashTooltip}>{t('clearFile', 'Clear file')}</span>
<TrashCan className={styles.trashIcon} onClick={handleDeleteAttachment} size={20} />
</div>
</div>
))}
</div>
)}
{value && !isViewMode(sessionMode) && (
<div className={styles.attachmentContainer}>
{(Array.isArray(value) ? value : [value]).map((file, index) => (
<div key={index} className={styles.attachmentPreview}>
{file.bytesContentFamily === 'PDF' ? (
<div className={styles.pdfThumbnail}>
<DocumentPdf size={24} />
<div className={styles.trashCanContainer}>
<span className={styles.trashTooltip}>{t('clearFile', 'Clear file')}</span>
<TrashCan
className={styles.trashIcon}
onClick={handleDeleteAttachment}
size={20}
aria-label={t('clearFile', 'Clear file')}
role="button"
tabIndex={0}
/>
</div>
</div>
) : (
file.src && (
<div className={styles.imagePreview}>
<img src={file.src} alt="Preview" width="200px" />
<div className={styles.trashCanContainer}>
<span className={styles.trashTooltip}>{t('clearFile', 'Clear file')}</span>
<TrashCan
className={styles.trashIcon}
onClick={handleDeleteAttachment}
size={20}
aria-label={t('clearFile', 'Clear file')}
role="button"
tabIndex={0}
/>
</div>
</div>
)
)}
</div>
))}
</div>
)}

</div>
{!dataSource && value && (
<div className={styles.editModeImage}>
Expand Down
65 changes: 61 additions & 4 deletions src/components/inputs/file/file.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,7 @@
display: flex;
align-items: center;
margin-bottom: 1rem;
}

.selectorButton {
margin-right: 1rem;
flex-wrap: wrap;
}

.caption {
Expand Down Expand Up @@ -90,6 +87,66 @@
padding: 1rem;
}

.selectorButton {
margin-right: 1rem;
margin-bottom: 0.5rem;
}

.attachmentContainer {
display: flex;
flex-wrap: wrap;
gap: 1rem;
}

.trashCanContainer {
position: relative;
cursor: pointer;
display: flex;
align-items: center;
justify-content: center;
}

.trashIcon {
font-size: 20px;
color: red;
transition: transform 0.3s ease;
}

.trashIcon:hover {
transform: scale(1.2);
}
.trashTooltip {
position: absolute;
bottom: 30px;
left: 50%;
transform: translateX(-50%);
background-color: #333;
color: white;
padding: 5px 10px;
border-radius: 4px;
font-size: 12px;
white-space: nowrap;
opacity: 0;
visibility: hidden;
transition: opacity 0.3s ease-in-out;
}

.trashCanContainer:hover .trashTooltip {
opacity: 1;
visibility: visible;
}

.attachmentPreview {
position: relative;
display: inline-block;
}

.attachmentPreview img {
max-width: 200px;
border: 1px solid #ccc;
border-radius: 8px;
}

.pdfThumbnail {
cursor: pointer;
background-color: gray;
Expand Down
Loading