@carbon/ibm-products 1.0.0-rc.0 → 1.0.1

package/es/components/TagSet/TagSetOverflow.js

@@ -0,0 +1,121 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+//
+// 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 React, { useState, useRef } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Link, Tag, Tooltip } from 'carbon-components-react';
+import { pkg } from '../../settings';
+import { noop } from '../../global/js/utils/pconsole';
+var componentName = 'TagSetOverflow';
+var blockClass = "".concat(pkg.prefix, "--tag-set-overflow");
+export var TagSetOverflow = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+      overflowTags = _ref.overflowTags,
+      onShowAllClick = _ref.onShowAllClick,
+      overflowAlign = _ref.overflowAlign,
+      overflowDirection = _ref.overflowDirection,
+      showAllTagsLabel = _ref.showAllTagsLabel,
+      allTagsModalSearchThreshold = _ref.allTagsModalSearchThreshold;
+
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      tipOpen = _useState2[0],
+      setTipOpen = _useState2[1];
+
+  var overflowTagContent = useRef(null);
+
+  var handleChange = function handleChange(ev, _ref2) {
+    var open = _ref2.open;
+    setTipOpen(open);
+  };
+
+  var handleShowAllTagsClick = function handleShowAllTagsClick(ev) {
+    ev.stopPropagation();
+    ev.preventDefault();
+    setTipOpen(false);
+    onShowAllClick();
+  };
+
+  return /*#__PURE__*/React.createElement("span", {
+    "aria-hidden": overflowTags.length === 0,
+    className: cx("".concat(blockClass), _defineProperty({}, "".concat(blockClass, "--hidden"), overflowTags.length === 0)),
+    ref: ref
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    align: overflowAlign,
+    className: cx(className, "".concat(blockClass, "__tooltip")),
+    direction: overflowDirection,
+    onChange: handleChange,
+    open: tipOpen,
+    triggerText: /*#__PURE__*/React.createElement(Tag, {
+      onClick: noop
+    }, "+", overflowTags.length),
+    showIcon: false
+  }, /*#__PURE__*/React.createElement("div", {
+    ref: overflowTagContent,
+    className: "".concat(blockClass, "__content")
+  }, /*#__PURE__*/React.createElement("ul", {
+    className: "".concat(blockClass, "__tag-list")
+  }, overflowTags.filter(function (_, index) {
+    return overflowTags.length > allTagsModalSearchThreshold ? index < allTagsModalSearchThreshold : index <= allTagsModalSearchThreshold;
+  }).map(function (tag, index) {
+    return /*#__PURE__*/React.createElement("li", {
+      className: "".concat(blockClass, "__tag-item"),
+      key: index
+    }, /*#__PURE__*/React.cloneElement(tag, {
+      filter: false
+    }));
+  })), overflowTags.length > allTagsModalSearchThreshold && /*#__PURE__*/React.createElement(Link, {
+    className: "".concat(blockClass, "__show-all-tags-link"),
+    href: "",
+    onClick: handleShowAllTagsClick,
+    role: "button"
+  }, showAllTagsLabel))));
+});
+TagSetOverflow.displayName = componentName;
+TagSetOverflow.propTypes = {
+  /**
+   * count of overflowTags over which a modal is offered
+   */
+  allTagsModalSearchThreshold: PropTypes.number,
+
+  /**
+   * className
+   */
+  className: PropTypes.string,
+
+  /**
+   * function to execute on clicking show all
+   */
+  onShowAllClick: PropTypes.func.isRequired,
+
+  /**
+   * overflowAlign from the standard tooltip
+   */
+  overflowAlign: PropTypes.oneOf(['start', 'center', 'end']),
+
+  /**
+   * overflowDirection from the standard tooltip
+   */
+  overflowDirection: PropTypes.oneOf(['top', 'right', 'bottom', 'left']),
+
+  /**
+   * tags shown in overflow
+   */
+  overflowTags: PropTypes.arrayOf(PropTypes.object).isRequired,
+
+  /**
+   * label for the overflow show all tags link
+   */
+  showAllTagsLabel: PropTypes.string
+};
+TagSetOverflow.defaultProps = {
+  allTagsModalSearchThreshold: 10,
+  overflowAlign: 'center',
+  overflowDirection: 'bottom'
+};

package/es/components/TagSet/index.js

@@ -0,0 +1,7 @@
+//
+// 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 { TagSet } from './TagSet';

package/es/components/Tearsheet/Tearsheet.js

