@eccenca/gui-elements
Version:
GUI elements based on other libraries, usable in React application, written in Typescript.
347 lines • 20.6 kB
JavaScript
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
import React, { useEffect, useState } from "react";
import { Suggest as BlueprintSuggest } from "@blueprintjs/select";
import { CLASSPREFIX as eccgui } from "../../configuration/constants.js";
import { Highlighter, IconButton, Menu, MenuItem, Notification, OverflowText, Spinner, } from "../../index.js";
SuggestField.defaultProps = {
autoFocus: false,
disabled: false,
onlyDropdownWithQuery: false, // FIXME: this should be `true` by default, otherwise similarity to `<Select />` is very close
fill: true,
requestErrorPrefix: "",
hasBackDrop: false,
};
/**
* A component with the appearance of an input field that allows to select and optionally create new items.
* It shows suggestions for the entered text from which the user can select any option.
*
* It has the following fixed behavior:
*
* - When not focused, a different representation of the item value can be shown, e.g. the label of the value.
* - When changing an existing item the input text is set to the original value in order to be able to edit the original value.
* - When for a specific input text, the only item returned is the currently set item itself, all items are shown below it, to make
* clear that there are still other items to choose from.
* - The suggestions are fetched with a short delay, so not too many unnecessary requests are fired.
* - Items where itemRenderer returns a string have a default representation, i.e. highlighting of search words, active flag etc.
*/
export function SuggestField(props) {
var _this = this;
var _a, _b, _c;
var className = props.className, reset = props.reset, noResultText = props.noResultText, disabled = props.disabled, onlyDropdownWithQuery = props.onlyDropdownWithQuery, itemValueSelector = props.itemValueSelector, itemRenderer = props.itemRenderer, onSearch = props.onSearch, onChange = props.onChange, initialValue = props.initialValue, autoFocus = props.autoFocus, createNewItem = props.createNewItem, itemValueRenderer = props.itemValueRenderer, resetQueryToValue = props.resetQueryToValue, itemValueString = props.itemValueString, requestErrorPrefix = props.requestErrorPrefix, hasBackDrop = props.hasBackDrop, fill = props.fill, loadMoreResults = props.loadMoreResults, otherProps = __rest(props, ["className", "reset", "noResultText", "disabled", "onlyDropdownWithQuery", "itemValueSelector", "itemRenderer", "onSearch", "onChange", "initialValue", "autoFocus", "createNewItem", "itemValueRenderer", "resetQueryToValue", "itemValueString", "requestErrorPrefix", "hasBackDrop", "fill", "loadMoreResults"]);
var _d = __read(useState(initialValue), 2), selectedItem = _d[0], setSelectedItem = _d[1];
// If the selection list elements are currently fetched from the backend
var _e = __read(useState(false), 2), listLoading = _e[0], setListLoading = _e[1];
var _f = __read(useState(""), 2), query = _f[0], setQuery = _f[1];
// If the input field has focus
var _g = __read(useState(false), 2), inputHasFocus = _g[0], setInputHasFocus = _g[1];
var _h = __read(useState(true), 2), highlightingEnabled = _h[0], setHighlightingEnabled = _h[1];
var _j = __read(useState(undefined), 2), requestError = _j[0], setRequestError = _j[1];
// The suggestions that match the user's input
var _k = __read(useState([]), 2), filtered = _k[0], setFiltered = _k[1];
var readOnly = !!((_a = otherProps.inputProps) === null || _a === void 0 ? void 0 : _a.readOnly);
// Sets the query to the item value if it has a valid string value
var setQueryToSelectedValue = function (item) {
if (item) {
// If new values can be created, always reset the query value to the actual value of the selected item.
// This e.g. prevents that the "create new" option will be shown, since an item with the same value already exists.
var defaultResetValue = createNewItem
? itemValueString(item)
: itemValueRenderer(item);
var resetVal = resetQueryToValue ? resetQueryToValue(item) : defaultResetValue;
setQuery(resetVal);
}
};
// The key for the option elements
var itemKey = function (item) {
return itemValueString(item);
};
useEffect(function () {
setQueryToSelectedValue(selectedItem);
}, [selectedItem]);
useEffect(function () {
if (!disabled && !readOnly && inputHasFocus) {
setListLoading(true);
var timeout_1 = window.setTimeout(function () { return __awaiter(_this, void 0, void 0, function () {
return __generator(this, function (_a) {
fetchQueryResults(query);
return [2 /*return*/];
});
}); }, 200);
return function () {
clearTimeout(timeout_1);
setListLoading(false);
};
}
return;
}, [inputHasFocus, query]);
// We need to fire some actions when the auto-complete widget gets or loses focus
var handleOnFocusIn = function () {
setInputHasFocus(true);
};
var handleOnFocusOut = function () {
setInputHasFocus(false);
};
// On popover close reset query to selected item
var onPopoverClose = function () {
// Reset query to selected value when loosing focus, so the selected value can always be edited.
setQueryToSelectedValue(selectedItem);
// Reset option list when the popover closes, so next use there is not displayed a stale list
setFiltered([]);
};
// Triggered when an item from the selection list gets selected
var onSelectionChange = function (value, e) {
setSelectedItem(value);
onChange === null || onChange === void 0 ? void 0 : onChange(itemValueSelector(value), e);
setQueryToSelectedValue(value);
};
var areEqualItems = function (itemA, itemB) { return itemValueSelector(itemA) === itemValueSelector(itemB); };
// Return the index of the item in the array based on the itemValueRenderer value
var itemIndexOf = function (arr, searchItem) {
var idx = -1;
var searchItemString = itemValueString(searchItem);
arr.forEach(function (v, i) {
if (itemValueString(v) === searchItemString) {
idx = i;
}
});
return idx;
};
// Fetches the results for the given query
var fetchQueryResults = function (input) { return __awaiter(_this, void 0, void 0, function () {
var result, onlySelectItemReturned, enableHighlighting, emptyStringResults, withoutSelected, e_1, details;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
setListLoading(true);
setRequestError(undefined);
_b.label = 1;
case 1:
_b.trys.push([1, 5, 6, 7]);
return [4 /*yield*/, onSearch(input)];
case 2:
result = _b.sent();
onlySelectItemReturned = result.length <= 1 &&
selectedItem &&
input.length > 0 &&
(itemValueRenderer(selectedItem) === input || itemValueString(selectedItem) === input);
enableHighlighting = true;
if (!onlySelectItemReturned) return [3 /*break*/, 4];
return [4 /*yield*/, onSearch("")];
case 3:
emptyStringResults = _b.sent();
// Disable highlighting, since we used empty string search
enableHighlighting = false;
// Put selected item at the top if it is not in the result list
if (!!selectedItem && itemIndexOf(emptyStringResults, selectedItem) > -1) {
withoutSelected = __spreadArray([], __read(emptyStringResults), false);
withoutSelected.splice(itemIndexOf(emptyStringResults, selectedItem), 1);
result = __spreadArray([selectedItem], __read(withoutSelected), false);
}
else {
result = emptyStringResults;
}
_b.label = 4;
case 4:
setHighlightingEnabled(enableHighlighting);
setFiltered(result);
return [3 /*break*/, 7];
case 5:
e_1 = _b.sent();
details = (_a = e_1 === null || e_1 === void 0 ? void 0 : e_1.message) !== null && _a !== void 0 ? _a : "";
setRequestError(requestErrorPrefix + details);
return [3 /*break*/, 7];
case 6:
setListLoading(false);
return [7 /*endfinally*/];
case 7: return [2 /*return*/];
}
});
}); };
// Renders the item in the selection list
var optionRenderer = function (item, _a) {
var handleClick = _a.handleClick, modifiers = _a.modifiers, query = _a.query;
if (!modifiers.matchesPredicate) {
return null;
}
var relevantModifiers = {
active: modifiers.active,
disabled: modifiers.disabled,
highlightingEnabled: highlightingEnabled,
};
var renderedItem = itemRenderer(item, query, relevantModifiers, handleClick);
if (typeof renderedItem === "string") {
return (React.createElement(MenuItem, { active: modifiers.active, disabled: modifiers.disabled, key: itemKey(item), onClick: handleClick, text: React.createElement(OverflowText, null, !highlightingEnabled ? (renderedItem) : (React.createElement(Highlighter, { label: renderedItem, searchValue: query }))) }));
}
else {
return renderedItem;
}
};
// Resets the selection
var clearSelection = function (resetValue) { return function () {
setSelectedItem(undefined);
onChange === null || onChange === void 0 ? void 0 : onChange(resetValue);
setQuery("");
}; };
var requestErrorRenderer = function () {
return React.createElement(Notification, { intent: "danger", message: requestError });
};
// Optional clear button to reset the selected value
var clearButton = !readOnly && !disabled && reset && selectedItem != null && reset.resettableValue(selectedItem) ? (React.createElement(IconButton, { "data-test-id": (((_b = otherProps.inputProps) === null || _b === void 0 ? void 0 : _b.id) ? "".concat(otherProps.inputProps.id, "-") : "") + "auto-complete-clear-btn", name: "operation-clear", text: reset.resetButtonText, onClick: clearSelection(reset.resetValue) })) : undefined;
// Additional properties for the input element of the auto-completion widget
var updatedInputProps = __assign(__assign({ rightElement: clearButton || onlyDropdownWithQuery === false ? (React.createElement(React.Fragment, null,
clearButton,
onlyDropdownWithQuery === false && (React.createElement(IconButton, { name: "toggler-caretdown", onClick: function (e) {
var _a;
var target = (_a = e.currentTarget
.closest(".".concat(eccgui, "-autocompletefield__input"))) === null || _a === void 0 ? void 0 : _a.querySelector("input");
target.focus();
e.stopPropagation();
} })))) : undefined, autoFocus: autoFocus, onBlur: handleOnFocusOut, onFocus: handleOnFocusIn }, otherProps.inputProps), { title: selectedItem !== undefined && (readOnly || disabled)
? itemValueString(selectedItem)
: (_c = otherProps.inputProps) === null || _c === void 0 ? void 0 : _c.title });
var preventOverlayOnReadonly = readOnly ? { isOpen: false } : {};
var updatedContextOverlayProps = __assign(__assign(__assign({ minimal: true, matchTargetWidth: fill, popoverClassName: "".concat(eccgui, "-autocompletefield__options"), onClosed: onPopoverClose }, otherProps.contextOverlayProps), preventOverlayOnReadonly), {
// Needed to capture clicks outside of the popover, e.g. in order to close it.
hasBackdrop: hasBackDrop });
if (selectedItem !== undefined) {
// Makes sure that even when an empty string is selected, the placeholder won't be shown.
updatedInputProps.placeholder = "";
}
// For some reason Typescript is not able to infer the union type from the ternary expression
var createNewItemPosition = (createNewItem === null || createNewItem === void 0 ? void 0 : createNewItem.showNewItemOptionFirst) ? "first" : "last";
var createNewItemProps = createNewItem
? {
createNewItemFromQuery: createNewItem.itemFromQuery,
createNewItemRenderer: function (query, active, handleClick) {
if (selectedItem && query === itemValueString(selectedItem)) {
// Never show create new item option if the same item is already selected
return undefined;
}
else {
return createNewItem.itemRenderer(query, { active: active, highlightingEnabled: false }, handleClick);
}
},
createNewItemPosition: createNewItemPosition,
}
: {};
var handleMenuScroll = React.useCallback(function (event) { return __awaiter(_this, void 0, void 0, function () {
var menu, scrollTop, scrollHeight, clientHeight, results_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
menu = event.target;
scrollTop = menu.scrollTop, scrollHeight = menu.scrollHeight, clientHeight = menu.clientHeight;
if (!(Math.round(scrollTop + clientHeight) >= scrollHeight && loadMoreResults)) return [3 /*break*/, 2];
return [4 /*yield*/, loadMoreResults()];
case 1:
results_1 = _a.sent();
if (results_1) {
setFiltered(function (prev) { return __spreadArray(__spreadArray([], __read(prev), false), __read(results_1), false); });
setTimeout(function () {
menu.scrollTop = scrollTop; //safari adaptation
menu.scrollTo({ left: 0, top: scrollTop, behavior: "auto" });
});
}
_a.label = 2;
case 2: return [2 /*return*/];
}
});
}); }, [loadMoreResults]);
return (React.createElement(BlueprintSuggest, __assign({ className: "".concat(eccgui, "-suggestfield ").concat(eccgui, "-autocompletefield__input") + (className ? " ".concat(className) : ""), disabled: disabled,
// Need to display error messages in list
items: requestError ? [requestError] : filtered, initialContent: onlyDropdownWithQuery ? null : undefined, inputValueRenderer: selectedItem !== undefined ? itemValueRenderer : function () { return ""; }, itemRenderer: requestError ? requestErrorRenderer : optionRenderer, itemsEqual: areEqualItems, noResults: React.createElement(MenuItem, { disabled: true, text: noResultText }), onItemSelect: onSelectionChange, onQueryChange: function (q) { return setQuery(q); }, resetOnQuery: false, closeOnSelect: true, menuProps: {
onScroll: handleMenuScroll,
}, query: query,
// This leads to odd compile errors without "as any"
popoverProps: updatedContextOverlayProps, popoverContentProps: { className: "nodrag" }, selectedItem: selectedItem, fill: fill }, createNewItemProps, {
// This leads to odd compile errors without "as any"
inputProps: updatedInputProps, itemListRenderer: listLoading
? function () { return (React.createElement(Menu, null,
React.createElement(MenuItem, { disabled: true, text: React.createElement(Spinner, { position: "inline" }) }))); }
: undefined })));
}
export default SuggestField;
//# sourceMappingURL=AutoCompleteField.js.map