feat: add actionable notification (#9494)

* feat: add actionable notification * style: add actionable notification scss * fix(notification): styling issues with tertiary action button * fix(actionablenotification): correct action button styling * chore: remove debugging comments * chore(notification): improve docs and test coverage for notifications * chore: remove unused code * fix(notification): pull component tokens from button correctly Co-authored-by: Josh Black <josh@josh.black> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
carbon-design-system · Sep 28, 2021 · 4dfcae7 · 4dfcae7
1 parent b510ad9
commit 4dfcae7
Show file tree

Hide file tree

Showing 19 changed files with 941 additions and 123 deletions.
diff --git a/packages/carbon-react/.storybook/Welcome/Welcome.stories.js b/packages/carbon-react/.storybook/Welcome/Welcome.stories.js
@@ -16,6 +16,9 @@ export default {
     docs: {
       page: mdx,
     },
+    controls: {
+      hideNoControlsWarning: true,
+    },
   },
 };
 

diff --git a/packages/carbon-react/__tests__/index-test.js b/packages/carbon-react/__tests__/index-test.js
@@ -18,6 +18,7 @@ Array [
   "Accordion",
   "AccordionItem",
   "AccordionSkeleton",
+  "ActionableNotification",
   "AspectRatio",
   "Breadcrumb",
   "BreadcrumbItem",

diff --git a/packages/carbon-react/src/components/Notification/Notification.stories.js b/packages/carbon-react/src/components/Notification/Notification.stories.js
@@ -6,84 +6,87 @@
  */
 
 import {
+  ActionableNotification,
   ToastNotification,
   InlineNotification,
-  NotificationActionButton,
+  unstable_FeatureFlags as FeatureFlags,
 } from 'carbon-components-react';
 import React from 'react';
-
-const notificationProps = () => ({
-  kind: 'info',
-  role: 'alert',
-  title: 'Notification title',
-  subtitle: 'Subtitle text goes here.',
-});
-
-const toastNotificationProps = () => ({
-  ...notificationProps(),
-});
+import { action } from '@storybook/addon-actions';
 
 export default {
   title: 'Components/Notifications',
-  parameters: {
-    controls: {
-      hideNoControlsWarning: true,
+  decorators: [
+    (Story) => (
+      <FeatureFlags flags={{ 'enable-v11-release': true }}>
+        <Story />
+      </FeatureFlags>
+    ),
+  ],
+  argTypes: {
+    kind: {
+      options: [
+        'error',
+        'info',
+        'info-square',
+        'success',
+        'warning',
+        'warning-alt',
+      ],
+      control: {
+        type: 'select',
+      },
     },
+    className: {
+      control: {
+        type: 'text',
+      },
+    },
+  },
+  args: {
+    kind: 'error',
+    children: 'Notification content',
+    lowContrast: false,
+    closeOnEscape: false,
+    hideCloseButton: false,
+    iconDescription: 'closes notification',
+    statusIconDescription: 'notification',
+    onClose: action('onClose'),
+    onCloseButtonClick: action('onCloseButtonClick'),
   },
 };
 
-export const Toast = () => (
-  <ToastNotification
-    {...toastNotificationProps()}
-    caption={('Caption (caption)', '00:00:00 AM')}
-    style={{ marginBottom: '.5rem' }}
-  />
-);
-
-export const ToastPlayground = ({
-  kind = 'info',
-  title = 'Notification title',
-  subtitle = 'Notification subtitle',
-  caption = '00:00:00 AM',
-  lowContrast = false,
-}) => {
-  return (
-    <ToastNotification
-      kind={kind}
-      title={title}
-      subtitle={subtitle}
-      lowContrast={lowContrast}
-      caption={caption}
-    />
-  );
-};
-ToastPlayground.argTypes = {
-  kind: {
-    options: [
-      'error',
-      'info',
-      'info-square',
-      'success',
-      'warning',
-      'warning-alt',
-    ],
+export const Toast = (args) => <ToastNotification {...args} />;
+Toast.argTypes = {
+  role: {
+    options: ['alert', 'log', 'status'],
     control: {
       type: 'select',
     },
   },
-  lowContrast: {
-    value: false,
+};
+Toast.args = { role: 'status', timeout: 0 };
+
+export const Inline = (args) => (
+  <>
+    <InlineNotification {...args} />
+    <InlineNotification {...args} />
+    <InlineNotification {...args} />
+  </>
+);
+Inline.argTypes = {
+  role: {
+    options: ['alert', 'log', 'status'],
     control: {
-      type: 'boolean',
+      type: 'select',
     },
   },
 };
+Inline.args = { role: 'status' };
 
-export const Inline = () => (
-  <InlineNotification
-    {...notificationProps()}
-    actions={<NotificationActionButton>{'Action'}</NotificationActionButton>}
-  />
-);
+export const Actionable = (args) => <ActionableNotification {...args} />;
 
-Inline.storyName = 'Inline';
+Actionable.args = {
+  actionButtonLabel: 'Action',
+  inline: false,
+};
diff --git a/packages/carbon-react/src/index.js b/packages/carbon-react/src/index.js
@@ -70,6 +70,7 @@ export {
   Loading,
   Modal,
   MultiSelect,
+  ActionableNotification,
   ToastNotification,
   InlineNotification,
   NotificationActionButton,

diff --git a/packages/components/src/components/notification/_mixins.scss b/packages/components/src/components/notification/_mixins.scss
@@ -37,7 +37,8 @@
   background: $background-color;
 
   .#{$prefix}--inline-notification__icon,
-  .#{$prefix}--toast-notification__icon {
+  .#{$prefix}--toast-notification__icon,
+  .#{$prefix}--actionable-notification__icon {
     fill: $color;
   }
 }
diff --git a/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap b/packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
@@ -4487,6 +4487,11 @@ Map {
     },
     "render": [Function],
   },
+  "ActionableNotification" => Object {
+    "$$typeof": Symbol(react.forward_ref),
+    "displayName": "FeatureToggle(ActionableNotification)",
+    "render": [Function],
+  },
   "ToastNotification" => Object {
     "$$typeof": Symbol(react.forward_ref),
     "displayName": "FeatureToggle(ToastNotification)",

diff --git a/packages/react/src/__tests__/index-test.js b/packages/react/src/__tests__/index-test.js
@@ -18,6 +18,7 @@ Array [
   "Accordion",
   "AccordionItem",
   "AccordionSkeleton",
+  "ActionableNotification",
   "AspectRatio",
   "Breadcrumb",
   "BreadcrumbItem",

diff --git a/packages/react/src/components/Notification/index.js b/packages/react/src/components/Notification/index.js
@@ -10,6 +10,7 @@ import {
   NotificationButton as NotificationButtonNext,
   ToastNotification as ToastNotificationNext,
   InlineNotification as InlineNotificationNext,
+  ActionableNotification as ActionableNotificationNext,
 } from './next/Notification';
 import {
   NotificationActionButton as NotificationActionButtonClassic,
@@ -48,3 +49,9 @@ export const InlineNotification = createComponentToggle({
   next: InlineNotificationNext,
   classic: InlineNotificationClassic,
 });
+
+export const ActionableNotification = createComponentToggle({
+  name: 'ActionableNotification',
+  next: ActionableNotificationNext,
+  classic: null,
+});
diff --git a/packages/react/src/components/Notification/next/Notification-test.js b/packages/react/src/components/Notification/next/Notification-test.js
@@ -11,7 +11,7 @@ import {
   NotificationButton,
   ToastNotification,
   InlineNotification,
-  NotificationActionButton,
+  ActionableNotification,
 } from '../next/Notification';
 import { render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
@@ -101,7 +101,7 @@ describe('ToastNotification', () => {
     expect(() => {
       render(
         <ToastNotification>
-          <button type="button">Sample text</button>
+          <button type="button">Sample button text</button>
         </ToastNotification>
       );
     }).toThrow();
@@ -174,9 +174,17 @@ describe('ToastNotification', () => {
       />
     );
 
+    // without focus being on/in the notification, it should not close via escape
+    userEvent.keyboard('{Escape}');
+    expect(onCloseButtonClick).toHaveBeenCalledTimes(0);
+    expect(onClose).toHaveBeenCalledTimes(0);
+
+    // after focus is placed, the notification should close via escape
+    userEvent.tab();
     userEvent.keyboard('{Escape}');
     expect(onCloseButtonClick).toHaveBeenCalledTimes(1);
     expect(onClose).toHaveBeenCalledTimes(1);
+
     await waitFor(() => {
       expect(screen.queryByRole('status')).not.toBeInTheDocument();
     });
@@ -221,13 +229,19 @@ describe('InlineNotification', () => {
     expect(screen.queryByText(/Sample text/i)).toBeInTheDocument();
   });
 
-  it('allows interactive elements as children', () => {
-    render(
-      <InlineNotification>
-        <button type="button">Sample text</button>
-      </InlineNotification>
-    );
-    expect(screen.queryByText(/Sample text/i)).toBeInTheDocument();
+  it('does not allow interactive elements as children', () => {
+    const spy = jest.spyOn(console, 'error').mockImplementation(() => {});
+
+    expect(() => {
+      render(
+        <InlineNotification>
+          <button type="button">Sample button text</button>
+        </InlineNotification>
+      );
+    }).toThrow();
+
+    expect(spy).toHaveBeenCalled();
+    spy.mockRestore();
   });
 
   it('close button is rendered by default and includes aria-hidden=true', () => {
@@ -293,26 +307,64 @@ describe('InlineNotification', () => {
       />
     );
 
+    // without focus being on/in the notification, it should not close via escape
+    userEvent.keyboard('{Escape}');
+    expect(onCloseButtonClick).toHaveBeenCalledTimes(0);
+    expect(onClose).toHaveBeenCalledTimes(0);
+
+    // after focus is placed, the notification should close via escape
+    userEvent.tab();
     userEvent.keyboard('{Escape}');
     expect(onCloseButtonClick).toHaveBeenCalledTimes(1);
     expect(onClose).toHaveBeenCalledTimes(1);
+
     await waitFor(() => {
       expect(screen.queryByRole('status')).not.toBeInTheDocument();
     });
   });
+});
 
-  it('renders actions when provided, and overrides role to be alertdialog', () => {
+describe('ActionableNotification', () => {
+  it('uses role=alertdialog', () => {
     const { container } = render(
-      <InlineNotification
-        actions={
-          <NotificationActionButton>Button text</NotificationActionButton>
-        }
-      />
+      <ActionableNotification actionButtonLabel="My custom action" />
     );
+
+    expect(container.firstChild).toHaveAttribute('role', 'alertdialog');
+  });
+
+  it('renders correct action label', () => {
+    render(<ActionableNotification actionButtonLabel="My custom action" />);
     const actionButton = screen.queryByRole('button', {
-      name: 'Button text',
+      name: 'My custom action',
     });
     expect(actionButton).toBeInTheDocument();
-    expect(container.firstChild).toHaveAttribute('role', 'alertdialog');
+  });
+
+  it('closes notification via escape button when focus is placed on the notification', async () => {
+    const onCloseButtonClick = jest.fn();
+    const onClose = jest.fn();
+    render(
+      <ActionableNotification
+        onClose={onClose}
+        onCloseButtonClick={onCloseButtonClick}
+        actionButtonLabel="My custom action"
+      />
+    );
+
+    // without focus being on/in the notification, it should not close via escape
+    userEvent.keyboard('{Escape}');
+    expect(onCloseButtonClick).toHaveBeenCalledTimes(0);
+    expect(onClose).toHaveBeenCalledTimes(0);
+
+    // after focus is placed, the notification should close via escape
+    userEvent.tab();
+    userEvent.keyboard('{Escape}');
+    expect(onCloseButtonClick).toHaveBeenCalledTimes(1);
+    expect(onClose).toHaveBeenCalledTimes(1);
+
+    await waitFor(() => {
+      expect(screen.queryByRole('alertdialog')).not.toBeInTheDocument();
+    });
   });
 });
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,9 @@ export default { @@
         docs: {
           page: mdx,
         },
+        controls: {
+          hideNoControlsWarning: true,
+        },
       },
     };
@@ Expand Down @@