--- title: DropZone description: "Dropzone allows file uploads through drag-and-drop functionality into a designated area on a page, or by activating a button. At present, Dropzone does not offer image upload preview capabilities. The use of object URLs directly in an image component is not possible due to the extension and host operating on separate domains. \ \ \ Any element focused within the Dropzone component, including child elements such as the 'Add file' button, will initiate the file selector when the Enter or Spacebar key is pressed. \ " api_version: 2025-01 api_name: customer-account-ui-extensions source_url: html: https://shopify.dev/docs/api/customer-account-ui-extensions/2025-01/components/dropzone md: https://shopify.dev/docs/api/customer-account-ui-extensions/2025-01/components/dropzone.md --- # Drop​Zone Dropzone allows file uploads through drag-and-drop functionality into a designated area on a page, or by activating a button. At present, Dropzone does not offer image upload preview capabilities. The use of object URLs directly in an image component is not possible due to the extension and host operating on separate domains. Any element focused within the Dropzone component, including child elements such as the 'Add file' button, will initiate the file selector when the Enter or Spacebar key is pressed. ## DropZoneProps * accept string A string representing the types of files that are accepted by the dropzone. This string is a comma-separated list of unique file type specifiers which can be one of the following: * A file extension starting with a period (".") character (e.g. .jpg, .pdf, .doc) * A valid MIME type string with no extensions If left empty, the dropzone will accept all files. * accessibilityLabel string A label that describes the purpose or contents of the item. When set, it will be announced to buyers using assistive technologies and will provide them with more context. * disabled boolean Whether the field can be modified. * error string | boolean Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately. * id string A unique identifier for the component. * label string Content to use as the field label. * multiple boolean Default: false Defines if the user can select or drop multiple files at once. * name string An identifier for the field that is unique within the nearest containing `Form` component. * onDropRejected (files: File\[]) => void Callback when rejected files are dropped. Files are rejected based on the `accept` prop. * onInput (files: File\[]) => void Callback when files are dropped or selected. * required boolean Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` prop. ### Examples * #### DropZone ##### React ```tsx import { DropZone, reactExtension, } from '@shopify/ui-extensions-react/customer-account'; import React from 'react'; export default reactExtension( 'customer-account.page.render', () => , ); function App() { return ; } ``` ##### JS ```js import {DropZone, extension} from '@shopify/ui-extensions/customer-account'; export default extension('customer-account.page.render', (root, api) => { renderApp(root, api); }); async function renderApp(root, api) { const dropZone = root.createComponent(DropZone, { accept: 'image/*', }); root.append(dropZone); } ``` ## Preview ![An image showcasing the DropZone component with a button to add files with error and dragged over states.](https://shopify.dev/images/templated-apis-screenshots/customer-account-ui-extensions/2025-01/dropzone-preview.png) ## Best Practices ### File storage File storage for uploads must be implemented separately. Metafields and [the Customer Account API](https://shopify.dev/docs/api/customer/latest/mutations/metafieldsSet) can be utilized to store references to files alongside the relevant objects. ### Mobile Remember that the drag and drop feature won't be effective on mobile devices. Adding a button can offer additional context and guide users through the next steps. ![An example showing DropZone with custom content optimized for mobile devices](https://shopify.dev/images/templated-apis-screenshots/customer-account-ui-extensions/unstable/dropzone-mobile-example.png) ### Minimum size To prevent cut-off text and spacing issues, the minimum size of a Dropzone should be 100px x 100px. ![An example showing DropZone with correct minimum size](https://shopify.dev/images/templated-apis-screenshots/customer-account-ui-extensions/unstable/dropzone-minimum-size.png)