- Prop
onFiles- Type
((files: File[]) => void) | undefined- Default
- —
- Requirement
- optional
Docs Components Advanced
FileDropzone
React example follows below.
Vue example follows below.
Angular example follows below.
Svelte example follows below.
Solid example follows below.
- parts
- —
- nodes
- —
- size
- —
- part
- —
ts
const fileDropzoneFixture = { id: "file-dropzone", hint: "PNG, PDF, CSV", accept: ".png,.pdf,.csv", multiple: true,}; import { FileDropzone } from "@grassroot/ui-react/advanced"; export default function FileDropzoneDemo() { const { id: _id, ...props } = fileDropzoneFixture; return ( <div> <FileDropzone {...props} /> </div> );}- parts
- —
- nodes
- —
- size
- —
- part
- —
ts
<script setup lang="ts">const fileDropzoneFixture = { id: "file-dropzone", hint: "PNG, PDF, CSV", accept: ".png,.pdf,.csv", multiple: true,}; import { FileDropzone } from "@grassroot/ui-vue";</script> <template> <div> <FileDropzone :hint="fileDropzoneFixture.hint" :accept="fileDropzoneFixture.accept" :multiple="fileDropzoneFixture.multiple" /> </div></template>- parts
- —
- nodes
- —
- size
- —
- part
- —
ts
import { Component } from "@angular/core";const fileDropzoneFixture = { id: "file-dropzone", hint: "PNG, PDF, CSV", accept: ".png,.pdf,.csv", multiple: true,}; import { GrassrootFileDropzone } from "@grassroot/ui-angular"; @Component({ selector: "app-file-dropzone-demo", standalone: true, imports: [GrassrootFileDropzone], template: ` <div> <grassroot-file-dropzone [hint]="fixture.hint" [accept]="fixture.accept" [multiple]="fixture.multiple" /> </div> `,})export class FileDropzoneDemoComponent { protected readonly fixture = fileDropzoneFixture;} export default FileDropzoneDemoComponent;- parts
- —
- nodes
- —
- size
- —
- part
- —
ts
<script lang="ts"> const fileDropzoneFixture = { id: "file-dropzone", hint: "PNG, PDF, CSV", accept: ".png,.pdf,.csv", multiple: true, }; import { FileDropzone } from "@grassroot/ui-svelte";</script> <div> <FileDropzone hint={fileDropzoneFixture.hint} accept={fileDropzoneFixture.accept} multiple={fileDropzoneFixture.multiple} /></div>- parts
- —
- nodes
- —
- size
- —
- part
- —
ts
/** @jsxImportSource solid-js */const fileDropzoneFixture = { id: "file-dropzone", hint: "PNG, PDF, CSV", accept: ".png,.pdf,.csv", multiple: true,}; import { FileDropzone } from "@grassroot/ui-solid"; export default function FileDropzoneDemo() { return ( <div> <FileDropzone hint={fileDropzoneFixture.hint} accept={fileDropzoneFixture.accept} multiple={fileDropzoneFixture.multiple} /> </div> );}Installation
API Reference
Import
import { FileDropzone } from "@grassroot/ui-react/advanced";
Props
Prop
Type
Default
Requirement
onFiles((files: File[]) => void) | undefined—
optional
onFilesChange((files: File[]) => void) | undefined—
optional
onFilesRejected((rejections: readonly FileDropzoneRejection[]) => void) | undefined—
optional
filesreadonly File[] | undefined—
optional
defaultFilesreadonly File[] | undefined—
optional
multipleboolean | undefined—
optional
acceptstring | undefined—
optional
hintstring | undefined—
optional
classNamestring | undefined—
optional
disabledboolean | undefined—
optional
maxFileSizenumber | undefined—
optional
maxFilesnumber | undefined—
optional
- Prop
onFilesChange- Type
((files: File[]) => void) | undefined- Default
- —
- Requirement
- optional
- Prop
onFilesRejected- Type
((rejections: readonly FileDropzoneRejection[]) => void) | undefined- Default
- —
- Requirement
- optional
- Prop
files- Type
readonly File[] | undefined- Default
- —
- Requirement
- optional
- Prop
defaultFiles- Type
readonly File[] | undefined- Default
- —
- Requirement
- optional
- Prop
multiple- Type
boolean | undefined- Default
- —
- Requirement
- optional
- Prop
accept- Type
string | undefined- Default
- —
- Requirement
- optional
- Prop
hint- Type
string | undefined- Default
- —
- Requirement
- optional
- Prop
className- Type
string | undefined- Default
- —
- Requirement
- optional
- Prop
disabled- Type
boolean | undefined- Default
- —
- Requirement
- optional
- Prop
maxFileSize- Type
number | undefined- Default
- —
- Requirement
- optional
- Prop
maxFiles- Type
number | undefined- Default
- —
- Requirement
- optional
Events
| Event | Payload |
|---|---|
onFiles | ((files: File[]) => void) | undefined |
onFilesChange | ((files: File[]) => void) | undefined |
onFilesRejected | ((rejections: readonly FileDropzoneRejection[]) => void) | undefined |
Import
import { FileDropzone } from "@grassroot/ui-vue";
Props
Prop
Type
Default
Requirement
filesreadonly File[] | undefined—
optional
defaultFilesreadonly File[] | undefined—
optional
multipleboolean | undefinedtrueoptional
acceptstring | undefined—
optional
hintstring | undefined"PNG, PDF, CSV"optional
classNamestring | undefined—
optional
disabledboolean | undefinedfalseoptional
maxFileSizenumber | undefined—
optional
maxFilesnumber | undefined—
optional
- Prop
files- Type
readonly File[] | undefined- Default
- —
- Requirement
- optional
- Prop
defaultFiles- Type
readonly File[] | undefined- Default
- —
- Requirement
- optional
- Prop
multiple- Type
boolean | undefined- Default
true- Requirement
- optional
- Prop
accept- Type
string | undefined- Default
- —
- Requirement
- optional
- Prop
hint- Type
string | undefined- Default
"PNG, PDF, CSV"- Requirement
- optional
- Prop
className- Type
string | undefined- Default
- —
- Requirement
- optional
- Prop
disabled- Type
boolean | undefined- Default
false- Requirement
- optional
- Prop
maxFileSize- Type
number | undefined- Default
- —
- Requirement
- optional
- Prop
maxFiles- Type
number | undefined- Default
- —
- Requirement
- optional
Events
| Event | Payload |
|---|---|
files | [files: File[]] |
update:files | [files: File[]] |
files-change | [files: File[]] |
files-rejected | [rejections: readonly FileDropzoneRejection[]] |
Import
import { Component } from "@angular/core";
import { GrassrootFileDropzone } from "@grassroot/ui-angular";
Props
Prop
Type
Default
Requirement
filesreadonly File[]—
optional
defaultFilesreadonly File[]—
optional
multiplebooleantrueoptional
acceptstring—
optional
hintstring"PNG, PDF, CSV"optional
classNamestring—
optional
disabledbooleanfalseoptional
maxFileSizenumber—
optional
maxFilesnumber—
optional
- Prop
files- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
defaultFiles- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
multiple- Type
boolean- Default
true- Requirement
- optional
- Prop
accept- Type
string- Default
- —
- Requirement
- optional
- Prop
hint- Type
string- Default
"PNG, PDF, CSV"- Requirement
- optional
- Prop
className- Type
string- Default
- —
- Requirement
- optional
- Prop
disabled- Type
boolean- Default
false- Requirement
- optional
- Prop
maxFileSize- Type
number- Default
- —
- Requirement
- optional
- Prop
maxFiles- Type
number- Default
- —
- Requirement
- optional
Events
| Event | Payload |
|---|---|
filesChange | File[] |
onFiles | File[] |
filesRejected | readonly FileDropzoneRejection[] |
Import
import { FileDropzone } from "@grassroot/ui-svelte";
Props
Prop
Type
Default
Requirement
filesreadonly File[]—
optional
defaultFilesreadonly File[]—
optional
onFiles(files: File[]) => void—
optional
onFilesChange(files: readonly File[]) => void—
optional
onFilesRejected(rejections: readonly Rejection[]) => void—
optional
maxFileSizenumber—
optional
maxFilesnumber—
optional
multiplebooleantrueoptional
acceptstring—
optional
hintstring"PNG, PDF, CSV"optional
classNamestring—
optional
disabledbooleanfalseoptional
- Prop
files- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
defaultFiles- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
onFiles- Type
(files: File[]) => void- Default
- —
- Requirement
- optional
- Prop
onFilesChange- Type
(files: readonly File[]) => void- Default
- —
- Requirement
- optional
- Prop
onFilesRejected- Type
(rejections: readonly Rejection[]) => void- Default
- —
- Requirement
- optional
- Prop
maxFileSize- Type
number- Default
- —
- Requirement
- optional
- Prop
maxFiles- Type
number- Default
- —
- Requirement
- optional
- Prop
multiple- Type
boolean- Default
true- Requirement
- optional
- Prop
accept- Type
string- Default
- —
- Requirement
- optional
- Prop
hint- Type
string- Default
"PNG, PDF, CSV"- Requirement
- optional
- Prop
className- Type
string- Default
- —
- Requirement
- optional
- Prop
disabled- Type
boolean- Default
false- Requirement
- optional
Events
| Event | Payload |
|---|---|
onFiles | (files: File[]) => void |
onFilesChange | (files: readonly File[]) => void |
onFilesRejected | (rejections: readonly Rejection[]) => void |
Import
import { FileDropzone } from "@grassroot/ui-solid";
Props
Prop
Type
Default
Requirement
filesreadonly File[]—
optional
defaultFilesreadonly File[]—
optional
onFilesChange(files: readonly File[]) => void—
optional
onFiles(files: File[]) => void—
optional
onFilesRejected(rejections: readonly FileDropzoneRejection[]) => void—
optional
maxFileSizenumber—
optional
maxFilesnumber—
optional
multiplebooleantrueoptional
acceptstring—
optional
hintstring"PNG, PDF, CSV"optional
classNamestring—
optional
disabledboolean—
optional
- Prop
files- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
defaultFiles- Type
readonly File[]- Default
- —
- Requirement
- optional
- Prop
onFilesChange- Type
(files: readonly File[]) => void- Default
- —
- Requirement
- optional
- Prop
onFiles- Type
(files: File[]) => void- Default
- —
- Requirement
- optional
- Prop
onFilesRejected- Type
(rejections: readonly FileDropzoneRejection[]) => void- Default
- —
- Requirement
- optional
- Prop
maxFileSize- Type
number- Default
- —
- Requirement
- optional
- Prop
maxFiles- Type
number- Default
- —
- Requirement
- optional
- Prop
multiple- Type
boolean- Default
true- Requirement
- optional
- Prop
accept- Type
string- Default
- —
- Requirement
- optional
- Prop
hint- Type
string- Default
"PNG, PDF, CSV"- Requirement
- optional
- Prop
className- Type
string- Default
- —
- Requirement
- optional
- Prop
disabled- Type
boolean- Default
- —
- Requirement
- optional
Events
| Event | Payload |
|---|---|
onFilesChange | (files: readonly File[]) => void |
onFiles | (files: File[]) => void |
onFilesRejected | (rejections: readonly FileDropzoneRejection[]) => void |