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

13 exports
View source packages/ui-headless/core/src/file-dropzone/index.ts
DeclarationView source
connectFileDropzonets
declare function connectFileDropzone(service: FileDropzoneService, scope: PartScope, options?: FileDropzoneConnectOptions): FileDropzoneApi;
Name
Kind
Type
Requirement
service
parameter
FileDropzoneService
required
scope
parameter
PartScope
required
options
parameter
FileDropzoneConnectOptions
optional
return
return value
FileDropzoneApi
n/a
Name
service
Kind
parameter
Type
FileDropzoneService
Requirement
required
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
DeclarationView source
fileDropzoneAnatomyts
export declare const fileDropzoneAnatomy: {
readonly scope: "file-dropzone";
readonly parts: readonly ["root", "trigger", "input", "item", "remove"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "input", "item", "remove"]
required
scope
property
"file-dropzone"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "input", "item", "remove"]
Requirement
required
Name
scope
Kind
property
Type
"file-dropzone"
Requirement
required

FileDropzoneApi

interface
DeclarationView source
FileDropzoneApits
interface 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[];
}
Name
Kind
Type
Requirement
addFiles
method
(files: readonly File[]) => void
required
files
property
readonly File[]
required
inputProps
method
() => PartProps
required
itemProps
method
(index: number) => PartProps
required
removeFile
method
(index: number) => void
required
removeProps
method
(index: number) => PartProps
required
reset
method
() => void
required
rootProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
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
DeclarationView source
FileDropzoneChangeDetailts
interface FileDropzoneChangeDetail {
readonly files: readonly File[];
readonly rejections: readonly FileDropzoneRejection[];
readonly changed: boolean;
}
Name
Kind
Type
Requirement
changed
property
boolean
required
files
property
readonly File[]
required
rejections
property
readonly FileDropzoneRejection[]
required
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
DeclarationView source
FileDropzoneConnectOptionsts
interface FileDropzoneConnectOptions extends FileDropzoneInput {
readonly onFilesChange?: (detail: FileDropzoneChangeDetail) => void;
readonly onFilesRejected?: (detail: {
readonly rejections: readonly FileDropzoneRejection[];
}) => void;
readonly messages?: Partial<FileDropzoneMessages>;
}
Name
Kind
Type
Requirement
messages
property
Partial<FileDropzoneMessages>
optional
onFilesChange
property
(detail: FileDropzoneChangeDetail) => void
optional
onFilesRejected
property
(detail: { readonly rejections: readonly FileDropzoneRejection[]; }) => void
optional
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
DeclarationView source
fileDropzoneMessagests
export declare const fileDropzoneMessages: FileDropzoneMessages;
DeclarationView source
FileDropzoneMessagests
type FileDropzoneMessages = Pick<MessageTable, "upload" | "remove">;

FileDropzoneMount

