@carbon/ibm-products 1.2.5 → 1.3.0

package/lib/components/CancelableTextEdit/CancelableTextEdit.js

@@ -0,0 +1,226 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CancelableTextEdit = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _carbonComponentsReact = require("carbon-components-react");
+
+var _propsHelper = require("../../global/js/utils/props-helper");
+
+var _settings = require("../../settings");
+
+var _iconsReact = require("@carbon/icons-react");
+
+var _excluded = ["className", "inline", "invalid", "invalidText", "labelText", "onChange", "onInput", "revertLabel", "saveLabel", "value", "warn", "warnText"];
+
+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; }
+
+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; }
+
+// Carbon and package components we use.
+
+/* TODO: @import(s) of carbon components and other package components. */
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--cancelable-text-edit");
+var componentName = 'CancelableTextEdit'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+/**
+ * TODO: A description of the component.
+ */
+
+var CancelableTextEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _cx;
+
+  var className = _ref.className,
+      inline = _ref.inline,
+      invalid = _ref.invalid,
+      invalidText = _ref.invalidText,
+      labelText = _ref.labelText,
+      onChange = _ref.onChange,
+      onInput = _ref.onInput,
+      revertLabel = _ref.revertLabel,
+      saveLabel = _ref.saveLabel,
+      value = _ref.value,
+      warn = _ref.warn,
+      warnText = _ref.warnText,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  // remove these props later
+  var removeProps = ['children', 'onInput', 'onChange', 'value'];
+  var showWarn = inline && warn && !invalid;
+  var showInvalid = inline && invalid;
+
+  var _useState = (0, _react.useState)(value !== null && value !== void 0 ? value : ''),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      liveValue = _useState2[0],
+      setLiveValue = _useState2[1];
+
+  (0, _react.useEffect)(function () {
+    if (value !== liveValue) {
+      setLiveValue(value);
+    } // Do not care if liveValue changes here
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+
+  }, [value]);
+
+  var doInput = function doInput(newValue) {
+    setLiveValue(newValue);
+
+    if (onInput) {
+      onInput(newValue);
+    }
+  };
+
+  var handleInput = function handleInput(ev) {
+    doInput(ev.target.value);
+  };
+
+  var handleRevert = function handleRevert() {
+    doInput(value);
+  };
+
+  var handleSave = function handleSave() {
+    if (onChange && !invalid) {
+      onChange(liveValue);
+    }
+  };
+
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)(className, "".concat(blockClass), (_cx = {}, (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--invalid"), invalid), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--warn"), warn), _cx))
+  }, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.TextInput, (0, _extends2.default)({}, (0, _propsHelper.prepareProps)(rest, removeProps), {
+    // it is not permitted to pass children down to TextInput guard against this
+    className: "".concat(blockClass, "__input"),
+    ref: ref,
+    onInput: handleInput,
+    value: liveValue !== null && liveValue !== void 0 ? liveValue : '' // ?? '' prevents controlled components test failure https://reactjs.org/docs/forms.html#controlled-components
+    ,
+    inline: inline,
+    invalid: invalid,
+    invalidText: invalidText,
+    labelText: labelText,
+    warn: warn,
+    warnText: warnText
+  })), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__buttons")
+  }, !inline && labelText && /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__label-spacer ").concat(_settings.carbon.prefix, "--label")
+  }, "\xA0"), /*#__PURE__*/_react.default.createElement("div", null, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, {
+    className: "".concat(blockClass, "__revert ").concat(_settings.carbon.prefix, "--search-close"),
+    kind: "ghost",
+    hasIconOnly: true,
+    iconDescription: revertLabel,
+    onClick: handleRevert,
+    renderIcon: _iconsReact.Reset16
+  }), /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, {
+    className: "".concat(blockClass, "__save  ").concat(_settings.carbon.prefix, "--search-close"),
+    kind: "ghost",
+    hasIconOnly: true,
+    iconDescription: saveLabel,
+    onClick: handleSave,
+    renderIcon: _iconsReact.Checkmark16,
+    disabled: invalid
+  }))), inline && (showInvalid || showWarn) && /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(_settings.carbon.prefix, "--form-requirement")
+  }, showInvalid ? invalidText : warnText));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+
+exports.CancelableTextEdit = CancelableTextEdit;
+exports.CancelableTextEdit = CancelableTextEdit = _settings.pkg.checkComponentEnabled(CancelableTextEdit, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+CancelableTextEdit.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.
+
+CancelableTextEdit.propTypes = _objectSpread(_objectSpread({}, (0, _propsHelper.prepareProps)(_carbonComponentsReact.TextInput.propTypes, ['inline', 'invalid', 'invalidText', 'labelText', 'onChange', 'onInput', 'value', 'warn', 'warnText'])), {}, {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+
+  /**
+   * inline variant
+   */
+  inline: _propTypes.default.bool,
+
+  /**
+   * show invalid for current value
+   */
+  invalid: _propTypes.default.bool,
+
+  /**
+   * invalid text
+   */
+  invalidText: _propTypes.default.string,
+
+  /**
+   * labelText for text input
+   */
+  labelText: _propTypes.default.string,
+
+  /**
+   * method called on change event
+   */
+  onChange: _propTypes.default.func,
+
+  /**
+   * method called on input event
+   */
+  onInput: _propTypes.default.func,
+
+  /**
+   * label for revert button
+   */
+  revertLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * label for save button
+   */
+  saveLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * unedited value
+   */
+  value: _propTypes.default.string,
+
+  /**
+   * show warning for current value
+   */
+  warn: _propTypes.default.bool,
+
+  /**
+   * warn text
+   */
+  warnText: _propTypes.default.string
+}); // 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.
+
+CancelableTextEdit.defaultProps = {
+  /* TODO: add defaults for relevant props. */
+};

package/lib/components/CancelableTextEdit/index.js

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

package/lib/components/index.js

@@ -15,6 +15,18 @@ Object.defineProperty(exports, "AboutModal", {
     return _AboutModal.AboutModal;
   }
 });
