@carbon/ibm-products 1.4.0 → 1.7.0

package/lib/components/DataSpreadsheet/DataSpreadsheet.js

@@ -0,0 +1,171 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DataSpreadsheet = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _reactTable = require("react-table");
+
+var _reactWindow = require("react-window");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _devtools = require("../../global/js/utils/devtools");
+
+var _settings = require("../../settings");
+
+var _getScrollbarWidth = require("../../global/js/utils/getScrollbarWidth");
+
+var _excluded = ["className", "columns", "data"];
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--data-spreadsheet");
+var componentName = 'DataSpreadsheet';
+/**
+ * DataSpreadsheet: used to organize and display large amounts of structured data, separated by columns and rows in a grid-like format.
+ */
+
+var DataSpreadsheet = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+      columns = _ref.columns,
+      data = _ref.data,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var defaultColumn = (0, _react.useMemo)(function () {
+    return {
+      width: 150,
+      rowHeaderWidth: 64
+    };
+  }, []);
+  var scrollBarSize = (0, _react.useMemo)(function () {
+    return (0, _getScrollbarWidth.getScrollbarWidth)();
+  }, []);
+
+  var _useTable = (0, _reactTable.useTable)({
+    columns: columns,
+    data: data,
+    defaultColumn: defaultColumn
+  }, _reactTable.useBlockLayout),
+      getTableProps = _useTable.getTableProps,
+      getTableBodyProps = _useTable.getTableBodyProps,
+      headerGroups = _useTable.headerGroups,
+      rows = _useTable.rows,
+      totalColumnsWidth = _useTable.totalColumnsWidth,
+      prepareRow = _useTable.prepareRow;
+
+  var RenderRow = _react.default.useCallback(function (_ref2) {
+    var index = _ref2.index,
+        style = _ref2.style;
+    var row = rows[index];
+    prepareRow(row);
+    return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, row.getRowProps({
+      style: style
+    }), {
+      className: "tr",
+      "data-row-index": index
+    }), /*#__PURE__*/_react.default.createElement("button", {
+      type: "button",
+      className: (0, _classnames.default)("".concat(blockClass, "__td"), "".concat(blockClass, "__td-th")),
+      style: {
+        width: defaultColumn === null || defaultColumn === void 0 ? void 0 : defaultColumn.rowHeaderWidth,
+        display: 'flex',
+        justifyContent: 'flex-end',
+        alignItems: 'center'
+      }
+    }, index + 1), row.cells.map(function (cell, index) {
+      return /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+        key: "cell_".concat(index)
+      }, cell.getCellProps(), {
+        type: "button",
+        className: "".concat(blockClass, "__td")
+      }), cell.render('Cell'));
+    }));
+  }, [prepareRow, rows, defaultColumn.rowHeaderWidth]);
+
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, getTableProps(), (0, _devtools.getDevtoolsProps)(componentName), {
+    className: (0, _classnames.default)(blockClass, className),
+    ref: ref,
+    role: "grid"
+  }), /*#__PURE__*/_react.default.createElement("div", null, headerGroups.map(function (headerGroup, index) {
+    return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({
+      key: "header_".concat(index)
+    }, headerGroup.getHeaderGroupProps(), {
+      className: "".concat(blockClass, "__tr")
+    }), /*#__PURE__*/_react.default.createElement("button", {
+      type: "button",
+      className: "".concat(blockClass, "__th"),
+      style: {
+        width: defaultColumn === null || defaultColumn === void 0 ? void 0 : defaultColumn.rowHeaderWidth
+      }
+    }, "\xA0"), headerGroup.headers.map(function (column, index) {
+      return /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+        key: "column_".concat(index)
+      }, column.getHeaderProps(), {
+        type: "button",
+        className: "".concat(blockClass, "__th")
+      }), column.render('Header'));
+    }));
+  })), /*#__PURE__*/_react.default.createElement("div", getTableBodyProps(), /*#__PURE__*/_react.default.createElement(_reactWindow.FixedSizeList, {
+    height: 400,
+    itemCount: rows.length,
+    itemSize: 36,
+    width: totalColumnsWidth + scrollBarSize
+  }, RenderRow)));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+
+exports.DataSpreadsheet = DataSpreadsheet;
+exports.DataSpreadsheet = DataSpreadsheet = _settings.pkg.checkComponentEnabled(DataSpreadsheet, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+DataSpreadsheet.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.
+
+DataSpreadsheet.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+
+  /**
+   * The data that will build the column headers
+   */
+  columns: _propTypes.default.arrayOf(_propTypes.default.shape({
+    Header: _propTypes.default.string,
+    accessor: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.func]),
+    Cell: _propTypes.default.func // optional cell formatter
+
+  })),
+
+  /**
+   * The spreadsheet data that will be rendered in the body of the spreadsheet component
+   */
+  data: _propTypes.default.arrayOf(_propTypes.default.shape)
+  /* TODO: add types and DocGen for all props. */
+
+}; // 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.
+
+DataSpreadsheet.defaultProps = {
+  data: [],
+  columns: []
+};

