@team_yumi/ramen 0.4.0-next.20231219-327a2c3-d6b832e2ea82cee8758e4f6c5a5cf8a0 → 0.4.0-next.20231219-2241d97-88623b51301e936ab6c7a1c25ff918aa

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,12 +1,39 @@
1
1
  import React from 'react';
2
2
  import { Collections } from '../../../models';
3
3
  export interface IProps {
4
+ /**
5
+ * Type of the snackbar can be info, success, warning, error or loading
6
+ */
4
7
  type: (typeof Collections.ISnackbarType)[number];
8
+ /**
9
+ * The Placement of the snackbar can be top or bottom
10
+ * @deprecated the Placement is going to be removed in the next release
11
+ * is going to be always on top
12
+ */
13
+ placement: (typeof Collections.IPlacementY)[number];
14
+ /**
15
+ * The text to show in the snackbar
16
+ */
5
17
  text: string;
18
+ /**
19
+ * The duration of the snackbar in seconds
20
+ */
6
21
  duration?: number;
22
+ /**
23
+ * If the snackbar is closable
24
+ */
7
25
  closable?: boolean;
26
+ /**
27
+ * Function to trigger when the snackbar is closed
28
+ */
8
29
  onClose?: () => void;
30
+ /**
31
+ * Function to trigger when the action is clicked
32
+ */
9
33
  onActionClick?: () => void;
34
+ /**
35
+ * The text of the action
36
+ */
10
37
  actionText?: string;
11
38
  }
12
39
  declare const XSnackbar: React.FC<IProps>;