mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-20 20:33:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Run "yarn build:docs"

Browse source
This commit is contained in:
Eric Liu 2022-02-21 10:25:40 -08:00
commit 65bbef12c5
3 changed files with 45 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

11
COMPONENT_INDEX.md
View file

@ -1329,11 +1329,12 @@ None.
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :------------ | :--------------- | :------- | :----------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| :------------ | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLInputElement</code> | <code>null</code> | Obtain a reference to the input HTML element |
| files | <code>let</code> | Yes | <code>File[]</code> | <code>[]</code> | Obtain a reference to the uploaded files |
| accept | <code>let</code> | No | <code>string[]</code> | <code>[]</code> | Specify the accepted file types |
| multiple | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to allow multiple files |
| validateFiles | <code>let</code> | No | <code>(files: FileList) => FileList</code> | <code>(files) => files</code> | Override the default behavior of validating uploaded files<br />The default behavior does not validate files |
| validateFiles | <code>let</code> | No | <code>(files: File) => File</code> | <code>(files) => files</code> | Override the default behavior of validating uploaded files<br />The default behavior does not validate files |
| labelText | <code>let</code> | No | <code>string</code> | <code>"Add file"</code> | Specify the label text |
| role | <code>let</code> | No | <code>string</code> | <code>"button"</code> | Specify the `role` attribute of the drop container |
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable the input |
@ -1350,13 +1351,13 @@ None.
### Events
| Event name | Type | Detail |
| :--------- | :--------- | :-------------------- |
| add | dispatched | <code>FileList</code> |
| :--------- | :--------- | :------------------ |
| add | dispatched | <code>File[]</code> |
| change | dispatched | <code>File[]</code> |
| dragover | forwarded | -- |
| dragleave | forwarded | -- |
| drop | forwarded | -- |
| keydown | forwarded | -- |
| change | forwarded | -- |
| click | forwarded | -- |
## `FileUploaderItem`

17
docs/src/COMPONENT_API.json
View file

@ -3749,6 +3749,17 @@
"constant": false,
"reactive": false
},
{
"name": "files",
"kind": "let",
"description": "Obtain a reference to the uploaded files",
"type": "File[]",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": true
},
{
"name": "multiple",
"kind": "let",
@ -3764,7 +3775,7 @@
"name": "validateFiles",
"kind": "let",
"description": "Override the default behavior of validating uploaded files\nThe default behavior does not validate files",
"type": "(files: FileList) => FileList",
"type": "(files: File) => File",
"value": "(files) => files",
"isFunction": true,
"isFunctionDeclaration": false,
@ -3858,12 +3869,12 @@
}
],
"events": [
{ "type": "dispatched", "name": "add", "detail": "FileList" },
{ "type": "dispatched", "name": "add", "detail": "File[]" },
{ "type": "dispatched", "name": "change", "detail": "File[]" },
{ "type": "forwarded", "name": "dragover", "element": "div" },
{ "type": "forwarded", "name": "dragleave", "element": "div" },
{ "type": "forwarded", "name": "drop", "element": "div" },
{ "type": "forwarded", "name": "keydown", "element": "label" },
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "click", "element": "input" }
],
"typedefs": [],

12
types/FileUploader/FileUploaderDropContainer.svelte.d.ts vendored
View file

@ -9,6 +9,12 @@ export interface FileUploaderDropContainerProps
*/
accept?: string[];
/**
* Obtain a reference to the uploaded files
* @default []
*/
files?: File[];
/**
* Set to `true` to allow multiple files
* @default false
@ -20,7 +26,7 @@ export interface FileUploaderDropContainerProps
* The default behavior does not validate files
* @default (files) => files
*/
validateFiles?: (files: FileList) => FileList;
validateFiles?: (files: File) => File;
/**
* Specify the label text
@ -68,12 +74,12 @@ export interface FileUploaderDropContainerProps
export default class FileUploaderDropContainer extends SvelteComponentTyped<
FileUploaderDropContainerProps,
{
add: CustomEvent<FileList>;
add: CustomEvent<File[]>;
change: CustomEvent<File[]>;
dragover: WindowEventMap["dragover"];
dragleave: WindowEventMap["dragleave"];
drop: WindowEventMap["drop"];
keydown: WindowEventMap["keydown"];
change: WindowEventMap["change"];
click: WindowEventMap["click"];
},
{ labelText: {} }