diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 8f969289..30e93290 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -4311,18 +4311,19 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100"; ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :-------------- | :------- | :--------------- | :------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | -| kind | No | let | No | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | "error" | Specify the kind of notification | -| lowContrast | No | let | No | boolean | false | Set to `true` to use the low contrast variant | -| timeout | No | let | No | number | 0 | Set the timeout duration (ms) to hide the notification after opening it | -| role | No | let | No | string | "alert" | Set the `role` attribute | -| title | No | let | No | string | "" | Specify the title text | -| subtitle | No | let | No | string | "" | Specify the subtitle text | -| caption | No | let | No | string | "" | Specify the caption text | -| iconDescription | No | let | No | string | "Closes notification" | Specify the ARIA label for the icon | -| hideCloseButton | No | let | No | boolean | false | Set to `true` to hide the close button | -| fullWidth | No | let | No | boolean | false | Set to `true` for the notification to span
the full width of its containing element. | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :--------------------- | :------- | :--------------- | :------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------- | +| kind | No | let | No | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | "error" | Specify the kind of notification | +| lowContrast | No | let | No | boolean | false | Set to `true` to use the low contrast variant | +| timeout | No | let | No | number | 0 | Set the timeout duration (ms) to hide the notification after opening it | +| role | No | let | No | string | "alert" | Set the `role` attribute | +| title | No | let | No | string | "" | Specify the title text | +| subtitle | No | let | No | string | "" | Specify the subtitle text | +| caption | No | let | No | string | "" | Specify the caption text | +| statusIconDescription | No | let | No | string | kind + " icon" | Specify the ARIA label for the status icon | +| closeButtonDescription | No | let | No | string | "Close notification" | Specify the ARIA label for the close button | +| hideCloseButton | No | let | No | boolean | false | Set to `true` to hide the close button | +| fullWidth | No | let | No | boolean | false | Set to `true` for the notification to span
the full width of its containing element. | ### Slots diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 01f0c082..ce55e9ba 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -13401,11 +13401,23 @@ "reactive": false }, { - "name": "iconDescription", + "name": "statusIconDescription", "kind": "let", - "description": "Specify the ARIA label for the icon", + "description": "Specify the ARIA label for the status icon", "type": "string", - "value": "\"Closes notification\"", + "value": "kind + \" icon\"", + "isFunction": false, + "isFunctionDeclaration": false, + "isRequired": false, + "constant": false, + "reactive": false + }, + { + "name": "closeButtonDescription", + "kind": "let", + "description": "Specify the ARIA label for the close button", + "type": "string", + "value": "\"Close notification\"", "isFunction": false, "isFunctionDeclaration": false, "isRequired": false, diff --git a/types/Notification/ToastNotification.svelte.d.ts b/types/Notification/ToastNotification.svelte.d.ts index 9e86f6ed..4bc6d359 100644 --- a/types/Notification/ToastNotification.svelte.d.ts +++ b/types/Notification/ToastNotification.svelte.d.ts @@ -52,10 +52,16 @@ export interface ToastNotificationProps caption?: string; /** - * Specify the ARIA label for the icon - * @default "Closes notification" + * Specify the ARIA label for the status icon + * @default kind + " icon" */ - iconDescription?: string; + statusIconDescription?: string; + + /** + * Specify the ARIA label for the close button + * @default "Close notification" + */ + closeButtonDescription?: string; /** * Set to `true` to hide the close button