carbon-components-svelte/types/FileUploader/FileUploader.svelte.d.ts
metonym 78072a1c66
Align v10.53 (#1109)
* chore(deps): upgrade carbon-components to v10.53.0

* feat(text-area): add maxCount prop

* docs(text-area): add maximum character count

* feat(file-uploader): add disabled prop

* docs(file-uploader): add disabled state example
2022-02-21 13:40:57 -08:00

91 lines
1.8 KiB
TypeScript

/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface FileUploaderProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the file uploader status
* @default "uploading"
*/
status?: "uploading" | "edit" | "complete";
/**
* Set to `true` to disable the file uploader
* @default false
*/
disabled?: boolean;
/**
* Specify the accepted file types
* @default []
*/
accept?: string[];
/**
* Obtain a reference to the uploaded files
* @default []
*/
files?: File[];
/**
* Set to `true` to allow multiple files
* @default false
*/
multiple?: boolean;
/**
* Specify the label description
* @default ""
*/
labelDescription?: string;
/**
* Specify the label title
* @default ""
*/
labelTitle?: string;
/**
* Specify the kind of file uploader button
* @default "primary"
*/
kind?: "primary" | "secondary" | "tertiary" | "ghost" | "danger";
/**
* Specify the button label
* @default ""
*/
buttonLabel?: string;
/**
* Specify the ARIA label used for the status icons
* @default "Provide icon description"
*/
iconDescription?: string;
/**
* Specify a name attribute for the file button uploader input
* @default ""
*/
name?: string;
}
export default class FileUploader extends SvelteComponentTyped<
FileUploaderProps,
{
add: CustomEvent<File[]>;
remove: CustomEvent<File[]>;
change: CustomEvent<File[]>;
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
keydown: WindowEventMap["keydown"];
},
{}
> {
/**
* Programmatically clear the uploaded files
*/
clearFiles: () => void;
}