- Name
service- Kind
- parameter
- Type
FileDropzoneService- Requirement
- required
DocsAPI referenceHeadlessfile-dropzone
file-dropzone headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
@grassroot/ui-headless-core/file-dropzone
Core connector and vanilla API
connectFileDropzone
functiondeclare function connectFileDropzone(service: FileDropzoneService, scope: PartScope, options?: FileDropzoneConnectOptions): FileDropzoneApi;serviceFileDropzoneServicescopePartScopeoptionsFileDropzoneConnectOptionsreturnFileDropzoneApi- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
FileDropzoneConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
FileDropzoneApi- Requirement
- n/a
fileDropzoneAnatomy
valueexport declare const fileDropzoneAnatomy: { readonly scope: "file-dropzone"; readonly parts: readonly ["root", "trigger", "input", "item", "remove"];};partsreadonly ["root", "trigger", "input", "item", "remove"]scope"file-dropzone"- Name
parts- Kind
- property
- Type
readonly ["root", "trigger", "input", "item", "remove"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"file-dropzone"- Requirement
- required
FileDropzoneApi
interfaceinterface FileDropzoneApi { rootProps(): PartProps; triggerProps(): PartProps; inputProps(): PartProps; itemProps(index: number): PartProps; removeProps(index: number): PartProps; addFiles(files: readonly File[]): void; removeFile(index: number): void; reset(): void; readonly files: readonly File[];}addFiles(files: readonly File[]) => voidfilesreadonly File[]inputProps() => PartPropsitemProps(index: number) => PartPropsremoveFile(index: number) => voidremoveProps(index: number) => PartPropsreset() => voidrootProps() => PartPropstriggerProps() => PartProps- Name
addFiles- Kind
- method
- Type
(files: readonly File[]) => void- Requirement
- required
- Name
files- Kind
- property
- Type
readonly File[]- Requirement
- required
- Name
inputProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
itemProps- Kind
- method
- Type
(index: number) => PartProps- Requirement
- required
- Name
removeFile- Kind
- method
- Type
(index: number) => void- Requirement
- required
- Name
removeProps- Kind
- method
- Type
(index: number) => PartProps- Requirement
- required
- Name
reset- Kind
- method
- Type
() => void- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
triggerProps- Kind
- method
- Type
() => PartProps- Requirement
- required
FileDropzoneChangeDetail
interfaceinterface FileDropzoneChangeDetail { readonly files: readonly File[]; readonly rejections: readonly FileDropzoneRejection[]; readonly changed: boolean;}changedbooleanfilesreadonly File[]rejectionsreadonly FileDropzoneRejection[]- Name
changed- Kind
- property
- Type
boolean- Requirement
- required
- Name
files- Kind
- property
- Type
readonly File[]- Requirement
- required
- Name
rejections- Kind
- property
- Type
readonly FileDropzoneRejection[]- Requirement
- required
FileDropzoneConnectOptions
interfaceinterface FileDropzoneConnectOptions extends FileDropzoneInput { readonly onFilesChange?: (detail: FileDropzoneChangeDetail) => void; readonly onFilesRejected?: (detail: { readonly rejections: readonly FileDropzoneRejection[]; }) => void; readonly messages?: Partial<FileDropzoneMessages>;}messagesPartial<FileDropzoneMessages>onFilesChange(detail: FileDropzoneChangeDetail) => voidonFilesRejected(detail: {
readonly rejections: readonly FileDropzoneRejection[];
}) => void- Name
messages- Kind
- property
- Type
Partial<FileDropzoneMessages>- Requirement
- optional
- Name
onFilesChange- Kind
- property
- Type
(detail: FileDropzoneChangeDetail) => void- Requirement
- optional
- Name
onFilesRejected- Kind
- property
- Type
(detail: { readonly rejections: readonly FileDropzoneRejection[]; }) => void- Requirement
- optional
fileDropzoneMessages
valueexport declare const fileDropzoneMessages: FileDropzoneMessages;FileDropzoneMessages
typetype FileDropzoneMessages = Pick<MessageTable, "upload" | "remove">;FileDropzoneMount
interfaceinterface FileDropzoneMount { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly root: HTMLElement; destroy(): void;}connectorFileDropzoneApidestroy() => voidrootHTMLElementserviceFileDropzoneService- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLElement- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
FileDropzonePart
typetype FileDropzonePart = (typeof fileDropzoneAnatomy.parts)[number];FileDropzoneRejection
interfaceinterface FileDropzoneRejection { readonly file: File; readonly reason: FileDropzoneRejectionReason;}fileFilereasonFileDropzoneRejectionReason- Name
file- Kind
- property
- Type
File- Requirement
- required
- Name
reason- Kind
- property
- Type
FileDropzoneRejectionReason- Requirement
- required
FileDropzoneService
typetype FileDropzoneService = Service<FileDropzoneInput, "ready", FileDropzoneContext, FileDropzoneEvent, FileDropzoneCommand>;mountFileDropzone
functiondeclare function mountFileDropzone(container: HTMLElement, options?: MountFileDropzoneOptions): FileDropzoneMount;containerHTMLElementoptionsMountFileDropzoneOptionsreturnFileDropzoneMount- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountFileDropzoneOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
FileDropzoneMount- Requirement
- n/a
MountFileDropzoneOptions
interfaceinterface MountFileDropzoneOptions extends FileDropzoneConnectOptions {}Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React imports
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-react/file-dropzone";Vue imports
<script setup lang="ts">import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-vue/file-dropzone";</script>Angular imports
import { GrFileDropzoneItem, GrFileDropzoneRemove, GrFileDropzoneRoot, GrFileDropzoneRootProvider, GrFileDropzoneTrigger, Item, Remove, Root } from "@grassroot/ui-headless-angular/file-dropzone"; // +2 more exportsSvelte imports
<script lang="ts"> import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-svelte/file-dropzone";</script>Solid imports
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-solid/file-dropzone";@grassroot/ui-headless-react/file-dropzone
React adapter
FileDropzoneRootProps
interfaceinterface FileDropzoneRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "id">, FileDropzoneInput, UseFileDropzoneOptions { readonly children?: ReactNode;}childrenReactNode- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
Input
valueexport declare const Input: import("react").ForwardRefExoticComponent<InputHTMLAttributes<HTMLInputElement> & import("react").RefAttributes<HTMLInputElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Item
valueexport declare const Item: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLLIElement> & { readonly index: number;} & import("react").RefAttributes<HTMLLIElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Remove
valueexport declare const Remove: import("react").ForwardRefExoticComponent<ButtonHTMLAttributes<HTMLButtonElement> & { readonly index: number;} & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Root
valueexport declare const Root: import("react").ForwardRefExoticComponent<FileDropzoneRootProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: import("react").ForwardRefExoticComponent<{ readonly value: UseFileDropzoneResult; readonly children?: ReactNode;} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Trigger
valueexport declare const Trigger: import("react").ForwardRefExoticComponent<ButtonHTMLAttributes<HTMLButtonElement> & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
useFileDropzone
functiondeclare function useFileDropzone(input: FileDropzoneInput, options?: UseFileDropzoneOptions): UseFileDropzoneResult;inputFileDropzoneInputoptionsUseFileDropzoneOptionsreturnUseFileDropzoneResult- Name
input- Kind
- parameter
- Type
FileDropzoneInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseFileDropzoneOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseFileDropzoneResult- Requirement
- n/a
UseFileDropzoneOptions
interfaceinterface UseFileDropzoneOptions { readonly id?: string; readonly onFilesChange?: FileDropzoneConnectOptions["onFilesChange"]; readonly onFilesRejected?: FileDropzoneConnectOptions["onFilesRejected"];}idstringonFilesChangeFileDropzoneConnectOptions["onFilesChange"]onFilesRejectedFileDropzoneConnectOptions["onFilesRejected"]- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onFilesChange- Kind
- property
- Type
FileDropzoneConnectOptions["onFilesChange"]- Requirement
- optional
- Name
onFilesRejected- Kind
- property
- Type
FileDropzoneConnectOptions["onFilesRejected"]- Requirement
- optional
UseFileDropzoneResult
interfaceinterface UseFileDropzoneResult { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly scope: PartScope; readonly snapshot: FileDropzoneSnapshot;}connectorFileDropzoneApiscopePartScopeserviceFileDropzoneServicesnapshotFileDropzoneSnapshot- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
FileDropzoneSnapshot- Requirement
- required
@grassroot/ui-headless-vue/file-dropzone
Vue adapter
Input
valueexport declare const Input: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Item
valueexport declare const Item: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Remove
valueexport declare const Remove: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Root
valueexport declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ multiple: BooleanConstructor; accept: StringConstructor; disabled: BooleanConstructor; files: PropType<FileDropzoneInput$1["files"]>; defaultFiles: PropType<FileDropzoneInput$1["defaultFiles"]>; maxFileSize: NumberConstructor; maxFiles: NumberConstructor; id: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { filesChange: (_detail: FileDropzoneChangeEvent) => true; filesRejected: (_detail: FileDropzoneRejectedEvent) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ multiple: BooleanConstructor; accept: StringConstructor; disabled: BooleanConstructor; files: PropType<FileDropzoneInput$1["files"]>; defaultFiles: PropType<FileDropzoneInput$1["defaultFiles"]>; maxFileSize: NumberConstructor; maxFiles: NumberConstructor; id: StringConstructor;}>> & Readonly<{ onFilesChange?: ((_detail: FileDropzoneChangeEvent) => any) | undefined; onFilesRejected?: ((_detail: FileDropzoneRejectedEvent) => any) | undefined;}>, { multiple: boolean; disabled: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;RootProvider
valueexport declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: PropType<UseFileDropzoneResult>; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ value: { type: PropType<UseFileDropzoneResult>; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Trigger
valueexport declare const Trigger: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;useFileDropzone
functiondeclare function useFileDropzone(input: () => FileDropzoneInput, options?: () => FileDropzoneOptions): UseFileDropzoneResult;input() => FileDropzoneInputoptions() => FileDropzoneOptionsreturnUseFileDropzoneResult- Name
input- Kind
- parameter
- Type
() => FileDropzoneInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
() => FileDropzoneOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseFileDropzoneResult- Requirement
- n/a
UseFileDropzoneResult
interfaceinterface UseFileDropzoneResult { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly scope: PartScope; readonly snapshot: ShallowRef<FileDropzoneSnapshot>;}connectorFileDropzoneApiscopePartScopeserviceFileDropzoneServicesnapshotShallowRef<FileDropzoneSnapshot>- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<FileDropzoneSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/file-dropzone
Angular adapter
createFileDropzoneStore
functionexport declare function createFileDropzoneStore(initial: FileDropzoneInput, options?: FileDropzoneConnectOptions): FileDropzoneStore;initialFileDropzoneInputoptionsFileDropzoneConnectOptionsreturnFileDropzoneStore- Name
initial- Kind
- parameter
- Type
FileDropzoneInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
FileDropzoneConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
FileDropzoneStore- Requirement
- n/a
FileDropzoneChangeDetail
interfaceinterface FileDropzoneChangeDetail { readonly files: readonly File[]; readonly rejections: readonly FileDropzoneRejection[]; readonly changed: boolean;}changedbooleanfilesreadonly File[]rejectionsreadonly FileDropzoneRejection[]- Name
changed- Kind
- property
- Type
boolean- Requirement
- required
- Name
files- Kind
- property
- Type
readonly File[]- Requirement
- required
- Name
rejections- Kind
- property
- Type
readonly FileDropzoneRejection[]- Requirement
- required
FileDropzoneRejection
interfaceinterface FileDropzoneRejection { readonly file: File; readonly reason: FileDropzoneRejectionReason;}fileFilereasonFileDropzoneRejectionReason- Name
file- Kind
- property
- Type
File- Requirement
- required
- Name
reason- Kind
- property
- Type
FileDropzoneRejectionReason- Requirement
- required
FileDropzoneStore
interfaceexport interface FileDropzoneStore { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: Record<string, unknown>): void;}connectorFileDropzoneApiscopePartScopeserviceFileDropzoneServicestart() => voidstop() => voidsync(input: Record<string, unknown>) => voidversionWritableSignal<number>- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: Record<string, unknown>) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
GrFileDropzoneInput
classexport declare class GrFileDropzoneInput implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrFileDropzoneItem
classexport declare class GrFileDropzoneItem implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanyindeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrFileDropzoneRemove
classexport declare class GrFileDropzoneRemove implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanyindeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrFileDropzoneRoot
classexport declare class GrFileDropzoneRoot implements OnDestroy { readonly files: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>; readonly defaultFiles: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>; readonly multiple: import("@angular/core").InputSignal<boolean | undefined>; readonly accept: import("@angular/core").InputSignal<string | undefined>; readonly disabled: import("@angular/core").InputSignal<boolean>; readonly maxFileSize: import("@angular/core").InputSignal<number | undefined>; readonly maxFiles: import("@angular/core").InputSignal<number | undefined>; readonly filesChange: import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>; readonly store: FileDropzoneStore; private readonly host; private readonly listeners; private readonly consumer; private readonly options; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrFileDropzoneRoot, "gr-file-dropzone-root", never, { "files": { "alias": "files"; "required": false; "isSignal": true; }; "defaultFiles": { "alias": "defaultFiles"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "accept": { "alias": "accept"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; "isSignal": true; }; "maxFiles": { "alias": "maxFiles"; "required": false; "isSignal": true; }; }, { "filesChange": "filesChange"; }, never, ["*"], true, never>;}acceptimport("@angular/core").InputSignal<string | undefined>consumeranydefaultFilesimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>disabledimport("@angular/core").InputSignal<boolean>filesimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>filesChangeimport("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>hostanylastanylistenersanymaxFilesimport("@angular/core").InputSignal<number | undefined>maxFileSizeimport("@angular/core").InputSignal<number | undefined>multipleimport("@angular/core").InputSignal<boolean | undefined>ngOnDestroy() => voidoptionsany- Name
accept- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
defaultFiles- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>- Requirement
- required
- Name
disabled- Kind
- property
- Type
import("@angular/core").InputSignal<boolean>- Requirement
- required
- Name
files- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>- Requirement
- required
- Name
filesChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
maxFiles- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
maxFileSize- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
multiple- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
options- Kind
- property
- Type
any- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrFileDropzoneRoot, "gr-file-dropzone-root", never, { "files": { "alias": "files"; "required": false; "isSignal": true; }; "defaultFiles": { "alias": "defaultFiles"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "accept": { "alias": "accept"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; "isSignal": true; }; "maxFiles": { "alias": "maxFiles"; "required": false; "isSignal": true; }; }, { "filesChange": "filesChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRoot, never>- Requirement
- required
- Name
store- Kind
- property
- Type
FileDropzoneStore- Requirement
- required
export declare class GrFileDropzoneRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>;}hostanylistenersanyngOnDestroy() => voidɵcmpi0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>storeany- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrFileDropzoneTrigger
classexport declare class GrFileDropzoneTrigger implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Input
classexport declare class GrFileDropzoneInput implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Item
classexport declare class GrFileDropzoneItem implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanyindeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Remove
classexport declare class GrFileDropzoneRemove implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanyindeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Root
classexport declare class GrFileDropzoneRoot implements OnDestroy { readonly files: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>; readonly defaultFiles: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>; readonly multiple: import("@angular/core").InputSignal<boolean | undefined>; readonly accept: import("@angular/core").InputSignal<string | undefined>; readonly disabled: import("@angular/core").InputSignal<boolean>; readonly maxFileSize: import("@angular/core").InputSignal<number | undefined>; readonly maxFiles: import("@angular/core").InputSignal<number | undefined>; readonly filesChange: import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>; readonly store: FileDropzoneStore; private readonly host; private readonly listeners; private readonly consumer; private readonly options; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrFileDropzoneRoot, "gr-file-dropzone-root", never, { "files": { "alias": "files"; "required": false; "isSignal": true; }; "defaultFiles": { "alias": "defaultFiles"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "accept": { "alias": "accept"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; "isSignal": true; }; "maxFiles": { "alias": "maxFiles"; "required": false; "isSignal": true; }; }, { "filesChange": "filesChange"; }, never, ["*"], true, never>;}acceptimport("@angular/core").InputSignal<string | undefined>consumeranydefaultFilesimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>disabledimport("@angular/core").InputSignal<boolean>filesimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>filesChangeimport("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>hostanylastanylistenersanymaxFilesimport("@angular/core").InputSignal<number | undefined>maxFileSizeimport("@angular/core").InputSignal<number | undefined>multipleimport("@angular/core").InputSignal<boolean | undefined>ngOnDestroy() => voidoptionsany- Name
accept- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
defaultFiles- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>- Requirement
- required
- Name
disabled- Kind
- property
- Type
import("@angular/core").InputSignal<boolean>- Requirement
- required
- Name
files- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>- Requirement
- required
- Name
filesChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
maxFiles- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
maxFileSize- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
multiple- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
options- Kind
- property
- Type
any- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrFileDropzoneRoot, "gr-file-dropzone-root", never, { "files": { "alias": "files"; "required": false; "isSignal": true; }; "defaultFiles": { "alias": "defaultFiles"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "accept": { "alias": "accept"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; "isSignal": true; }; "maxFiles": { "alias": "maxFiles"; "required": false; "isSignal": true; }; }, { "filesChange": "filesChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRoot, never>- Requirement
- required
- Name
store- Kind
- property
- Type
FileDropzoneStore- Requirement
- required
RootProvider
classexport declare class GrFileDropzoneRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>;}hostanylistenersanyngOnDestroy() => voidɵcmpi0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>storeany- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Trigger
classexport declare class GrFileDropzoneTrigger implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
@grassroot/ui-headless-svelte/file-dropzone
Svelte adapter
createFileDropzone
functionexport declare function createFileDropzone(input: () => FileDropzoneInput, options?: UseFileDropzoneOptions): UseFileDropzoneResult;input() => FileDropzoneInputoptionsUseFileDropzoneOptionsreturnUseFileDropzoneResult- Name
input- Kind
- parameter
- Type
() => FileDropzoneInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseFileDropzoneOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseFileDropzoneResult- Requirement
- n/a
Input
valueexport declare const Input: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Item
valueexport declare const Item: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Remove
valueexport declare const Remove: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Root
valueexport declare const Root: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Trigger
valueexport declare const Trigger: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
UseFileDropzoneOptions
interfaceexport interface UseFileDropzoneOptions extends FileDropzoneConnectOptions { readonly id?: string;}idstring- Name
id- Kind
- property
- Type
string- Requirement
- optional
UseFileDropzoneResult
interfaceexport interface UseFileDropzoneResult { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>; readonly version: () => number;}connectorFileDropzoneApiscopeReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>serviceFileDropzoneServiceversion() => number- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
scope- Kind
- property
- Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/file-dropzone
Solid adapter
Input
functionexport declare function Input(props: JSX.InputHTMLAttributes<HTMLInputElement>): JSX.Element;propsJSX.InputHTMLAttributes<HTMLInputElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.InputHTMLAttributes<HTMLInputElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Item
functionexport declare function Item(props: JSX.LiHTMLAttributes<HTMLLIElement> & { readonly index: number;}): JSX.Element;propsJSX.LiHTMLAttributes<HTMLLIElement> & {
readonly index: number;
}returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.LiHTMLAttributes<HTMLLIElement> & { readonly index: number; }- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Remove
functionexport declare function Remove(props: JSX.ButtonHTMLAttributes<HTMLButtonElement> & { readonly index: number;}): JSX.Element;propsJSX.ButtonHTMLAttributes<HTMLButtonElement> & {
readonly index: number;
}returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.ButtonHTMLAttributes<HTMLButtonElement> & { readonly index: number; }- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Root
functionexport declare function Root(props: FileDropzoneInput & { readonly id?: string; readonly onFilesChange?: (detail: { readonly files: readonly File[]; readonly rejections: readonly FileDropzoneRejection[]; readonly changed: boolean; }) => void; readonly onFilesRejected?: (detail: { readonly rejections: readonly FileDropzoneRejection[]; }) => void; readonly children?: JSX.Element;} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;propsFileDropzoneInput & {
readonly id?: string;
readonly onFilesChange?: (detail: {
readonly files: readonly File[];
readonly rejections: readonly FileDropzoneRejection[];
readonly changed: boolean;
}) => void;
readonly onFilesRejected?: (detail: {
readonly rejections: readonly FileDropzoneRejection[];
}) => void;
readonly children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
FileDropzoneInput & { readonly id?: string; readonly onFilesChange?: (detail: { readonly files: readonly File[]; readonly rejections: readonly FileDropzoneRejection[]; readonly changed: boolean; }) => void; readonly onFilesRejected?: (detail: { readonly rejections: readonly FileDropzoneRejection[]; }) => void; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
RootProvider
functionexport declare function RootProvider(props: { readonly value: UseFileDropzoneResult; readonly children?: JSX.Element;} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;props{
readonly value: UseFileDropzoneResult;
readonly children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
{ readonly value: UseFileDropzoneResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Trigger
functionexport declare function Trigger(props: JSX.ButtonHTMLAttributes<HTMLButtonElement>): JSX.Element;propsJSX.ButtonHTMLAttributes<HTMLButtonElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.ButtonHTMLAttributes<HTMLButtonElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
useFileDropzone
functionexport declare function useFileDropzone(input: Accessor<FileDropzoneInput>, options?: UseFileDropzoneOptions): UseFileDropzoneResult;inputAccessor<FileDropzoneInput>optionsUseFileDropzoneOptionsreturnUseFileDropzoneResult- Name
input- Kind
- parameter
- Type
Accessor<FileDropzoneInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseFileDropzoneOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseFileDropzoneResult- Requirement
- n/a
UseFileDropzoneResult
interfaceexport interface UseFileDropzoneResult { readonly service: FileDropzoneService; readonly connector: FileDropzoneApi; readonly scope: PartScope; readonly snapshot: () => number;}connectorFileDropzoneApiscopePartScopeserviceFileDropzoneServicesnapshot() => number- Name
connector- Kind
- property
- Type
FileDropzoneApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
FileDropzoneService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
() => number- Requirement
- required