@carbon/ibm-products 1.2.4 → 1.5.0

package/es/components/CancelableTextEdit/CancelableTextEdit.js

@@ -0,0 +1,245 @@
+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 = ["className", "hideLabel", "inline", "invalid", "invalidText", "labelText", "onChange", "onInput", "onRevert", "revertDescription", "saveDescription", "saveDisabled", "size", "value", "warn", "warnText"];
+
+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. 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, { useEffect, useState } from 'react'; // Other standard imports.
+
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Button, TextInput } from 'carbon-components-react';
+import { prepareProps } from '../../global/js/utils/props-helper';
+import { pkg, carbon } from '../../settings';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { Checkmark16, Reset16 } from '@carbon/icons-react'; // 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(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.
+ */
+
+export var CancelableTextEdit = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var _cx;
+
+  var className = _ref.className,
+      hideLabel = _ref.hideLabel,
+      inline = _ref.inline,
+      invalid = _ref.invalid,
+      invalidText = _ref.invalidText,
+      labelText = _ref.labelText,
+      onChange = _ref.onChange,
+      onInput = _ref.onInput,
+      onRevert = _ref.onRevert,
+      revertDescription = _ref.revertDescription,
+      saveDescription = _ref.saveDescription,
+      saveDisabled = _ref.saveDisabled,
+      size = _ref.size,
+      value = _ref.value,
+      warn = _ref.warn,
+      warnText = _ref.warnText,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  // remove these props later
+  var removeProps = ['children', 'onInput', 'onChange', 'value'];
+  var showWarn = inline && warn && !invalid;
+  var showInvalid = inline && invalid;
+
+  var _useState = useState(value !== null && value !== void 0 ? value : ''),
+      _useState2 = _slicedToArray(_useState, 2),
+      liveValue = _useState2[0],
+      setLiveValue = _useState2[1];
+
+  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);
+
+    if (onRevert) {
+      onRevert(value);
+    }
+  };
+
+  var handleSave = function handleSave() {
+    if (onChange && !invalid) {
+      onChange(liveValue);
+    }
+  };
+
+  return /*#__PURE__*/React.createElement("div", _extends({
+    className: cx(className, "".concat(blockClass), "".concat(blockClass, "--").concat(size), (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "--invalid"), invalid), _defineProperty(_cx, "".concat(blockClass, "--warn"), warn), _defineProperty(_cx, "".concat(blockClass, "--inline"), inline), _cx))
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__main")
+  }, /*#__PURE__*/React.createElement(TextInput, _extends({}, prepareProps(rest, removeProps), {
+    // it is not permitted to pass children down to TextInput guard against this
+    className: "".concat(blockClass, "__input"),
+    ref: ref,
+    onInput: handleInput,
+    size: size,
+    value: liveValue !== null && liveValue !== void 0 ? liveValue : '' // ?? '' prevents controlled components test failure https://reactjs.org/docs/forms.html#controlled-components
+    ,
+    hideLabel: hideLabel,
+    inline: inline,
+    invalid: invalid,
+    invalidText: invalidText,
+    labelText: labelText,
+    warn: warn,
+    warnText: warnText
+  })), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__buttons")
+  }, !inline && !hideLabel && labelText && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__label-spacer ").concat(carbon.prefix, "--label")
+  }, "\xA0"), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__buttons-inner")
+  }, /*#__PURE__*/React.createElement(Button, {
+    className: "".concat(blockClass, "__revert"),
+    kind: "ghost",
+    hasIconOnly: true,
+    iconDescription: revertDescription,
+    onClick: handleRevert,
+    renderIcon: Reset16
+  }), /*#__PURE__*/React.createElement(Button, {
+    className: "".concat(blockClass, "__save"),
+    kind: "ghost",
+    hasIconOnly: true,
+    iconDescription: saveDescription,
+    onClick: handleSave,
+    renderIcon: Checkmark16,
+    disabled: invalid || saveDisabled || value === liveValue,
+    "data-v": value,
+    "data-lv": liveValue
+  })))), inline && (showInvalid || showWarn) && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__problem ").concat(carbon.prefix, "--form-requirement")
+  }, showInvalid ? invalidText : warnText));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+CancelableTextEdit = 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({}, prepareProps(TextInput.propTypes, ['inline', 'invalid', 'invalidText', 'labelText', 'onChange', 'onInput', 'value', 'warn', 'warnText'])), {}, {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+
+  /**
+   * hide the label
+   */
+  hideLabel: PropTypes.bool,
+
+  /**
+   * inline variant
+   */
+  inline: PropTypes.bool,
+
+  /**
+   * set invalid state for input
+   */
+  invalid: PropTypes.bool,
+
+  /**
+   * text shown when invalid is true
+   */
+  invalidText: PropTypes.string,
+
+  /**
+   * label for text input
+   */
+  labelText: PropTypes.string,
+
+  /**
+   * method called on change event
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * method called on input event
+   */
+  onInput: PropTypes.func,
+
+  /**
+   * method called on revert event
+   */
+  onRevert: PropTypes.func,
+
+  /**
+   * label for revert button
+   */
+  revertDescription: PropTypes.string.isRequired,
+
+  /**
+   * label for save button
+   */
+  saveDescription: PropTypes.string.isRequired,
+
+  /**
+   * disabled state of the save button
+   */
+  saveDisabled: PropTypes.bool,
+
+  /**
+   * vertical size of control
+   */
+  size: PropTypes.oneOf(['sm', 'md', 'lg']),
+
+  /**
+   * initial/unedited value
+   */
+  value: PropTypes.string,
+
+  /**
+   * set warn state for input
+   */
+  warn: PropTypes.bool,
+
+  /**
+   * text shown when warn true
+   */
+  warnText: PropTypes.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. */
+  size: 'md'
+};

package/es/components/{CreateTearsheet/constants.js → CancelableTextEdit/index.js}

@@ -4,5 +4,4 @@
  * 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 CREATE_TEARSHEET_STEP = 'CreateTearsheetStep';
-export var CREATE_TEARSHEET_SECTION = 'CreateTearsheetSection';
+export { CancelableTextEdit } from './CancelableTextEdit';