+Object.defineProperty(exports, "AddSelect", {
+  enumerable: true,
+  get: function get() {
+    return _AddSelect.AddSelect;
+  }
+});
+Object.defineProperty(exports, "CancelableTextEdit", {
+  enumerable: true,
+  get: function get() {
+    return _CancelableTextEdit.CancelableTextEdit;
+  }
+});
 Object.defineProperty(exports, "Cascade", {
   enumerable: true,
   get: function get() {
@@ -276,6 +288,8 @@ Object.defineProperty(exports, "WebTerminal", {
 
 var _AboutModal = require("./AboutModal");
 
+var _AddSelect = require("./AddSelect");
+
 var _APIKeyModal = require("./APIKeyModal");
 
 var _Cascade = require("./Cascade");
@@ -332,4 +346,6 @@ var _WebTerminal = require("./WebTerminal");
 
 var _EditSidePanel = require("./EditSidePanel");
 
-var _OptionsTile = require("./OptionsTile");
+var _OptionsTile = require("./OptionsTile");
+
+var _CancelableTextEdit = require("./CancelableTextEdit");

package/lib/global/js/package-settings.js

@@ -56,6 +56,7 @@ var defaults = {
     UnauthorizedEmptyState: true,
     UserProfileImage: true,
     // other public components not yet reviewed and released:
+    AddSelect: false,
     LoadingBar: false,
     ModifiedTabs: false,
     Toolbar: false,
@@ -63,7 +64,8 @@ var defaults = {
     ToolbarGroup: false,
     WebTerminal: false,
     EditSidePanel: false,
-    OptionsTile: false
+    OptionsTile: false,
+    CancelableTextEdit: false
     /* new component flags here - comment used by generate CLI */
 
   },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/ibm-products",
   "description": "Carbon for IBM Products",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -86,5 +86,5 @@
     "react": "^16.8.6 || ^17.0.1",
     "react-dom": "^16.8.6 || ^17.0.1"
   },
-  "gitHead": "f32985ca05fe906558bb5b330c306b7f0f6d0ef4"
+  "gitHead": "569d76f7fd293e929288516959f03a3eea777251"
 }

package/scss/components/AddSelect/_add-select.scss

@@ -0,0 +1,73 @@
+//
+// Copyright IBM Corp. 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.
+//
+
+// Standard imports.
+@import '../../global/styles/project-settings';
+
+@import 'carbon-components/scss/components/structured-list/structured-list';
+
+@mixin add-select {
+  $block-class: #{$pkg-prefix}--add-select;
+  $tearsheet-class: #{$pkg-prefix}--tearsheet;
+
+  .#{$block-class}__header {
+    padding: $spacing-05;
+    padding-bottom: 0;
+    border-top: 1px solid $ui-03;
+
+    .#{$block-class}__items-label {
+      @include carbon--type-style('productive-heading-01');
+    }
+  }
+
+  .#{$block-class}__items-label {
+    margin-right: $spacing-03;
+
+    &-container {
+      display: flex;
+      align-items: center;
+      margin-top: $spacing-05;
+      margin-bottom: $spacing-03;
+    }
+  }
+
+  .#{$block-class}__selections {
+    border-top: 1px solid $ui-03;
+  }
+
+  // multi select specific
+
+  .#{$block-class}__influencer-header {
+    display: flex;
+    padding: $spacing-06 $spacing-05 $spacing-03 $spacing-05;
+    border-bottom: 1px solid $ui-03;
+
+    .#{$block-class}__influencer-title {
+      @include carbon--type-style('productive-heading-02');
+    }
+  }
+
+  .#{$block-class}__influencer-title {
+    margin-right: $spacing-03;
+  }
+
+  .#{$block-class}__influencer-body {
+    padding: $spacing-05;
+  }
+
+  // overrides
+
+  // the influencer sidebar needs to be even with the buttons
+  .#{$block-class} .#{$tearsheet-class} .#{$tearsheet-class}__influencer {
+    max-width: 29rem;
+    flex: 0 0 50%;
+  }
+}
+
+@include exports('add-select') {
+  @include add-select;
+}

