@carbon/react 0.17.0 → 1.0.1

package/es/components/Notification/Notification.js

@@ -0,0 +1,530 @@
+/**
+ * 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, extends as _extends, defineProperty as _defineProperty, 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 { usePrefix } from '../../internal/usePrefix.js';
+
+var _iconTypes;
+
+var _excluded = ["children", "className", "onClick"],
+    _excluded2 = ["ariaLabel", "className", "iconDescription", "type", "renderIcon", "name", "notificationType"],
+    _excluded3 = ["title", "subtitle", "caption", "notificationType", "children"],
+    _excluded4 = ["role", "notificationType", "onClose", "onCloseButtonClick", "iconDescription", "statusIconDescription", "className", "caption", "subtitle", "title", "kind", "lowContrast", "hideCloseButton", "children", "timeout"],
+    _excluded5 = ["actions", "role", "notificationType", "onClose", "onCloseButtonClick", "iconDescription", "statusIconDescription", "className", "subtitle", "title", "kind", "lowContrast", "hideCloseButton", "children"];
+function NotificationActionButton(_ref) {
+  var children = _ref.children,
+      customClassName = _ref.className,
+      onClick = _ref.onClick,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var prefix = usePrefix();
+  var className = cx(customClassName, "".concat(prefix, "--inline-notification__action-button"));
+  return /*#__PURE__*/React__default.createElement(Button, _extends({
+    className: className,
+    kind: "ghost",
+    onClick: onClick,
+    size: "small"
+  }, 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,
+
+  /**
+   * 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']),
+
+  /**
+   * 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
+};
+function NotificationTextDetails(_ref3) {
+  var title = _ref3.title,
+      subtitle = _ref3.subtitle,
+      caption = _ref3.caption,
+      notificationType = _ref3.notificationType,
+      children = _ref3.children,
+      rest = _objectWithoutProperties(_ref3, _excluded3);
+
+  var prefix = usePrefix();
+
+  if (notificationType === 'toast') {
+    return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+      className: "".concat(prefix, "--toast-notification__details")
+    }), /*#__PURE__*/React__default.createElement("h3", {
+      className: "".concat(prefix, "--toast-notification__title")
+    }, title), /*#__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);
+  }
+
+  if (notificationType === 'inline') {
+    return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+      className: "".concat(prefix, "--inline-notification__text-wrapper")
+    }), /*#__PURE__*/React__default.createElement("p", {
+      className: "".concat(prefix, "--inline-notification__title")
+    }, title), /*#__PURE__*/React__default.createElement("div", {
+      className: "".concat(prefix, "--inline-notification__subtitle")
+    }, subtitle), children);
+  }
+}
+NotificationTextDetails.propTypes = {
+  /**
+   * Specify the caption
+   */
+  caption: PropTypes.node,
+
+  /**
+   * Pass in the children that will be rendered in NotificationTextDetails
+   */
+  children: PropTypes.node,
+
+  /**
+   * Specify the notification type
+   */
+  notificationType: PropTypes.oneOf(['toast', 'inline']),
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.node,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string
+};
+NotificationTextDetails.defaultProps = {
+  title: 'title',
+  notificationType: 'toast'
+};
+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(_ref4) {
+  var iconDescription = _ref4.iconDescription,
+      kind = _ref4.kind,
+      notificationType = _ref4.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(_ref5) {
+  var _cx3;
+
+  var role = _ref5.role,
+      notificationType = _ref5.notificationType,
+      onClose = _ref5.onClose,
+      onCloseButtonClick = _ref5.onCloseButtonClick,
+      iconDescription = _ref5.iconDescription,
+      statusIconDescription = _ref5.statusIconDescription,
+      className = _ref5.className,
+      caption = _ref5.caption,
+      subtitle = _ref5.subtitle,
+      title = _ref5.title,
+      kind = _ref5.kind,
+      lowContrast = _ref5.lowContrast,
+      hideCloseButton = _ref5.hideCloseButton,
+      children = _ref5.children,
+      timeout = _ref5.timeout,
+      rest = _objectWithoutProperties(_ref5, _excluded4);
+
+  var prefix = usePrefix();
+
+  var _useState = useState(true),
+      _useState2 = _slicedToArray(_useState, 2),
+      isOpen = _useState2[0],
+      setIsOpen = _useState2[1];
+
+  var containerClassName = cx(className, (_cx3 = {}, _defineProperty(_cx3, "".concat(prefix, "--toast-notification"), true), _defineProperty(_cx3, "".concat(prefix, "--toast-notification--low-contrast"), lowContrast), _defineProperty(_cx3, "".concat(prefix, "--toast-notification--").concat(kind), kind), _cx3));
+
+  var handleClose = function handleClose(evt) {
+    if (!onClose || onClose(evt) !== false) {
+      setIsOpen(false);
+    }
+  };
+
+  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({}, rest, {
+    role: role,
+    kind: kind,
+    className: containerClassName
+  }), /*#__PURE__*/React__default.createElement(NotificationIcon, {
+    notificationType: notificationType,
+    kind: kind,
+    iconDescription: statusIconDescription || "".concat(kind, " icon")
+  }), /*#__PURE__*/React__default.createElement(NotificationTextDetails, {
+    title: title,
+    subtitle: subtitle,
+    caption: caption,
+    notificationType: notificationType
+  }, children), !hideCloseButton && /*#__PURE__*/React__default.createElement(NotificationButton, {
+    iconDescription: iconDescription,
+    notificationType: notificationType,
+    onClick: handleCloseButtonClick
+  }));
+}
+ToastNotification.propTypes = {
+  /**
+   * Specify the caption
+   */
+  caption: PropTypes.node,
+
+  /**
+   * Pass in the children that will be rendered within the ToastNotification
+   */
+  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']).isRequired,
+
+  /**
+   * Specify whether you are using the low contrast variant of the ToastNotification.
+   */
+  lowContrast: PropTypes.bool,
+
+  /**
+   * By default, this value is "toast". You can also provide an alternate type
+   * if it makes sense for the underlying `<NotificationTextDetails>` and `<NotificationButton>`
+   */
+  notificationType: PropTypes.string,
+
+  /**
+   * 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 "alert". You can also provide an alternate
+   * role if it makes sense from the accessibility-side
+   */
+  role: PropTypes.string.isRequired,
+
+  /**
+   * Provide a description for "status" icon that can be read by screen readers
+   */
+  statusIconDescription: PropTypes.string,
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.node,
+
+  /**
+   * Specify an optional duration the notification should be closed in
+   */
+  timeout: PropTypes.number,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string.isRequired
+};
+ToastNotification.defaultProps = {
+  kind: 'error',
+  title: 'provide a title',
+  role: 'alert',
+  notificationType: 'toast',
+  iconDescription: 'closes notification',
+  onCloseButtonClick: function onCloseButtonClick() {},
+  hideCloseButton: false,
+  timeout: 0
+};
+function InlineNotification(_ref6) {
+  var _cx4;
+
+  var actions = _ref6.actions,
+      role = _ref6.role,
+      notificationType = _ref6.notificationType,
+      onClose = _ref6.onClose,
+      onCloseButtonClick = _ref6.onCloseButtonClick,
+      iconDescription = _ref6.iconDescription,
+      statusIconDescription = _ref6.statusIconDescription,
+      className = _ref6.className,
+      subtitle = _ref6.subtitle,
+      title = _ref6.title,
+      kind = _ref6.kind,
+      lowContrast = _ref6.lowContrast,
+      hideCloseButton = _ref6.hideCloseButton,
+      children = _ref6.children,
+      rest = _objectWithoutProperties(_ref6, _excluded5);
+
+  var prefix = usePrefix();
+
+  var _useState3 = useState(true),
+      _useState4 = _slicedToArray(_useState3, 2),
+      isOpen = _useState4[0],
+      setIsOpen = _useState4[1];
+
+  var containerClassName = cx(className, (_cx4 = {}, _defineProperty(_cx4, "".concat(prefix, "--inline-notification"), true), _defineProperty(_cx4, "".concat(prefix, "--inline-notification--low-contrast"), lowContrast), _defineProperty(_cx4, "".concat(prefix, "--inline-notification--").concat(kind), kind), _defineProperty(_cx4, "".concat(prefix, "--inline-notification--hide-close-button"), hideCloseButton), _cx4));
+
+  var handleClose = function handleClose(evt) {
+    if (!onClose || onClose(evt) !== false) {
+      setIsOpen(false);
+    }
+  };
+
+  function handleCloseButtonClick(event) {
+    onCloseButtonClick(event);
+    handleClose(event);
+  }
+
+  if (!isOpen) {
+    return null;
+  }
+
+  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+    role: role,
+    kind: kind,
+    className: containerClassName
+  }), /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(prefix, "--inline-notification__details")
+  }, /*#__PURE__*/React__default.createElement(NotificationIcon, {
+    notificationType: notificationType,
+    kind: kind,
+    iconDescription: statusIconDescription || "".concat(kind, " icon")
+  }), /*#__PURE__*/React__default.createElement(NotificationTextDetails, {
+    title: title,
+    subtitle: subtitle,
+    notificationType: notificationType
+  }, children)), actions, !hideCloseButton && /*#__PURE__*/React__default.createElement(NotificationButton, {
+    iconDescription: iconDescription,
+    notificationType: notificationType,
+    onClick: handleCloseButtonClick
+  }));
+}
+InlineNotification.propTypes = {
+  /**
+   * Pass in the action nodes that will be rendered within the InlineNotification
+   */
+  actions: PropTypes.node,
+
+  /**
+   * Pass in the children that will be rendered within the InlineNotification
+   */
+  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']).isRequired,
+
+  /**
+   * Specify whether you are using the low contrast variant of the InlineNotification.
+   */
+  lowContrast: PropTypes.bool,
+
+  /**
+   * By default, this value is "inline". You can also provide an alternate type
+   * if it makes sense for the underlying `<NotificationTextDetails>` and `<NotificationButton>`
+   */
+  notificationType: PropTypes.string,
+
+  /**
+   * 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 "alert". You can also provide an alternate
+   * role if it makes sense from the accessibility-side
+   */
+  role: PropTypes.string.isRequired,
+
+  /**
+   * Provide a description for "status" icon that can be read by screen readers
+   */
+  statusIconDescription: PropTypes.string,
+
+  /**
+   * Specify the sub-title
+   */
+  subtitle: PropTypes.node,
+
+  /**
+   * Specify the title
+   */
+  title: PropTypes.string.isRequired
+};
+InlineNotification.defaultProps = {
+  role: 'alert',
+  notificationType: 'inline',
+  iconDescription: 'closes notification',
+  onCloseButtonClick: function onCloseButtonClick() {},
+  hideCloseButton: false
+};
+
+export { InlineNotification, NotificationActionButton, NotificationButton, NotificationTextDetails, ToastNotification };

