mui-notifications 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# MUI Notifications
+
+Application notifications component using Material UI. Imperative APIs to show and interact with application notifications.
+
+
+### Install
+
+Make sure you have **@mui/material** in your project, then: 
+
+```js
+npm install mui-notifications
+```
+
+
+### Usage
+
+
+Install the NotificationsProvider.
+
+```tsx
+import { NotificationsProvider } from '@toolpad/core/useNotifications';
+
+function App({ children }) {
+  return <NotificationsProvider>{children}</NotificationsProvider>;
+}
+```
+
+Now you can get acess to the notifications APIs through the **useNotifications** hook.
+
+```tsx
+import { useNotifications } from '@toolpad/core/useNotifications';
+
+function MyApp() {
+  const notifications = useNotifications();
+  // ...
+}
+```
+
+### Basic notification
+
+You can notify your users with a neutral message by calling notifications.show. To have the notification automatically hide, add the autoHideDuration option. This expresses the time in milliseconds after which to close the notification.
+
+```tsx
+notifications.show('Consider yourself notified!', {
+  autoHideDuration: 3000,
+});
+```

package/dist/NotificationsContext.d.ts

@@ -0,0 +1,7 @@
+import { CloseNotification, ShowNotification } from './useNotifications';
+import * as React from "react";
+export interface NotificationsContextValue {
+    show: ShowNotification;
+    close: CloseNotification;
+}
+export declare const NotificationsContext: React.Context<NotificationsContextValue | null>;

package/dist/NotificationsProvider.d.ts

@@ -0,0 +1,15 @@
+import { SnackbarProps } from '@mui/material';
+import * as React from "react";
+export interface NotificationsProviderSlotProps {
+    snackbar: SnackbarProps;
+}
+export interface NotificationsProviderSlots {
+    snackbar: React.ElementType;
+}
+export interface NotificationsProviderProps {
+    children?: React.ReactNode;
+    slots?: Partial<NotificationsProviderSlots>;
+    slotProps?: Partial<NotificationsProviderSlotProps>;
+}
+declare function NotificationsProvider(props: NotificationsProviderProps): import("react/jsx-runtime").JSX.Element;
+export { NotificationsProvider };

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from './useNotifications';
+export * from './NotificationsProvider';