UNPKG

devextreme

Version:

HTML5 JavaScript Component Suite for Responsive Web Development

328 lines (324 loc) • 13.6 kB
/** * DevExtreme (esm/__internal/grids/grid_core/search/m_search.js) * Version: 23.2.6 * Build date: Wed May 01 2024 * * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ import domAdapter from "../../../../core/dom_adapter"; import $ from "../../../../core/renderer"; import { compileGetter, toComparable } from "../../../../core/utils/data"; import dataQuery from "../../../../data/query"; import messageLocalization from "../../../../localization/message"; import gridCoreUtils from "../m_utils"; var SEARCH_PANEL_CLASS = "search-panel"; var SEARCH_TEXT_CLASS = "search-text"; var HEADER_PANEL_CLASS = "header-panel"; var FILTERING_TIMEOUT = 700; function allowSearch(column) { var _a; return !!(null !== (_a = column.allowSearch) && void 0 !== _a ? _a : column.allowFiltering) } function parseValue(column, text) { var { lookup: lookup } = column; if (!column.parseValue) { return text } if (lookup) { return column.parseValue.call(lookup, text) } return column.parseValue(text) } var dataController = base => class extends base { optionChanged(args) { switch (args.fullName) { case "searchPanel.text": case "searchPanel": this._applyFilter(); args.handled = true; break; default: super.optionChanged(args) } } publicMethods() { return super.publicMethods().concat(["searchByText"]) } _calculateAdditionalFilter() { var filter = super._calculateAdditionalFilter(); var searchFilter = this.calculateSearchFilter(this.option("searchPanel.text")); return gridCoreUtils.combineFilters([filter, searchFilter]) } searchByText(text) { this.option("searchPanel.text", text) } calculateSearchFilter(text) { var i; var column; var columns = this._columnsController.getColumns(); var searchVisibleColumnsOnly = this.option("searchPanel.searchVisibleColumnsOnly"); var lookup; var filters = []; if (!text) { return null } function onQueryDone(items) { var valueGetter = compileGetter(lookup.valueExpr); for (var _i = 0; _i < items.length; _i++) { var value = valueGetter(items[_i]); filters.push(column.createFilterExpression(value, null, "search")) } } for (i = 0; i < columns.length; i++) { column = columns[i]; if (searchVisibleColumnsOnly && !column.visible) { continue } if (allowSearch(column) && column.calculateFilterExpression) { lookup = column.lookup; var filterValue = parseValue(column, text); if (lookup && lookup.items) { dataQuery(lookup.items).filter(column.createFilterExpression.call({ dataField: lookup.displayExpr, dataType: lookup.dataType, calculateFilterExpression: column.calculateFilterExpression }, filterValue, null, "search")).enumerate().done(onQueryDone) } else if (void 0 !== filterValue) { filters.push(column.createFilterExpression(filterValue, null, "search")) } } } if (0 === filters.length) { return ["!"] } return gridCoreUtils.combineFilters(filters, "or") } }; var headerPanel = Base => class extends Base { optionChanged(args) { if ("searchPanel" === args.name) { if ("searchPanel.text" === args.fullName) { var editor = this.getSearchTextEditor(); if (editor) { editor.option("value", args.value) } } else { this._invalidate() } args.handled = true } else { super.optionChanged(args) } } _getToolbarItems() { var items = super._getToolbarItems(); return this._prepareSearchItem(items) } _prepareSearchItem(items) { var that = this; var dataController = this._dataController; var searchPanelOptions = this.option("searchPanel"); if (searchPanelOptions && searchPanelOptions.visible) { var toolbarItem = { template(data, index, container) { var $search = $("<div>").addClass(that.addWidgetPrefix(SEARCH_PANEL_CLASS)).appendTo(container); that._editorFactoryController.createEditor($search, { width: searchPanelOptions.width, placeholder: searchPanelOptions.placeholder, parentType: "searchPanel", value: that.option("searchPanel.text"), updateValueTimeout: FILTERING_TIMEOUT, setValue(value) { dataController.searchByText(value) }, editorOptions: { inputAttr: { "aria-label": messageLocalization.format("".concat(that.component.NAME, "-ariaSearchInGrid")) } } }); that.resize() }, name: "searchPanel", location: "after", locateInMenu: "never", sortIndex: 40 }; items.push(toolbarItem) } return items } getSearchTextEditor() { var that = this; var $element = that.element(); var $searchPanel = $element.find(".".concat(that.addWidgetPrefix(SEARCH_PANEL_CLASS))).filter((function() { return $(this).closest(".".concat(that.addWidgetPrefix(HEADER_PANEL_CLASS))).is($element) })); if ($searchPanel.length) { return $searchPanel.dxTextBox("instance") } return null } isVisible() { var searchPanelOptions = this.option("searchPanel"); return super.isVisible() || !!(null === searchPanelOptions || void 0 === searchPanelOptions ? void 0 : searchPanelOptions.visible) } }; var rowsView = Base => class extends Base { init() { super.init.apply(this, arguments); this._searchParams = []; this._dataController = this.getController("data") } dispose() { clearTimeout(this._highlightTimer); super.dispose() } _getFormattedSearchText(column, searchText) { var value = parseValue(column, searchText); var formatOptions = gridCoreUtils.getFormatOptionsByColumn(column, "search"); return gridCoreUtils.formatValue(value, formatOptions) } _getStringNormalizer() { var _a, _b, _c, _d; var isCaseSensitive = this.option("searchPanel.highlightCaseSensitive"); var dataSource = null === (_b = null === (_a = this._dataController) || void 0 === _a ? void 0 : _a.getDataSource) || void 0 === _b ? void 0 : _b.call(_a); var langParams = null === (_d = null === (_c = null === dataSource || void 0 === dataSource ? void 0 : dataSource.loadOptions) || void 0 === _c ? void 0 : _c.call(dataSource)) || void 0 === _d ? void 0 : _d.langParams; return str => toComparable(str, isCaseSensitive, langParams) } _findHighlightingTextNodes(column, cellElement, searchText) { var $parent = cellElement.parent(); var $items; var stringNormalizer = this._getStringNormalizer(); var normalizedSearchText = stringNormalizer(searchText); var resultTextNodes = []; if (!$parent.length) { $parent = $("<div>").append(cellElement) } else if (column) { if (column.groupIndex >= 0 && !column.showWhenGrouped) { $items = cellElement } else { var columnIndex = this._columnsController.getVisibleIndex(column.index); $items = $parent.children("td").eq(columnIndex).find("*") } } $items = (null === $items || void 0 === $items ? void 0 : $items.length) ? $items : $parent.find("*"); $items.each((_, element) => { var _a, _b; var $contents = $(element).contents(); for (var i = 0; i < $contents.length; i++) { var node = $contents.get(i); if (3 === node.nodeType) { var normalizedText = stringNormalizer(null !== (_b = null !== (_a = node.textContent) && void 0 !== _a ? _a : node.nodeValue) && void 0 !== _b ? _b : ""); if (normalizedText.includes(normalizedSearchText)) { resultTextNodes.push(node) } } } }); return resultTextNodes } _highlightSearchTextCore($textNode, searchText) { var $searchTextSpan = $("<span>").addClass(this.addWidgetPrefix(SEARCH_TEXT_CLASS)); var text = $textNode.text(); var firstContentElement = $textNode[0]; var stringNormalizer = this._getStringNormalizer(); var index = stringNormalizer(text).indexOf(stringNormalizer(searchText)); if (index >= 0) { if (firstContentElement.textContent) { firstContentElement.textContent = text.substr(0, index) } else { firstContentElement.nodeValue = text.substr(0, index) } $textNode.after($searchTextSpan.text(text.substr(index, searchText.length))); $textNode = $(domAdapter.createTextNode(text.substr(index + searchText.length))).insertAfter($searchTextSpan); return this._highlightSearchTextCore($textNode, searchText) } } _highlightSearchText(cellElement, isEquals, column) { var that = this; var stringNormalizer = this._getStringNormalizer(); var searchText = that.option("searchPanel.text"); if (isEquals && column) { searchText = searchText && that._getFormattedSearchText(column, searchText) } if (searchText && that.option("searchPanel.highlightSearchText")) { var textNodes = that._findHighlightingTextNodes(column, cellElement, searchText); textNodes.forEach(textNode => { if (isEquals) { if (stringNormalizer($(textNode).text()) === stringNormalizer(null !== searchText && void 0 !== searchText ? searchText : "")) { $(textNode).replaceWith($("<span>").addClass(that.addWidgetPrefix(SEARCH_TEXT_CLASS)).text($(textNode).text())) } } else { that._highlightSearchTextCore($(textNode), searchText) } }) } } _renderCore() { var deferred = super._renderCore.apply(this, arguments); if (this.option().rowTemplate || this.option("dataRowTemplate")) { if (this.option("templatesRenderAsynchronously")) { clearTimeout(this._highlightTimer); this._highlightTimer = setTimeout(() => { this._highlightSearchText(this.getTableElement()) }) } else { this._highlightSearchText(this.getTableElement()) } } return deferred } _updateCell($cell, parameters) { var { column: column } = parameters; var dataType = column.lookup && column.lookup.dataType || column.dataType; var isEquals = "string" !== dataType; if (allowSearch(column) && !parameters.isOnForm) { if (this.option("templatesRenderAsynchronously")) { if (!this._searchParams.length) { clearTimeout(this._highlightTimer); this._highlightTimer = setTimeout(() => { this._searchParams.forEach(params => { this._highlightSearchText.apply(this, params) }); this._searchParams = [] }) } this._searchParams.push([$cell, isEquals, column]) } else { this._highlightSearchText($cell, isEquals, column) } } super._updateCell($cell, parameters) } }; export var searchModule = { defaultOptions: () => ({ searchPanel: { visible: false, width: 160, placeholder: messageLocalization.format("dxDataGrid-searchPanelPlaceholder"), highlightSearchText: true, highlightCaseSensitive: false, text: "", searchVisibleColumnsOnly: false } }), extenders: { controllers: { data: dataController }, views: { headerPanel: headerPanel, rowsView: rowsView } } };