@wordpress/components
Version:
UI components for WordPress.
98 lines (97 loc) • 3.56 kB
JavaScript
import clsx from "clsx";
import { __ } from "@wordpress/i18n";
import { useState } from "@wordpress/element";
import { Icon, upload } from "@wordpress/icons";
import { getFilesFromDataTransfer } from "@wordpress/dom";
import { __experimentalUseDropZone } from "@wordpress/compose";
import { jsx, jsxs } from "react/jsx-runtime";
// packages/components/src/drop-zone/index.tsx
/**
* `DropZone` is a component creating a drop zone area taking the full size of its parent element. It supports dropping files, HTML content or any other HTML drop event.
*
* ```jsx
* import { DropZone } from '@wordpress/components';
* import { useState } from '@wordpress/element';
*
* const MyDropZone = () => {
* const [ hasDropped, setHasDropped ] = useState( false );
*
* return (
* <div>
* { hasDropped ? 'Dropped!' : 'Drop something here' }
* <DropZone
* onFilesDrop={ () => setHasDropped( true ) }
* onHTMLDrop={ () => setHasDropped( true ) }
* onDrop={ () => setHasDropped( true ) }
* />
* </div>
* );
* }
* ```
*/
function DropZoneComponent({ className, icon = upload, label, onFilesDrop, onHTMLDrop, onDrop, isEligible = () => true, ...restProps }) {
const [isDraggingOverDocument, setIsDraggingOverDocument] = useState();
const [isDraggingOverElement, setIsDraggingOverElement] = useState();
const [isActive, setIsActive] = useState();
const ref = __experimentalUseDropZone({
onDrop(event) {
if (!event.dataTransfer) return;
const files = getFilesFromDataTransfer(event.dataTransfer);
const html = event.dataTransfer.getData("text/html");
/**
* From Windows Chrome 96, the `event.dataTransfer` returns both file object and HTML.
* The order of the checks is important to recognize the HTML drop.
*/
if (html && onHTMLDrop) onHTMLDrop(html);
else if (files.length && onFilesDrop) onFilesDrop(files);
else if (onDrop) onDrop(event);
},
onDragStart(event) {
setIsDraggingOverDocument(true);
if (!event.dataTransfer) return;
/**
* From Windows Chrome 96, the `event.dataTransfer` returns both file object and HTML.
* The order of the checks is important to recognize the HTML drop.
*/
if (event.dataTransfer.types.includes("text/html")) setIsActive(!!onHTMLDrop);
else if (event.dataTransfer.types.includes("Files") || getFilesFromDataTransfer(event.dataTransfer).length > 0) setIsActive(!!onFilesDrop);
else setIsActive(!!onDrop && isEligible(event.dataTransfer));
},
onDragEnd() {
setIsDraggingOverElement(false);
setIsDraggingOverDocument(false);
setIsActive(void 0);
},
onDragEnter() {
setIsDraggingOverElement(true);
},
onDragLeave() {
setIsDraggingOverElement(false);
}
});
const classes = clsx("components-drop-zone", className, {
"is-active": isActive,
"is-dragging-over-document": isDraggingOverDocument,
"is-dragging-over-element": isDraggingOverElement
});
return /* @__PURE__ */ jsx("div", {
...restProps,
ref,
className: classes,
children: /* @__PURE__ */ jsx("div", {
className: "components-drop-zone__content",
children: /* @__PURE__ */ jsxs("div", {
className: "components-drop-zone__content-inner",
children: [/* @__PURE__ */ jsx(Icon, {
icon,
className: "components-drop-zone__content-icon"
}), /* @__PURE__ */ jsx("span", {
className: "components-drop-zone__content-text",
children: label ? label : __("Drop files to upload")
})]
})
})
});
}
export { DropZoneComponent, DropZoneComponent as default };
//# sourceMappingURL=index.mjs.map