Files
payloadcms/packages/ui/src/elements/BulkUpload/FileSidebar/index.tsx
Alessio Gravili 59414bd8f1 feat(richtext-lexical): support copy & pasting and drag & dopping files/images into the editor (#13868)
This PR adds support for inserting images into the rich text editor via
both **copy & paste** and **drag & drop**, whether from local files or
image DOM nodes.

It leverages the bulk uploads UI to provide a smooth workflow for:
- Selecting the target collection
- Filling in any required fields defined on the uploads collection
- Uploading multiple images at once

This significantly improves the UX for adding images to rich text, and
also works seamlessly when pasting images from external editors like
Google Docs or Microsoft Word.

Test pre-release: `3.57.0-internal.801ab5a`

## Showcase - drag & drop images from computer


https://github.com/user-attachments/assets/c558c034-d2e4-40d8-9035-c0681389fb7b

## Showcase - copy & paste images from computer


https://github.com/user-attachments/assets/f36faf94-5274-4151-b141-00aff2b0efa4

## Showcase - copy & paste image DOM nodes


https://github.com/user-attachments/assets/2839ed0f-3f28-4e8d-8b47-01d0cb947edc

---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1211217132290841
2025-09-24 15:04:46 +00:00

288 lines
9.6 KiB
TypeScript

'use client'
import { useModal } from '@faceless-ui/modal'
import { useWindowInfo } from '@faceless-ui/window-info'
import { isImage } from 'payload/shared'
import React from 'react'
import { SelectInput } from '../../../fields/Select/Input.js'
import { ChevronIcon } from '../../../icons/Chevron/index.js'
import { XIcon } from '../../../icons/X/index.js'
import { useConfig } from '../../../providers/Config/index.js'
import { useTranslation } from '../../../providers/Translation/index.js'
import { AnimateHeight } from '../../AnimateHeight/index.js'
import { Button } from '../../Button/index.js'
import { Drawer } from '../../Drawer/index.js'
import { ErrorPill } from '../../ErrorPill/index.js'
import { Pill } from '../../Pill/index.js'
import { ShimmerEffect } from '../../ShimmerEffect/index.js'
import { createThumbnail } from '../../Thumbnail/createThumbnail.js'
import { Thumbnail } from '../../Thumbnail/index.js'
import { Actions } from '../ActionsBar/index.js'
import { AddFilesView } from '../AddFilesView/index.js'
import './index.scss'
import { useFormsManager } from '../FormsManager/index.js'
import { useBulkUpload } from '../index.js'
const addMoreFilesDrawerSlug = 'bulk-upload-drawer--add-more-files'
const baseClass = 'file-selections'
export function FileSidebar() {
const {
activeIndex,
addFiles,
forms,
isInitializing,
removeFile,
setActiveIndex,
totalErrorCount,
} = useFormsManager()
const { initialFiles, initialForms, maxFiles } = useBulkUpload()
const { i18n, t } = useTranslation()
const { closeModal, openModal } = useModal()
const [showFiles, setShowFiles] = React.useState(false)
const { breakpoints } = useWindowInfo()
const handleRemoveFile = React.useCallback(
(indexToRemove: number) => {
removeFile(indexToRemove)
},
[removeFile],
)
const handleAddFiles = React.useCallback(
(filelist: FileList) => {
void addFiles(filelist)
closeModal(addMoreFilesDrawerSlug)
},
[addFiles, closeModal],
)
const getFileSize = React.useCallback((file: File) => {
const size = file.size
const i = size === 0 ? 0 : Math.floor(Math.log(size) / Math.log(1024))
const decimals = i > 1 ? 1 : 0
const formattedSize =
(size / Math.pow(1024, i)).toFixed(decimals) + ' ' + ['B', 'kB', 'MB', 'GB', 'TB'][i]
return formattedSize
}, [])
const totalFileCount = isInitializing
? (initialFiles?.length ?? initialForms?.length)
: forms.length
const {
collectionSlug: bulkUploadCollectionSlug,
selectableCollections,
setCollectionSlug,
} = useBulkUpload()
const { getEntityConfig } = useConfig()
return (
<div
className={[baseClass, showFiles && `${baseClass}__showingFiles`].filter(Boolean).join(' ')}
>
{breakpoints.m && showFiles ? <div className={`${baseClass}__mobileBlur`} /> : null}
<div className={`${baseClass}__header`}>
{selectableCollections?.length > 1 && (
<SelectInput
className={`${baseClass}__collectionSelect`}
isClearable={false}
name="groupBy"
onChange={(e) => {
const val: string =
typeof e === 'object' && 'value' in e
? (e?.value as string)
: (e as unknown as string)
setCollectionSlug(val)
}}
options={
selectableCollections?.map((coll) => {
const config = getEntityConfig({ collectionSlug: coll })
return { label: config.labels.singular, value: config.slug }
}) || []
}
path="groupBy"
required
value={bulkUploadCollectionSlug}
/>
)}
<div className={`${baseClass}__headerTopRow`}>
<div className={`${baseClass}__header__text`}>
<ErrorPill count={totalErrorCount} i18n={i18n} withMessage />
<p>
<strong
title={`${totalFileCount} ${t(totalFileCount > 1 ? 'upload:filesToUpload' : 'upload:fileToUpload')}`}
>
{totalFileCount}{' '}
{t(totalFileCount > 1 ? 'upload:filesToUpload' : 'upload:fileToUpload')}
</strong>
</p>
</div>
<div className={`${baseClass}__header__actions`}>
{(typeof maxFiles === 'number' ? totalFileCount < maxFiles : true) ? (
<Pill
className={`${baseClass}__header__addFile`}
onClick={() => openModal(addMoreFilesDrawerSlug)}
size="small"
>
{t('upload:addFile')}
</Pill>
) : null}
<Button
buttonStyle="transparent"
className={`${baseClass}__toggler`}
onClick={() => setShowFiles((prev) => !prev)}
>
<span className={`${baseClass}__toggler__label`}>
<strong
title={`${totalFileCount} ${t(totalFileCount > 1 ? 'upload:filesToUpload' : 'upload:fileToUpload')}`}
>
{totalFileCount}{' '}
{t(totalFileCount > 1 ? 'upload:filesToUpload' : 'upload:fileToUpload')}
</strong>
</span>
<ChevronIcon direction={showFiles ? 'down' : 'up'} />
</Button>
<Drawer gutter={false} Header={null} slug={addMoreFilesDrawerSlug}>
<AddFilesView
onCancel={() => closeModal(addMoreFilesDrawerSlug)}
onDrop={handleAddFiles}
/>
</Drawer>
</div>
</div>
<div className={`${baseClass}__header__mobileDocActions`}>
<Actions />
</div>
</div>
<div className={`${baseClass}__animateWrapper`}>
<AnimateHeight height={!breakpoints.m || showFiles ? 'auto' : 0}>
<div className={`${baseClass}__filesContainer`}>
{isInitializing &&
forms.length === 0 &&
(initialFiles?.length > 0 || initialForms?.length > 0)
? (initialFiles ? Array.from(initialFiles) : initialForms).map((file, index) => (
<ShimmerEffect
animationDelay={`calc(${index} * ${60}ms)`}
height="35px"
key={index}
/>
))
: null}
{forms.map(({ errorCount, formID, formState }, index) => {
const currentFile = (formState?.file?.value as File) || ({} as File)
return (
<div
className={[
`${baseClass}__fileRowContainer`,
index === activeIndex && `${baseClass}__fileRowContainer--active`,
errorCount && errorCount > 0 && `${baseClass}__fileRowContainer--error`,
]
.filter(Boolean)
.join(' ')}
key={formID}
>
<button
className={`${baseClass}__fileRow`}
onClick={() => setActiveIndex(index)}
type="button"
>
<SidebarThumbnail file={currentFile} formID={formID} />
<div className={`${baseClass}__fileDetails`}>
<p className={`${baseClass}__fileName`} title={currentFile.name}>
{currentFile.name || t('upload:noFile')}
</p>
</div>
{currentFile instanceof File ? (
<p className={`${baseClass}__fileSize`}>{getFileSize(currentFile)}</p>
) : null}
<div className={`${baseClass}__remove ${baseClass}__remove--underlay`}>
<XIcon />
</div>
{errorCount ? (
<ErrorPill
className={`${baseClass}__errorCount`}
count={errorCount}
i18n={i18n}
/>
) : null}
</button>
<button
aria-label={t('general:remove')}
className={`${baseClass}__remove ${baseClass}__remove--overlay`}
onClick={() => handleRemoveFile(index)}
type="button"
>
<XIcon />
</button>
</div>
)
})}
</div>
</AnimateHeight>
</div>
</div>
)
}
function SidebarThumbnail({ file, formID }: { file: File; formID: string }) {
const [thumbnailURL, setThumbnailURL] = React.useState<null | string>(null)
const [isLoading, setIsLoading] = React.useState(true)
React.useEffect(() => {
let isCancelled = false
async function generateThumbnail() {
setIsLoading(true)
setThumbnailURL(null)
try {
if (isImage(file.type)) {
const url = await createThumbnail(file)
if (!isCancelled) {
setThumbnailURL(url)
}
} else {
setThumbnailURL(null)
}
} catch (_) {
if (!isCancelled) {
setThumbnailURL(null)
}
} finally {
if (!isCancelled) {
setIsLoading(false)
}
}
}
void generateThumbnail()
return () => {
isCancelled = true
}
}, [file])
if (isLoading) {
return <ShimmerEffect className={`${baseClass}__thumbnail-shimmer`} disableInlineStyles />
}
return (
<Thumbnail
className={`${baseClass}__thumbnail`}
fileSrc={thumbnailURL}
key={`${formID}-${thumbnailURL || 'placeholder'}`}
/>
)
}