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

package/lib/components/Tearsheet/Tearsheet.js

@@ -0,0 +1,196 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deprecatedProps = exports.Tearsheet = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _devtools = require("../../global/js/utils/devtools");
+var _propsHelper = require("../../global/js/utils/props-helper");
+var _settings = require("../../settings");
+var _react2 = require("@carbon/react");
+var _ActionSet = require("../ActionSet");
+var _TearsheetShell = require("./TearsheetShell");
+var _excluded = ["influencerPosition", "influencerWidth", "verticalPosition"];
+/**
+ * Copyright IBM Corp. 2020, 2023
+ *
+ * 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.
+// Other standard imports.
+// Carbon and package components we use.
+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) { (0, _defineProperty2.default)(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; }
+var componentName = 'Tearsheet';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values for props
+var defaults = {
+  influencerPosition: 'left',
+  influencerWidth: 'narrow',
+  verticalPosition: 'lower'
+};
+
+/**
+ * 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.
+ */
+var Tearsheet = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _ref$influencerPositi = _ref.influencerPosition,
+    influencerPosition = _ref$influencerPositi === void 0 ? defaults.influencerPosition : _ref$influencerPositi,
+    _ref$influencerWidth = _ref.influencerWidth,
+    influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
+    _ref$verticalPosition = _ref.verticalPosition,
+    verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement(_TearsheetShell.TearsheetShell, _objectSpread(_objectSpread(_objectSpread({}, (0, _devtools.getDevtoolsProps)(componentName)), rest), {}, {
+    influencerPosition: influencerPosition,
+    influencerWidth: influencerWidth,
+    verticalPosition: verticalPosition,
+    ref: ref,
+    size: 'wide'
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.Tearsheet = Tearsheet;
+exports.Tearsheet = Tearsheet = _settings.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;
+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.default.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.
+exports.deprecatedProps = deprecatedProps;
+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, except 'size'. 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: (0, _propsHelper.allPropTypes)([_ActionSet.ActionSet.validateActions(function () {
+    return '2xl';
+  }), _propTypes.default.arrayOf(_propTypes.default.shape(_objectSpread(_objectSpread({}, _react2.Button.propTypes), {}, {
+    kind: _propTypes.default.oneOf(['ghost', 'danger--ghost', 'secondary', 'danger', 'primary']),
+    label: _propTypes.default.string,
+    loading: _propTypes.default.bool,
+    // we duplicate this Button prop to improve the DocGen here
+    onClick: _react2.Button.propTypes.onClick
+  })))]),
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: _propTypes.default.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.default.string.isRequired.if(function (_ref2) {
+    var actions = _ref2.actions,
+      hasCloseIcon = _ref2.hasCloseIcon;
+    return (0, _TearsheetShell.tearsheetHasCloseIcon)(actions, hasCloseIcon);
+  }),
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: _propTypes.default.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.default.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.default.element,
+  /**
+   * The position of the influencer section, 'left' or 'right'.
+   */
+  influencerPosition: _propTypes.default.oneOf(['left', 'right']),
+  /**
+   * The width of the influencer: 'narrow' (the default) is 256px, and 'wide'
+   * is 320px.
+   */
+  influencerWidth: _propTypes.default.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.default.node,
+  /**
+   * Navigation content, such as a set of tabs, to be displayed at the bottom
+   * of the header area of the tearsheet.
+   */
+  navigation: _propTypes.default.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.default.func,
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: _propTypes.default.bool,
+  /**
+   * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+   */
+  portalTarget: _propTypes.default.node,
+  /**
+   * Specify a CSS selector that matches the DOM element that should be focused when the Modal opens
+   */
+  selectorPrimaryFocus: _propTypes.default.string,
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: _propTypes.default.node
+}, deprecatedProps);

package/lib/components/Tearsheet/TearsheetNarrow.js

@@ -0,0 +1,158 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deprecatedProps = exports.TearsheetNarrow = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _devtools = require("../../global/js/utils/devtools");
+var _propsHelper = require("../../global/js/utils/props-helper");
+var _settings = require("../../settings");
+var _react2 = require("@carbon/react");
+var _ActionSet = require("../ActionSet");
+var _TearsheetShell = require("./TearsheetShell");
+var _excluded = ["verticalPosition"];
+/**
+ * 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.
+// Other standard imports.
+// Carbon and package components we use.
+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) { (0, _defineProperty2.default)(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; }
+var componentName = 'TearsheetNarrow';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values for props
+var defaults = {
+  verticalPosition: 'lower'
+};
+
+/**
+ * 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.
+ */
+var TearsheetNarrow = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _ref$verticalPosition = _ref.verticalPosition,
+    verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement(_TearsheetShell.TearsheetShell, _objectSpread(_objectSpread(_objectSpread({}, (0, _devtools.getDevtoolsProps)(componentName)), (0, _propsHelper.prepareProps)(rest, _TearsheetShell.tearsheetShellWideProps)), {}, {
+    verticalPosition: verticalPosition,
+    ref: ref,
+    size: 'narrow'
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.TearsheetNarrow = TearsheetNarrow;
+exports.TearsheetNarrow = TearsheetNarrow = _settings.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;
+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.default.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.
+exports.deprecatedProps = deprecatedProps;
+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: (0, _propsHelper.allPropTypes)([_ActionSet.ActionSet.validateActions(function () {
+    return 'lg';
+  }), _propTypes.default.arrayOf(_propTypes.default.shape(_objectSpread(_objectSpread({}, _react2.Button.propTypes), {}, {
+    kind: _propTypes.default.oneOf(['ghost', 'danger--ghost', 'secondary', 'danger', 'primary']),
+    label: _propTypes.default.string,
+    loading: _propTypes.default.bool,
+    // we duplicate this Button prop to improve the DocGen here
+    onClick: _react2.Button.propTypes.onClick
+  })))]),
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: _propTypes.default.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.default.string.isRequired.if(function (_ref2) {
+    var actions = _ref2.actions,
+      hasCloseIcon = _ref2.hasCloseIcon;
+    return (0, _TearsheetShell.tearsheetHasCloseIcon)(actions, hasCloseIcon);
+  }),
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: _propTypes.default.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.default.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.default.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.default.func,
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: _propTypes.default.bool,
+  /**
+   * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+   */
+  portalTarget: _propTypes.default.node,
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: _propTypes.default.node
+}, deprecatedProps);