@verifiedinc-public/shared-ui-elements 0.13.1 → 0.13.2-beta.2

package/dist/components/Snackbar/index.d.ts

@@ -0,0 +1,52 @@
+import { AlertColor, SxProps } from '@mui/material';
+import { CustomContentProps, SnackbarKey, SnackbarProvider } from 'notistack';
+declare module 'notistack' {
+    interface VariantOverrides {
+        default: false;
+        success: false;
+        info: false;
+        warning: false;
+        error: false;
+        customAlertComponent: {
+            onAction?: (id: SnackbarKey) => void;
+            icon?: JSX.Element;
+            severity?: AlertColor;
+        };
+    }
+}
+export type { SnackbarKey };
+export { SnackbarProvider };
+interface AlertAction {
+    onAction?: (id: SnackbarKey) => void;
+    icon?: JSX.Element;
+}
+interface CustomAlertComponentProps extends Partial<CustomContentProps> {
+    severity: AlertColor;
+    alertAction?: AlertAction;
+    showCloseIcon?: boolean;
+    sx?: SxProps;
+}
+/**
+ * Hook to manage snackbar messages
+ * It wraps the enqueueSnackbar and closeSnackbar functions from the notistack library
+ * @returns
+ *  - updateSnackbar: Function to enqueue a snackbar message
+ *  - closeSnackbar: Function to close one or all snackbar messages
+ *  @see https://notistack.com/api-reference
+ */
+export declare function useSnackbar(): {
+    updateSnackbar: (message: string, severity?: AlertColor, options?: Omit<CustomAlertComponentProps, 'severity'>) => void;
+    closeSnackbar: (key?: SnackbarKey) => void;
+};
+/**
+ * Custom Alert component to show snackbar messages
+ * This is a wrapper around the notistack SnackbarContent component
+ *
+ * Use it in the SnackbarProvider Components prop:
+ * @see https://notistack.com/features/customization#custom-component
+ * @example
+ * <SnackbarProvider
+ *   Components={{ customAlertComponent: CustomAlertComponent }}
+ * />
+ */
+export declare const CustomAlertComponent: import('react').ForwardRefExoticComponent<CustomAlertComponentProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/components/index.d.ts

@@ -8,3 +8,4 @@ export * from './Image';
 export * from './form/';
 export * from './verified';
 export * from './QRCodeDisplay';
+export * from './Snackbar';

package/dist/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * The shared-ui-elements library is a collection of reusable, customizable UI components developed for Verified Inc..
+ *
+ * @see https://github.com/VerifiedInc/shared-ui-elements
+ *
+ * @packageDocumentation
+ */
 export * from './components';
 export * from './hooks';
 export * from './styles';