@carbon/react 0.17.0 → 1.0.0-rc.0

package/es/components/Notification/next/Notification.js

@@ -0,0 +1,684 @@
+/**
+ * Copyright IBM Corp. 2016, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends, slicedToArray as _slicedToArray } from '../../../_virtual/_rollupPluginBabelHelpers.js';
+import PropTypes from 'prop-types';
+import React__default, { useState, useRef, useEffect } from 'react';
+import cx from 'classnames';
+import { Close, WarningAltFilled, InformationFilled, InformationSquareFilled, ErrorFilled, CheckmarkFilled, WarningFilled } from '@carbon/icons-react';
+import Button from '../../Button/Button.js';
+import useIsomorphicEffect from '../../../internal/useIsomorphicEffect.js';
+import { useNoInteractiveChildren } from '../../../internal/useNoInteractiveChildren.js';
+import { usePrefix } from '../../../internal/usePrefix.js';
+import { matches } from '../../../internal/keyboard/match.js';
+import { Escape } from '../../../internal/keyboard/keys.js';
+
+var _iconTypes;
+
+var _excluded = ["children", "className", "onClick", "inline"],
+    _excluded2 = ["ariaLabel", "className", "iconDescription", "type", "renderIcon", "name", "notificationType"],
+    _excluded3 = ["role", "onClose", "onCloseButtonClick", "iconDescription", "statusIconDescription", "className", "children", "kind", "lowContrast", "hideCloseButton", "timeout", "title", "caption", "subtitle"],
+    _excluded4 = ["children", "title", "subtitle", "role", "onClose", "onCloseButtonClick", "iconDescription", "statusIconDescription", "className", "kind", "lowContrast", "hideCloseButton"],
+    _excluded5 = ["actionButtonLabel", "children", "role", "onActionButtonClick", "onClose", "onCloseButtonClick", "iconDescription", "statusIconDescription", "className", "inline", "kind", "lowContrast", "hideCloseButton", "hasFocus", "closeOnEscape", "title", "subtitle"];
+/**
+ * Conditionally call a callback when the escape key is pressed
+ * @param {node} ref - ref of the container element to scope the functionality to
+ * @param {func} callback - function to be called
+ * @param {bool} override - escape hatch to conditionally call the callback
+ */
+
+function useEscapeToClose(ref, callback) {
+  var override = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+
+  var handleKeyDown = function handleKeyDown(event) {
+    // The callback should only be called when focus is on or within the container
+    var elementContainsFocus = ref.current && document.activeElement === ref.current || ref.current.contains(document.activeElement);
+
+    if (matches(event, [Escape]) && override && elementContainsFocus) {
+      callback(event);
+    }
+  };
+
+  useIsomorphicEffect(function () {
+    document.addEventListener('keydown', handleKeyDown, false);
+    return function () {
+      return document.removeEventListener('keydown', handleKeyDown, false);
+    };
+  });
+}
+
+function NotificationActionButton(_ref) {
+  var children = _ref.children,
+      customClassName = _ref.className,
+      onClick = _ref.onClick,
+      inline = _ref.inline,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var prefix = usePrefix();
+  var className = cx(customClassName, _defineProperty({}, "".concat(prefix, "--actionable-notification__action-button"), true));
+  return /*#__PURE__*/React__default.createElement(Button, _extends({
+    className: className,
+    kind: inline ? 'ghost' : 'tertiary',
+    onClick: onClick,
+    size: "sm"
+  }, rest), children);
+}
+NotificationActionButton.propTypes = {
+  /**
+   * Specify the content of the notification action button.
+   */
+  children: PropTypes.node,
+
+  /**
+   * Specify an optional className to be applied to the notification action button
+   */
+  className: PropTypes.string,
+
+  /**
+   * Specify if the visual treatment of the button should be for an inline notification
+   */
+  inline: PropTypes.bool,
+
+  /**
+   * Optionally specify a click handler for the notification action button.
+   */
+  onClick: PropTypes.func
+};
+function NotificationButton(_ref2) {
+  var ariaLabel = _ref2.ariaLabel,
+      className = _ref2.className,
+      iconDescription = _ref2.iconDescription,
+      type = _ref2.type,
+      IconTag = _ref2.renderIcon,
+      name = _ref2.name,
+      notificationType = _ref2.notificationType,
+      rest = _objectWithoutProperties(_ref2, _excluded2);
+
+  var prefix = usePrefix();
+  var buttonClassName = cx(className, _defineProperty({}, "".concat(prefix, "--").concat(notificationType, "-notification__close-button"), notificationType));
+  var iconClassName = cx(_defineProperty({}, "".concat(prefix, "--").concat(notificationType, "-notification__close-icon"), notificationType));
+  return /*#__PURE__*/React__default.createElement("button", _extends({}, rest, {
+    // eslint-disable-next-line react/button-has-type
+    type: type,
+    "aria-label": iconDescription,
+    title: iconDescription,
+    className: buttonClassName
+  }), IconTag && /*#__PURE__*/React__default.createElement(IconTag, {
+    "aria-label": ariaLabel,
+    className: iconClassName,
+    name: name
+  }));
+}
+NotificationButton.propTypes = {
+  /**
+   * Specify a label to be read by screen readers on the notification button
+   */
+  ariaLabel: PropTypes.string,
+
+  /**
+   * Specify an optional className to be applied to the notification button
+   */
+  className: PropTypes.string,
+
+  /**
+   * Provide a description for "close" icon that can be read by screen readers
+   */
+  iconDescription: PropTypes.string,
+
+  /**
+   * Specify an optional icon for the Button through a string,
+   * if something but regular "close" icon is desirable
+   */
+  name: PropTypes.string,
+
+  /**
+   * Specify the notification type
+   */
+  notificationType: PropTypes.oneOf(['toast', 'inline', 'actionable']),
+
+  /**
+   * Optional prop to allow overriding the icon rendering.
+   * Can be a React component class
+   */
+  renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+
+  /**
+   * Optional prop to specify the type of the Button
+   */
+  type: PropTypes.string
+};
+NotificationButton.defaultProps = {
+  ariaLabel: 'close notification',
+  // TODO: deprecate this prop
+  notificationType: 'toast',
+  type: 'button',
+  iconDescription: 'close icon',
+  renderIcon: Close
+};
+var iconTypes = (_iconTypes = {
+  error: ErrorFilled,
+  success: CheckmarkFilled,
+  warning: WarningFilled
+}, _defineProperty(_iconTypes, 'warning-alt', WarningAltFilled), _defineProperty(_iconTypes, "info", InformationFilled), _defineProperty(_iconTypes, 'info-square', InformationSquareFilled), _iconTypes);
+
+function NotificationIcon(_ref3) {
+  var iconDescription = _ref3.iconDescription,
+      kind = _ref3.kind,
+      notificationType = _ref3.notificationType;
+  var prefix = usePrefix();
+  var IconForKind = iconTypes[kind];
+
+  if (!IconForKind) {
+    return null;
+  }
+
+  return /*#__PURE__*/React__default.createElement(IconForKind, {
+    className: "".concat(prefix, "--").concat(notificationType, "-notification__icon")
+  }, /*#__PURE__*/React__default.createElement("title", null, iconDescription));
+}
+
+NotificationIcon.propTypes = {
+  iconDescription: PropTypes.string.isRequired,
+  kind: PropTypes.oneOf(['error', 'success', 'warning', 'warning-alt', 'info', 'info-square']).isRequired,
+  notificationType: PropTypes.oneOf(['inline', 'toast']).isRequired
+};
+function ToastNotification(_ref4) {
+  var _cx4;
+
+  var role = _ref4.role,
+      onClose = _ref4.onClose,
+      onCloseButtonClick = _ref4.onCloseButtonClick,
+      iconDescription = _ref4.iconDescription,
+      statusIconDescription = _ref4.statusIconDescription,
+      className = _ref4.className,
+      children = _ref4.children,
+      kind = _ref4.kind,
+      lowContrast = _ref4.lowContrast,
+      hideCloseButton = _ref4.hideCloseButton,
+      timeout = _ref4.timeout,
+      title = _ref4.title,
+      caption = _ref4.caption,
+      subtitle = _ref4.subtitle,
+      rest = _objectWithoutProperties(_ref4, _excluded3);
+
+  var _useState = useState(true),
+      _useState2 = _slicedToArray(_useState, 2),
+      isOpen = _useState2[0],
+      setIsOpen = _useState2[1];
+
+  var prefix = usePrefix();
+  var containerClassName = cx(className, (_cx4 = {}, _defineProperty(_cx4, "".concat(prefix, "--toast-notification"), true), _defineProperty(_cx4, "".concat(prefix, "--toast-notification--low-contrast"), lowContrast), _defineProperty(_cx4, "".concat(prefix, "--toast-notification--").concat(kind), kind), _cx4));
+  var contentRef = useRef(null);
+  useNoInteractiveChildren(contentRef);
+
+  var handleClose = function handleClose(evt) {
+    if (!onClose || onClose(evt) !== false) {
+      setIsOpen(false);
+    }
+  };
+
+  var ref = useRef(null);
+
+  function handleCloseButtonClick(event) {
+    onCloseButtonClick(event);
+    handleClose(event);
+  }
+
+  var savedOnClose = useRef(onClose);
+  useEffect(function () {
+    savedOnClose.current = onClose;
+  });
+  useEffect(function () {
+    if (!timeout) {
+      return;
+    }
+
+    var timeoutId = window.setTimeout(function (event) {
+      setIsOpen(false);
+
+      if (savedOnClose.current) {
+        savedOnClose.current(event);
+      }
+    }, timeout);
+    return function () {
+      window.clearTimeout(timeoutId);
+    };
+  }, [timeout]);
+
+  if (!isOpen) {
+    return null;
+  }
+
+  return /*#__PURE__*/React__default.createElement("div", _extends({
+    ref: ref
+  }, rest, {
+    role: role,
+    className: containerClassName
+  }), /*#__PURE__*/React__default.createElement(NotificationIcon, {
+    notificationType: "toast",
+    kind: kind,
+    iconDescription: statusIconDescription || "".concat(kind, " icon")
+  }), /*#__PURE__*/React__default.createElement("div", {
+    ref: contentRef,
+    className: "".concat(prefix, "--toast-notification__details")
+  }, title && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--toast-notification__title")
+  }, title), subtitle && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--toast-notification__subtitle")
+  }, subtitle), caption && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--toast-notification__caption")
+  }, caption), children), !hideCloseButton && /*#__PURE__*/React__default.createElement(NotificationButton, {
+    iconDescription: iconDescription,
+    notificationType: "toast",
+    onClick: handleCloseButtonClick,
+    "aria-hidden": "true",
+    tabIndex: "-1"
+  }));
+}
+ToastNotification.propTypes = {
+  /**
+   * Specify the caption
+   */
+  caption: PropTypes.string,
+
+  /**
+   * Specify the content
+   */
+  children: PropTypes.node,
+
+  /**
+   * Specify an optional className to be applied to the notification box
+   */
+  className: PropTypes.string,
+
+  /**
+   * Specify the close button should be disabled, or not
+   */
+  hideCloseButton: PropTypes.bool,
+
+  /**
+   * Provide a description for "close" icon that can be read by screen readers
+   */
+  iconDescription: PropTypes.string,
+
+  /**
+   * Specify what state the notification represents
+   */
+  kind: PropTypes.oneOf(['error', 'info', 'info-square', 'success', 'warning', 'warning-alt']),
+
+  /**
+   * Specify whether you are using the low contrast variant of the ToastNotification.
+   */
+  lowContrast: PropTypes.bool,
+
+  /**
+   * Provide a function that is called when menu is closed
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Provide a function that is called when the close button is clicked
+   */
+  onCloseButtonClick: PropTypes.func,
+
+  /**
+   * By default, this value is "status". You can also provide an alternate
+   * role if it makes sense from the accessibility-side
+   */
+  role: PropTypes.oneOf(['alert', 'log', 'status']),
+
+  /**
+   * Provide a description for "status" icon that can be read by screen readers
+   */
+  statusIconDescription: PropTypes.string,
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.string,
+
+  /**
+   * Specify an optional duration the notification should be closed in
+   */
+  timeout: PropTypes.number,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string
+};
+ToastNotification.defaultProps = {
+  kind: 'error',
+  role: 'status',
+  iconDescription: 'closes notification',
+  onCloseButtonClick: function onCloseButtonClick() {},
+  hideCloseButton: false,
+  timeout: 0
+};
+function InlineNotification(_ref5) {
+  var _cx5;
+
+  var children = _ref5.children,
+      title = _ref5.title,
+      subtitle = _ref5.subtitle,
+      role = _ref5.role,
+      onClose = _ref5.onClose,
+      onCloseButtonClick = _ref5.onCloseButtonClick,
+      iconDescription = _ref5.iconDescription,
+      statusIconDescription = _ref5.statusIconDescription,
+      className = _ref5.className,
+      kind = _ref5.kind,
+      lowContrast = _ref5.lowContrast,
+      hideCloseButton = _ref5.hideCloseButton,
+      rest = _objectWithoutProperties(_ref5, _excluded4);
+
+  var _useState3 = useState(true),
+      _useState4 = _slicedToArray(_useState3, 2),
+      isOpen = _useState4[0],
+      setIsOpen = _useState4[1];
+
+  var prefix = usePrefix();
+  var containerClassName = cx(className, (_cx5 = {}, _defineProperty(_cx5, "".concat(prefix, "--inline-notification"), true), _defineProperty(_cx5, "".concat(prefix, "--inline-notification--low-contrast"), lowContrast), _defineProperty(_cx5, "".concat(prefix, "--inline-notification--").concat(kind), kind), _defineProperty(_cx5, "".concat(prefix, "--inline-notification--hide-close-button"), hideCloseButton), _cx5));
+  var contentRef = useRef(null);
+  useNoInteractiveChildren(contentRef);
+
+  var handleClose = function handleClose(evt) {
+    if (!onClose || onClose(evt) !== false) {
+      setIsOpen(false);
+    }
+  };
+
+  var ref = useRef(null);
+
+  function handleCloseButtonClick(event) {
+    onCloseButtonClick(event);
+    handleClose(event);
+  }
+
+  if (!isOpen) {
+    return null;
+  }
+
+  return /*#__PURE__*/React__default.createElement("div", _extends({
+    ref: ref
+  }, rest, {
+    role: role,
+    className: containerClassName
+  }), /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--inline-notification__details")
+  }, /*#__PURE__*/React__default.createElement(NotificationIcon, {
+    notificationType: "inline",
+    kind: kind,
+    iconDescription: statusIconDescription || "".concat(kind, " icon")
+  }), /*#__PURE__*/React__default.createElement("div", {
+    ref: contentRef,
+    className: "".concat(prefix, "--inline-notification__text-wrapper")
+  }, title && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--inline-notification__title")
+  }, title), subtitle && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--inline-notification__subtitle")
+  }, subtitle), children)), !hideCloseButton && /*#__PURE__*/React__default.createElement(NotificationButton, {
+    iconDescription: iconDescription,
+    notificationType: "inline",
+    onClick: handleCloseButtonClick,
+    "aria-hidden": "true",
+    tabIndex: "-1"
+  }));
+}
+InlineNotification.propTypes = {
+  /**
+   * Specify the content
+   */
+  children: PropTypes.node,
+
+  /**
+   * Specify an optional className to be applied to the notification box
+   */
+  className: PropTypes.string,
+
+  /**
+   * Specify the close button should be disabled, or not
+   */
+  hideCloseButton: PropTypes.bool,
+
+  /**
+   * Provide a description for "close" icon that can be read by screen readers
+   */
+  iconDescription: PropTypes.string,
+
+  /**
+   * Specify what state the notification represents
+   */
+  kind: PropTypes.oneOf(['error', 'info', 'info-square', 'success', 'warning', 'warning-alt']),
+
+  /**
+   * Specify whether you are using the low contrast variant of the InlineNotification.
+   */
+  lowContrast: PropTypes.bool,
+
+  /**
+   * Provide a function that is called when menu is closed
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Provide a function that is called when the close button is clicked
+   */
+  onCloseButtonClick: PropTypes.func,
+
+  /**
+   * By default, this value is "status". You can also provide an alternate
+   * role if it makes sense from the accessibility-side.
+   */
+  role: PropTypes.oneOf(['alert', 'log', 'status']),
+
+  /**
+   * Provide a description for "status" icon that can be read by screen readers
+   */
+  statusIconDescription: PropTypes.string,
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.string,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string
+};
+InlineNotification.defaultProps = {
+  kind: 'error',
+  role: 'status',
+  iconDescription: 'closes notification',
+  onCloseButtonClick: function onCloseButtonClick() {},
+  hideCloseButton: false
+};
+function ActionableNotification(_ref6) {
+  var _cx6;
+
+  var actionButtonLabel = _ref6.actionButtonLabel,
+      children = _ref6.children,
+      role = _ref6.role,
+      onActionButtonClick = _ref6.onActionButtonClick,
+      onClose = _ref6.onClose,
+      onCloseButtonClick = _ref6.onCloseButtonClick,
+      iconDescription = _ref6.iconDescription,
+      statusIconDescription = _ref6.statusIconDescription,
+      className = _ref6.className,
+      inline = _ref6.inline,
+      kind = _ref6.kind,
+      lowContrast = _ref6.lowContrast,
+      hideCloseButton = _ref6.hideCloseButton,
+      hasFocus = _ref6.hasFocus,
+      closeOnEscape = _ref6.closeOnEscape,
+      title = _ref6.title,
+      subtitle = _ref6.subtitle,
+      rest = _objectWithoutProperties(_ref6, _excluded5);
+
+  var _useState5 = useState(true),
+      _useState6 = _slicedToArray(_useState5, 2),
+      isOpen = _useState6[0],
+      setIsOpen = _useState6[1];
+
+  var prefix = usePrefix();
+  var containerClassName = cx(className, (_cx6 = {}, _defineProperty(_cx6, "".concat(prefix, "--actionable-notification"), true), _defineProperty(_cx6, "".concat(prefix, "--actionable-notification--toast"), !inline), _defineProperty(_cx6, "".concat(prefix, "--actionable-notification--low-contrast"), lowContrast), _defineProperty(_cx6, "".concat(prefix, "--actionable-notification--").concat(kind), kind), _defineProperty(_cx6, "".concat(prefix, "--actionable-notification--hide-close-button"), hideCloseButton), _cx6));
+  var ref = useRef(null);
+  useIsomorphicEffect(function () {
+    if (ref.current && hasFocus) {
+      ref.current.focus();
+    }
+  });
+
+  var handleClose = function handleClose(evt) {
+    if (!onClose || onClose(evt) !== false) {
+      setIsOpen(false);
+    }
+  };
+
+  useEscapeToClose(ref, handleCloseButtonClick, closeOnEscape);
+
+  function handleCloseButtonClick(event) {
+    onCloseButtonClick(event);
+    handleClose(event);
+  }
+
+  if (!isOpen) {
+    return null;
+  }
+
+  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+    ref: ref,
+    role: role,
+    className: containerClassName
+  }), /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--actionable-notification__details")
+  }, /*#__PURE__*/React__default.createElement(NotificationIcon, {
+    notificationType: inline ? 'inline' : 'toast',
+    kind: kind,
+    iconDescription: statusIconDescription || "".concat(kind, " icon")
+  }), /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--actionable-notification__text-wrapper")
+  }, /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--actionable-notification__content")
+  }, title && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--actionable-notification__title")
+  }, title), subtitle && /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--actionable-notification__subtitle")
+  }, subtitle), children))), /*#__PURE__*/React__default.createElement(NotificationActionButton, {
+    onClick: onActionButtonClick,
+    inline: inline
+  }, actionButtonLabel), !hideCloseButton && /*#__PURE__*/React__default.createElement(NotificationButton, {
+    iconDescription: iconDescription,
+    notificationType: "actionable",
+    onClick: handleCloseButtonClick
+  }));
+}
+ActionableNotification.propTypes = {
+  /**
+   * Pass in the action button label that will be rendered within the ActionableNotification.
+   */
+  actionButtonLabel: PropTypes.string.isRequired,
+
+  /**
+   * Specify the caption
+   */
+  caption: PropTypes.string,
+
+  /**
+   * Specify the content
+   */
+  children: PropTypes.node,
+
+  /**
+   * Specify an optional className to be applied to the notification box
+   */
+  className: PropTypes.string,
+
+  /**
+   * Specify if pressing the escape key should close notifications
+   */
+  closeOnEscape: PropTypes.bool,
+
+  /**
+   * Specify if focus should be moved to the component when the notification contains actions
+   */
+  hasFocus: PropTypes.bool,
+
+  /**
+   * Specify the close button should be disabled, or not
+   */
+  hideCloseButton: PropTypes.bool,
+
+  /**
+   * Provide a description for "close" icon that can be read by screen readers
+   */
+  iconDescription: PropTypes.string,
+
+  /*
+   * Specify if the notification should have inline styling applied instead of toast
+   */
+  inline: PropTypes.bool,
+
+  /**
+   * Specify what state the notification represents
+   */
+  kind: PropTypes.oneOf(['error', 'info', 'info-square', 'success', 'warning', 'warning-alt']).isRequired,
+
+  /**
+   * Specify whether you are using the low contrast variant of the ActionableNotification.
+   */
+  lowContrast: PropTypes.bool,
+
+  /**
+   * Provide a function that is called when the action is clicked
+   */
+  onActionButtonClick: PropTypes.func,
+
+  /**
+   * Provide a function that is called when menu is closed
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Provide a function that is called when the close button is clicked
+   */
+  onCloseButtonClick: PropTypes.func,
+
+  /**
+   * By default, this value is "alertdialog". You can also provide an alternate
+   * role if it makes sense from the accessibility-side.
+   */
+  role: PropTypes.string,
+
+  /**
+   * Provide a description for "status" icon that can be read by screen readers
+   */
+  statusIconDescription: PropTypes.string,
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.string,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string
+};
+ActionableNotification.defaultProps = {
+  kind: 'error',
+  role: 'alertdialog',
+  iconDescription: 'closes notification',
+  onCloseButtonClick: function onCloseButtonClick() {},
+  hideCloseButton: false,
+  hasFocus: true,
+  closeOnEscape: true,
+  inline: false
+};
+
+export { ActionableNotification, InlineNotification, NotificationActionButton, NotificationButton, ToastNotification };