|
|
--- |
|
|
title: File Upload |
|
|
description: Used to select and upload files from their device. |
|
|
links: |
|
|
source: components/file-upload |
|
|
storybook: components-file-upload--basic |
|
|
recipe: file-upload |
|
|
ark: https://ark-ui.com/react/docs/components/file-upload |
|
|
--- |
|
|
|
|
|
<ExampleTabs name="file-upload-basic" /> |
|
|
|
|
|
|
|
|
|
|
|
```jsx |
|
|
import { FileUpload } from "@chakra-ui/react" |
|
|
``` |
|
|
|
|
|
```jsx |
|
|
<FileUpload.Root> |
|
|
<FileUpload.HiddenInput /> |
|
|
<FileUpload.Label /> |
|
|
<FileUpload.Dropzone> |
|
|
<FileUpload.DropzoneContent /> |
|
|
</FileUpload.Dropzone> |
|
|
<FileUpload.Trigger /> |
|
|
<FileUpload.ItemGroup> |
|
|
<FileUpload.Item> |
|
|
<FileUpload.ItemPreview /> |
|
|
<FileUpload.ItemFileName /> |
|
|
<FileUpload.ItemSizeText /> |
|
|
<FileUpload.ItemDeleteTrigger /> |
|
|
</FileUpload.Item> |
|
|
</FileUpload.ItemGroup> |
|
|
</FileUpload.Root> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
The `FileUpload` component also provides a set of shortcuts for common use |
|
|
cases. |
|
|
|
|
|
|
|
|
|
|
|
By default, the `FileUploadItems` shortcut renders the list of uploaded files. |
|
|
|
|
|
This works: |
|
|
|
|
|
```tsx |
|
|
<FileUpload.ItemGroup> |
|
|
<FileUpload.Context> |
|
|
{({ acceptedFiles }) => |
|
|
acceptedFiles.map((file) => ( |
|
|
<FileUpload.Item key={file.name} file={file}> |
|
|
<FileUpload.ItemPreview /> |
|
|
<FileUpload.ItemName /> |
|
|
<FileUpload.ItemSizeText /> |
|
|
<FileUpload.ItemDeleteTrigger /> |
|
|
</FileUpload.Item> |
|
|
)) |
|
|
} |
|
|
</FileUpload.Context> |
|
|
</FileUpload.ItemGroup> |
|
|
``` |
|
|
|
|
|
This might be more concise, if you don't need to customize the file upload |
|
|
items: |
|
|
|
|
|
```tsx |
|
|
<FileUpload.ItemGroup> |
|
|
<FileUpload.Items /> |
|
|
</FileUpload.ItemGroup> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
The `FileUploadList` shortcut renders the list of uploaded files. It composes |
|
|
the `FileUpload.ItemGroup` and `FileUpload.Items` components. |
|
|
|
|
|
```tsx |
|
|
<FileUpload.List /> |
|
|
``` |
|
|
|
|
|
is the same as: |
|
|
|
|
|
```tsx |
|
|
<FileUpload.ItemGroup> |
|
|
<FileUpload.Items /> |
|
|
</FileUpload.ItemGroup> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Define the accepted files for upload using the `accept` prop. |
|
|
|
|
|
<ExampleTabs name="file-upload-accepted-files" /> |
|
|
|
|
|
|
|
|
|
|
|
Upload multiple files at once by using the `maxFiles` prop. |
|
|
|
|
|
<ExampleTabs name="file-upload-multiple" /> |
|
|
|
|
|
|
|
|
|
|
|
Here's an example of how to show a custom image preview for files. |
|
|
|
|
|
<ExampleTabs name="file-upload-custom-preview" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `directory` prop to allow selecting a directory instead of a file. |
|
|
|
|
|
<ExampleTabs name="file-upload-directory" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `capture` prop to select and upload files from different environments |
|
|
and media types. |
|
|
|
|
|
> **Note:** This is |
|
|
> [not fully supported](https://caniuse.com/mdn-api_htmlinputelement_capture) in |
|
|
> all browsers. |
|
|
|
|
|
<ExampleTabs name="file-upload-media-capture" /> |
|
|
|
|
|
|
|
|
|
|
|
Drop multiple files inside the dropzone and use the `maxFiles` prop to set the |
|
|
number of files that can be uploaded at once. |
|
|
|
|
|
<ExampleTabs name="file-upload-with-dropzone" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `FileInput` component to create a trigger that looks like a text input. |
|
|
|
|
|
<ExampleTabs name="file-upload-with-input" /> |
|
|
|
|
|
|
|
|
|
|
|
Here's an example of a clearable file upload input. |
|
|
|
|
|
<ExampleTabs name="file-upload-with-input-clear" /> |
|
|
|
|
|
|
|
|
|
|
|
Here's an example of handling files pasted from the clipboard. |
|
|
|
|
|
<ExampleTabs name="file-upload-with-paste-event" /> |
|
|
|
|
|
|
|
|
|
|
|
An alternative way to control the file upload is to use the `RootProvider` |
|
|
component and the `useFileUpload` store hook. |
|
|
|
|
|
This way you can access the file upload state and methods from outside the file |
|
|
upload. |
|
|
|
|
|
<ExampleTabs name="file-upload-with-store" /> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<PropTable component="FileUpload" part="Root" /> |
|
|
|