package/lib/components/DataSpreadsheet/generateData.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateData = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+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; }
+
+// cspell:disable
+var pets = ['dog', 'cat', 'bird', 'lizard', 'frog', 'hamster', 'fish', 'rabbit', 'snake'];
+var petNames = ['Bruno', 'Willow', 'Kona', 'Heidi', 'Rusty', 'Bonnie', 'Cash', 'Gucci', 'Brody', 'Emma', 'Loki', 'Angel', 'Astro', 'Sherman', 'Layla', 'Peanut', 'Grace', 'Mickey', 'Sasha', 'Finn', 'Tucker', 'Bear', 'Mocha', 'Roscoe']; // cspell:enable
+
+var range = function range(len) {
+  var arr = [];
+
+  for (var i = 0; i < len; i++) {
+    arr.push(i);
+  }
+
+  return arr;
+};
+
+var newPet = function newPet() {
+  return {
+    petType: pets[Math.floor(Math.random() * pets.length)],
+    firstName: petNames[Math.floor(Math.random() * petNames.length)],
+    age: Math.floor(Math.random() * 30),
+    visits: Math.floor(Math.random() * 40),
+    health: Math.floor(Math.random() * 100)
+  };
+};
+
+var generateData = function generateData() {
+  for (var _len = arguments.length, lens = new Array(_len), _key = 0; _key < _len; _key++) {
+    lens[_key] = arguments[_key];
+  }
+
+  var makeDataLevel = function makeDataLevel() {
+    var depth = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    var len = lens[depth];
+    return range(len).map(function () {
+      return _objectSpread(_objectSpread({}, newPet()), {}, {
+        subRows: lens[depth + 1] ? makeDataLevel(depth + 1) : undefined
+      });
+    });
+  };
+
+  return makeDataLevel();
+};
+
+exports.generateData = generateData;

package/lib/components/DataSpreadsheet/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "DataSpreadsheet", {
+  enumerable: true,
+  get: function get() {
+    return _DataSpreadsheet.DataSpreadsheet;
+  }
+});
+
+var _DataSpreadsheet = require("./DataSpreadsheet");

package/lib/components/EmptyStates/EmptyState.js