interface
DeclarationView source
FileDropzoneMountts
interface FileDropzoneMount {
readonly service: FileDropzoneService;
readonly connector: FileDropzoneApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
FileDropzoneService
required
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
DeclarationView source
FileDropzonePartts
type FileDropzonePart = (typeof fileDropzoneAnatomy.parts)[number];
DeclarationView source
FileDropzoneRejectionts
interface FileDropzoneRejection {
readonly file: File;
readonly reason: FileDropzoneRejectionReason;
}
Name
Kind
Type
Requirement
file
property
File
required
reason
property
FileDropzoneRejectionReason
required
Name
file
Kind
property
Type
File
Requirement
required
Name
reason
Kind
property
Type
FileDropzoneRejectionReason
Requirement
required
DeclarationView source
FileDropzoneServicets
type FileDropzoneService = Service<FileDropzoneInput, "ready", FileDropzoneContext, FileDropzoneEvent, FileDropzoneCommand>;
DeclarationView source
mountFileDropzonets
declare function mountFileDropzone(container: HTMLElement, options?: MountFileDropzoneOptions): FileDropzoneMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountFileDropzoneOptions
optional
return
return value
FileDropzoneMount
n/a
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
DeclarationView source
MountFileDropzoneOptionsts
interface 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 example follows below.

React imports

@grassroot/ui-headless-react/file-dropzonets
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-react/file-dropzone";

Vue imports

@grassroot/ui-headless-vue/file-dropzonets
<script setup lang="ts">
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-vue/file-dropzone";
</script>

Angular imports

@grassroot/ui-headless-angular/file-dropzonets
import { GrFileDropzoneItem, GrFileDropzoneRemove, GrFileDropzoneRoot, GrFileDropzoneRootProvider, GrFileDropzoneTrigger, Item, Remove, Root } from "@grassroot/ui-headless-angular/file-dropzone"; // +2 more exports

Svelte imports

@grassroot/ui-headless-svelte/file-dropzonets
<script lang="ts">
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-svelte/file-dropzone";
</script>

Solid imports

@grassroot/ui-headless-solid/file-dropzonets
import { Item, Remove, Root, RootProvider, Trigger } from "@grassroot/ui-headless-solid/file-dropzone";

@grassroot/ui-headless-react/file-dropzone

React adapter

10 exports
View source packages/ui-headless/react/src/file-dropzone/index.ts
DeclarationView source
FileDropzoneRootPropsts
interface FileDropzoneRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "id">, FileDropzoneInput, UseFileDropzoneOptions {
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional

Input

value
DeclarationView source
Inputts
export declare const Input: import("react").ForwardRefExoticComponent<InputHTMLAttributes<HTMLInputElement> & import("react").RefAttributes<HTMLInputElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Item

value
DeclarationView source
Itemts
export declare const Item: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLLIElement> & {
readonly index: number;
} & import("react").RefAttributes<HTMLLIElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Remove

value
DeclarationView source
Removets
export declare const Remove: import("react").ForwardRefExoticComponent<ButtonHTMLAttributes<HTMLButtonElement> & {
readonly index: number;
} & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<FileDropzoneRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<{
readonly value: UseFileDropzoneResult;
readonly children?: ReactNode;
} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: import("react").ForwardRefExoticComponent<ButtonHTMLAttributes<HTMLButtonElement> & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useFileDropzone

function
DeclarationView source
useFileDropzonets
declare function useFileDropzone(input: FileDropzoneInput, options?: UseFileDropzoneOptions): UseFileDropzoneResult;
Name
Kind
Type
Requirement
input
parameter
FileDropzoneInput
required
options
parameter
UseFileDropzoneOptions
optional
return
return value
UseFileDropzoneResult
n/a
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
DeclarationView source
UseFileDropzoneOptionsts
interface UseFileDropzoneOptions {
readonly id?: string;
readonly onFilesChange?: FileDropzoneConnectOptions["onFilesChange"];
readonly onFilesRejected?: FileDropzoneConnectOptions["onFilesRejected"];
}
Name
Kind
Type
Requirement
id
property
string
optional
onFilesChange
property
FileDropzoneConnectOptions["onFilesChange"]
optional
onFilesRejected
property
FileDropzoneConnectOptions["onFilesRejected"]
optional
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
DeclarationView source
UseFileDropzoneResultts
interface UseFileDropzoneResult {
readonly service: FileDropzoneService;
readonly connector: FileDropzoneApi;
readonly scope: PartScope;
readonly snapshot: FileDropzoneSnapshot;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
scope
property
PartScope
required
service
property
FileDropzoneService
required
snapshot
property
FileDropzoneSnapshot
required
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

8 exports
View source packages/ui-headless/vue/src/file-dropzone/index.ts

Input

value
DeclarationView source
Inputts
export 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

value
DeclarationView source
Itemts
export 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

value
DeclarationView source
Removets
export 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

value
DeclarationView source
Rootts
export 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

value
DeclarationView source
RootProviderts
export 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

value
DeclarationView source
Triggerts
export 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

function
DeclarationView source
useFileDropzonets
declare function useFileDropzone(input: () => FileDropzoneInput, options?: () => FileDropzoneOptions): UseFileDropzoneResult;
Name
Kind
Type
Requirement
input
parameter
() => FileDropzoneInput
required
options
parameter
() => FileDropzoneOptions
optional
return
return value
UseFileDropzoneResult
n/a
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
DeclarationView source
UseFileDropzoneResultts
interface UseFileDropzoneResult {
readonly service: FileDropzoneService;
readonly connector: FileDropzoneApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<FileDropzoneSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
scope
property
PartScope
required
service
property
FileDropzoneService
required
snapshot
property
ShallowRef<FileDropzoneSnapshot>
required
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

16 exports
View source packages/ui-headless/angular/src/file-dropzone/index.ts
DeclarationView source
createFileDropzoneStorets
export declare function createFileDropzoneStore(initial: FileDropzoneInput, options?: FileDropzoneConnectOptions): FileDropzoneStore;
Name
Kind
Type
Requirement
initial
parameter
FileDropzoneInput
required
options
parameter
FileDropzoneConnectOptions
optional
return
return value
FileDropzoneStore
n/a
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
DeclarationView source
FileDropzoneChangeDetailts
interface FileDropzoneChangeDetail {
readonly files: readonly File[];
readonly rejections: readonly FileDropzoneRejection[];
readonly changed: boolean;
}
Name
Kind
Type
Requirement
changed
property
boolean
required
files
property
readonly File[]
required
rejections
property
readonly FileDropzoneRejection[]
required
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
DeclarationView source
FileDropzoneRejectionts
interface FileDropzoneRejection {
readonly file: File;
readonly reason: FileDropzoneRejectionReason;
}
Name
Kind
Type
Requirement
file
property
File
required
reason
property
FileDropzoneRejectionReason
required
Name
file
Kind
property
Type
File
Requirement
required
Name
reason
Kind
property
Type
FileDropzoneRejectionReason
Requirement
required

FileDropzoneStore

interface
DeclarationView source
FileDropzoneStorets
export 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;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
scope
property
PartScope
required
service
property
FileDropzoneService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: Record<string, unknown>) => void
required
version
property
WritableSignal<number>
required
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
DeclarationView source
GrFileDropzoneInputts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>
required
store
property
any
required
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
DeclarationView source
GrFileDropzoneItemts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>
required
store
property
any
required
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
DeclarationView source
GrFileDropzoneRemovets
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>
required
store
property
any
required
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
DeclarationView source
GrFileDropzoneRootts
export 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>;
}
Name
Kind
Type
Requirement
accept
property
import("@angular/core").InputSignal<string | undefined>
required
consumer
property
any
required
defaultFiles
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean>
required
files
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>
required
filesChange
property
import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
maxFiles
property
import("@angular/core").InputSignal<number | undefined>
required
maxFileSize
property
import("@angular/core").InputSignal<number | undefined>
required
multiple
property
import("@angular/core").InputSignal<boolean | undefined>
required
ngOnDestroy
method
() => void
required
options
property
any
required
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
DeclarationView source
GrFileDropzoneRootProviderts
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>;
}
Name
Kind
Type
Requirement
host
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>
required
store
property
any
required
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
DeclarationView source
GrFileDropzoneTriggerts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>
required
store
property
any
required
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

class
DeclarationView source
Inputts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneInput, "[grFileDropzoneInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneInput, never>
required
store
property
any
required
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

class
DeclarationView source
Itemts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneItem, "[grFileDropzoneItem]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneItem, never>
required
store
property
any
required
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

class
DeclarationView source
Removets
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
index
property
import("@angular/core").InputSignal<number>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneRemove, "[grFileDropzoneRemove]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneRemove, never>
required
store
property
any
required
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

class
DeclarationView source
Rootts
export 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>;
}
Name
Kind
Type
Requirement
accept
property
import("@angular/core").InputSignal<string | undefined>
required
consumer
property
any
required
defaultFiles
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean>
required
files
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/file-dropzone").FileDropzoneFile[] | undefined>
required
filesChange
property
import("@angular/core").OutputEmitterRef<FileDropzoneChangeDetail>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
maxFiles
property
import("@angular/core").InputSignal<number | undefined>
required
maxFileSize
property
import("@angular/core").InputSignal<number | undefined>
required
multiple
property
import("@angular/core").InputSignal<boolean | undefined>
required
ngOnDestroy
method
() => void
required
options
property
any
required
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

