Skip to content

Commit 07a0e41

Browse files
committed
chore: add documentation
1 parent 825be6d commit 07a0e41

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

src/Shared/Services/ToastManager/toastManager.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
}
3434

3535
&__content {
36+
// Override the style for the action button
3637
button {
3738
color: var(--N0);
3839

src/Shared/Services/ToastManager/types.ts

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,33 @@ export enum ToastVariantType {
1010
}
1111

1212
export interface ToastProps {
13+
/**
14+
* Title for the toast
15+
* If not provided, defaults to a value based on the selected variant
16+
*/
1317
title?: string
18+
/**
19+
* Description for the toast
20+
*/
1421
description: string
22+
/**
23+
* Custom icon for the toast to override the icon based on variant
24+
*/
1525
icon?: ReactElement
26+
/**
27+
* Variant for the toast
28+
*
29+
* @default ToastVariantType.info
30+
*/
1631
variant?: ToastVariantType
32+
/**
33+
* Props for the action button to be displayed in the toast
34+
*
35+
* Note: Size, variant and style are hard-coded and cannot be overriden
36+
*/
1737
buttonProps?: ButtonProps
18-
progressBarBg?: `var(--${string})`
38+
/**
39+
* Custom progress bar color
40+
*/
41+
progressBarBg?: string
1942
}

0 commit comments

Comments
 (0)