@elastic/eui 94.1.0 → 94.2.0

package/es/components/selectable/matching_options.js

@@ -17,7 +17,14 @@ var getSelectedOptionForSearchValue = function getSelectedOptionForSearchValue(s
     return getSearchableLabel(option) === normalizedSearchValue;
   });
 };
-var collectMatchingOption = function collectMatchingOption(accumulator, option, normalizedSearchValue, isPreFiltered, selectedOptions) {
+var collectMatchingOption = function collectMatchingOption(_ref) {
+  var selectedOptions = _ref.selectedOptions,
+    isPreFiltered = _ref.isPreFiltered,
+    option = _ref.option,
+    accumulator = _ref.accumulator,
+    searchValue = _ref.searchValue,
+    normalizedSearchValue = _ref.normalizedSearchValue,
+    optionMatcher = _ref.optionMatcher;
   // Don't show options that have already been requested if
   // the selectedOptions list exists
   if (selectedOptions) {
@@ -37,16 +44,47 @@ var collectMatchingOption = function collectMatchingOption(accumulator, option,
     accumulator.push(option);
     return;
   }
-  var normalizedOption = getSearchableLabel(option);
-  if (normalizedOption.includes(normalizedSearchValue)) {
+  var isMatching = optionMatcher({
+    option: option,
+    searchValue: searchValue,
+    normalizedSearchValue: normalizedSearchValue
+  });
+  if (isMatching) {
     accumulator.push(option);
   }
 };
-export var getMatchingOptions = function getMatchingOptions(options, searchValue, isPreFiltered, selectedOptions) {
+export var getMatchingOptions = function getMatchingOptions(_ref2) {
+  var searchValue = _ref2.searchValue,
+    options = _ref2.options,
+    isPreFiltered = _ref2.isPreFiltered,
+    _ref2$selectedOptions = _ref2.selectedOptions,
+    selectedOptions = _ref2$selectedOptions === void 0 ? [] : _ref2$selectedOptions,
+    optionMatcher = _ref2.optionMatcher;
   var normalizedSearchValue = searchValue.toLowerCase();
   var matchingOptions = [];
   options.forEach(function (option) {
-    collectMatchingOption(matchingOptions, option, normalizedSearchValue, isPreFiltered, selectedOptions);
+    collectMatchingOption({
+      accumulator: matchingOptions,
+      option: option,
+      searchValue: searchValue,
+      normalizedSearchValue: normalizedSearchValue,
+      isPreFiltered: isPreFiltered,
+      selectedOptions: selectedOptions,
+      optionMatcher: optionMatcher
+    });
   });
   return matchingOptions;
+};
+
+/**
+ * Partial string equality option matcher for EuiSelectable
+ * It matches all options with labels including the searched string.
+ */
+export var createPartialStringEqualityOptionMatcher = function createPartialStringEqualityOptionMatcher() {
+  return function (_ref3) {
+    var option = _ref3.option,
+      normalizedSearchValue = _ref3.normalizedSearchValue;
+    var normalizedOption = getSearchableLabel(option);
+    return normalizedOption.includes(normalizedSearchValue);
+  };
 };

package/es/components/selectable/selectable.js

@@ -1,4 +1,4 @@
-var _excluded = ["children", "className", "options", "onChange", "onActiveOptionChange", "searchable", "searchProps", "singleSelection", "isLoading", "listProps", "renderOption", "height", "allowExclusions", "aria-label", "aria-describedby", "loadingMessage", "noMatchesMessage", "emptyMessage", "errorMessage", "selectableScreenReaderText", "isPreFiltered"],
+var _excluded = ["children", "className", "options", "onChange", "onActiveOptionChange", "searchable", "searchProps", "singleSelection", "isLoading", "listProps", "renderOption", "height", "allowExclusions", "aria-label", "aria-describedby", "loadingMessage", "noMatchesMessage", "emptyMessage", "errorMessage", "selectableScreenReaderText", "isPreFiltered", "optionMatcher"],
   _excluded2 = ["aria-label", "aria-describedby", "onChange", "defaultValue", "inputRef"],
   _excluded3 = ["aria-label", "aria-describedby", "isVirtualized", "rowHeight"];
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
@@ -42,7 +42,7 @@ import { EuiSelectableMessage } from './selectable_message';
 import { EuiSelectableList } from './selectable_list';
 import { EuiLoadingSpinner } from '../loading';
 import { EuiSpacer } from '../spacer';
-import { getMatchingOptions } from './matching_options';
+import { createPartialStringEqualityOptionMatcher, getMatchingOptions } from './matching_options';
 import { keys, htmlIdGenerator } from '../../services';
 import { EuiScreenReaderLive, EuiScreenReaderOnly } from '../accessibility';
 import { EuiI18n } from '../i18n';
@@ -234,9 +234,16 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
     _defineProperty(_assertThisInitialized(_this), "onOptionClick", function (options, event, clickedOption) {
       var _this$props = _this.props,
         isPreFiltered = _this$props.isPreFiltered,
-        onChange = _this$props.onChange;
+        onChange = _this$props.onChange,
+        optionMatcher = _this$props.optionMatcher;
       var searchValue = _this.state.searchValue;
-      var visibleOptions = getMatchingOptions(options, searchValue, isPreFiltered);
+      var visibleOptions = getMatchingOptions({
+        options: options,
+        searchValue: searchValue !== null && searchValue !== void 0 ? searchValue : '',
+        isPreFiltered: !!isPreFiltered,
+        selectedOptions: [],
+        optionMatcher: optionMatcher
+      });
       _this.setState({
         visibleOptions: visibleOptions
       });
@@ -261,7 +268,13 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
       _isPreFiltered = props.isPreFiltered,
       searchProps = props.searchProps;
     var initialSearchValue = (searchProps === null || searchProps === void 0 ? void 0 : searchProps.value) || String((searchProps === null || searchProps === void 0 ? void 0 : searchProps.defaultValue) || '');
-    var _visibleOptions = getMatchingOptions(_options, initialSearchValue, _isPreFiltered);
+    var _visibleOptions = getMatchingOptions({
+      options: _options,
+      searchValue: initialSearchValue,
+      isPreFiltered: !!_isPreFiltered,
+      selectedOptions: [],
+      optionMatcher: props.optionMatcher
+    });
     searchProps === null || searchProps === void 0 ? void 0 : (_searchProps$onChange = searchProps.onChange) === null || _searchProps$onChange === void 0 ? void 0 : _searchProps$onChange.call(searchProps, initialSearchValue, _visibleOptions);
 
     // ensure that the currently selected single option is active if it is in the visibleOptions
@@ -317,6 +330,7 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
         errorMessage = _this$props3.errorMessage,
         selectableScreenReaderText = _this$props3.selectableScreenReaderText,
         isPreFiltered = _this$props3.isPreFiltered,
+        optionMatcher = _this$props3.optionMatcher,
         rest = _objectWithoutProperties(_this$props3, _excluded);
       var _this$state = this.state,
         searchValue = _this$state.searchValue,
@@ -455,7 +469,8 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
           "aria-activedescendant": _this2.makeOptionId(activeOptionIndex) // the current faux-focused option
           ,
           placeholder: placeholderName,
-          isPreFiltered: isPreFiltered !== null && isPreFiltered !== void 0 ? isPreFiltered : false,
+          isPreFiltered: !!isPreFiltered,
+          optionMatcher: optionMatcher,
           inputRef: function inputRef(node) {
             var _searchProps$inputRef;
             _this2.inputRef = node;
@@ -499,6 +514,7 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
           options: options,
           visibleOptions: visibleOptions,
           searchValue: searchValue,
+          isPreFiltered: isPreFiltered,
           activeOptionIndex: activeOptionIndex,
           setActiveOptionIndex: function setActiveOptionIndex(index, cb) {
             _this2.setState({
@@ -533,7 +549,8 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
       var _stateUpdate$searchVa;
       var options = nextProps.options,
         isPreFiltered = nextProps.isPreFiltered,
-        searchProps = nextProps.searchProps;
+        searchProps = nextProps.searchProps,
+        optionMatcher = nextProps.optionMatcher;
       var activeOptionIndex = prevState.activeOptionIndex,
         searchValue = prevState.searchValue;
       var stateUpdate = {
@@ -543,7 +560,13 @@ export var EuiSelectable = /*#__PURE__*/function (_Component) {
       if ((searchProps === null || searchProps === void 0 ? void 0 : searchProps.value) != null && searchProps.value !== searchValue) {
         stateUpdate.searchValue = searchProps.value;
       }
-      stateUpdate.visibleOptions = getMatchingOptions(options, (_stateUpdate$searchVa = stateUpdate.searchValue) !== null && _stateUpdate$searchVa !== void 0 ? _stateUpdate$searchVa : '', isPreFiltered);
+      stateUpdate.visibleOptions = getMatchingOptions({
+        options: options,
+        searchValue: (_stateUpdate$searchVa = stateUpdate.searchValue) !== null && _stateUpdate$searchVa !== void 0 ? _stateUpdate$searchVa : '',
+        isPreFiltered: !!isPreFiltered,
+        selectedOptions: [],
+        optionMatcher: optionMatcher
+      });
       if (activeOptionIndex != null && activeOptionIndex >= stateUpdate.visibleOptions.length) {
         stateUpdate.activeOptionIndex = -1;
       }
@@ -556,7 +579,8 @@ _defineProperty(EuiSelectable, "defaultProps", {
   options: [],
   singleSelection: false,
   searchable: false,
-  isPreFiltered: false
+  isPreFiltered: false,
+  optionMatcher: createPartialStringEqualityOptionMatcher()
 });
 EuiSelectable.propTypes = {
   className: PropTypes.string,
@@ -707,14 +731,32 @@ EuiSelectable.propTypes = {
        */
   errorMessage: PropTypes.oneOfType([PropTypes.element.isRequired, PropTypes.string.isRequired, PropTypes.oneOf([null])]),
   /**
-       * Control whether or not options get filtered internally or if consumer will filter
-       * Default: false
+       * Control whether or not options get filtered internally (i.e., whether filtering is
+       * handled by EUI or by you, the consumer).
+       * If set to `true`, all passed `options` will be displayed regardless of the user's
+       * search input.
+       *
+       * Additionally allows passing a configuration object which enables turning off
+       * search highlighting if needed.
+       *
+       * @default false
        */
-  isPreFiltered: PropTypes.bool,
+  isPreFiltered: PropTypes.oneOfType([PropTypes.bool.isRequired, PropTypes.shape({
+    highlightSearch: PropTypes.bool
+  }).isRequired]),
   /**
        * Optional screen reader instructions to announce upon focus/interaction. This text is read out
        * after the `EuiSelectable` label and a brief pause, but before the default keyboard instructions for
        * interacting with a selectable are read out.
        */
-  selectableScreenReaderText: PropTypes.string
+  selectableScreenReaderText: PropTypes.string,
+  /**
+       * Optional custom option matcher function
+       *
+       * @example
+       * const exactEqualityMatcher: EuiSelectableOptionMatcher = ({ option, searchValue }) => {
+       *   return option.label === searchValue;
+       * }
+       */
+  optionMatcher: PropTypes.func
 };

package/es/components/selectable/selectable_list/selectable_list.js

@@ -1,9 +1,9 @@
 var _excluded = ["data"],
   _excluded2 = ["label", "isGroupLabel", "checked", "disabled", "prepend", "append", "ref", "key", "searchableLabel", "data", "truncationProps"],
-  _excluded3 = ["className", "options", "searchValue", "onOptionClick", "renderOption", "height", "windowProps", "rowHeight", "activeOptionIndex", "makeOptionId", "showIcons", "singleSelection", "visibleOptions", "allowExclusions", "bordered", "paddingSize", "searchable", "onFocusBadge", "listId", "setActiveOptionIndex", "aria-label", "aria-labelledby", "aria-describedby", "role", "isVirtualized", "textWrap", "truncationProps"];
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+  _excluded3 = ["className", "options", "searchValue", "onOptionClick", "renderOption", "height", "windowProps", "rowHeight", "activeOptionIndex", "makeOptionId", "showIcons", "singleSelection", "visibleOptions", "allowExclusions", "bordered", "paddingSize", "searchable", "onFocusBadge", "listId", "setActiveOptionIndex", "aria-label", "aria-labelledby", "aria-describedby", "role", "isPreFiltered", "isVirtualized", "textWrap", "truncationProps"];
 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; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
@@ -136,6 +136,7 @@ export var EuiSelectableList = /*#__PURE__*/function (_Component) {
         setActiveOptionIndex = _this$props2.setActiveOptionIndex,
         searchable = _this$props2.searchable,
         searchValue = _this$props2.searchValue,
+        isPreFiltered = _this$props2.isPreFiltered,
         isVirtualized = _this$props2.isVirtualized;
       if (isGroupLabel) {
         return ___EmotionJSX("li", _extends({
@@ -148,13 +149,17 @@ export var EuiSelectableList = /*#__PURE__*/function (_Component) {
       var id = makeOptionId(index);
       var isFocused = activeOptionIndex === index;
 
+      // Search highlighting
+      var hasSearch = !!searchValue;
+      var highlightSearch = hasSearch && (_typeof(isPreFiltered) === 'object' ? isPreFiltered.highlightSearch !== false : true);
+
       // Text wrapping
       var canWrap = !isVirtualized;
       var _textWrap = (_option$textWrap = option.textWrap) !== null && _option$textWrap !== void 0 ? _option$textWrap : _this.props.textWrap;
       var textWrap = canWrap ? _textWrap : 'truncate';
 
       // Truncation config (if any). If none, CSS truncation is used
-      var truncationProps = textWrap === 'truncate' ? _this.getTruncationProps(option, isFocused) : undefined;
+      var truncationProps = textWrap === 'truncate' ? _this.getTruncationProps(option, highlightSearch, isFocused) : undefined;
       return ___EmotionJSX(EuiSelectableListItem, _extends({
         key: id,
         id: id,
@@ -182,7 +187,7 @@ export var EuiSelectableList = /*#__PURE__*/function (_Component) {
         searchable: searchable,
         textWrap: textWrap
       }, optionRest), renderOption ? renderOption( // @ts-ignore complex
-      _objectSpread(_objectSpread({}, _option), optionData), searchValue) : searchValue ? _this.renderSearchedText(label, truncationProps) : truncationProps ? _this.renderTruncatedText(label, truncationProps) : label);
+      _objectSpread(_objectSpread({}, _option), optionData), searchValue) : highlightSearch ? _this.renderSearchedText(label, truncationProps) : truncationProps ? _this.renderTruncatedText(label, truncationProps) : label);
     }, areEqual));
     _defineProperty(_assertThisInitialized(_this), "renderVirtualizedList", function () {
       if (!_this.props.isVirtualized) return null;
@@ -280,12 +285,12 @@ export var EuiSelectableList = /*#__PURE__*/function (_Component) {
         }
       });
     });
-    _defineProperty(_assertThisInitialized(_this), "getTruncationProps", function (option, isFocused) {
+    _defineProperty(_assertThisInitialized(_this), "getTruncationProps", function (option, highlightSearch, isFocused) {
       // Individual truncation settings should override component-wide settings
       var truncationProps = _objectSpread(_objectSpread({}, _this.props.truncationProps), option.truncationProps);
 
       // If we're not actually using EuiTextTruncate, no need to continue
-      var hasComplexTruncation = _this.props.searchValue || Object.keys(truncationProps).length > 0;
+      var hasComplexTruncation = highlightSearch || Object.keys(truncationProps).length > 0;
       if (!hasComplexTruncation) return undefined;
 
       // Determine whether we can use the optimized default option width
@@ -487,6 +492,7 @@ export var EuiSelectableList = /*#__PURE__*/function (_Component) {
         ariaLabelledby = _this$props10['aria-labelledby'],
         ariaDescribedby = _this$props10['aria-describedby'],
         role = _this$props10.role,
+        isPreFiltered = _this$props10.isPreFiltered,
         isVirtualized = _this$props10.isVirtualized,
         textWrap = _this$props10.textWrap,
         truncationProps = _this$props10.truncationProps,
@@ -737,6 +743,9 @@ EuiSelectableList.propTypes = {
      */
   allowExclusions: PropTypes.bool,
   searchable: PropTypes.bool,
+  isPreFiltered: PropTypes.oneOfType([PropTypes.bool.isRequired, PropTypes.shape({
+    highlightSearch: PropTypes.bool
+  }).isRequired]),
   makeOptionId: PropTypes.func.isRequired,
   listId: PropTypes.string.isRequired,
   setActiveOptionIndex: PropTypes.func.isRequired

package/es/components/selectable/selectable_search/selectable_search.js

@@ -1,4 +1,4 @@
-var _excluded = ["onChange", "options", "value", "placeholder", "isPreFiltered", "listId", "className"];
+var _excluded = ["onChange", "options", "value", "placeholder", "isPreFiltered", "listId", "className", "optionMatcher"];
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
@@ -23,12 +23,18 @@ export var EuiSelectableSearch = function EuiSelectableSearch(_ref) {
     isPreFiltered = _ref.isPreFiltered,
     listId = _ref.listId,
     className = _ref.className,
+    optionMatcher = _ref.optionMatcher,
     rest = _objectWithoutProperties(_ref, _excluded);
   var onChange = useCallback(function (e) {
     var searchValue = e.target.value;
-    var matchingOptions = getMatchingOptions(options, searchValue, isPreFiltered);
+    var matchingOptions = getMatchingOptions({
+      options: options,
+      searchValue: searchValue,
+      isPreFiltered: isPreFiltered,
+      optionMatcher: optionMatcher
+    });
     onChangeCallback(searchValue, matchingOptions);
-  }, [options, isPreFiltered, onChangeCallback]);
+  }, [options, isPreFiltered, onChangeCallback, optionMatcher]);
   var classes = classNames('euiSelectableSearch', className);
   var ariaPropsIfListIsPresent = listId ? {
     role: 'combobox',

package/es/components/steps/step_horizontal.js

@@ -78,6 +78,7 @@ export var EuiStepHorizontal = function EuiStepHorizontal(_ref) {
     if (!disabled) onClick(event);
   };
   return ___EmotionJSX("button", _extends({
+    "aria-disabled": status === 'disabled' ? true : undefined,
     className: classes,
     title: titleAttr,
     onClick: onStepClick,

package/es/components/table/table_row_cell.styles.js

@@ -8,7 +8,7 @@ function _EMOTION_STRINGIFIED_CSS_ERROR__() { return "You have tried to stringif
  */
 
 import { css } from '@emotion/react';
-import { euiCanAnimate, euiFontSize, euiTextTruncate, logicalCSS } from '../../global_styling';
+import { euiCanAnimate, euiFontSize, euiTextTruncate, logicalCSS, logicalTextAlignCSS } from '../../global_styling';
 import { euiTableVariables } from './table.styles';
 var _ref = process.env.NODE_ENV === "production" ? {
   name: "1amvdy6-bottom",
@@ -52,7 +52,7 @@ export var euiTableRowCellStyles = function euiTableRowCellStyles(euiThemeContex
   var hasIcons = "line-height: 1;";
   return {
     euiTableRowCell: /*#__PURE__*/css("color:", euiTheme.colors.text, ";;label:euiTableRowCell;"),
-    rowHeader: /*#__PURE__*/css("font-weight:", euiTheme.font.weight.regular, ";;label:rowHeader;"),
+    rowHeader: /*#__PURE__*/css("font-weight:", euiTheme.font.weight.regular, ";", logicalTextAlignCSS('left'), ";;label:rowHeader;"),
     isExpander: /*#__PURE__*/css(hasIcons, ";;label:isExpander;"),
     hasActions: /*#__PURE__*/css(hasIcons, ";;label:hasActions;"),
     // valign

package/es/components/tour/tour_step.js

@@ -274,7 +274,7 @@ EuiTourStep.propTypes = {
   /**
      * Minimum distance between the popover and the bounding container;
      * Pass an array of 4 values to adjust each side differently: `[top, right, bottom, left]`
-     * Default is 16
+     * @default 16
      */
   buffer: PropTypes.oneOfType([PropTypes.number.isRequired, PropTypes.any.isRequired]),
   /**