class
DeclarationView source
RootProviderts
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>;
}
Name
Kind
Type
Requirement
host
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrFileDropzoneRootProvider, "gr-file-dropzone-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneRootProvider, never>
required
store
property
any
required
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

class
DeclarationView source
Triggerts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrFileDropzoneTrigger, "[grFileDropzoneTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrFileDropzoneTrigger, never>
required
store
property
any
required
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

9 exports
View source packages/ui-headless/svelte/src/file-dropzone/index.ts
DeclarationView source
createFileDropzonets
export declare function createFileDropzone(input: () => FileDropzoneInput, options?: UseFileDropzoneOptions): UseFileDropzoneResult;
Name
Kind
Type
Requirement
input
parameter
() => FileDropzoneInput
required
options
parameter
UseFileDropzoneOptions
optional
return
return value
UseFileDropzoneResult
n/a
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

value
DeclarationView source
Inputts
export declare const Input: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
Itemts
export declare const Item: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
Removets
export declare const Remove: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
Rootts
export declare const Root: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
Triggerts
export declare const Trigger: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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
DeclarationView source
UseFileDropzoneOptionsts
export interface UseFileDropzoneOptions extends FileDropzoneConnectOptions {
readonly id?: string;
}
Name
Kind
Type
Requirement
id
property
string
optional
Name
id
Kind
property
Type
string
Requirement
optional
DeclarationView source
UseFileDropzoneResultts
export interface UseFileDropzoneResult {
readonly service: FileDropzoneService;
readonly connector: FileDropzoneApi;
readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
FileDropzoneService
required
version
property
() => number
required
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

8 exports
View source packages/ui-headless/solid/src/file-dropzone/index.ts

Input

function
DeclarationView source
Inputts
export declare function Input(props: JSX.InputHTMLAttributes<HTMLInputElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.InputHTMLAttributes<HTMLInputElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.InputHTMLAttributes<HTMLInputElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Item

function
DeclarationView source
Itemts
export declare function Item(props: JSX.LiHTMLAttributes<HTMLLIElement> & {
readonly index: number;
}): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.LiHTMLAttributes<HTMLLIElement> & { readonly index: number; }
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
Removets
export declare function Remove(props: JSX.ButtonHTMLAttributes<HTMLButtonElement> & {
readonly index: number;
}): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.ButtonHTMLAttributes<HTMLButtonElement> & { readonly index: number; }
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
Rootts
export 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;
Name
Kind
Type
Requirement
props
parameter
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>
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: {
readonly value: UseFileDropzoneResult;
readonly children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ readonly value: UseFileDropzoneResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
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

function
DeclarationView source
Triggerts
export declare function Trigger(props: JSX.ButtonHTMLAttributes<HTMLButtonElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.ButtonHTMLAttributes<HTMLButtonElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.ButtonHTMLAttributes<HTMLButtonElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useFileDropzone

function
DeclarationView source
useFileDropzonets
export declare function useFileDropzone(input: Accessor<FileDropzoneInput>, options?: UseFileDropzoneOptions): UseFileDropzoneResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<FileDropzoneInput>
required
options
parameter
UseFileDropzoneOptions
optional
return
return value
UseFileDropzoneResult
n/a
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
DeclarationView source
UseFileDropzoneResultts
export interface UseFileDropzoneResult {
readonly service: FileDropzoneService;
readonly connector: FileDropzoneApi;
readonly scope: PartScope;
readonly snapshot: () => number;
}
Name
Kind
Type
Requirement
connector
property
FileDropzoneApi
required
scope
property
PartScope
required
service
property
FileDropzoneService
required
snapshot
property
() => number
required
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