package/scss/components/AddSelect/_index.scss

@@ -0,0 +1,10 @@
+//
+// Copyright IBM Corp. 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.
+//
+
+// An index file is most useful when you have multiple components
+
+@import './add-select';

package/scss/components/AddSelect/_storybook-styles.scss

@@ -0,0 +1,6 @@
+//
+// Copyright IBM Corp. 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.
+//

package/scss/components/CancelableTextEdit/_cancelable-text-edit.scss

@@ -0,0 +1,140 @@
+//
+// 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.
+//
+
+// Standard imports.
+@import '../../global/styles/project-settings';
+@import '../../global/styles/mixins';
+
+// Other Carbon settings.
+// TODO: @import 'carbon-components/scss/globals/grid/grid'; if needed
+
+// CancelableTextEdit uses the following Carbon components:
+// TODO: @import(s) of Carbon component styles used by CancelableTextEdit
+
+// CancelableTextEdit uses the following Carbon for IBM Products components:
+// TODO: @import(s) of IBM Products component styles used by CancelableTextEdit
+
+// Define all component styles in a mixin which is then exported using
+// the Carbon import-once mechanism.
+@mixin cancelable-text-edit {
+  // The block part of our conventional BEM class names (blockClass__E--M).
+  $block-class: #{$pkg-prefix}--cancelable-text-edit;
+
+  .#{$block-class}.#{$block-class} {
+    --size: #{$spacing-08};
+
+    position: relative;
+    width: 100%;
+    min-height: var(--size);
+  }
+
+  .#{$block-class}.#{$block-class}--xl {
+    --size: $spacing-09;
+  }
+
+  .#{$block-class}.#{$block-class} .#{$block-class}__input {
+    height: var(--size);
+    // stylelint-disable-next-line carbon/layout-token-use
+    padding-right: calc(2 * var(--size));
+  }
+
+  .#{$block-class}__buttons {
+    position: absolute;
+    top: 0;
+    right: 0;
+  }
+  .#{$block-class}.#{$block-class} .#{$block-class}__revert,
+  .#{$block-class}.#{$block-class} .#{$block-class}__save {
+    width: var(--size);
+    height: var(--size);
+    min-height: var(--size);
+
+    &:hover {
+      // border hover input does NOT have focus
+      border-color: $hover-field;
+      border-bottom: 1px solid transparent;
+      background-clip: content-box;
+      box-shadow: initial;
+    }
+
+    &:focus:active,
+    &:focus {
+      // border focus input does NOT have focus
+      border-width: 2px;
+      border-color: $focus;
+      box-shadow: initial;
+    }
+
+    &:focus:active:hover {
+      // stylelint-disable-next-line carbon/layout-token-use
+      padding: 1px;
+    }
+
+    &::before {
+      background-color: transparent;
+    }
+  }
+
+  // border hover input has focus
+  // and/or is invalid
+  .#{$block-class}.#{$block-class}--invalid
+    .#{$carbon-prefix}--text-input-wrapper
+    ~ .#{$block-class}__buttons,
+  .#{$block-class}.#{$block-class}
+    .#{$carbon-prefix}--text-input-wrapper:focus-within
+    ~ .#{$block-class}__buttons {
+    .#{$block-class}__revert,
+    .#{$block-class}__save {
+      border: 2px solid transparent;
+      // transition-property: initial; // turn off seems to cause a bit of a visual glitch
+    }
+
+    // button hover state
+    .#{$block-class}__revert:hover,
+    .#{$block-class}__save:hover {
+      border-top: 2px solid transparent;
+      border-bottom: 2px solid transparent;
+      background-clip: content-box;
+    }
+    .#{$block-class}__save {
+      // border hover input has focus or is in error
+      border-right: 2px solid transparent;
+    }
+  }
+
+  // > only wish to affect version added for inline
+  .#{$block-class}--invalid > .#{$carbon-prefix}--form-requirement,
+  .#{$block-class}--warn > .#{$carbon-prefix}--form-requirement {
+    display: block;
+    max-height: initial;
+    // stylelint-disable-next-line carbon/layout-token-use
+    margin-left: calc(20% + 1.25rem); // needs to match inline input layout
+  }
+
+  // > only wish to affect version added for inline
+  .#{$block-class}--invalid > .#{$carbon-prefix}--form-requirement {
+    color: $text-error;
+  }
+
+  .#{$block-class} .#{$carbon-prefix}--text-input {
+    // stylelint-disable-next-line carbon/layout-token-use
+    padding-right: calc(2 * var(--size)); // to take account of save and revert
+  }
+
+  .#{$block-class} .#{$carbon-prefix}--text-input--invalid {
+    // stylelint-disable-next-line carbon/layout-token-use
+    padding-right: calc(3 * var(--size)); // to take account of save and revert
+  }
+
+  .#{$block-class} .#{$carbon-prefix}--text-input__invalid-icon {
+    margin-right: $spacing-11;
+  }
+}
+
+@include exports('cancelable-text-edit') {
+  @include cancelable-text-edit;
+}

package/scss/components/CancelableTextEdit/_index.scss

@@ -0,0 +1,8 @@
+//
+// 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 './cancelable-text-edit';

package/scss/components/CancelableTextEdit/_storybook-styles.scss

@@ -0,0 +1,15 @@
+//
+// 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 './index';
+
+// TODO: add any additional styles used by CancelableTextEdit.stories.js
+
+// Uncomment next line (which must appear last) to test in storybook
+// that the SCSS styles for this component are sufficiently specific
+// to override Carbon whichever order the styles get loaded in.
+//@import 'carbon-components/css/carbon-components.min';

package/scss/components/_index.scss

@@ -9,6 +9,7 @@
 
 @import './_Canary/canary';
 
+@import './AddSelect/index';
 @import './APIKeyModal/index';
 @import './AboutModal/index';
 @import './ActionSet/index';
@@ -41,3 +42,4 @@
 @import './UserProfileImage/index';
 @import './EditSidePanel/index';
 @import './OptionsTile/index';
+@import './CancelableTextEdit/index';