@@ -123,7 +123,7 @@ EmptyState.propTypes = {
   /**
    * Empty state subtext
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state heading

package/lib/components/EmptyStates/EmptyStateContent.js

@@ -37,7 +37,7 @@ var EmptyStateContent = function EmptyStateContent(_ref) {
       title = _ref.title;
   return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("h3", {
     className: (0, _classnames.default)("".concat(blockClass, "__header"), (0, _defineProperty2.default)({}, "".concat(blockClass, "__header--small"), size === 'sm'))
-  }, title), /*#__PURE__*/_react.default.createElement("p", {
+  }, title), subtitle && /*#__PURE__*/_react.default.createElement("p", {
     className: (0, _classnames.default)("".concat(blockClass, "__subtitle"), (0, _defineProperty2.default)({}, "".concat(blockClass, "__subtitle--small"), size === 'sm'))
   }, subtitle), (action === null || action === void 0 ? void 0 : action.text) && (action === null || action === void 0 ? void 0 : action.onClick) && /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, (0, _extends2.default)({}, action, {
     className: "".concat(blockClass, "__action-button"),
@@ -85,7 +85,7 @@ EmptyStateContent.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js

@@ -114,7 +114,7 @@ ErrorEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js

@@ -114,7 +114,7 @@ NoDataEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js

@@ -114,7 +114,7 @@ NoTagsEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js

@@ -114,7 +114,7 @@ NotFoundEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js

@@ -114,7 +114,7 @@ NotificationsEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js

@@ -114,7 +114,7 @@ UnauthorizedEmptyState.propTypes = {
   /**
    * Empty state subtitle
    */
-  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  subtitle: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
 
   /**
    * Empty state title

package/lib/components/ExportModal/ExportModal.js

@@ -33,7 +33,7 @@ var _uuidv = _interopRequireDefault(require("../../global/js/utils/uuidv4"));
 
 var _settings = require("../../settings");
 
-var _excluded = ["body", "className", "error", "errorMessage", "filename", "inputLabel", "invalidInputText", "loading", "loadingMessage", "onClose", "onRequestSubmit", "open", "preformattedExtensions", "preformattedExtensionsLabel", "primaryButtonText", "secondaryButtonText", "successMessage", "successful", "title", "validExtensions"];
+var _excluded = ["body", "className", "error", "errorMessage", "filename", "hidePasswordLabel", "inputLabel", "inputType", "invalidInputText", "loading", "loadingMessage", "onClose", "onRequestSubmit", "open", "preformattedExtensions", "preformattedExtensionsLabel", "primaryButtonText", "secondaryButtonText", "showPasswordLabel", "successMessage", "successful", "title", "validExtensions"];
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
@@ -52,7 +52,9 @@ var ExportModal = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       error = _ref.error,
       errorMessage = _ref.errorMessage,
       filename = _ref.filename,
+      hidePasswordLabel = _ref.hidePasswordLabel,
       inputLabel = _ref.inputLabel,
+      inputType = _ref.inputType,
       invalidInputText = _ref.invalidInputText,
       loading = _ref.loading,
       loadingMessage = _ref.loadingMessage,
@@ -63,6 +65,7 @@ var ExportModal = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       preformattedExtensionsLabel = _ref.preformattedExtensionsLabel,
       primaryButtonText = _ref.primaryButtonText,
       secondaryButtonText = _ref.secondaryButtonText,
+      showPasswordLabel = _ref.showPasswordLabel,
       successMessage = _ref.successMessage,
       successful = _ref.successful,
       title = _ref.title,
@@ -124,6 +127,15 @@ var ExportModal = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var internalId = (0, _react.useRef)((0, _uuidv.default)());
   var primaryButtonDisabled = loading || !name || hasInvalidExtension();
   var submitted = loading || error || successful;
+  var commonInputProps = (0, _defineProperty2.default)({
+    id: "text-input--".concat(internalId.current),
+    value: name,
+    onChange: onNameChangeHandler,
+    labelText: inputLabel,
+    invalid: hasInvalidExtension(),
+    invalidText: invalidInputText,
+    onBlur: onBlurHandler
+  }, 'data-modal-primary-focus', true);
   return /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.ComposedModal, (0, _extends2.default)({}, rest, {
     className: (0, _classnames.default)(blockClass, className),
     "aria-label": title,
@@ -155,16 +167,13 @@ var ExportModal = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       labelText: "".concat(o.extension, " (").concat(o.description, ")"),
       "data-modal-primary-focus": true
     });
-  }))) : /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.TextInput, {
-    id: "text-input--".concat(internalId.current),
-    value: name,
-    onChange: onNameChangeHandler,
-    labelText: inputLabel,
-    invalid: hasInvalidExtension(),
-    invalidText: invalidInputText,
-    onBlur: onBlurHandler,
-    "data-modal-primary-focus": true
-  })), /*#__PURE__*/_react.default.createElement("div", {
+  }))) : /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__input-container")
+  }, inputType === 'text' ? /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.TextInput, commonInputProps) : /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.PasswordInput, (0, _extends2.default)({}, commonInputProps, {
+    showPasswordLabel: showPasswordLabel,
+    hidePasswordLabel: hidePasswordLabel,
+    tooltipPosition: "left"
+  })))), /*#__PURE__*/_react.default.createElement("div", {
     className: "".concat(blockClass, "__messaging")
   }, loading && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Loading, {
     small: true,
@@ -215,11 +224,21 @@ ExportModal.propTypes = {
    */
   filename: _propTypes.default.string.isRequired,
 
+  /**
+   * label text that's displayed when hovering over visibility toggler to hide key
+   */
+  hidePasswordLabel: _propTypes.default.string,
+
   /**
    * label for the text input
    */
   inputLabel: _propTypes.default.string,
 
+  /**
+   * specify the type of text input
+   */
+  inputType: _propTypes.default.oneOf(['text', 'password']),
+
   /**
    * text for an invalid input
    */
@@ -273,6 +292,11 @@ ExportModal.propTypes = {
    */
   secondaryButtonText: _propTypes.default.string.isRequired,
 
+  /**
+   * label text that's displayed when hovering over visibility toggler to show key
+   */
+  showPasswordLabel: _propTypes.default.string,
+
   /**
    * messaging to display if the export was successful
    */
@@ -294,6 +318,7 @@ ExportModal.propTypes = {
   validExtensions: _propTypes.default.array
 };
 ExportModal.defaultProps = {
+  inputType: 'text',
   preformattedExtensions: [],
   validExtensions: []
 };