orc-shared 1.5.0-dev.12 → 1.5.0-dev.13

package/dist/components/MaterialUI/Inputs/PredefinedElements/SearchControl.js

@@ -21,12 +21,6 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
   var enterModule = typeof reactHotLoaderGlobal !== 'undefined' ? reactHotLoaderGlobal.enterModule : undefined;
   enterModule && enterModule(module);
 })();
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 var __signature__ = typeof reactHotLoaderGlobal !== 'undefined' ? reactHotLoaderGlobal.default.signature : function (a) {
   return a;
 };
@@ -107,15 +101,9 @@ var useStyles = (0, _styles.makeStyles)(function (theme) {
     },
     parentInput: {
       flex: "13 0 0",
-      zIndex: function zIndex(props) {
-        return props.focused ? 99 : 1;
-      },
-      border: function border(props) {
-        return props.focused ? "".concat(theme.spacing(0.1), " solid ").concat(theme.palette.focus) : "".concat(theme.spacing(0.1), " solid ").concat(theme.palette.grey.borders);
-      },
-      boxShadow: function boxShadow(props) {
-        return props.focused ? "0 0 4px ".concat(theme.palette.focus) : "none";
-      },
+      zIndex: 1,
+      border: "".concat(theme.spacing(0.1), " solid ").concat(theme.palette.grey.borders),
+      boxShadow: "none",
       width: "100%",
       display: "inherit",
       marginLeft: theme.spacing(-0.1),
@@ -133,6 +121,11 @@ var useStyles = (0, _styles.makeStyles)(function (theme) {
           borderTopLeftRadius: 0,
           borderBottomLeftRadius: 0
         }
+      },
+      "&:focus-within": {
+        zIndex: 99,
+        border: "".concat(theme.spacing(0.1), " solid ").concat(theme.palette.focus),
+        boxShadow: "0 0 4px ".concat(theme.palette.focus)
       }
     },
     selectRoot: {
@@ -184,19 +177,27 @@ var SearchControl = function SearchControl(_ref) {
     onSearch = _ref$onSearch === void 0 ? function () {} : _ref$onSearch,
     disabled = _ref.disabled,
     _ref$focusAndSelectSe = _ref.focusAndSelectSearchFieldOnLoad,
-    focusAndSelectSearchFieldOnLoad = _ref$focusAndSelectSe === void 0 ? true : _ref$focusAndSelectSe;
+    focusAndSelectSearchFieldOnLoad = _ref$focusAndSelectSe === void 0 ? true : _ref$focusAndSelectSe,
+    _ref$focusSearchOnSea = _ref.focusSearchOnSearchOptionChange,
+    focusSearchOnSearchOptionChange = _ref$focusSearchOnSea === void 0 ? false : _ref$focusSearchOnSea;
   searchOptions = !((_searchOptions = searchOptions) != null && _searchOptions.length) ? null : searchOptions;
   searchOption = getSearchOptionValue(searchOptions, searchOption);
-  var _useState = (0, _react.useState)(false),
-    _useState2 = _slicedToArray(_useState, 2),
-    inputFocused = _useState2[0],
-    setInputFocused = _useState2[1];
-  var classes = useStyles({
-    focused: inputFocused
-  });
+  var classes = useStyles();
   var inputRef = (0, _react.useRef)();
   var update = function update(value) {
-    onSearch(value, defaultValue);
+    if (focusSearchOnSearchOptionChange && inputRef.current) {
+      onSearch(value, "");
+      setTimeout(function () {
+        /* istanbul ignore next */
+        if (inputRef.current) {
+          inputRef.current.value = "";
+          inputRef.current.focus();
+          inputRef.current.select();
+        }
+      }, 0);
+    } else {
+      onSearch(value, defaultValue);
+    }
   };
   var selectProps = new _SelectProps.default();
   selectProps.set(_SelectProps.default.propNames.update, update);
@@ -213,23 +214,11 @@ var SearchControl = function SearchControl(_ref) {
   });
   selectProps.setStyle(_SelectProps.default.ruleNames.root, classes.selectRoot);
   selectProps.setStyle(_SelectProps.default.ruleNames.paper, classes.selectPaper);
-  var handleKeyDown = function handleKeyDown(e) {
-    if (e.key === "Enter") {
-      onSearch(searchOption, e.target.value);
-      e.preventDefault();
-      e.stopPropagation();
-    }
-  };
-  var onFocusedEvent = function onFocusedEvent(event, focused) {
-    setInputFocused(focused);
-    event.preventDefault();
-    event.stopPropagation();
-  };
   (0, _react.useEffect)(function () {
+    /* istanbul ignore next */
     if (focusAndSelectSearchFieldOnLoad && inputRef.current) {
       inputRef.current.focus();
       inputRef.current.select();
-      setInputFocused(true);
     }
   }, [focusAndSelectSearchFieldOnLoad]);
   var SelectSection = function SelectSection() {
@@ -239,13 +228,19 @@ var SearchControl = function SearchControl(_ref) {
       selectProps: selectProps
     });
   };
+  var onSubmit = function onSubmit(event) {
+    var _inputRef$current;
+    // using form submit instead of a keydown (with key=enter) to allow the 'enter key' event to be canceled elsewhere to avoid the submit event
+    onSearch(searchOption, (_inputRef$current = inputRef.current) == null ? void 0 : _inputRef$current.value);
+    event.preventDefault();
+  };
   var inputSection = /*#__PURE__*/_react.default.createElement("div", {
     "data-qa": "searchInput",
-    "data-qa-is-focused": inputFocused,
     className: classes.parentInput
   }, /*#__PURE__*/_react.default.createElement("form", {
     "data-qa": "searchForm",
-    className: classes.fullWidth
+    className: classes.fullWidth,
+    onSubmitCapture: onSubmit
   }, /*#__PURE__*/_react.default.createElement(_Input.default, {
     placeholder: placeholder,
     defaultValue: defaultValue,
@@ -255,14 +250,7 @@ var SearchControl = function SearchControl(_ref) {
     classes: {
       input: classes.controlInput
     },
-    onKeyDown: handleKeyDown,
     disableUnderline: true,
-    onFocus: function onFocus(e) {
-      return onFocusedEvent(e, true);
-    },
-    onBlur: function onBlur(e) {
-      return onFocusedEvent(e, false);
-    },
     endAdornment: /*#__PURE__*/_react.default.createElement(_InputAdornment.default, {
       position: "start"
     }, /*#__PURE__*/_react.default.createElement(_IconButton.default, {
@@ -296,10 +284,10 @@ var SearchControl = function SearchControl(_ref) {
     className: classes.container
   }, /*#__PURE__*/_react.default.createElement(SelectSection, null), inputSection, searchSection);
 };
-__signature__(SearchControl, "useState{[inputFocused, setInputFocused](false)}\nuseStyles{classes}\nuseRef{inputRef}\nuseEffect{}", function () {
+__signature__(SearchControl, "useStyles{classes}\nuseRef{inputRef}\nuseEffect{}", function () {
   return [useStyles];
 });
-__signature__(SearchControl, "useState{[inputFocused, setInputFocused](false)}\nuseStyles{classes}\nuseRef{inputRef}\nuseEffect{}", function () {
+__signature__(SearchControl, "useStyles{classes}\nuseRef{inputRef}\nuseEffect{}", function () {
   return [useStyles];
 });
 var _default = SearchControl;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "orc-shared",
-	"version": "1.5.0-dev.12",
+	"version": "1.5.0-dev.13",
 	"description": "Shared code for Orckestra applications",
 	"main": "./src/index.js",
 	"exports": {

package/src/components/MaterialUI/Inputs/PredefinedElements/SearchControl.js

@@ -1,4 +1,4 @@
-import React, { useState, useRef, useEffect } from "react";
+import React, { useRef, useEffect } from "react";
 import { makeStyles } from "@material-ui/core/styles";
 import SelectProps from "../SelectProps";
 import Icon from "../../DataDisplay/Icon";
@@ -80,12 +80,9 @@ export const useStyles = makeStyles(theme => ({
 	},
 	parentInput: {
 		flex: "13 0 0",
-		zIndex: props => (props.focused ? 99 : 1),
-		border: props =>
-			props.focused
-				? `${theme.spacing(0.1)} solid ${theme.palette.focus}`
-				: `${theme.spacing(0.1)} solid ${theme.palette.grey.borders}`,
-		boxShadow: props => (props.focused ? `0 0 4px ${theme.palette.focus}` : "none"),
+		zIndex: 1,
+		border: `${theme.spacing(0.1)} solid ${theme.palette.grey.borders}`,
+		boxShadow: "none",
 		width: "100%",
 		display: "inherit",
 		marginLeft: theme.spacing(-0.1),
@@ -104,6 +101,11 @@ export const useStyles = makeStyles(theme => ({
 				borderBottomLeftRadius: 0,
 			},
 		},
+		"&:focus-within": {
+			zIndex: 99,
+			border: `${theme.spacing(0.1)} solid ${theme.palette.focus}`,
+			boxShadow: `0 0 4px ${theme.palette.focus}`,
+		},
 	},
 	selectRoot: {
 		zIndex: 10,
@@ -150,17 +152,29 @@ const SearchControl = ({
 	onSearch = () => {},
 	disabled,
 	focusAndSelectSearchFieldOnLoad = true,
+	focusSearchOnSearchOptionChange = false,
 }) => {
 	searchOptions = !searchOptions?.length ? null : searchOptions;
 	searchOption = getSearchOptionValue(searchOptions, searchOption);
-	const [inputFocused, setInputFocused] = useState(false);
 
-	const classes = useStyles({ focused: inputFocused });
+	const classes = useStyles();
 
 	const inputRef = useRef();
 
 	const update = value => {
-		onSearch(value, defaultValue);
+		if (focusSearchOnSearchOptionChange && inputRef.current) {
+			onSearch(value, "");
+			setTimeout(() => {
+				/* istanbul ignore next */
+				if (inputRef.current) {
+					inputRef.current.value = "";
+					inputRef.current.focus();
+					inputRef.current.select();
+				}
+			}, 0);
+		} else {
+			onSearch(value, defaultValue);
+		}
 	};
 
 	const selectProps = new SelectProps();
@@ -179,25 +193,11 @@ const SearchControl = ({
 	selectProps.setStyle(SelectProps.ruleNames.root, classes.selectRoot);
 	selectProps.setStyle(SelectProps.ruleNames.paper, classes.selectPaper);
 
-	const handleKeyDown = e => {
-		if (e.key === "Enter") {
-			onSearch(searchOption, e.target.value);
-			e.preventDefault();
-			e.stopPropagation();
-		}
-	};
-
-	const onFocusedEvent = (event, focused) => {
-		setInputFocused(focused);
-		event.preventDefault();
-		event.stopPropagation();
-	};
-
 	useEffect(() => {
+		/* istanbul ignore next */
 		if (focusAndSelectSearchFieldOnLoad && inputRef.current) {
 			inputRef.current.focus();
 			inputRef.current.select();
-			setInputFocused(true);
 		}
 	}, [focusAndSelectSearchFieldOnLoad]);
 
@@ -206,9 +206,15 @@ const SearchControl = ({
 		else return <Select className={classes.selectInput} options={searchOptions} selectProps={selectProps} />;
 	};
 
+	const onSubmit = event => {
+		// using form submit instead of a keydown (with key=enter) to allow the 'enter key' event to be canceled elsewhere to avoid the submit event
+		onSearch(searchOption, inputRef.current?.value);
+		event.preventDefault();
+	};
+
 	const inputSection = (
-		<div data-qa="searchInput" data-qa-is-focused={inputFocused} className={classes.parentInput}>
-			<form data-qa="searchForm" className={classes.fullWidth}>
+		<div data-qa="searchInput" className={classes.parentInput}>
+			<form data-qa="searchForm" className={classes.fullWidth} onSubmitCapture={onSubmit}>
 				<Input
 					placeholder={placeholder}
 					defaultValue={defaultValue}
@@ -216,10 +222,7 @@ const SearchControl = ({
 					type="text"
 					disabled={disabled}
 					classes={{ input: classes.controlInput }}
-					onKeyDown={handleKeyDown}
 					disableUnderline={true}
-					onFocus={e => onFocusedEvent(e, true)}
-					onBlur={e => onFocusedEvent(e, false)}
 					endAdornment={
 						<InputAdornment position="start">
 							<IconButton

package/src/components/MaterialUI/Inputs/PredefinedElements/SearchControl.test.js

@@ -53,10 +53,11 @@ describe("useStyles", () => {
 });
 
 describe("SearchControl Component", () => {
-	const stateSetter = sinon.spy().named("focus");
-	const useStateMock = initState => [initState, stateSetter];
-
+	beforeEach(() => {
+		jest.useFakeTimers();
+	});
 	afterEach(() => {
+		jest.useRealTimers();
 		jest.clearAllMocks();
 	});
 
@@ -232,8 +233,7 @@ describe("SearchControl Component", () => {
 		expect(searchInput.length, "to be", 1);
 
 		searchInput.instance().value = "abc";
-		searchInput.simulate("keydown", { key: "Tab" });
-		searchInput.simulate("keydown", { key: "Enter" });
+		mountedComponent.find("form").simulate("submit", { preventDefault: () => {} });
 
 		expect(onSearchEvent, "to have calls satisfying", [{ args: ["aValue", "abc"] }]);
 	});
@@ -371,7 +371,7 @@ describe("SearchControl Component", () => {
 		expect(onSearchEvent, "to have calls satisfying", [{ args: ["anotherValue", "abcdef123"] }]);
 	});
 
-	it("Search Control should render with the 2nd value", () => {
+	it("Search Control should clear the search when changing the option", () => {
 		const options = [
 			{ value: "aValue", label: "aLabel" },
 			{ value: "anotherValue", label: "anotherLabel" },
@@ -385,8 +385,8 @@ describe("SearchControl Component", () => {
 					placeholder="placeHolderTest"
 					defaultValue={"abcdef123"}
 					searchOptions={options}
-					searchOption={"anotherValue"}
 					onSearch={onSearchEvent}
+					focusSearchOnSearchOptionChange={true}
 				/>
 			</TestWrapper>
 		);
@@ -395,48 +395,53 @@ describe("SearchControl Component", () => {
 
 		const selectMui = mountedComponent.find(SelectMUI);
 
-		expect(selectMui.props().value, "to equal", "anotherValue");
-	});
+		const event = {
+			target: {
+				value: "anotherValue",
+			},
+		};
+
+		onSearchEvent.resetHistory();
+
+		selectMui.invoke("onChange")(event);
+
+		expect(onSearchEvent.callCount, "to equal", 1);
+		expect(onSearchEvent, "to have calls satisfying", [{ args: ["anotherValue", ""] }]);
+
+		const allInputs = mountedComponent.find("input");
+		const searchInput = allInputs.find("[placeholder='placeHolderTest']");
+		expect(searchInput.length, "to be", 1);
 
-	it("focusing text input should set focus on container", () => {
-		jest.spyOn(React, "useState").mockImplementation(useStateMock);
+		expect(searchInput.instance().value, "to be", "abcdef123");
+		jest.runOnlyPendingTimers();
+		expect(searchInput.instance().value, "to be", "");
+	});
 
+	it("Search Control should render with the 2nd value", () => {
 		const options = [
 			{ value: "aValue", label: "aLabel" },
 			{ value: "anotherValue", label: "anotherLabel" },
 		];
 
+		const onSearchEvent = sinon.spy().named("search");
+
 		const component = (
 			<TestWrapper stylesProvider muiThemeProvider={{ theme }}>
-				<SearchControl placeholder="placeHolderTest" searchOptions={options} focusAndSelectSearchFieldOnLoad={false} />
+				<SearchControl
+					placeholder="placeHolderTest"
+					defaultValue={"abcdef123"}
+					searchOptions={options}
+					searchOption={"anotherValue"}
+					onSearch={onSearchEvent}
+				/>
 			</TestWrapper>
 		);
 
 		const mountedComponent = mount(component);
 
-		const allInputs = mountedComponent.find("input");
-		const searchInput = allInputs.find("[placeholder='placeHolderTest']");
-		expect(searchInput.length, "to be", 1);
-
-		let searchEditParent = mountedComponent.find('[data-qa="searchInput"]');
-		expect(searchEditParent.length, "to be", 1);
-
-		expect(searchEditParent.props()["data-qa-is-focused"], "to be", false);
-
-		const event = {
-			preventDefault: () => {},
-			stopPropagation: () => {},
-		};
-
-		searchInput.invoke("onFocus")(event);
-
-		searchEditParent = mountedComponent.find('[data-qa="searchInput"]');
-		expect(searchEditParent.props()["data-qa-is-focused"], "to be", true);
-
-		searchInput.invoke("onBlur")(event);
+		const selectMui = mountedComponent.find(SelectMUI);
 
-		searchEditParent = mountedComponent.find('[data-qa="searchInput"]');
-		expect(searchEditParent.props()["data-qa-is-focused"], "to be", false);
+		expect(selectMui.props().value, "to equal", "anotherValue");
 	});
 
 	it("Renders Search Control component without errors when disabled", () => {
@@ -484,46 +489,6 @@ describe("SearchControl Component", () => {
 
 		expect(component, "when mounted", "to satisfy", expected);
 	});
-
-	it("focusAndSelectSearchFieldOnLoad set to true gives focus to control", () => {
-		jest.spyOn(React, "useState").mockImplementation(useStateMock);
-
-		const options = [
-			{ value: "aValue", label: "aLabel" },
-			{ value: "anotherValue", label: "anotherLabel" },
-		];
-
-		const component = (
-			<TestWrapper stylesProvider muiThemeProvider={{ theme }}>
-				<SearchControl placeholder="placeHolderTest" searchOptions={options} focusAndSelectSearchFieldOnLoad={true} />
-			</TestWrapper>
-		);
-
-		const mountedComponent = mount(component);
-		const searchEditParent = mountedComponent.find('[data-qa="searchInput"]');
-
-		expect(searchEditParent.props()["data-qa-is-focused"], "to be", true);
-	});
-
-	it("focusAndSelectSearchFieldOnLoad set to false does not give focus to control", () => {
-		jest.spyOn(React, "useState").mockImplementation(useStateMock);
-
-		const options = [
-			{ value: "aValue", label: "aLabel" },
-			{ value: "anotherValue", label: "anotherLabel" },
-		];
-
-		const component = (
-			<TestWrapper stylesProvider muiThemeProvider={{ theme }}>
-				<SearchControl placeholder="placeHolderTest" searchOptions={options} focusAndSelectSearchFieldOnLoad={false} />
-			</TestWrapper>
-		);
-
-		const mountedComponent = mount(component);
-		const searchEditParent = mountedComponent.find('[data-qa="searchInput"]');
-
-		expect(searchEditParent.props()["data-qa-is-focused"], "to be", false);
-	});
 });
 
 describe("getSearchOptionValue function", () => {