Drop Zone
Lets users upload files through drag-and-drop functionality into a designated area on a page, or by activating a button.
Anchor to propertiesProperties
- Anchor to acceptacceptstring
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.
- Anchor to accessibilityLabelaccessibilityLabelstring
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.
- Anchor to disableddisabledbooleanDefault: false
Disables the field, disallowing any interaction.
- Anchor to errorerrorstring
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
- string
A unique identifier for the element.
- Anchor to labellabelstring
Content to use as the field label.
- Anchor to multiplemultiplebooleanDefault: false
Defines if the user can select or drop multiple files at once.
- Anchor to namenamestring
An identifier for the field that is unique within the nearest containing form.
- Anchor to requiredrequiredbooleanDefault: false
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
property.
DropZoneElementProps
- accept
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.
string
- accessibilityLabel
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.
string
- disabled
Disables the field, disallowing any interaction.
boolean
- error
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
string
- id
A unique identifier for the element.
string
- label
Content to use as the field label.
string
- multiple
Defines if the user can select or drop multiple files at once.
boolean
- name
An identifier for the field that is unique within the nearest containing form.
string
- required
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` property.
boolean
export interface DropZoneElementProps extends Pick<DropZoneProps$1, 'accept' | 'accessibilityLabel' | 'disabled' | 'error' | 'id' | 'label' | 'multiple' | 'name' | 'required'> {
}
Anchor to eventsEvents
- Anchor to droprejecteddroprejected((event: CallbackEventListener<typeof tagName>) => void) | null
Callback when rejected files are dropped. Files are rejected based on the
accept
prop.- Anchor to inputinput((event: CallbackEventListener<typeof tagName>) => void) | null
Callback when the user makes any changes in the field.
DropZoneElementEvents
- droprejected
Callback when rejected files are dropped. Files are rejected based on the `accept` prop.
((event: CallbackEventListener<typeof tagName>) => void) | null
- input
Callback when the user makes any changes in the field.
((event: CallbackEventListener<typeof tagName>) => void) | null
export interface DropZoneElementEvents {
/**
* Callback when rejected files are dropped. Files are rejected based on the `accept` prop.
*/
droprejected?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
/**
* Callback when the user makes any changes in the field.
*/
input?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
}
CallbackEventListener
(EventListener & {
(event: CallbackEvent<TTagName, TEvent>): void;
}) | null
CallbackEvent
TEvent & {
currentTarget: HTMLElementTagNameMap[TTagName];
}
Code
examples
Code
<s-drop-zone accept="image/*"> </s-drop-zone>
Preview

Anchor to best-practicesBest Practices
File storage
File storage for uploads must be implemented separately. Metafields and the corresponding Checkout API or Customer Accounts API 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.

Minimum size
To prevent cut-off text and spacing issues, the minimum size of a Dropzone should be 100px by 100px.
