@elastic/eui
Version:
Elastic UI Component Library
332 lines (324 loc) • 21.2 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.EuiSuggest = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
var _react = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _classnames = _interopRequireDefault(require("classnames"));
var _icon = require("../icon");
var _i18n = require("../i18n");
var _popover = require("../popover");
var _selectable = require("../selectable");
var _tool_tip = require("../tool_tip");
var _suggest_item = require("./suggest_item");
var _react2 = require("@emotion/react");
var _excluded = ["onItemClick", "onBlur", "onFocus", "onInput", "onSearch", "status", "append", "tooltipContent", "suggestions", "id", "aria-label", "aria-labelledby", "isPreFiltered", "isVirtualized", "fullWidth", "maxHeight"];
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
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) { (0, _defineProperty2.default)(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; }
var statusMap = {
unsaved: {
icon: 'dot',
color: 'accent'
},
saved: {
icon: 'checkInCircleFilled',
color: 'success'
},
unchanged: {
icon: '',
color: 'success'
},
loading: {}
};
// keys of _EuiSuggestItemPropsBase
var suggestItemPropsKeys = ['label', 'type', 'description', 'labelDisplay', 'labelWidth', 'descriptionDisplay'];
var EuiSuggest = function EuiSuggest(_ref) {
var onItemClick = _ref.onItemClick,
onBlur = _ref.onBlur,
onFocus = _ref.onFocus,
onInput = _ref.onInput,
onSearch = _ref.onSearch,
_ref$status = _ref.status,
status = _ref$status === void 0 ? 'unchanged' : _ref$status,
append = _ref.append,
tooltipContent = _ref.tooltipContent,
suggestions = _ref.suggestions,
id = _ref.id,
ariaLabel = _ref['aria-label'],
labelId = _ref['aria-labelledby'],
_ref$isPreFiltered = _ref.isPreFiltered,
isPreFiltered = _ref$isPreFiltered === void 0 ? false : _ref$isPreFiltered,
_ref$isVirtualized = _ref.isVirtualized,
isVirtualized = _ref$isVirtualized === void 0 ? false : _ref$isVirtualized,
_ref$fullWidth = _ref.fullWidth,
fullWidth = _ref$fullWidth === void 0 ? true : _ref$fullWidth,
_ref$maxHeight = _ref.maxHeight,
maxHeight = _ref$maxHeight === void 0 ? '60vh' : _ref$maxHeight,
rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
/**
* Popover helpers
*/
var _useState = (0, _react.useState)(null),
_useState2 = (0, _slicedToArray2.default)(_useState, 2),
popoverRef = _useState2[0],
setPopoverRef = _useState2[1];
var _useState3 = (0, _react.useState)(false),
_useState4 = (0, _slicedToArray2.default)(_useState3, 2),
isPopoverOpen = _useState4[0],
setIsPopoverOpen = _useState4[1];
var openPopover = function openPopover() {
return setIsPopoverOpen(true);
};
var closePopover = function closePopover() {
return setIsPopoverOpen(false);
};
/**
* Search helpers
*/
var searchOnFocus = function searchOnFocus(e) {
onFocus === null || onFocus === void 0 ? void 0 : onFocus(e);
openPopover();
};
var searchOnBlur = function searchOnBlur(e) {
onBlur === null || onBlur === void 0 ? void 0 : onBlur(e);
if (!(popoverRef !== null && popoverRef !== void 0 && popoverRef.contains(e.relatedTarget))) {
closePopover();
}
};
var searchOnInput = function searchOnInput(e) {
onInput === null || onInput === void 0 ? void 0 : onInput(e.target);
openPopover();
};
var searchOnChange = function searchOnChange(value) {
onSearch === null || onSearch === void 0 ? void 0 : onSearch(value);
};
/**
* Status
*/
var icon = '';
var color = '';
if (statusMap[status]) {
icon = statusMap[status].icon || '';
color = statusMap[status].color || '';
}
// EuiFieldText's append accepts an array of elements so start by creating an empty array
var appendArray = [];
var _useEuiI18n = (0, _i18n.useEuiI18n)(['euiSuggest.stateSavedTooltip', 'euiSuggest.stateUnsavedTooltip'], ['Saved.', 'Changes have not been saved.']),
_useEuiI18n2 = (0, _slicedToArray2.default)(_useEuiI18n, 2),
statusSaved = _useEuiI18n2[0],
statusUnsaved = _useEuiI18n2[1];
statusMap.saved.tooltip = statusSaved;
statusMap.unsaved.tooltip = statusUnsaved;
var statusElement = (status === 'saved' || status === 'unsaved') && (0, _react2.jsx)(_tool_tip.EuiToolTip, {
position: "left",
content: tooltipContent || statusMap[status].tooltip
}, (0, _react2.jsx)(_icon.EuiIcon, {
className: "euiSuggestInput__statusIcon",
color: color,
type: icon
}));
// Push the status element to the array if it is not undefined
if (statusElement) appendArray.push(statusElement);
// Check to see if consumer passed an append item and if so, add it to the array
if (append) appendArray.push(append);
var _useEuiI18n3 = (0, _i18n.useEuiI18n)(['euiSuggest.stateLoading', 'euiSuggest.stateSaved', 'euiSuggest.stateUnsaved', 'euiSuggest.stateUnchanged'], ['State: loading.', 'State: saved.', 'State: unsaved.', 'State: unchanged.']),
_useEuiI18n4 = (0, _slicedToArray2.default)(_useEuiI18n3, 4),
stateLoading = _useEuiI18n4[0],
stateSaved = _useEuiI18n4[1],
stateUnsaved = _useEuiI18n4[2],
stateUnchanged = _useEuiI18n4[3];
var stateMessageMap = {
loading: stateLoading,
saved: stateSaved,
unsaved: stateUnsaved,
unchanged: stateUnchanged
};
var stateMessage = stateMessageMap[status];
/**
* Options list
*/
var suggestionList = suggestions.map(function (props) {
// Omit props destined for the EuiSuggestItem so that they don't
// cause warnings or render in the DOM of the EuiSelectableItem
var data = {};
var liProps = {
label: props.label
};
Object.keys(props).forEach(function (key) {
if (suggestItemPropsKeys.includes(key)) {
// @ts-ignore string index type
data[key] = props[key];
} else {
// @ts-ignore string index type
liProps[key] = props[key];
}
});
return _objectSpread(_objectSpread({}, liProps), {}, {
data: data,
className: (0, _classnames.default)(props.className, 'euiSuggestItemOption'),
// Force truncation if `isVirtualized` is true
truncate: isVirtualized ? true : props.truncate
});
});
var renderOption = (0, _react.useCallback)(function (props) {
return (0, _react2.jsx)(_suggest_item.EuiSuggestItem, props);
}, []);
var onItemSelect = (0, _react.useCallback)(function (options) {
if (onItemClick) {
var selectedIndex = options.findIndex(function (option) {
return option.checked === 'on';
});
if (selectedIndex >= 0) {
var selectedSuggestion = suggestions[selectedIndex];
onItemClick(selectedSuggestion);
}
}
}, [onItemClick, suggestions]);
return (0, _react2.jsx)(_react.default.Fragment, null, (0, _react2.jsx)(_selectable.EuiSelectable, {
selectableScreenReaderText: stateMessage,
singleSelection: true,
height: isVirtualized ? undefined : 'full',
options: suggestionList,
renderOption: renderOption,
onChange: onItemSelect,
listProps: {
bordered: false,
showIcons: false,
onFocusBadge: false,
paddingSize: 'none',
textWrap: isVirtualized ? 'truncate' : 'wrap',
isVirtualized: isVirtualized
},
searchable: true,
isPreFiltered: isPreFiltered,
searchProps: _objectSpread({
id: id,
append: appendArray.length ? appendArray : undefined,
fullWidth: fullWidth,
isLoading: status === 'loading' ? true : false,
onFocus: searchOnFocus,
onBlur: searchOnBlur,
onInput: searchOnInput,
onChange: searchOnChange,
'aria-label': ariaLabel,
'aria-labelledby': labelId
}, rest)
}, function (list, search) {
return (0, _react2.jsx)(_popover.EuiInputPopover, {
disableFocusTrap: true,
input: (0, _react2.jsx)(_react.default.Fragment, null, search),
isOpen: isPopoverOpen,
panelPaddingSize: "none",
fullWidth: fullWidth,
closePopover: closePopover,
panelRef: setPopoverRef,
panelProps: {
'aria-live': undefined,
'aria-modal': false,
role: undefined
}
}, (0, _react2.jsx)("div", {
style: {
maxHeight: maxHeight
},
className: "eui-yScroll"
}, list));
}));
};
exports.EuiSuggest = EuiSuggest;
EuiSuggest.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.oneOfType([_propTypes.default.string.isRequired, _propTypes.default.string])]),
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* List of suggestions to display using EuiSuggestItem.
* Accepts props from #EuiSuggestItemProps
*/
suggestions: _propTypes.default.arrayOf(_propTypes.default.shape({
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* Takes `iconType` for EuiIcon and 'color'. 'color' can be tint1 through tint9.
*/
type: _propTypes.default.shape({
iconType: _propTypes.default.oneOfType([_propTypes.default.oneOf(["accessibility", "addDataApp", "advancedSettingsApp", "agentApp", "aggregate", "analyzeEvent", "annotation", "apmApp", "apmTrace", "appSearchApp", "apps", "arrowDown", "arrowLeft", "arrowRight", "arrowUp", "arrowStart", "arrowEnd", "article", "asterisk", "at", "auditbeatApp", "beaker", "bell", "bellSlash", "beta", "bolt", "boxesHorizontal", "boxesVertical", "branch", "branchUser", "broom", "brush", "bug", "bullseye", "calendar", "canvasApp", "casesApp", "check", "checkInCircleFilled", "cheer", "classificationJob", "clock", "cloudDrizzle", "cloudStormy", "cloudSunny", "cluster", "codeApp", "color", "compute", "console", "consoleApp", "container", "continuityAbove", "continuityAboveBelow", "continuityBelow", "continuityWithin", "controlsHorizontal", "controlsVertical", "copy", "copyClipboard", "createAdvancedJob", "createMultiMetricJob", "createPopulationJob", "createSingleMetricJob", "cross", "crossClusterReplicationApp", "crosshairs", "currency", "cut", "dashboardApp", "dataVisualizer", "database", "desktop", "devToolsApp", "discoverApp", "discuss", "document", "documentEdit", "documentation", "documents", "dot", "dotInCircle", "doubleArrowLeft", "doubleArrowRight", "download", "editorAlignCenter", "editorAlignLeft", "editorAlignRight", "editorBold", "editorChecklist", "editorCodeBlock", "editorComment", "editorDistributeHorizontal", "editorDistributeVertical", "editorHeading", "editorItalic", "editorItemAlignBottom", "editorItemAlignCenter", "editorItemAlignLeft", "editorItemAlignMiddle", "editorItemAlignRight", "editorItemAlignTop", "editorLink", "editorOrderedList", "editorPositionBottomLeft", "editorPositionBottomRight", "editorPositionTopLeft", "editorPositionTopRight", "editorRedo", "editorStrike", "editorTable", "editorUnderline", "editorUndo", "editorUnorderedList", "email", "empty", "emsApp", "eql", "eraser", "error", "exit", "expand", "expandMini", "exportAction", "eye", "eyeClosed", "faceHappy", "faceNeutral", "faceSad", "filebeatApp", "filter", "filterExclude", "filterIgnore", "filterInclude", "filterInCircle", "flag", "fleetApp", "fold", "folderCheck", "folderClosed", "folderExclamation", "folderOpen", "frameNext", "framePrevious", "fullScreen", "fullScreenExit", "function", "gear", "gisApp", "glasses", "globe", "grab", "grabHorizontal", "graphApp", "grid", "grokApp", "heart", "heartbeatApp", "heatmap", "help", "home", "iInCircle", "image", "importAction", "indexClose", "indexEdit", "indexFlush", "indexManagementApp", "indexMapping", "indexOpen", "indexPatternApp", "indexRollupApp", "indexRuntime", "indexSettings", "indexTemporary", "infinity", "inputOutput", "inspect", "invert", "ip", "key", "keyboard", "kqlField", "kqlFunction", "kqlOperand", "kqlSelector", "kqlValue", "kubernetesNode", "kubernetesPod", "launch", "layers", "lensApp", "lettering", "lineDashed", "lineDotted", "lineSolid", "link", "list", "listAdd", "lock", "lockOpen", "logoAWS", "logoAWSMono", "logoAerospike", "logoApache", "logoAppSearch", "logoAzure", "logoAzureMono", "logoBeats", "logoBusinessAnalytics", "logoCeph", "logoCloud", "logoCloudEnterprise", "logoCode", "logoCodesandbox", "logoCouchbase", "logoDocker", "logoDropwizard", "logoElastic", "logoElasticStack", "logoElasticsearch", "logoEnterpriseSearch", "logoEtcd", "logoGCP", "logoGCPMono", "logoGithub", "logoGmail", "logoGolang", "logoGoogleG", "logoHAproxy", "logoIBM", "logoIBMMono", "logoKafka", "logoKibana", "logoKubernetes", "logoLogging", "logoLogstash", "logoMaps", "logoMemcached", "logoMetrics", "logoMongodb", "logoMySQL", "logoNginx", "logoObservability", "logoOsquery", "logoPhp", "logoPostgres", "logoPrometheus", "logoRabbitmq", "logoRedis", "logoSecurity", "logoSiteSearch", "logoSketch", "logoSlack", "logoUptime", "logoVulnerabilityManagement", "logoWebhook", "logoWindows", "logoWorkplaceSearch", "logsApp", "logstashFilter", "logstashIf", "logstashInput", "logstashOutput", "logstashQueue", "machineLearningApp", "magnet", "magnifyWithExclamation", "magnifyWithMinus", "magnifyWithPlus", "managementApp", "mapMarker", "memory", "menu", "menuDown", "menuLeft", "menuRight", "menuUp", "merge", "metricbeatApp", "metricsApp", "minimize", "minus", "minusInCircle", "minusInCircleFilled", "mobile", "monitoringApp", "moon", "namespace", "nested", "node", "notebookApp", "number", "offline", "online", "outlierDetectionJob", "package", "packetbeatApp", "pageSelect", "pagesSelect", "paperClip", "partial", "pause", "payment", "pencil", "percent", "pin", "pinFilled", "pipelineApp", "pivot", "play", "playFilled", "plus", "plusInCircle", "plusInCircleFilled", "popout", "push", "questionInCircle", "quote", "recentlyViewedApp", "refresh", "regressionJob", "reporter", "reportingApp", "returnKey", "save", "savedObjectsApp", "scale", "search", "searchProfilerApp", "securityAnalyticsApp", "securityApp", "securitySignal", "securitySignalDetected", "securitySignalResolved", "sessionViewer", "shard", "share", "snowflake", "sortAscending", "sortDescending", "sortDown", "sortLeft", "sortRight", "sortUp", "sortable", "spaces", "spacesApp", "sparkles", "sqlApp", "starEmpty", "starEmptySpace", "starFilled", "starFilledSpace", "starMinusEmpty", "starMinusFilled", "starPlusEmpty", "starPlusFilled", "stats", "stop", "stopFilled", "stopSlash", "storage", "string", "submodule", "sun", "swatchInput", "symlink", "tableDensityCompact", "tableDensityExpanded", "tableDensityNormal", "tableOfContents", "tag", "tear", "temperature", "timeline", "timelineWithArrow", "timelionApp", "timeRefresh", "timeslider", "training", "trash", "unfold", "unlink", "upgradeAssistantApp", "uptimeApp", "user", "userAvatar", "users", "usersRolesApp", "vector", "videoPlayer", "visArea", "visAreaStacked", "visBarHorizontal", "visBarHorizontalStacked", "visBarVertical", "visBarVerticalStacked", "visGauge", "visGoal", "visLine", "visMapCoordinate", "visMapRegion", "visMetric", "visPie", "visTable", "visTagCloud", "visText", "visTimelion", "visVega", "visVisualBuilder", "visualizeApp", "vulnerabilityManagementApp", "warning", "alert", "watchesApp", "wordWrap", "wordWrapDisabled", "workplaceSearchApp", "wrench", "tokenAlias", "tokenAnnotation", "tokenArray", "tokenBinary", "tokenBoolean", "tokenClass", "tokenCompletionSuggester", "tokenConstant", "tokenDate", "tokenDenseVector", "tokenElement", "tokenEnum", "tokenEnumMember", "tokenEvent", "tokenException", "tokenField", "tokenFile", "tokenFlattened", "tokenFunction", "tokenGeo", "tokenHistogram", "tokenInterface", "tokenIP", "tokenJoin", "tokenKey", "tokenKeyword", "tokenMethod", "tokenMetricCounter", "tokenMetricGauge", "tokenModule", "tokenNamespace", "tokenNested", "tokenNull", "tokenNumber", "tokenObject", "tokenOperator", "tokenPackage", "tokenParameter", "tokenPercolator", "tokenProperty", "tokenRange", "tokenRankFeature", "tokenRankFeatures", "tokenRepo", "tokenSearchType", "tokenShape", "tokenString", "tokenStruct", "tokenSymbol", "tokenTag", "tokenText", "tokenTokenCount", "tokenVariable"]).isRequired, _propTypes.default.string.isRequired, _propTypes.default.elementType.isRequired]).isRequired,
color: _propTypes.default.oneOfType([_propTypes.default.string.isRequired, _propTypes.default.oneOf(["tint0", "tint1", "tint2", "tint3", "tint4", "tint5", "tint6", "tint7", "tint8", "tint9", "tint10"]).isRequired]).isRequired
}).isRequired,
/**
* Label or primary text.
*/
label: _propTypes.default.string.isRequired,
/**
* Description or secondary text (optional).
*/
description: _propTypes.default.string,
/**
* Percentage width of `label`.
* Accepts multiples of `10`, from `20` to `90`.
* Label will expand to 100% if `description` is not provided.
*/
labelWidth: _propTypes.default.oneOf(["20", "30", "40", "50", "60", "70", "80", "90", 20, 30, 40, 50, 60, 70, 80, 90]),
/**
* Truncates both label and description.
*/
truncate: _propTypes.default.bool
}).isRequired).isRequired,
/**
* Changes the content of the tooltip that wraps the status icon
*/
tooltipContent: _propTypes.default.string,
/**
* Status of the current query 'unsaved', 'saved', 'unchanged' or 'loading'.
*/
status: _propTypes.default.any,
/**
* Element to be appended to the input bar.
*/
append: _propTypes.default.any,
/**
* Handler for click on an EuiSuggestItem.
*/
onItemClick: _propTypes.default.func,
/**
* Callback function called when the input changes.
*/
onInput: _propTypes.default.func,
/**
* Callback function called when the search changes.
*/
onSearch: _propTypes.default.func,
/**
* Use virtualized rendering for list items with `react-window`.
* Best used when there are a lot of items.
*/
isVirtualized: _propTypes.default.bool,
/**
* Maximum height to set for the list.
* Default is `60vh`
*/
maxHeight: _propTypes.default.any,
/**
* Control whether or not options get filtered internally or if consumer will filter.
* Default `false`
*/
isPreFiltered: _propTypes.default.bool,
"aria-labelledby": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.string.isRequired])
};