@carbon/ibm-products 2.0.0-rc.34 → 2.0.0-rc.38

package/es/components/UserProfileImage/UserProfileImage.js

@@ -0,0 +1,176 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["backgroundColor", "className", "kind", "icon", "initials", "image", "imageDescription", "size", "theme", "tooltipText"];
+/**
+ * Copyright IBM Corp. 2021, 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 portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import '../../global/js/utils/props-helper';
+import { pkg } from '../../settings';
+
+// Carbon and package components we use.
+import { User, Group } from '@carbon/react/icons';
+import { IconButton } from '@carbon/react';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--user-profile-image");
+var componentName = 'UserProfileImage';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+/**
+ * This is a user profile image component which displays an image, or initials or icon for a user.
+ */
+export var UserProfileImage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var backgroundColor = _ref.backgroundColor,
+    className = _ref.className,
+    kind = _ref.kind,
+    icon = _ref.icon,
+    initials = _ref.initials,
+    image = _ref.image,
+    imageDescription = _ref.imageDescription,
+    size = _ref.size,
+    theme = _ref.theme,
+    tooltipText = _ref.tooltipText,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var icons = {
+    user: {
+      md: function md(props) {
+        return /*#__PURE__*/React.createElement(User, _extends({
+          size: 20
+        }, props));
+      },
+      lg: function lg(props) {
+        return /*#__PURE__*/React.createElement(User, _extends({
+          size: 24
+        }, props));
+      },
+      xl: function xl(props) {
+        return /*#__PURE__*/React.createElement(User, _extends({
+          size: 32
+        }, props));
+      }
+    },
+    group: {
+      md: function md(props) {
+        return /*#__PURE__*/React.createElement(Group, _extends({
+          size: 20
+        }, props));
+      },
+      lg: function lg(props) {
+        return /*#__PURE__*/React.createElement(Group, _extends({
+          size: 24
+        }, props));
+      },
+      xl: function xl(props) {
+        return /*#__PURE__*/React.createElement(Group, _extends({
+          size: 32
+        }, props));
+      }
+    }
+  };
+  var formatInitials = function formatInitials() {
+    if (initials.length === 2) {
+      return initials;
+    }
+    // RegEx takes in the display name and returns the first and last initials. Thomas Watson and Thomas J. Watson
+    // both return JW.
+    return initials.match(/(^\S\S?|\b\S)?/g).join('').match(/(^\S|\S$)?/g).join('').toUpperCase();
+  };
+  var getFillItem = function getFillItem() {
+    if (image) {
+      return function () {
+        return /*#__PURE__*/React.createElement("img", {
+          alt: imageDescription,
+          src: image,
+          className: "".concat(blockClass, "__photo ").concat(blockClass, "__photo--").concat(size)
+        });
+      };
+    }
+    if (initials) {
+      return formatInitials;
+    }
+    if (kind && size) {
+      return icons[kind][size];
+    }
+    return icon;
+  };
+
+  // if user doesn't provide a color just generate a random one
+  var getRandomColor = function getRandomColor() {
+    var colors = ['light-cyan', 'dark-cyan', 'light-gray', 'dark-gray', 'light-green', 'dark-green', 'light-magenta', 'dark-magenta', 'light-purple', 'dark-purple', 'light-teal', 'dark-teal'];
+    return colors[Math.floor(Math.random() * colors.length)];
+  };
+  var FillItem = getFillItem();
+  var renderUserProfileImage = function renderUserProfileImage() {
+    return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+      ref: ref,
+      className: cx([blockClass, className, "".concat(blockClass, "--").concat(size), "".concat(blockClass, "--").concat(theme), "".concat(blockClass, "--").concat(backgroundColor || getRandomColor())])
+    }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(FillItem, null));
+  };
+  return FillItem && (tooltipText ? /*#__PURE__*/React.createElement(IconButton, {
+    label: tooltipText,
+    className: "".concat(blockClass, "__tooltip"),
+    kind: "ghost"
+  }, renderUserProfileImage()) : renderUserProfileImage());
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+UserProfileImage = pkg.checkComponentEnabled(UserProfileImage, componentName);
+UserProfileImage.displayName = componentName;
+UserProfileImage.propTypes = {
+  /**
+   * The background color passed should match one of the background colors in the library documentation:
+   * https://pages.github.ibm.com/cdai-design/pal/patterns/user-profile-images/
+   */
+  backgroundColor: PropTypes.oneOf(['light-cyan', 'dark-cyan', 'light-gray', 'dark-gray', 'light-green', 'dark-green', 'light-magenta', 'dark-magenta', 'light-purple', 'dark-purple', 'light-teal', 'dark-teal']),
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * Provide a custom icon to use if you need to use an icon other than the included ones
+   */
+  icon: PropTypes.func,
+  /**
+   * When passing the image prop, supply a full path to the image to be displayed.
+   */
+  image: PropTypes.string,
+  /**
+   * When passing the image prop use the imageDescription prop to describe the image for screen reader.
+   */
+  imageDescription: PropTypes.string.isRequired.if(function (_ref2) {
+    var image = _ref2.image;
+    return !!image;
+  }),
+  /**
+   * When passing the initials prop, either send the initials to be used or the user's display name. The first two capital letters of the display name will be used as the initials.
+   */
+  initials: PropTypes.string,
+  /**
+   * When passing the kind prop, use either "user" or "group". The values match up to the Carbon Library icons.
+   */
+  kind: PropTypes.oneOf(['user', 'group']),
+  /**
+   * Set the size of the avatar circle
+   */
+  size: PropTypes.oneOf(['xl', 'lg', 'md']).isRequired,
+  /**
+   * Set theme in which the component will be rendered
+   */
+  theme: PropTypes.oneOf(['light', 'dark']).isRequired,
+  /**
+   * Pass in the display name to have it shown on hover
+   */
+  tooltipText: PropTypes.string
+};