package/es/components/Notification/index.js

@@ -0,0 +1,42 @@
+/**
+ * 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 { NotificationActionButton as NotificationActionButton$1, NotificationButton as NotificationButton$1, ToastNotification as ToastNotification$1, InlineNotification as InlineNotification$1, ActionableNotification as ActionableNotification$1 } from './next/Notification.js';
+import { NotificationActionButton as NotificationActionButton$2, NotificationTextDetails as NotificationTextDetails$1, NotificationButton as NotificationButton$2, ToastNotification as ToastNotification$2, InlineNotification as InlineNotification$2 } from './Notification.js';
+import { createComponentToggle } from '../../internal/ComponentToggle.js';
+
+var NotificationActionButton = createComponentToggle({
+  name: 'NotificationActionButton',
+  next: NotificationActionButton$1,
+  classic: NotificationActionButton$2
+});
+var NotificationTextDetails = createComponentToggle({
+  name: 'NotificationTextDetails',
+  classic: NotificationTextDetails$1
+});
+var NotificationButton = createComponentToggle({
+  name: 'NotificationButton',
+  next: NotificationButton$1,
+  classic: NotificationButton$2
+});
+var ToastNotification = createComponentToggle({
+  name: 'ToastNotification',
+  next: ToastNotification$1,
+  classic: ToastNotification$2
+});
+var InlineNotification = createComponentToggle({
+  name: 'InlineNotification',
+  next: InlineNotification$1,
+  classic: InlineNotification$2
+});
+var ActionableNotification = createComponentToggle({
+  name: 'ActionableNotification',
+  next: ActionableNotification$1,
+  classic: null
+});
+
+export { ActionableNotification, InlineNotification, NotificationActionButton, NotificationButton, NotificationTextDetails, ToastNotification };