@carbon/react 1.22.0 → 1.23.0-rc.0

package/es/components/NumberInput/NumberInput.d.ts

@@ -0,0 +1,132 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * 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, { ReactNode } from 'react';
+export declare const translationIds: {
+    'increment.number': string;
+    'decrement.number': string;
+};
+type ExcludedAttributes = 'defaultValue' | 'id' | 'min' | 'max' | 'onChange' | 'onClick' | 'size' | 'step' | 'value';
+export interface NumberInputProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, ExcludedAttributes> {
+    /**
+     * `true` to allow empty string.
+     */
+    allowEmpty?: boolean;
+    /**
+     * Specify an optional className to be applied to the wrapper node
+     */
+    className?: string;
+    /**
+     * Optional starting value for uncontrolled state
+     */
+    defaultValue?: number | string;
+    /**
+     * Specify if the wheel functionality for the input should be disabled, or not
+     */
+    disableWheel?: boolean;
+    /**
+     * Specify if the control should be disabled, or not
+     */
+    disabled?: boolean;
+    /**
+     * Provide text that is used alongside the control label for additional help
+     */
+    helperText?: ReactNode;
+    /**
+     * Specify whether you want the underlying label to be visually hidden
+     */
+    hideLabel?: boolean;
+    /**
+     * Specify whether you want the steppers to be hidden
+     */
+    hideSteppers?: boolean;
+    /**
+     * Provide a description for up/down icons that can be read by screen readers
+     */
+    iconDescription?: string;
+    /**
+     * Specify a custom `id` for the input
+     */
+    id: string;
+    /**
+     * Specify if the currently value is invalid.
+     */
+    invalid?: boolean;
+    /**
+     * Message which is displayed if the value is invalid.
+     */
+    invalidText?: ReactNode;
+    /**
+     * Generic `label` that will be used as the textual representation of what
+     * this field is for
+     */
+    label?: ReactNode;
+    /**
+     * `true` to use the light version.
+     *
+     * @deprecated The `light` prop for `NumberInput` is no longer needed and has
+     *     been deprecated in v11 in favor of the new `Layer` component. It will be moved in the next major release.
+     */
+    light?: boolean;
+    /**
+     * The maximum value.
+     */
+    max?: number;
+    /**
+     * The minimum value.
+     */
+    min?: number;
+    /**
+     * Provide an optional handler that is called when the internal state of
+     * NumberInput changes. This handler is called with event and state info.
+     * `(event, { value, direction }) => void`
+     */
+    onChange?: (event: React.MouseEvent<HTMLButtonElement>, state: {
+        value: number | string;
+        direction: string;
+    }) => void;
+    /**
+     * Provide an optional function to be called when the up/down button is clicked
+     */
+    onClick?: (event: React.MouseEvent<HTMLElement>, state?: {
+        value: number | string;
+        direction: string;
+    }) => void;
+    /**
+     * Provide an optional function to be called when a key is pressed in the number input
+     */
+    onKeyUp?: React.KeyboardEventHandler<HTMLInputElement>;
+    /**
+     * Specify if the component should be read-only
+     */
+    readOnly?: boolean;
+    /**
+     * Specify the size of the Number Input.
+     */
+    size?: 'sm' | 'md' | 'lg';
+    /**
+     * Specify how much the values should increase/decrease upon clicking on up/down button
+     */
+    step?: number;
+    /**
+     * Provide custom text for the component for each translation id
+     */
+    translateWithId?: (id: string) => string;
+    /**
+     * Specify the value of the input
+     */
+    value?: number | string;
+    /**
+     * Specify whether the control is currently in warning state
+     */
+    warn?: boolean;
+    /**
+     * Provide the text that is displayed when the control is in warning state
+     */
+    warnText?: ReactNode;
+}
+declare const NumberInput: React.ForwardRefExoticComponent<NumberInputProps & React.RefAttributes<unknown>>;
+export { NumberInput };

package/es/components/NumberInput/NumberInput.js

@@ -127,11 +127,12 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
   var iconClasses = cx((_cx3 = {}, _defineProperty(_cx3, "".concat(prefix, "--number__invalid"), normalizedProps.invalid || normalizedProps.warn), _defineProperty(_cx3, "".concat(prefix, "--number__invalid--warning"), normalizedProps.warn), _cx3));
 
   if (controlledValue !== prevControlledValue) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     setValue(controlledValue);
     setPrevControlledValue(controlledValue);
   }
 
