'use client'
import { Button, FileUpload } from '@saas-ui/react'
import { HiUpload } from 'react-icons/hi'
export const FileUploadBasic = () => {
return (
<FileUpload.Root>
<FileUpload.Trigger asChild>
<Button variant="outline" size="sm">
<HiUpload /> Upload file
</Button>
</FileUpload.Trigger>
<FileUpload.List />
</FileUpload.Root>
)
}
Anatomy
import { FileUpload } from '@saas-ui/react/file-upload'<FileUpload.Root>
<FileUpload.Dropzone>
<FileUpload.Trigger asChild>
<Button>Select files</Button>
</FileUpload.Trigger>
</FileUpload.Dropzone>
<FileUpload.List />
</FileUpload.Root>Examples
Directory
Use the directory prop to allow selecting a directory instead of a file.
'use client'
import { Button, FileUpload } from '@saas-ui/react'
import { HiUpload } from 'react-icons/hi'
export const FileUploadDirectory = () => {
return (
<FileUpload.Root directory>
<FileUpload.Trigger asChild>
<Button variant="outline" size="sm">
<HiUpload /> Upload file
</Button>
</FileUpload.Trigger>
<FileUpload.List />
</FileUpload.Root>
)
}
Media Capture
Use the capture prop to select and upload files from different environments
and media types.
Note: This is not fully supported in all browsers.
'use client'
import { Button, FileUpload } from '@saas-ui/react'
import { HiCamera } from 'react-icons/hi'
export const FileUploadMediaCapture = () => {
return (
<FileUpload.Root capture="environment">
<FileUpload.Trigger asChild>
<Button variant="outline" size="sm">
<HiCamera /> Open Camera
</Button>
</FileUpload.Trigger>
<FileUpload.List />
</FileUpload.Root>
)
}
Multiple Files
Upload multiple files at once by using the maxFiles prop.
'use client'
import { Button, FileUpload } from '@saas-ui/react'
import { HiUpload } from 'react-icons/hi'
export const FileUploadMultiple = () => {
return (
<FileUpload.Root maxFiles={5}>
<FileUpload.Trigger asChild>
<Button variant="outline" size="sm">
<HiUpload /> Upload file
</Button>
</FileUpload.Trigger>
<FileUpload.List showSize clearable />
</FileUpload.Root>
)
}
Dropzone
Drop multiple files inside the dropzone and use the maxFiles prop to set the
number of files that can be uploaded at once.
Drag and drop here to upload
.png, .jpg up to 5MB
'use client'
import { Heading, Text } from '@saas-ui/react'
import { FileUpload } from '@saas-ui/react'
export const FileUploadWithDropzone = () => {
return (
<FileUpload.Root maxW="xl" alignItems="stretch" maxFiles={10}>
<FileUpload.Dropzone>
<Heading size="md">Drag and drop here to upload</Heading>
<Text color="fg.muted">.png, .jpg up to 5MB</Text>
</FileUpload.Dropzone>
<FileUpload.List />
</FileUpload.Root>
)
}
Input
Use the FileInput component to create a trigger that looks like a text input.
'use client'
import { FileUpload } from '@saas-ui/react'
export const FileUploadWithInput = () => {
return (
<FileUpload.Root gap="1" maxWidth="300px">
<FileUpload.Label>Upload file</FileUpload.Label>
<FileUpload.Input />
</FileUpload.Root>
)
}
Clearable
Here's an example of a clearable file upload input.
'use client'
import { CloseButton, FileUpload, InputGroup } from '@saas-ui/react'
import { LuFileUp } from 'react-icons/lu'
export const FileUploadWithInputClear = () => {
return (
<FileUpload.Root gap="1" maxWidth="300px">
<FileUpload.Label>Upload file</FileUpload.Label>
<InputGroup
w="full"
startElement={<LuFileUp />}
endElement={
<FileUpload.ClearTrigger asChild>
<CloseButton
me="-1"
size="xs"
variant="plain"
focusVisibleRing="inside"
focusRingWidth="2px"
pointerEvents="auto"
color="fg.subtle"
/>
</FileUpload.ClearTrigger>
}
>
<FileUpload.Input />
</InputGroup>
</FileUpload.Root>
)
}
Accepted Files
Define the accepted files for upload using the accept prop.
'use client'
import { Button, FileUpload } from '@saas-ui/react'
import { HiUpload } from 'react-icons/hi'
export const FileUploadAcceptedFiles = () => {
return (
<FileUpload.Root accept={['image/png']}>
<FileUpload.Trigger asChild>
<Button variant="outline" size="sm">
<HiUpload /> Upload file
</Button>
</FileUpload.Trigger>
<FileUpload.List />
</FileUpload.Root>
)
}
Props
Root
| Prop | Default | Type |
|---|---|---|
allowDrop | true | booleanWhether to allow drag and drop in the dropzone element |
locale | '\'en-US\'' | stringThe current locale. Based on the BCP 47 definition. |
maxFiles | '1' | numberThe maximum number of files |
maxFileSize | 'Infinity' | numberThe maximum file size in bytes |
minFileSize | '0' | numberThe minimum file size in bytes |
preventDocumentDrop | true | booleanWhether to prevent the drop event on the document |
accept | Record<string, string[]> | FileMimeType | FileMimeType[]The accept file types | |
asChild | booleanUse the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide. | |
capture | 'user' | 'environment'The default camera to use when capturing media | |
directory | booleanWhether to accept directories, only works in webkit browsers | |
disabled | booleanWhether the file input is disabled | |
ids | Partial<{
root: string
dropzone: string
hiddenInput: string
trigger: string
label: string
item(id: string): string
itemName(id: string): string
itemSizeText(id: string): string
itemPreview(id: string): string
}>The ids of the elements. Useful for composition. | |
invalid | booleanWhether the file input is invalid | |
name | stringThe name of the underlying file input | |
onFileAccept | (details: FileAcceptDetails) => voidFunction called when the file is accepted | |
onFileChange | (details: FileChangeDetails) => voidFunction called when the value changes, whether accepted or rejected | |
onFileReject | (details: FileRejectDetails) => voidFunction called when the file is rejected | |
required | booleanWhether the file input is required | |
transformFiles | (files: File[]) => Promise<File[]>Function to transform the accepted files to apply transformations | |
translations | IntlTranslationsThe localized messages to use. | |
validate | (file: File, details: FileValidateDetails) => FileError[] | nullFunction to validate a file | |
as | React.ElementTypeThe underlying element to render. | |
unstyled | booleanWhether to remove the component's style. |