@react-md/core 1.0.0-next.1 → 1.0.0-next.11

package/src/snackbar/Snackbar.tsx

@@ -1,10 +1,5 @@
 "use client";
-import {
-  forwardRef,
-  type AriaRole,
-  type ComponentType,
-  type HTMLAttributes,
-} from "react";
+import { forwardRef, type ComponentType, type HTMLAttributes } from "react";
 import { Portal } from "../portal/Portal.js";
 import { useEnsuredId } from "../useEnsuredId.js";
 import {
@@ -19,14 +14,9 @@ import { snackbar, type SnackbarPosition } from "./snackbarStyles.js";
  * @remarks \@since 6.0.0 The `id` prop is optional
  */
 export interface SnackbarProps extends HTMLAttributes<HTMLDivElement> {
-  /**
-   * @defaultValue `"snackbar-" + useId()`
-   */
+  /** @defaultValue `"snackbar-" + useId()` */
   id?: string;
 
-  /** @defaultValue `"status"` */
-  role?: AriaRole;
-
   /**
    * Set this to the number of toasts that can be visible within the snackbar at
    * the same time. Any toasts added after this value will be added into the
@@ -37,13 +27,18 @@ export interface SnackbarProps extends HTMLAttributes<HTMLDivElement> {
   limit?: number;
 
   /**
-   * @defaultValue `"bottom"`
+   * Set this to `true` if the snackbar should use absolute positioning so it
+   * can be fixed within a `position: relative` container instead of the entire
+   * viewport.
+   *
+   * @defaultValue `false`
    */
+  absolute?: boolean;
+
+  /** @defaultValue `"bottom"` */
   position?: SnackbarPosition;
 
-  /**
-   * @defaultValue `false`
-   */
+  /** @defaultValue `false` */
   disablePortal?: boolean;
 
   /**
@@ -154,9 +149,9 @@ export const Snackbar = forwardRef<HTMLDivElement, SnackbarProps>(
   function Snackbar(props, ref) {
     const {
       id: propId,
-      role = "status",
       className,
       limit = 1,
+      absolute,
       position = "bottom",
       renderToast: RenderToast = DefaultToastRenderer,
       disablePortal,
@@ -168,21 +163,22 @@ export const Snackbar = forwardRef<HTMLDivElement, SnackbarProps>(
 
     return (
       <Portal disabled={disablePortal}>
-        <div
-          {...remaining}
-          id={id}
-          ref={ref}
-          role={role}
-          className={snackbar({ position, className })}
-        >
-          {queue.map((toast) => (
-            <RenderToast
-              {...toast}
-              key={toast.toastId}
-              toastDefaults={toastDefaults}
-            />
-          ))}
-        </div>
+        {queue.length > 0 && (
+          <div
+            {...remaining}
+            id={id}
+            ref={ref}
+            className={snackbar({ absolute, position, className })}
+          >
+            {queue.map((toast) => (
+              <RenderToast
+                {...toast}
+                key={toast.toastId}
+                toastDefaults={toastDefaults}
+              />
+            ))}
+          </div>
+        )}
       </Portal>
     );
   }

package/src/snackbar/Toast.tsx

@@ -38,7 +38,7 @@ export interface ConfigurableToastProps
   /**
    * Note: This is set while creating the toast.
    *
-   * @defaultValue `visibleTime === null ? "alert" : undefined`
+   * @defaultValue `visibleTime === null ? "alert" : "status"`
    */
   role?: AriaRole;
 
@@ -149,7 +149,7 @@ export const Toast = forwardRef<HTMLDivElement, ToastProps>(
       actionButton: propActionButton,
       paused,
       visible,
-      closeIcon,
+      closeIcon: propCloseIcon,
       closeButtonProps,
       closeButton = !!closeButtonProps,
       contentProps,
@@ -190,6 +190,11 @@ export const Toast = forwardRef<HTMLDivElement, ToastProps>(
       );
     }
 
+    let closeIcon = propCloseIcon;
+    if (typeof closeButtonProps?.children !== "undefined") {
+      closeIcon = closeButtonProps.children;
+    }
+
     const action = !!actionButton;
     const reordered = stacked && action && closeButton;
     const { elementProps, rendered } = useScaleTransition({

package/src/snackbar/ToastManager.tsx

@@ -15,7 +15,8 @@ export const DEFAULT_TOAST_VISIBLE_TIME = 5000;
  * - `"replace"` - if there is a currently visible toast, it will start the
  *   leave transition and display the newly added toast instead.
  * - `"immediate"` - the same behavior as `"replace"` except that if there was a
- *   currently visible toast, it will be shown once the newly added toast again.
+ *   currently visible toast, the toast will be shown again once the `"immediate"`
+ *   toast is hidden.
  *
  * @remarks \@since 6.0.0 Renamed from `MessagePriority` to `ToastPriority`
  */
@@ -304,7 +305,7 @@ export class ToastManager {
     const {
       toastId = nanoid(),
       visibleTime = DEFAULT_TOAST_VISIBLE_TIME,
-      role = visibleTime === null ? "alert" : undefined,
+      role = visibleTime === null ? "alert" : "status",
       priority = "normal",
       duplicates = "restart",
     } = toast;

package/src/snackbar/__tests__/Snackbar.tsx

@@ -16,12 +16,13 @@ const render = (
   ui: ReactElement,
   options?: ReactMDRenderOptions
 ): RenderResult => {
+  const manager = new ToastManager();
+  manager.addToast({ children: "Toast" });
+
   return rmdRender(ui, {
     ...options,
     wrapper: ({ children }) => (
-      <ToastManagerProvider manager={new ToastManager()}>
-        {children}
-      </ToastManagerProvider>
+      <ToastManagerProvider manager={manager}>{children}</ToastManagerProvider>
     ),
   });
 };
@@ -30,12 +31,12 @@ describe("Snackbar", () => {
   it("should apply the correct styling, HTML attributes, and allow a ref", () => {
     const ref = createRef<HTMLDivElement>();
     const props = {
-      "aria-label": "Notifications",
+      "data-testid": "snackbar",
       ref,
     } as const;
     const { rerender } = render(<Snackbar {...props} />);
 
-    const snackbar = screen.getByRole("status", { name: "Notifications" });
+    const snackbar = screen.getByTestId("snackbar");
     expect(ref.current).toBeInstanceOf(HTMLDivElement);
     expect(ref.current).toBe(snackbar);
     expect(snackbar).toMatchSnapshot();
@@ -60,8 +61,8 @@ describe("Snackbar", () => {
       "top-right",
     ];
 
-    const { rerender } = render(<Snackbar />);
-    const snackbar = screen.getByRole("status");
+    const { rerender } = render(<Snackbar data-testid="snackbar" />);
+    const snackbar = screen.getByTestId("snackbar");
     expect(snackbar).toMatchSnapshot();
 
     positions.forEach((position) => {
@@ -72,13 +73,13 @@ describe("Snackbar", () => {
   });
 
   it("should allow the portal behavior to be disabled", () => {
-    const { container, rerender } = render(<Snackbar />);
-    let snackbar = screen.getByRole("status");
+    const { container, rerender } = render(<Snackbar data-testid="snackbar" />);
+    let snackbar = screen.getByTestId("snackbar");
     expect(container).not.toContainElement(snackbar);
     expect(snackbar).toBeInTheDocument();
 
-    rerender(<Snackbar disablePortal />);
-    snackbar = screen.getByRole("status");
+    rerender(<Snackbar data-testid="snackbar" disablePortal />);
+    snackbar = screen.getByTestId("snackbar");
     expect(container).toContainElement(snackbar);
   });
 });

package/src/snackbar/__tests__/ToastManagerProvider.tsx

@@ -78,7 +78,7 @@ function SimpleTest(props: SimpleTestProps): ReactElement {
         Button
       </Button>
       {children}
-      <Snackbar {...snackbar} />
+      <Snackbar data-testid="snackbar" {...snackbar} />
     </>
   );
 }
@@ -101,21 +101,18 @@ describe("ToastManagerProvider", () => {
             <Button onClick={() => addToast({ children: "Hello, world!" })}>
               Button
             </Button>
-            <Snackbar />
+            <Snackbar data-testid="snackbar" />
           </>
         );
       }
 
       rmdRender(<Test />);
       const button = screen.getByRole("button", { name: "Button" });
-      const snackbar = screen.getByRole("status");
-      expect(snackbar).toBeInTheDocument();
+      expect(() => screen.getByTestId("snackbar")).toThrow();
 
       await user.click(button);
-      const message = snackbar.firstElementChild;
-      if (!message) {
-        throw new Error();
-      }
+      const snackbar = await screen.findByTestId("snackbar");
+      const message = await screen.findByRole("status");
 
       expect(snackbar).toMatchSnapshot();
 
@@ -126,20 +123,14 @@ describe("ToastManagerProvider", () => {
     });
 
     it("should allow toasts to be added outside of a react component (like redux)", async () => {
-      rmdRender(<Snackbar />);
-      const snackbar = screen.getByRole("status");
-      expect(snackbar).toBeInTheDocument();
-      expect(snackbar).toBeEmptyDOMElement();
+      rmdRender(<Snackbar data-testid="snackbar" />);
 
       act(() => {
         addToast({ toastId: "toast-id", children: "Fired outside of react!" });
       });
 
-      let toast = screen.getByText("Fired outside of react!");
+      let toast = await screen.findByRole("status");
       expect(toast).toBeInTheDocument();
-      await waitFor(() => {
-        expect(toast.parentElement).not.toHaveClass(ENTER_CLASS_NAME);
-      });
 
       act(() => {
         popToast();
@@ -150,8 +141,7 @@ describe("ToastManagerProvider", () => {
         addToast({ toastId: "toast-id", children: "Fired outside of react!" });
         addToast({ toastId: "toast-id-2", children: "Second toast" });
       });
-      toast = screen.getByText("Fired outside of react!");
-      expect(toast).toBeInTheDocument();
+      toast = await screen.findByRole("status");
 
       act(() => {
         removeToast("invalid-toast-id", false);
@@ -170,7 +160,7 @@ describe("ToastManagerProvider", () => {
         addToast({ children: "Toast" });
         clearToasts();
       });
-      expect(snackbar).toBeEmptyDOMElement();
+      expect(() => screen.getByTestId("snackbar")).toThrow();
     });
 
     it("should not add a toast to another toast manager", async () => {
@@ -185,21 +175,20 @@ describe("ToastManagerProvider", () => {
             <Button onClick={() => addToast({ children: "Global" })}>
               Global
             </Button>
-            <Snackbar />
+            <Snackbar data-testid="snackbar" />
           </>
         );
       }
 
       renderWithManager(<Test />);
-      const snackbar = screen.getByRole("status");
       const scopedAdd = screen.getByRole("button", { name: "Scoped" });
       const globalAdd = screen.getByRole("button", { name: "Global" });
 
       await user.click(globalAdd);
-      expect(snackbar).toBeEmptyDOMElement();
+      expect(() => screen.getByTestId("snackbar")).toThrow();
 
       await user.click(scopedAdd);
-      expect(snackbar).not.toBeEmptyDOMElement();
+      const snackbar = await screen.findByTestId("snackbar");
       expect(within(snackbar).getByText("Scoped")).toBeInTheDocument();
     });
   });
@@ -221,15 +210,10 @@ describe("ToastManagerProvider", () => {
       // eslint-disable-next-line testing-library/render-result-naming-convention
       const result = renderWithManager(<SimpleTest {...props} />);
       const button = screen.getByRole("button", { name: "Button" });
-      const snackbar = screen.getByRole("status");
-      expect(snackbar).toBeEmptyDOMElement();
 
       await user.click(button);
-      expect(snackbar).not.toBeEmptyDOMElement();
-      const message = snackbar.firstElementChild;
-      if (!message) {
-        throw new Error();
-      }
+      const snackbar = await screen.findByTestId("snackbar");
+      const message = await screen.findByRole("status");
 
       act(() => {
         jest.runOnlyPendingTimers();
@@ -331,15 +315,9 @@ describe("ToastManagerProvider", () => {
       const user = userEvent.setup({ delay: null });
       renderWithManager(<SimpleTest toast={{ toastId: "same-toast-id" }} />);
       const button = screen.getByRole("button", { name: "Button" });
-      const snackbar = screen.getByRole("status");
-      expect(snackbar).toBeEmptyDOMElement();
 
       await user.click(button);
-      expect(snackbar).not.toBeEmptyDOMElement();
-      const message = snackbar.firstElementChild;
-      if (!message) {
-        throw new Error();
-      }
+      const message = await screen.findByRole("status");
 
       act(() => {
         jest.runOnlyPendingTimers();
@@ -456,7 +434,7 @@ describe("ToastManagerProvider", () => {
           </>
         );
       }
-      const { user, message, snackbar } = await init({
+      const { user, message } = await init({
         children: <Children />,
       });
       act(() => {
@@ -474,8 +452,8 @@ describe("ToastManagerProvider", () => {
 
       const testFullFlow = async (button: HTMLElement): Promise<void> => {
         await user.click(button);
-        expect(snackbar).not.toBeEmptyDOMElement();
-        const nextMessage = snackbar.firstElementChild;
+        const snackbar = await screen.findByTestId("snackbar");
+        const nextMessage = within(snackbar).getByRole("status");
         expect(nextMessage).toHaveClass(ENTER_CLASS_NAME);
         act(() => {
           jest.runOnlyPendingTimers();
@@ -746,17 +724,17 @@ describe("ToastManagerProvider", () => {
             >
               Alert
             </Button>
-            <Snackbar />
+            <Snackbar data-testid="snackbar" />
           </>
         );
       }
 
       renderWithManager(<Test />);
-      const snackbar = screen.getByRole("status");
       const button = screen.getByRole("button", { name: "Alert" });
 
       await user.click(button);
 
+      const snackbar = screen.getByTestId("snackbar");
       const alert = screen.getByRole("alert");
       expect(snackbar).toMatchSnapshot();
 

package/src/snackbar/__tests__/__snapshots__/Snackbar.tsx.snap

@@ -2,75 +2,175 @@
 
 exports[`Snackbar should apply the correct styling, HTML attributes, and allow a ref 1`] = `
 <div
-  aria-label="Notifications"
   class="rmd-snackbar rmd-snackbar--bottom"
+  data-testid="snackbar"
   id="snackbar-:r0:"
-  role="status"
-/>
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r1:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should apply the correct styling, HTML attributes, and allow a ref 2`] = `
 <div
-  aria-label="Notifications"
   class="rmd-snackbar rmd-snackbar--bottom custom-class-name"
+  data-testid="snackbar"
   id="snackbar-:r0:"
-  role="status"
   style="color: white;"
-/>
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r1:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 1`] = `
 <div
   class="rmd-snackbar rmd-snackbar--bottom"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  data-testid="snackbar"
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 2`] = `
 <div
   class="rmd-snackbar rmd-snackbar--bottom"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 3`] = `
 <div
   class="rmd-snackbar rmd-snackbar--bottom rmd-snackbar--start"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 4`] = `
 <div
   class="rmd-snackbar rmd-snackbar--bottom rmd-snackbar--end"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 5`] = `
 <div
   class="rmd-snackbar rmd-snackbar--top"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 6`] = `
 <div
   class="rmd-snackbar rmd-snackbar--top rmd-snackbar--start"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;
 
 exports[`Snackbar should support different positions within the viewport 7`] = `
 <div
   class="rmd-snackbar rmd-snackbar--top rmd-snackbar--end"
-  id="snackbar-:r1:"
-  role="status"
-/>
+  id="snackbar-:r2:"
+>
+  <div
+    class="rmd-toast"
+    id="toast-:r3:"
+    role="status"
+  >
+    <div
+      class="rmd-toast-content"
+    >
+      Toast
+    </div>
+  </div>
+</div>
 `;