Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import "./FileDropZone.css";
import { useCallback, useEffect, useRef, useState } from "preact/hooks";
import { t } from "../../services/i18n";
import { isMobile } from "../../services/utils";
import ActionButton from "./ActionButton";
export interface FileDropZoneProps {
name?: string;
/** Reports the current selection after every change (picking, dropping, per-file removal, clearing); `null` when empty. */
onChange: (files: File[] | null) => void;
multiple?: boolean;
/** Optional `accept` attribute forwarded to the underlying file input (e.g. `".zip"`). */
accept?: string;
/**
* Overrides the click-to-browse action (e.g. open a native OS dialog on desktop instead of the
* in-page file input). Drag-and-drop still goes through `onChange`.
*/
onBrowse?: () => void;
/**
* Externally-controlled selection to display in place of the internal one — e.g. native picks whose
* filenames are known but which aren't `File` objects. When non-empty it wins; dropping files clears it.
*/
displayNames?: string[];
/**
* Desktop only: given the dropped files, try to route them through the native (in-place) import. Return
* `true` if handled — the upload `onChange` is then skipped; return `false` to fall back to upload.
*/
onNativeDrop?: (files: File[]) => Promise<boolean>;
/**
* Called when the user removes an *external* entry (`displayNames[index]`) via its per-file [X].
* Internal selections are trimmed by the zone itself and reported through `onChange`; callers
* passing `displayNames` must pass this too.
*/
onRemove?: (index: number) => void;
}
/**
* A styled drop region for selecting files: drag-and-drop onto it or click it to open the native file
* picker. Selected files are listed inside, each removable via its own [X]. Covers the same role as
* {@link FormFileUpload}, but reports the selection as a `File[]` (so per-file removal can be
* expressed) rather than the input's raw `FileList`.
*/
export default function FileDropZone({ name, onChange, multiple, accept, onBrowse, displayNames, onNativeDrop, onRemove }: FileDropZoneProps) {
const inputRef = useRef<HTMLInputElement>(null);
const [files, setFiles] = useState<File[]>([]);
const [dragging, setDragging] = useState(false);
// Tracks dragenter/dragleave depth so moving the cursor over child elements doesn't flicker the
// highlight (dragleave fires when crossing between nested children, not just on leaving the zone).
const dragDepth = useRef(0);
// Reset any stale selection carried over from a previous mount of this widget.
useEffect(() => { onChange(null); }, []);
// An external selection wins, so drop the internal list to keep it from lingering underneath.
useEffect(() => {
if (displayNames?.length) {
setFiles([]);
}
}, [displayNames]);
const update = useCallback((list: FileList | null) => {
const selected = list && list.length ? (multiple ? Array.from(list) : [list[0]]) : [];
setFiles(selected);
onChange(selected.length ? selected : null);
}, [multiple, onChange]);
const onDragEnter = useCallback((e: DragEvent) => {
e.preventDefault();
dragDepth.current++;
setDragging(true);
}, []);
const onDragLeave = useCallback(() => {
dragDepth.current = Math.max(0, dragDepth.current - 1);
if (dragDepth.current === 0) {
setDragging(false);
}
}, []);
const onDrop = useCallback(async (e: DragEvent) => {
e.preventDefault();
dragDepth.current = 0;
setDragging(false);
const dropped = e.dataTransfer?.files;
if (!dropped || !dropped.length) {
return;
}
// On desktop, try the native in-place route first; only fall back to upload if it didn't handle the
// drop. Capture the File list before any await so it survives the event being recycled.
if (onNativeDrop && await onNativeDrop(Array.from(dropped))) {
return;
}
update(dropped);
}, [update, onNativeDrop]);
// Removes a single entry. An external (native) selection belongs to the caller, so its entries go
// through onRemove; internal ones are trimmed here and reported via onChange. The input's value is
// dropped so its stale FileList can't resurface and re-picking the same file still fires a change event.
const removeAt = useCallback((e: MouseEvent, index: number) => {
e.preventDefault();
e.stopPropagation();
if (displayNames?.length) {
onRemove?.(index);
return;
}
if (inputRef.current) {
inputRef.current.value = "";
}
const remaining = files.filter((_, i) => i !== index);
setFiles(remaining);
onChange(remaining.length ? remaining : null);
}, [displayNames, files, onChange, onRemove]);
// An external (native) selection takes precedence over whatever the in-page input/drop produced.
const selectedNames = displayNames?.length ? displayNames : files.map((file) => file.name);
return (
<label
className={`file-drop-zone ${dragging ? "dragging" : ""} ${selectedNames.length ? "has-files" : ""}`}
// When the caller overrides browsing (desktop native dialog), stop the label from opening the
// in-page file input and call the override instead. Drag-and-drop is unaffected.
onClick={onBrowse ? (e) => { e.preventDefault(); onBrowse(); } : undefined}
onDragEnter={onDragEnter}
onDragOver={(e) => e.preventDefault()}
onDragLeave={onDragLeave}
onDrop={(e) => void onDrop(e)}
>
<input
ref={inputRef}
name={name}
type="file"
className="file-drop-zone-input"
multiple={multiple}
accept={accept}
onChange={(e) => update((e.target as HTMLInputElement).files)}
/>
{selectedNames.length ? (
<div className="file-drop-zone-selection">
<ul className="file-drop-zone-files">
{selectedNames.map((fileName, index) => (
<li key={index}>
<span className="bx bx-file-blank" />
<span className="file-drop-zone-filename">{fileName}</span>
<ActionButton
className="file-drop-zone-remove"
icon="bx bx-x"
text={t("file_upload.remove_file")}
tooltipClass="tooltip-top"
onClick={(e) => removeAt(e, index)}
/>
</li>
))}
</ul>
</div>
) : (
<div className="file-drop-zone-prompt">
<span className="bx bx-cloud-upload file-drop-zone-icon" />
<span>{isMobile()
? (multiple ? t("file_upload.browse_multiple") : t("file_upload.browse_single"))
: (multiple ? t("file_upload.drop_or_browse_multiple") : t("file_upload.drop_or_browse_single"))}</span>
</div>
)}
</label>
);
}