package/es/components/UserProfileImage/index.js

@@ -0,0 +1,10 @@
+//
+// Copyright IBM Corp. 2021, 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.
+//
+
+// NOTE: An index file is most useful when you have multiple components
+
+export { UserProfileImage } from './UserProfileImage';

package/es/components/WebTerminal/WebTerminal.js

@@ -0,0 +1,205 @@
+import _objectDestructuringEmpty from "@babel/runtime/helpers/objectDestructuringEmpty";
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["actions", "children", "className", "closeIconDescription", "documentationLinks", "documentationLinksIconDescription", "isInitiallyOpen"];
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * Copyright IBM Corp. 2020, 2022
+ *
+ * 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 portions of React that are needed.
+import React, { useMemo, useState, useEffect } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { pkg } from '../../settings';
+
+// Carbon and package components we use.
+import { Close, Help } from '@carbon/react/icons';
+import { Button, OverflowMenu, OverflowMenuItem } from '@carbon/react';
+import { moderate02 } from '@carbon/motion';
+import { useWebTerminal } from './hooks';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var componentName = 'WebTerminal';
+var blockClass = "".concat(pkg.prefix, "--web-terminal");
+
+// Default values for props
+var defaults = {
+  actions: Object.freeze([]),
+  documentationLinks: Object.freeze([]),
+  documentationLinksIconDescription: 'Show documentation links',
+  isInitiallyOpen: false
+};
+export var WebTerminal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var _ref3;
+  var _ref$actions = _ref.actions,
+    actions = _ref$actions === void 0 ? defaults.actions : _ref$actions,
+    children = _ref.children,
+    className = _ref.className,
+    closeIconDescription = _ref.closeIconDescription,
+    _ref$documentationLin = _ref.documentationLinks,
+    documentationLinks = _ref$documentationLin === void 0 ? defaults.documentationLinks : _ref$documentationLin,
+    _ref$documentationLin2 = _ref.documentationLinksIconDescription,
+    documentationLinksIconDescription = _ref$documentationLin2 === void 0 ? defaults.documentationLinksIconDescription : _ref$documentationLin2,
+    _ref$isInitiallyOpen = _ref.isInitiallyOpen,
+    isInitiallyOpen = _ref$isInitiallyOpen === void 0 ? defaults.isInitiallyOpen : _ref$isInitiallyOpen,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var _useWebTerminal = useWebTerminal(),
+    open = _useWebTerminal.open,
+    closeWebTerminal = _useWebTerminal.closeWebTerminal,
+    openWebTerminal = _useWebTerminal.openWebTerminal;
+  var _useState = useState(open),
+    _useState2 = _slicedToArray(_useState, 2),
+    shouldRender = _useState2[0],
+    setRender = _useState2[1];
+  var _ref2 = window && window.matchMedia ? window.matchMedia('(prefers-reduced-motion: reduce)') : {
+      matches: true
+    },
+    prefersReducedMotion = _ref2.matches;
+  var webTerminalAnimationName = "".concat(open ? 'web-terminal-entrance' : 'web-terminal-exit', " ").concat(moderate02);
+  var showDocumentationLinks = useMemo(function () {
+    return documentationLinks.length > 0;
+  }, [documentationLinks]);
+  useEffect(function () {
+    if (open) {
+      setRender(true);
+    }
+  }, [open]);
+
+  /**
+    On render, check if user want's the web terminal to be open by default
+  */
+  useEffect(function () {
+    if (isInitiallyOpen) {
+      openWebTerminal();
+    }
+  }, []); // eslint-disable-line
+
+  /**
+    When the web terminal slide in animation is complete, sets render to false.
+  */
+  var onAnimationEnd = function onAnimationEnd() {
+    if (!open) {
+      setRender(false);
+    }
+  };
+  var handleCloseTerminal = function handleCloseTerminal() {
+    /**
+      If the user prefers reduced motion, we have to manually set render to false
+      because onAnimationEnd will never be called.
+    */
+    if (prefersReducedMotion) {
+      setRender(false);
+    }
+    closeWebTerminal();
+  };
+  return shouldRender ? /*#__PURE__*/React.createElement("div", _extends({}, _objectSpread(_objectSpread({}, rest), getDevtoolsProps(componentName)), {
+    ref: ref,
+    className: cx([blockClass, className, (_ref3 = {}, _defineProperty(_ref3, "".concat(blockClass, "--open"), open), _defineProperty(_ref3, "".concat(blockClass, "--closed"), !open), _ref3)]),
+    style: {
+      animation: !prefersReducedMotion && webTerminalAnimationName
+    },
+    onAnimationEnd: onAnimationEnd
+  }), /*#__PURE__*/React.createElement("header", {
+    className: "".concat(blockClass, "__bar")
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__actions")
+  }, showDocumentationLinks && /*#__PURE__*/React.createElement(OverflowMenu, {
+    renderIcon: function renderIcon(props) {
+      return /*#__PURE__*/React.createElement(Help, _extends({
+        size: 16
+      }, props));
+    },
+    iconDescription: documentationLinksIconDescription,
+    "aria-label": documentationLinksIconDescription,
+    menuOptionsClass: "".concat(blockClass, "__documentation-overflow"),
+    size: "lg"
+  }, documentationLinks.map(function (_ref4, i) {
+    var rest = _extends({}, (_objectDestructuringEmpty(_ref4), _ref4));
+    return /*#__PURE__*/React.createElement(OverflowMenuItem, _extends({
+      key: i
+    }, rest));
+  })), actions.map(function (_ref5) {
+    var renderIcon = _ref5.renderIcon,
+      onClick = _ref5.onClick,
+      iconDescription = _ref5.iconDescription;
+    return /*#__PURE__*/React.createElement(Button, {
+      key: iconDescription,
+      hasIconOnly: true,
+      renderIcon: renderIcon,
+      onClick: onClick,
+      iconDescription: iconDescription,
+      kind: "ghost",
+      "aria-label": iconDescription
+    });
+  })), /*#__PURE__*/React.createElement(Button, {
+    hasIconOnly: true,
+    renderIcon: function renderIcon(props) {
+      return /*#__PURE__*/React.createElement(Close, _extends({
+        size: 16
+      }, props));
+    },
+    kind: "ghost",
+    iconDescription: closeIconDescription,
+    onClick: handleCloseTerminal,
+    onAnimationEnd: function onAnimationEnd(event) {
+      return event.stopPropagation();
+    }
+  })), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__body")
+  }, children)) : null;
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+WebTerminal = pkg.checkComponentEnabled(WebTerminal, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+WebTerminal.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+WebTerminal.propTypes = {
+  /**
+   * An array of actions to be displayed in the web terminal header bar
+   */
+  actions: PropTypes.arrayOf(PropTypes.shape({
+    renderIcon: PropTypes.func.isRequired,
+    onClick: PropTypes.func.isRequired,
+    iconDescription: PropTypes.string.isRequired
+  })),
+  /**
+   * Provide your own terminal component as children to show up in the web terminal
+   */
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
+  /**
+   * Custom classname for additional styling of the web terminal
+   */
+  className: PropTypes.string,
+  /**
+   * Icon description for the close button
+   */
+  closeIconDescription: PropTypes.string.isRequired,
+  /**
+   * Array of objects for each documentation link. Each documentation link uses the prop types of OverflowMenuItems. See more: https://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default
+   */
+  documentationLinks: PropTypes.arrayOf(PropTypes.shape(_objectSpread({}, OverflowMenuItem.propTypes))),
+  /**
+   * Description for the documentation link overflow menu tooltip
+   */
+  documentationLinksIconDescription: PropTypes.string,
+  /**
+   * Optionally pass if the web terminal should be open by default
+   */
+  isInitiallyOpen: PropTypes.bool
+};

package/es/components/WebTerminal/WebTerminalContentWrapper.js

@@ -0,0 +1,50 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children"];
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * 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 portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { pkg } from '../../settings';
+import { useWebTerminal } from './hooks';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var componentName = 'WebTerminalContentWrapper';
+var blockClass = "".concat(pkg.prefix, "--web-terminal-content-wrapper");
+export var WebTerminalContentWrapper = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var _useWebTerminal = useWebTerminal(),
+    open = _useWebTerminal.open;
+  return /*#__PURE__*/React.createElement("div", _extends({
+    ref: ref,
+    className: cx([blockClass, _defineProperty({}, "".concat(blockClass, "--open"), open)])
+  }, rest), children);
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+WebTerminalContentWrapper = pkg.checkComponentEnabled(WebTerminalContentWrapper, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+WebTerminalContentWrapper.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+WebTerminalContentWrapper.propTypes = {
+  /**
+   * Pass in content as children.
+   */
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired
+};

package/es/components/WebTerminal/hooks/index.js

@@ -0,0 +1,52 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+//
+// Copyright IBM Corp. 2022, 2022
+//
+// 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 React, { useState, useCallback, createContext } from 'react';
+import { useContext } from 'react';
+import PropTypes from 'prop-types';
+import { pkg } from '../../../settings';
+export var WebTerminalContext = /*#__PURE__*/createContext();
+var componentName = 'WebTerminalProvider';
+export var WebTerminalProvider = function WebTerminalProvider(_ref) {
+  var children = _ref.children;
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    open = _useState2[0],
+    setOpen = _useState2[1];
+  var openWebTerminal = useCallback(function () {
+    return setOpen(true);
+  }, []);
+  var closeWebTerminal = useCallback(function () {
+    return setOpen(false);
+  }, []);
+  var toggleWebTerminal = useCallback(function () {
+    return setOpen(!open);
+  }, [open]);
+  return /*#__PURE__*/React.createElement(WebTerminalContext.Provider, {
+    value: {
+      open: open,
+      openWebTerminal: openWebTerminal,
+      closeWebTerminal: closeWebTerminal,
+      toggleWebTerminal: toggleWebTerminal
+    }
+  }, children);
+};
+
+// Return a placeholder if not released and not enabled by feature flag
+WebTerminalProvider = pkg.checkComponentEnabled(WebTerminalProvider, componentName);
+WebTerminalProvider.propTypes = {
+  /**
+   * Provide your own terminal component as children to show up in the web terminal
+   */
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired
+};
+
+// Custom hook that exposes the provided value from context
+export var useWebTerminal = function useWebTerminal() {
+  return useContext(WebTerminalContext);
+};

package/es/components/WebTerminal/index.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright IBM Corp. 2020, 2022
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { WebTerminal } from './WebTerminal';
+export { WebTerminalContentWrapper } from './WebTerminalContentWrapper';
+export { useWebTerminal, WebTerminalProvider } from './hooks';

package/es/components/WebTerminal/preview-components/Navigation.js

@@ -0,0 +1,37 @@
+//
+// Copyright IBM Corp. 2020, 2022
+//
+// 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 React from 'react';
+import { Header, HeaderName, HeaderGlobalAction, HeaderGlobalBar } from '@carbon/react';
+import { Terminal, Search, User } from '@carbon/react/icons';
+import { useWebTerminal } from '../hooks';
+var Navigation = function Navigation() {
+  var _useWebTerminal = useWebTerminal(),
+    openWebTerminal = _useWebTerminal.openWebTerminal;
+  return /*#__PURE__*/React.createElement(Header, {
+    "aria-label": "IBM Platform Name"
+  }, /*#__PURE__*/React.createElement(HeaderName, {
+    href: "#",
+    prefix: "IBM"
+  }, "[Platform]"), /*#__PURE__*/React.createElement(HeaderGlobalBar, null, /*#__PURE__*/React.createElement(HeaderGlobalAction, {
+    "aria-label": "Web terminal",
+    onClick: openWebTerminal
+  }, /*#__PURE__*/React.createElement(Terminal, {
+    size: 20
+  })), /*#__PURE__*/React.createElement(HeaderGlobalAction, {
+    "aria-label": "Search",
+    onClick: function onClick() {}
+  }, /*#__PURE__*/React.createElement(Search, {
+    size: 20
+  })), /*#__PURE__*/React.createElement(HeaderGlobalAction, {
+    "aria-label": "User",
+    onClick: function onClick() {}
+  }, /*#__PURE__*/React.createElement(User, {
+    size: 20
+  }))));
+};
+export default Navigation;

package/es/components/WebTerminal/preview-components/documentationLinks.js

@@ -0,0 +1,32 @@
+//
+// Copyright IBM Corp. 2020, 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.
+//
+
+export var documentationLinks = [{
+  itemText: 'BX/ICP docs',
+  href: '#',
+  onClick: function onClick() {
+    return console.log('clicked');
+  }
+}, {
+  itemText: 'Kubernetes docs',
+  href: '#',
+  onClick: function onClick() {
+    return console.log('clicked');
+  }
+}, {
+  itemText: 'Docker docs',
+  href: '#',
+  onClick: function onClick() {
+    return console.log('clicked');
+  }
+}, {
+  itemText: 'Helm docs',
+  href: '#',
+  onClick: function onClick() {
+    return console.log('clicked');
+  }
+}];

package/es/components/WebTerminal/preview-components/index.js

@@ -0,0 +1,12 @@
+//
+// Copyright IBM Corp. 2020, 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.
+//
+
+/**
+ * Preview components are components only to be used
+ * in the context of storybook.
+ */
+export { default as Navigation } from './Navigation';

package/es/components/_Canary/Canary.js

@@ -0,0 +1,48 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "componentName"];
+/**
+ * Copyright IBM Corp. 2020, 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 portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+
+// load the package settings direct, because Canary is used by settings.js
+import pkg from '../../global/js/package-settings';
+
+// Carbon and package components we use.
+import { CodeSnippet } from '@carbon/react';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--canary");
+
+/**
+ *  Canary component used when the component requested is not yet production
+ */
+export var Canary = function Canary(_ref /*, originalArgs*/) {
+  var className = _ref.className,
+    componentName = _ref.componentName,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var instructions = "\nimport { pkg } from '@carbon/ibm-products';\n// NOTE: must happen before component is first used\npkg.component.".concat(componentName, " = true;\n");
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, className)
+  }), /*#__PURE__*/React.createElement("h2", null, "This component ", /*#__PURE__*/React.createElement("strong", null, componentName), " is not ready yet."), /*#__PURE__*/React.createElement("p", null, "To enable it, initialize package flags before the component is first used."), /*#__PURE__*/React.createElement("br", null), /*#__PURE__*/React.createElement("p", null, "e.g. in main.js"), /*#__PURE__*/React.createElement(CodeSnippet, {
+    type: "multi"
+  }, instructions), /*#__PURE__*/React.createElement("br", null), /*#__PURE__*/React.createElement("p", null, "View a live example on", ' ', /*#__PURE__*/React.createElement("a", {
+    href: "https://codesandbox.io/s/example-component-olif5?file=/src/config.js"
+  }, "codesandbox"), "."));
+};
+Canary.propTypes = {
+  /** Provide an optional class to be applied to the containing node */
+  className: PropTypes.string,
+  /** Name of the component that is not ready yet */
+  componentName: PropTypes.string.isRequired
+};

package/es/components/_Canary/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+
+export { Canary } from './Canary';