@up42/up-components 2.8.0 → 2.9.0
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.
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/types/components/Container/Container.overrides.d.ts +1 -0
- package/dist/cjs/types/global/providers/AlertProvider/AlertProvider.d.ts +35 -0
- package/dist/cjs/types/global/providers/AlertProvider/AlertStack.d.ts +2 -0
- package/dist/cjs/types/global/providers/AlertProvider/SnackbarWrapper.d.ts +2 -0
- package/dist/cjs/types/index.d.ts +1 -1
- package/dist/esm/index.js +2 -2
- package/dist/esm/types/components/Container/Container.overrides.d.ts +1 -0
- package/dist/esm/types/global/providers/AlertProvider/AlertProvider.d.ts +35 -0
- package/dist/esm/types/global/providers/AlertProvider/AlertStack.d.ts +2 -0
- package/dist/esm/types/global/providers/AlertProvider/SnackbarWrapper.d.ts +2 -0
- package/dist/esm/types/index.d.ts +1 -1
- package/dist/index.d.ts +30 -2
- package/package.json +1 -3
- package/dist/cjs/types/global/providers/AlertProvider/SnackBarStack.d.ts +0 -2
- package/dist/esm/types/global/providers/AlertProvider/SnackBarStack.d.ts +0 -2
- /package/dist/cjs/types/global/providers/AlertProvider/{SnackBarStack.test.d.ts → AlertStack.test.d.ts} +0 -0
- /package/dist/esm/types/global/providers/AlertProvider/{SnackBarStack.test.d.ts → AlertStack.test.d.ts} +0 -0
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ElementType, ReactNode } from 'react';
|
|
2
|
+
import { Fade, GrowProps, SnackbarProps as MUISnackbarProps, SlideProps } from '@mui/material';
|
|
2
3
|
import { AlertColor } from '../../../components/Alert/Alert';
|
|
3
4
|
export declare type CreateAlertProps = {
|
|
4
5
|
title?: string;
|
|
@@ -9,6 +10,36 @@ export declare type CreateAlertProps = {
|
|
|
9
10
|
*/
|
|
10
11
|
duration?: number;
|
|
11
12
|
};
|
|
13
|
+
/**
|
|
14
|
+
* Props for creating a snackbar.
|
|
15
|
+
*/
|
|
16
|
+
export declare type CreateSnackbarProps = {
|
|
17
|
+
/**
|
|
18
|
+
* The message to be displayed in the snackbar.
|
|
19
|
+
*/
|
|
20
|
+
message: string | ReactNode;
|
|
21
|
+
/**
|
|
22
|
+
* The type of the snackbar. Optional.
|
|
23
|
+
*/
|
|
24
|
+
type?: AlertColor;
|
|
25
|
+
/**
|
|
26
|
+
* The duration for which the snackbar should be displayed. Optional.
|
|
27
|
+
*/
|
|
28
|
+
duration?: number;
|
|
29
|
+
/**
|
|
30
|
+
* The number of columns the snackbar should occupy. Optional.
|
|
31
|
+
*/
|
|
32
|
+
columns?: 2 | 4 | 6 | 8;
|
|
33
|
+
/**
|
|
34
|
+
* The transition effect for the snackbar. Optional.
|
|
35
|
+
*/
|
|
36
|
+
transition?: 'slide' | 'grow' | 'fade';
|
|
37
|
+
} & MUISnackbarProps;
|
|
38
|
+
export declare const transitionComponents: {
|
|
39
|
+
slide: (props: SlideProps) => JSX.Element;
|
|
40
|
+
grow: (props: GrowProps) => JSX.Element;
|
|
41
|
+
fade: typeof Fade;
|
|
42
|
+
};
|
|
12
43
|
export declare type DisplayAlertProps = CreateAlertProps & {
|
|
13
44
|
id: string;
|
|
14
45
|
onClose?: (id: string) => void;
|
|
@@ -18,7 +49,11 @@ declare type ContextState = {
|
|
|
18
49
|
alertStack: DisplayAlertProps[];
|
|
19
50
|
removeFromStack: (id: string) => void;
|
|
20
51
|
animationTime: number;
|
|
52
|
+
createSnackbar: (props: CreateSnackbarProps) => void;
|
|
53
|
+
currentSnackbar: CreateSnackbarProps;
|
|
54
|
+
closeSnackbar: (props: CreateSnackbarProps) => void;
|
|
21
55
|
};
|
|
56
|
+
export declare const defaultSnackbarState: CreateSnackbarProps;
|
|
22
57
|
export declare const AlertProvider: ({ children }: {
|
|
23
58
|
children: ReactNode;
|
|
24
59
|
}) => JSX.Element;
|
|
@@ -55,4 +55,4 @@ export { formatFileSize } from './utils/helpers/formatFileSize';
|
|
|
55
55
|
export { useQueryParams } from './utils/hooks/useQueryParams';
|
|
56
56
|
export { useRemotePagination, type PaginatedResponse } from './utils/hooks/useRemotePagination';
|
|
57
57
|
export { useDebounce } from './utils/hooks/useDebounce';
|
|
58
|
-
export { useAlert, type CreateAlertProps } from './global/providers/AlertProvider/AlertProvider';
|
|
58
|
+
export { useAlert, type CreateAlertProps, type CreateSnackbarProps, } from './global/providers/AlertProvider/AlertProvider';
|