mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
2f3cff2942The `clearFiles` prop description currently reads "Override the default behavior of clearing the array of uploaded files." This is misleading as `clearFiles` is a component accessor, not a `let` prop.
85 lines
1.7 KiB
TypeScript
85 lines
1.7 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";
|
|
|
|
/**
|
|
* Specify the accepted file types
|
|
* @default []
|
|
*/
|
|
accept?: string[];
|
|
|
|
/**
|
|
* Obtain the uploaded file names
|
|
* @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;
|
|
}
|