diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index b1e320e8..e78b10dc 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -1250,20 +1250,20 @@ None. ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :--------------- | :------- | :----------------- | :------- | ------------------------------------------------------------------------------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| files | No | let | Yes | ReadonlyArray | [] | Obtain a reference to the uploaded files | -| status | No | let | No | "uploading" | "edit" | "complete" | "uploading" | Specify the file uploader status | -| disabled | No | let | No | boolean | false | Set to `true` to disable the file uploader | -| accept | No | let | No | ReadonlyArray | [] | Specify the accepted file types | -| multiple | No | let | No | boolean | false | Set to `true` to allow multiple files | -| clearFiles | No | const | No | () => void | () => { files = []; } | Programmatically clear the uploaded files | -| labelTitle | No | let | No | string | "" | Specify the label title.
Alternatively, use the named slot "labelTitle" (e.g., `<span slot="labelTitle">...</span>`) | -| labelDescription | No | let | No | string | "" | Specify the label description.
Alternatively, use the named slot "labelDescription" (e.g., `<span slot="labelDescription">...</span>`) | -| kind | No | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "primary" | Specify the kind of file uploader button | -| buttonLabel | No | let | No | string | "" | Specify the button label | -| iconDescription | No | let | No | string | "Provide icon description" | Specify the ARIA label used for the status icons | -| name | No | let | No | string | "" | Specify a name attribute for the file button uploader input | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :--------------- | :------- | :----------------- | :------- | ------------------------------------------------------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| files | No | let | Yes | ReadonlyArray | [] | Obtain a reference to the uploaded files | +| status | No | let | No | "uploading" | "edit" | "complete" | "uploading" | Specify the file uploader status | +| disabled | No | let | No | boolean | false | Set to `true` to disable the file uploader | +| accept | No | let | No | ReadonlyArray | [] | Specify the accepted file types | +| multiple | No | let | No | boolean | false | Set to `true` to allow multiple files | +| clearFiles | No | const | No | () => void | () => { files = []; } | Programmatically clear the uploaded files | +| labelTitle | No | let | No | string | "" | Specify the label title.
Alternatively, use the named slot "labelTitle" (e.g., `<span slot="labelTitle">...</span>`) | +| labelDescription | No | let | No | string | "" | Specify the label description.
Alternatively, use the named slot "labelDescription" (e.g., `<span slot="labelDescription">...</span>`) | +| kind | No | let | No | import("../Button/Button.svelte").ButtonProps["kind"] | "primary" | Specify the kind of file uploader button | +| buttonLabel | No | let | No | string | "" | Specify the button label | +| iconDescription | No | let | No | string | "Provide icon description" | Specify the ARIA label used for the status icons | +| name | No | let | No | string | "" | Specify a name attribute for the file button uploader input | ### Slots @@ -1289,20 +1289,20 @@ None. ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :------------------ | :------- | :--------------- | :------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------ | -------------------------------------------- | -| ref | No | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element | -| labelText | No | let | Yes | string | "Add file" | Specify the label text | -| files | No | let | Yes | ReadonlyArray | [] | Obtain a reference to the uploaded files | -| accept | No | let | No | ReadonlyArray | [] | Specify the accepted file types | -| multiple | No | let | No | boolean | false | Set to `true` to allow multiple files | -| disabled | No | let | No | boolean | false | Set to `true` to disable the input | -| disableLabelChanges | No | let | No | boolean | false | Set to `true` to disable label changes | -| kind | No | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "primary" | Specify the kind of file uploader button | -| role | No | let | No | string | "button" | Specify the label role | -| tabindex | No | let | No | string | "0" | Specify `tabindex` attribute | -| id | No | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | -| name | No | let | No | string | "" | Specify a name attribute for the input | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :------------------ | :------- | :--------------- | :------- | ------------------------------------------------------------------ | ------------------------------------------------ | -------------------------------------------- | +| ref | No | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element | +| labelText | No | let | Yes | string | "Add file" | Specify the label text | +| files | No | let | Yes | ReadonlyArray | [] | Obtain a reference to the uploaded files | +| accept | No | let | No | ReadonlyArray | [] | Specify the accepted file types | +| multiple | No | let | No | boolean | false | Set to `true` to allow multiple files | +| disabled | No | let | No | boolean | false | Set to `true` to disable the input | +| disableLabelChanges | No | let | No | boolean | false | Set to `true` to disable label changes | +| kind | No | let | No | import("../Button/Button.svelte").ButtonProps["kind"] | "primary" | Specify the kind of file uploader button | +| role | No | let | No | string | "button" | Specify the label role | +| tabindex | No | let | No | string | "0" | Specify `tabindex` attribute | +| id | No | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | +| name | No | let | No | string | "" | Specify a name attribute for the input | ### Slots diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 6b3124a7..d5be4edc 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -3822,7 +3822,7 @@ "name": "kind", "kind": "let", "description": "Specify the kind of file uploader button", - "type": "\"primary\" | \"secondary\" | \"tertiary\" | \"ghost\" | \"danger\"", + "type": "import(\"../Button/Button.svelte\").ButtonProps[\"kind\"]", "value": "\"primary\"", "isFunction": false, "isFunctionDeclaration": false, @@ -3975,7 +3975,7 @@ "name": "kind", "kind": "let", "description": "Specify the kind of file uploader button", - "type": "\"primary\" | \"secondary\" | \"tertiary\" | \"ghost\" | \"danger\"", + "type": "import(\"../Button/Button.svelte\").ButtonProps[\"kind\"]", "value": "\"primary\"", "isFunction": false, "isFunctionDeclaration": false, diff --git a/src/FileUploader/FileUploader.svelte b/src/FileUploader/FileUploader.svelte index dc887999..51871793 100644 --- a/src/FileUploader/FileUploader.svelte +++ b/src/FileUploader/FileUploader.svelte @@ -51,7 +51,7 @@ /** * Specify the kind of file uploader button - * @type {"primary" | "secondary" | "tertiary" | "ghost" | "danger"} + * @type {import("../Button/Button.svelte").ButtonProps["kind"]} */ export let kind = "primary"; diff --git a/src/FileUploader/FileUploaderButton.svelte b/src/FileUploader/FileUploaderButton.svelte index 2c8dedab..630b9304 100644 --- a/src/FileUploader/FileUploaderButton.svelte +++ b/src/FileUploader/FileUploaderButton.svelte @@ -26,7 +26,7 @@ /** * Specify the kind of file uploader button - * @type {"primary" | "secondary" | "tertiary" | "ghost" | "danger"} + * @type {import("../Button/Button.svelte").ButtonProps["kind"]} */ export let kind = "primary"; diff --git a/tests/FileUploader.test.svelte b/tests/FileUploader.test.svelte index cc065d7a..379deb87 100644 --- a/tests/FileUploader.test.svelte +++ b/tests/FileUploader.test.svelte @@ -20,6 +20,7 @@