-  var ariaDescribedBy = null;
+  var ariaDescribedBy = undefined;
 
   if (normalizedProps.invalid) {
     ariaDescribedBy = normalizedProps.invalidId;
@@ -158,7 +159,7 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
   }
 
   var handleFocus = function handleFocus(evt) {
-    if (evt.target.type === 'button') {
+    if ('type' in evt.target && evt.target.type === 'button') {
       setIsFocused(false);
     } else {
       setIsFocused(evt.type === 'focus' ? true : false);
@@ -166,10 +167,11 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
   };
 
   var outerElementClasses = cx("".concat(prefix, "--form-item"), (_cx4 = {}, _defineProperty(_cx4, customClassName, !!customClassName), _defineProperty(_cx4, "".concat(prefix, "--number-input--fluid--invalid"), isFluid && normalizedProps.invalid), _defineProperty(_cx4, "".concat(prefix, "--number-input--fluid--focus"), isFluid && isFocused), _defineProperty(_cx4, "".concat(prefix, "--number-input--fluid--disabled"), isFluid && disabled), _cx4));
+  var Icon = normalizedProps.icon;
   return /*#__PURE__*/React__default.createElement("div", {
     className: outerElementClasses,
-    onFocus: isFluid ? handleFocus : null,
-    onBlur: isFluid ? handleFocus : null
+    onFocus: isFluid ? handleFocus : undefined,
+    onBlur: isFluid ? handleFocus : undefined
   }, /*#__PURE__*/React__default.createElement("div", {
     className: numberInputClasses,
     "data-invalid": normalizedProps.invalid ? true : undefined
@@ -215,7 +217,7 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
     step: step,
     type: "number",
     value: value
-  })), normalizedProps.icon ? /*#__PURE__*/React__default.createElement(normalizedProps.icon, {
+  })), Icon ? /*#__PURE__*/React__default.createElement(Icon, {
     className: iconClasses
   }) : null, !hideSteppers && /*#__PURE__*/React__default.createElement("div", {
     className: "".concat(prefix, "--number__controls")
@@ -238,7 +240,7 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
         _onClick(event, state);
       }
     },
-    tabIndex: "-1",
+    tabIndex: -1,
     title: decrementNumLabel || iconDescription,
     type: "button"
   }, _Subtract || (_Subtract = /*#__PURE__*/React__default.createElement(Subtract, {
@@ -264,7 +266,7 @@ var NumberInput = /*#__PURE__*/React__default.forwardRef(function NumberInput(pr
         _onClick(event, state);
       }
     },
-    tabIndex: "-1",
+    tabIndex: -1,
     title: incrementNumLabel || iconDescription,
     type: "button"
   }, _Add || (_Add = /*#__PURE__*/React__default.createElement(Add, {

package/es/components/TextArea/TextArea.js

@@ -104,6 +104,7 @@ var TextArea = /*#__PURE__*/React__default.forwardRef(function TextArea(_ref, fo
   useIsomorphicEffect(function () {
     if (other.cols) {
       textareaRef.current.style.width = null;
+      textareaRef.current.style.resize = 'none';
     } else {
       textareaRef.current.style.width = "100%";
     }

package/es/components/Toggle/Toggle.js

@@ -6,7 +6,7 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default from 'react';
+import React__default, { useRef } from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { useControllableState } from '../../internal/useControllableState.js';
@@ -41,6 +41,7 @@ function Toggle(_ref) {
       other = _objectWithoutProperties(_ref, _excluded);
 
   var prefix = usePrefix();
+  var buttonElement = useRef(null);
 
   var _useControllableState = useControllableState({
     value: toggled,
@@ -69,37 +70,53 @@ function Toggle(_ref) {
   var labelTextClasses = cx("".concat(prefix, "--toggle__label-text"), _defineProperty({}, "".concat(prefix, "--visually-hidden"), hideLabel));
   var appearanceClasses = cx("".concat(prefix, "--toggle__appearance"), _defineProperty({}, "".concat(prefix, "--toggle__appearance--sm"), isSm));
   var switchClasses = cx("".concat(prefix, "--toggle__switch"), _defineProperty({}, "".concat(prefix, "--toggle__switch--checked"), checked));
-  return /*#__PURE__*/React__default.createElement("div", {
-    className: wrapperClasses
-  }, /*#__PURE__*/React__default.createElement("button", _extends({}, other, {
-    id: id,
-    className: "".concat(prefix, "--toggle__button"),
-    role: "switch",
-    type: "button",
-    "aria-checked": checked,
-    "aria-labelledby": ariaLabelledby,
-    disabled: disabled,
-    onClick: handleClick
-  })), /*#__PURE__*/React__default.createElement(LabelComponent, {
-    htmlFor: ariaLabelledby ? null : id,
-    className: "".concat(prefix, "--toggle__label")
-  }, labelText && /*#__PURE__*/React__default.createElement("span", {
-    className: labelTextClasses
-  }, labelText), /*#__PURE__*/React__default.createElement("div", {
-    className: appearanceClasses
-  }, /*#__PURE__*/React__default.createElement("div", {
-    className: switchClasses
-  }, isSm && /*#__PURE__*/React__default.createElement("svg", {
-    className: "".concat(prefix, "--toggle__check"),
-    width: "6px",
-    height: "5px",
-    viewBox: "0 0 6 5"
-  }, _path || (_path = /*#__PURE__*/React__default.createElement("path", {
-    d: "M2.2 2.7L5 0 6 1 2.2 5 0 2.7 1 1.5z"
-  })))), renderSideLabel && /*#__PURE__*/React__default.createElement("span", {
-    className: "".concat(prefix, "--toggle__text"),
-    "aria-hidden": "true"
-  }, sideLabel))));
+  return (
+    /*#__PURE__*/
+    // eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions
+    React__default.createElement("div", {
+      className: wrapperClasses,
+      onClick: ariaLabelledby ? function (e) {
+        // the underlying <button> can only be activated by keyboard as it is visually hidden;
+        // therefore, if this event's target is the <button>, it had to be triggered by
+        // the keyboard event which already calls handleClick. if we wouldn't catch this, the
+        // onClick and onToggle functions would be called twice whenever the user activates the
+        // toggle by keyboard and props['aria-labelledby'] is passed.
+        if (buttonElement.current && e.target !== buttonElement.current) {
+          handleClick(e);
+          buttonElement.current.focus();
+        }
+      } : null
+    }, /*#__PURE__*/React__default.createElement("button", _extends({}, other, {
+      ref: buttonElement,
+      id: id,
+      className: "".concat(prefix, "--toggle__button"),
+      role: "switch",
+      type: "button",
+      "aria-checked": checked,
+      "aria-labelledby": ariaLabelledby,
+      disabled: disabled,
+      onClick: handleClick
+    })), /*#__PURE__*/React__default.createElement(LabelComponent, {
+      htmlFor: ariaLabelledby ? null : id,
+      className: "".concat(prefix, "--toggle__label")
+    }, labelText && /*#__PURE__*/React__default.createElement("span", {
+      className: labelTextClasses
+    }, labelText), /*#__PURE__*/React__default.createElement("div", {
+      className: appearanceClasses
+    }, /*#__PURE__*/React__default.createElement("div", {
+      className: switchClasses
+    }, isSm && /*#__PURE__*/React__default.createElement("svg", {
+      className: "".concat(prefix, "--toggle__check"),
+      width: "6px",
+      height: "5px",
+      viewBox: "0 0 6 5"
+    }, _path || (_path = /*#__PURE__*/React__default.createElement("path", {
+      d: "M2.2 2.7L5 0 6 1 2.2 5 0 2.7 1 1.5z"
+    })))), renderSideLabel && /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(prefix, "--toggle__text"),
+      "aria-hidden": "true"
+    }, sideLabel))))
+  );
 }
 Toggle.propTypes = {
   /**
@@ -123,7 +140,11 @@ Toggle.propTypes = {
   disabled: PropTypes.bool,
 
   /**
-   * Specify whether the label should be hidden, or not
+   * If true, the side labels (props.labelA and props.labelB) will be replaced by
+   * props.labelText, so that the toggle doesn't render a top label. In order to fully
+   * hide any labels, you can use props['aria-labelledby'] to refer to another element
+   * that labels the toggle. props.labelText would no longer be required in that case
+   * and can therefore be omitted.
    */
   hideLabel: PropTypes.bool,
 

package/es/components/Toggletip/index.js

@@ -102,10 +102,34 @@ function Toggletip(_ref2) {
 
   function onKeyDown(event) {
     if (open && match(event, Escape)) {
-      actions.close();
+      actions.close(); // If the menu is closed while focus is still inside the menu, it should return to the trigger button  (#12922)
+
+      var button = ref.current.children[0];
+
+      if (button && button.type === 'button') {
+        button.focus();
+      }
     }
   }
 
+  function handleBlur(event) {
+    // Do not close if the menu itself is clicked, should only close on focus out
+    if (open && event.relatedTarget === null) {
+      return;
+    }
+
+    if (!event.currentTarget.contains(event.relatedTarget)) {
+      // The menu should be closed when focus leaves the `Toggletip`  (#12922)
+      actions.close();
+    }
+  } // If the `Toggletip` is the last focusable item in the tab order, it shoudl also close when the browser window loses focus  (#12922)
+
+
+  useWindowEvent('blur', function () {
+    if (open) {
+      actions.close();
+    }
+  });
   useWindowEvent('click', function (event) {
     if (open && !ref.current.contains(event.target)) {
       actions.close();
@@ -122,6 +146,7 @@ function Toggletip(_ref2) {
     highContrast: true,
     open: open,
     onKeyDown: onKeyDown,
+    onBlur: handleBlur,
     ref: ref
   }, children));
 }

package/es/internal/useNormalizedInputProps.js

@@ -12,12 +12,12 @@ import { usePrefix } from './usePrefix.js';
 /**
  * @typedef {object} InputProps
  * @property {string} id - The input's id
- * @property {boolean} readOnly - Whether the input should be readonly
+ * @property {boolean | undefined} readOnly - Whether the input should be readonly
  * @property {boolean} disabled - Whether the input should be disabled
  * @property {boolean} invalid - Whether the input should be marked as invalid
- * @property {string} invalidText - The validation message displayed in case the input is considered invalid
+ * @property {React.ReactNode | undefined} invalidText - The validation message displayed in case the input is considered invalid
  * @property {boolean} warn - Whether the input should be in warning state
- * @property {string} warnText - The validation message displayed in case the input is in warning state
+ * @property {React.ReactNode | undefined} warnText - The validation message displayed in case the input is in warning state
  */
 
 /**

package/lib/components/CodeSnippet/CodeSnippet.js

@@ -13,7 +13,7 @@ var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelper
 var PropTypes = require('prop-types');
 var React = require('react');
 var cx = require('classnames');
-var polyfilled = require('../../node_modules/use-resize-observer/polyfilled.js');
+var useResizeObserver = require('use-resize-observer/polyfilled');
 var iconsReact = require('@carbon/icons-react');
 var Copy = require('../Copy/Copy.js');
 var Button = require('../Button/Button.js');
@@ -28,6 +28,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+var useResizeObserver__default = /*#__PURE__*/_interopDefaultLegacy(useResizeObserver);
 var copy__default = /*#__PURE__*/_interopDefaultLegacy(copy);
 
 var _excluded = ["className", "type", "children", "disabled", "feedback", "feedbackTimeout", "onClick", "ariaLabel", "copyText", "copyButtonDescription", "light", "showMoreText", "showLessText", "hideCopyButton", "wrapText", "maxCollapsedNumberOfRows", "maxExpandedNumberOfRows", "minCollapsedNumberOfRows", "minExpandedNumberOfRows"];
@@ -128,7 +129,7 @@ function CodeSnippet(_ref) {
     setHasLeftOverflow(horizontalOverflow && !!codeScrollLeft);
     setHasRightOverflow(horizontalOverflow && codeScrollLeft + codeClientWidth !== codeScrollWidth);
   }, [type, getCodeRefDimensions]);
-  polyfilled["default"]({
+  useResizeObserver__default["default"]({
     ref: getCodeRef(),
     onResize: function onResize() {
       if (codeContentRef !== null && codeContentRef !== void 0 && codeContentRef.current && type === 'multi') {
@@ -150,7 +151,7 @@ function CodeSnippet(_ref) {
         handleScroll();
       }
     }
-  });
+  }, [type, maxCollapsedNumberOfRows, maxExpandedNumberOfRows, minExpandedNumberOfRows, rowHeightInPixels]);
   React.useEffect(function () {
     handleScroll();
   }, [handleScroll]);

package/lib/components/ComboBox/ComboBox.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * 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 Downshift from 'downshift';
+import { ReactNodeLike } from 'prop-types';
+import React from 'react';
+import { ListBoxType, ListBoxSize } from '../ListBox';
+type ExcludedAttributes = 'id' | 'onChange' | 'onClick' | 'type' | 'size';
+export interface ComboBoxProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, ExcludedAttributes> {
+    /**
+     * 'aria-label' of the ListBox component.
+     */
+    ariaLabel?: string;
+    /**
+     * An optional className to add to the container node
+     */
+    className?: string;
+    /**
+     * Specify the direction of the combobox dropdown. Can be either top or bottom.
+     */
+    direction?: 'top' | 'bottom';
+    /**
+     * Specify if the control should be disabled, or not
+     */
+    disabled?: boolean;
+    /**
+     * Additional props passed to Downshift
+     */
+    downshiftProps?: React.ComponentProps<typeof Downshift>;
+    /**
+     * Provide helper text that is used alongside the control label for
+     * additional help
+     */
+    helperText?: string;
+    /**
+     * Specify a custom `id` for the input
+     */
+    id: string;
+    /**
+     * Allow users to pass in an arbitrary item or a string (in case their items are an array of strings)
+     * from their collection that are pre-selected
+     */
+    initialSelectedItem?: object | string | number;
+    /**
+     * Specify if the currently selected value is invalid.
+     */
+    invalid?: boolean;
+    /**
+     * Message which is displayed if the value is invalid.
+     */
+    invalidText?: ReactNodeLike;
+    /**
+     * Optional function to render items as custom components instead of strings.
+     * Defaults to null and is overridden by a getter
+     */
+    itemToElement?: React.ComponentType | null;
+    /**
+     * Helper function passed to downshift that allows the library to render a
+     * given item to a string label. By default, it extracts the `label` field
+     * from a given item to serve as the item label in the list
+     */
+    itemToString?: (item: unknown) => string;
+    /**
+     * We try to stay as generic as possible here to allow individuals to pass
+     * in a collection of whatever kind of data structure they prefer
+     */
+    items: (object | string | number)[];
+    /**
+     * @deprecated
+     * should use "light theme" (white background)?
+     */
+    light?: boolean;
+    /**
+     * `onChange` is a utility for this controlled component to communicate to a
+     * consuming component when a specific dropdown item is selected.
+     * `({ selectedItem }) => void`
+    //  * @param {{ selectedItem }}
+     */
+    onChange: (data: {
+        selectedItem: any;
+    }) => void;
+    /**
+     * Callback function to notify consumer when the text input changes.
+     * This provides support to change available items based on the text.
+     * `(inputText) => void`
+     * @param {string} inputText
+     */
+    onInputChange?: (inputText: string) => void;
+    /**
+     * Helper function passed to Downshift that allows the user to observe internal
+     * state changes
+     * `(changes, stateAndHelpers) => void`
+     */
+    onStateChange?: (changes: object, stateAndHelpers: object) => void;
+    /**
+     * Callback function that fires when the combobox menu toggle is clicked
+     * `(evt) => void`
+     * @param {MouseEvent} event
+     */
+    onToggleClick?: (evt: MouseEvent) => void;
+    /**
+     * Used to provide a placeholder text node before a user enters any input.
+     * This is only present if the control has no items selected
+     */
+    placeholder?: string;
+    /**
+     * Is the ComboBox readonly?
+     */
+    readOnly?: boolean;
+    /**
+     * For full control of the selection
+     */
+    selectedItem?: object | string | number;
+    /**
+     * Specify your own filtering logic by passing in a `shouldFilterItem`
+     * function that takes in the current input and an item and passes back
+     * whether or not the item should be filtered.
+     */
+    shouldFilterItem?: (input: any) => boolean;
+    /**
+     * Specify the size of the ListBox. Currently supports either `sm`, `md` or `lg` as an option.
+     */
+    size?: ListBoxSize;
+    /**
+     * Provide text to be used in a `<label>` element that is tied to the
+     * combobox via ARIA attributes.
+     */
+    titleText?: ReactNodeLike;
+    /**
+     * Specify a custom translation function that takes in a message identifier
+     * and returns the localized string for the message
+     */
+    translateWithId?: (id: any) => string;
+    /**
+     * Currently supports either the default type, or an inline variant
+     */
+    type?: ListBoxType;
+    /**
+     * Specify whether the control is currently in warning state
+     */
+    warn?: boolean;
+    /**
+     * Provide the text that is displayed when the control is in warning state
+     */
+    warnText?: ReactNodeLike;
+}
+declare const ComboBox: React.ForwardRefExoticComponent<ComboBoxProps & React.RefAttributes<unknown>>;
+export default ComboBox;