mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
102 lines
2.3 KiB
TypeScript
102 lines
2.3 KiB
TypeScript
import type { SvelteComponentTyped } from "svelte";
|
|
import type { SvelteHTMLElements } from "svelte/elements";
|
|
|
|
type RestProps = SvelteHTMLElements["div"];
|
|
|
|
export interface FileUploaderProps extends RestProps {
|
|
/**
|
|
* 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?: ReadonlyArray<string>;
|
|
|
|
/**
|
|
* Obtain a reference to the uploaded files
|
|
* @default []
|
|
*/
|
|
files?: ReadonlyArray<File>;
|
|
|
|
/**
|
|
* Set to `true` to allow multiple files
|
|
* @default false
|
|
*/
|
|
multiple?: boolean;
|
|
|
|
/**
|
|
* Specify the label title.
|
|
* Alternatively, use the named slot "labelTitle" (e.g., `<span slot="labelTitle">...</span>`)
|
|
* @default ""
|
|
*/
|
|
labelTitle?: string;
|
|
|
|
/**
|
|
* Specify the label description.
|
|
* Alternatively, use the named slot "labelDescription" (e.g., `<span slot="labelDescription">...</span>`)
|
|
* @default ""
|
|
*/
|
|
labelDescription?: string;
|
|
|
|
/**
|
|
* Specify the kind of file uploader button
|
|
* @default "primary"
|
|
*/
|
|
kind?: import("../Button/Button.svelte").ButtonProps["kind"];
|
|
|
|
/**
|
|
* Specify the size of the file uploader button
|
|
* @default "small"
|
|
*/
|
|
size?: import("../Button/Button.svelte").ButtonProps["size"];
|
|
|
|
/**
|
|
* 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;
|
|
|
|
[key: `data-${string}`]: any;
|
|
}
|
|
|
|
export default class FileUploader extends SvelteComponentTyped<
|
|
FileUploaderProps,
|
|
{
|
|
add: CustomEvent<ReadonlyArray<File>>;
|
|
remove: CustomEvent<ReadonlyArray<File>>;
|
|
change: CustomEvent<ReadonlyArray<File>>;
|
|
click: WindowEventMap["click"];
|
|
mouseover: WindowEventMap["mouseover"];
|
|
mouseenter: WindowEventMap["mouseenter"];
|
|
mouseleave: WindowEventMap["mouseleave"];
|
|
keydown: WindowEventMap["keydown"];
|
|
},
|
|
{ labelDescription: {}; labelTitle: {} }
|
|
> {
|
|
/**
|
|
* Programmatically clear the uploaded files
|
|
*/
|
|
clearFiles: () => void;
|
|
}
|