@@ -0,0 +1,180 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _extends from "@babel/runtime/helpers/extends";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+/**
+ * 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 { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { allPropTypes, prepareProps } from '../../global/js/utils/props-helper';
+import { pkg } from '../../settings'; // Carbon and package components we use.
+
+import { Button } from 'carbon-components-react';
+import { ActionSet } from '../ActionSet';
+import { tearsheetHasCloseIcon, TearsheetShell } from './TearsheetShell';
+var componentName = 'Tearsheet'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+/**
+ * A tearsheet is a mostly full-screen type of dialog that keeps users
+ * in-context and focused by bringing actionable content front and center while
+ * revealing parts of the UI behind it. There is also a narrow variant of the
+ * tearsheet.
+ *
+ * A tearsheet comprises up to 5 zones, allowing for flexibility depending on
+ * the content: a heading area including a title, an optional navigation area
+ * that sits just below the heading, an optional influencer which is a side
+ * panel on either the left or right side, the main content area, and a set of
+ * action buttons.
+ */
+
+export var Tearsheet = /*#__PURE__*/React.forwardRef(function (props, ref) {
+  return /*#__PURE__*/React.createElement(TearsheetShell, _extends({}, getDevtoolsProps(componentName), prepareProps(props, [], {
+    ref: ref,
+    size: 'wide'
+  })));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+Tearsheet = pkg.checkComponentEnabled(Tearsheet, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+Tearsheet.displayName = componentName;
+export var deprecatedProps = {
+  /**
+   * **Deprecated**
+   *
+   * The position of the top of tearsheet in the viewport. The 'normal'
+   * position is a short distance down from the top of the
+   * viewport, leaving room at the top for a global header bar to show through
+   * from below. The 'lower' position (the default) provides a little extra room at the top
+   * to allow an action bar navigation or breadcrumbs to also show through.
+   */
+  verticalPosition: PropTypes.oneOf(['normal', 'lower'])
+}; // The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+// Note that the descriptions here should be kept in sync with those for the
+// corresponding props for TearsheetNarrow and TearsheetShell components.
+
+Tearsheet.propTypes = _objectSpread({
+  /**
+   * The navigation actions to be shown as buttons in the action area at the
+   * bottom of the tearsheet. Each action is specified as an object with
+   * optional fields: 'label' to supply the button label, 'kind' to select the
+   * button kind (must be 'primary', 'secondary' or 'ghost'), 'loading' to
+   * display a loading indicator, and 'onClick' to receive notifications when
+   * the button is clicked. Additional fields in the object will be passed to
+   * the Button component, and these can include 'disabled', 'ref', 'className',
+   * and any other Button props. Any other fields in the object will be passed
+   * through to the button element as HTML attributes.
+   *
+   * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+   */
+  actions: allPropTypes([ActionSet.validateActions(function () {
+    return 'max';
+  }), PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, Button.propTypes), {}, {
+    kind: PropTypes.oneOf(['ghost', 'secondary', 'primary']),
+    label: PropTypes.string,
+    loading: PropTypes.bool,
+    // we duplicate this Button prop to improve the DocGen here
+    onClick: Button.propTypes.onClick
+  })))]),
+
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: PropTypes.string,
+
+  /**
+   * The accessibility title for the close icon (if shown).
+   *
+   * **Note:** This prop is only required if a close icon is shown, i.e. if
+   * there are a no navigation actions and/or hasCloseIcon is true.
+   */
+  closeIconDescription: PropTypes.string.isRequired.if(function (_ref) {
+    var actions = _ref.actions,
+        hasCloseIcon = _ref.hasCloseIcon;
+    return tearsheetHasCloseIcon(actions, hasCloseIcon);
+  }),
+
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: PropTypes.node,
+
+  /**
+   * Enable a close icon ('x') in the header area of the tearsheet. By default,
+   * (when this prop is omitted, or undefined or null) a tearsheet does not
+   * display a close icon if there are navigation actions ("transactional
+   * tearsheet") and displays one if there are no navigation actions ("passive
+   * tearsheet"), and that behavior can be overridden if required by setting
+   * this prop to either true or false.
+   */
+  hasCloseIcon: PropTypes.bool,
+
+  /**
+   * The content for the influencer section of the tearsheet, displayed
+   * alongside the main content. This is typically a menu, or filter, or
+   * progress indicator, or similar.
+   */
+  influencer: PropTypes.element,
+
+  /**
+   * The position of the influencer section, 'left' or 'right'.
+   */
+  influencerPosition: PropTypes.oneOf(['left', 'right']),
+
+  /**
+   * The width of the influencer: 'narrow' (the default) is 256px, and 'wide'
+   * is 320px.
+   */
+  influencerWidth: PropTypes.oneOf(['narrow', 'wide']),
+
+  /**
+   * A label for the tearsheet, displayed in the header area of the tearsheet
+   * to maintain context for the tearsheet (e.g. as the title changes from page
+   * to page of a multi-page task).
+   */
+  label: PropTypes.node,
+
+  /**
+   * Navigation content, such as a set of tabs, to be displayed at the bottom
+   * of the header area of the tearsheet.
+   */
+  navigation: PropTypes.element,
+
+  /**
+   * An optional handler that is called when the user closes the tearsheet (by
+   * clicking the close button, if enabled, or clicking outside, if enabled).
+   * Returning `false` here prevents the modal from closing.
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: PropTypes.bool,
+
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: PropTypes.node
+}, deprecatedProps); // Default values for component props. Default values are not required for
+// props that are required, nor for props where the component can apply
+// 'undefined' values reasonably. Default values should be provided when the
+// component needs to make a choice or assumption when a prop is not supplied.
+
+Tearsheet.defaultProps = {
+  influencerPosition: 'left',
+  influencerWidth: 'narrow',
+  verticalPosition: 'lower'
+};

package/es/components/Tearsheet/TearsheetNarrow.js

@@ -0,0 +1,148 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _extends from "@babel/runtime/helpers/extends";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+/**
+ * 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 { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { allPropTypes, prepareProps } from '../../global/js/utils/props-helper';
+import { pkg } from '../../settings'; // Carbon and package components we use.
+
+import { Button } from 'carbon-components-react';
+import { ActionSet } from '../ActionSet';
+import { tearsheetHasCloseIcon, TearsheetShell, tearsheetShellWideProps as blocked } from './TearsheetShell';
+var componentName = 'TearsheetNarrow'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+/**
+ * A narrow tearsheet is a slimmer variant of the tearsheet, providing a dialog
+ * that keeps users in-context and focused by bringing actionable content front
+ * and center while revealing more of the UI behind it.
+ *
+ * A narrow tearsheet comprises 3 zones: a heading area including a title, the
+ * main content area, and a set of action buttons.
+ */
+
+export var TearsheetNarrow = /*#__PURE__*/React.forwardRef(function (props, ref) {
+  return /*#__PURE__*/React.createElement(TearsheetShell, _extends({}, getDevtoolsProps(componentName), prepareProps(props, blocked, {
+    ref: ref,
+    size: 'narrow'
+  })));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+TearsheetNarrow = pkg.checkComponentEnabled(TearsheetNarrow, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+TearsheetNarrow.displayName = componentName;
+export var deprecatedProps = {
+  /**
+   * **Deprecated**
+   *
+   * The position of the top of tearsheet in the viewport. The 'normal'
+   * position is a short distance down from the top of the
+   * viewport, leaving room at the top for a global header bar to show through
+   * from below. The 'lower' position (the default) provides a little extra room at the top
+   * to allow an action bar navigation or breadcrumbs to also show through.
+   */
+  verticalPosition: PropTypes.oneOf(['normal', 'lower'])
+}; // The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+// Note that the descriptions here should be kept in sync with those for the
+// corresponding props for Tearsheet and TearsheetShell components.
+
+TearsheetNarrow.propTypes = _objectSpread({
+  /**
+   * The navigation actions to be shown as buttons in the action area at the
+   * bottom of the tearsheet. Each action is specified as an object with
+   * optional fields: 'label' to supply the button label, 'kind' to select the
+   * button kind (must be 'primary', 'secondary' or 'ghost'), 'loading' to
+   * display a loading indicator, and 'onClick' to receive notifications when
+   * the button is clicked. Additional fields in the object will be passed to
+   * the Button component, and these can include 'disabled', 'ref', 'className',
+   * and any other Button props. Any other fields in the object will be passed
+   * through to the button element as HTML attributes.
+   *
+   * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+   */
+  actions: allPropTypes([ActionSet.validateActions(function () {
+    return 'lg';
+  }), PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, Button.propTypes), {}, {
+    kind: PropTypes.oneOf(['ghost', 'secondary', 'primary']),
+    label: PropTypes.string,
+    loading: PropTypes.bool,
+    // we duplicate this Button prop to improve the DocGen here
+    onClick: Button.propTypes.onClick
+  })))]),
+
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: PropTypes.string,
+
+  /**
+   * The accessibility title for the close icon (if shown).
+   *
+   * **Note:** This prop is only required if a close icon is shown, i.e. if
+   * there are a no navigation actions and/or hasCloseIcon is true.
+   */
+  closeIconDescription: PropTypes.string.isRequired.if(function (_ref) {
+    var actions = _ref.actions,
+        hasCloseIcon = _ref.hasCloseIcon;
+    return tearsheetHasCloseIcon(actions, hasCloseIcon);
+  }),
+
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: PropTypes.node,
+
+  /**
+   * Enable a close icon ('x') in the header area of the tearsheet. By default,
+   * a tearsheet does not display a close icon, but one should be enabled if
+   * the tearsheet is read-only or has no navigation actions (sometimes called
+   * a "passive tearsheet").
+   */
+  hasCloseIcon: PropTypes.bool,
+
+  /**
+   * A label for the tearsheet, displayed in the header area of the tearsheet
+   * to maintain context for the tearsheet (e.g. as the title changes from page
+   * to page of a multi-page task).
+   */
+  label: PropTypes.node,
+
+  /**
+   * An optional handler that is called when the user closes the tearsheet (by
+   * clicking the close button, if enabled, or clicking outside, if enabled).
+   * Returning `false` here prevents the modal from closing.
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: PropTypes.bool,
+
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: PropTypes.node
+}, deprecatedProps); // Default values for component props. Default values are not required for
+// props that are required, nor for props where the component can apply
+// 'undefined' values reasonably. Default values should be provided when the
+// component needs to make a choice or assumption when a prop is not supplied.
+
+TearsheetNarrow.defaultProps = {
+  verticalPosition: 'lower'
+};