SearchPad.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551
  1. import {
  2. clear as domClear,
  3. delegate as domDelegate,
  4. query as domQuery,
  5. classes as domClasses,
  6. attr as domAttr,
  7. domify as domify
  8. } from 'min-dom';
  9. import {
  10. getBBox as getBoundingBox
  11. } from '../../util/Elements';
  12. import {
  13. escapeHTML
  14. } from '../../util/EscapeUtil';
  15. /**
  16. * Provides searching infrastructure
  17. */
  18. export default function SearchPad(canvas, eventBus, overlays, selection) {
  19. this._open = false;
  20. this._results = [];
  21. this._eventMaps = [];
  22. this._canvas = canvas;
  23. this._eventBus = eventBus;
  24. this._overlays = overlays;
  25. this._selection = selection;
  26. // setup elements
  27. this._container = domify(SearchPad.BOX_HTML);
  28. this._searchInput = domQuery(SearchPad.INPUT_SELECTOR, this._container);
  29. this._resultsContainer = domQuery(SearchPad.RESULTS_CONTAINER_SELECTOR, this._container);
  30. // attach search pad
  31. this._canvas.getContainer().appendChild(this._container);
  32. // cleanup on destroy
  33. eventBus.on([ 'canvas.destroy', 'diagram.destroy' ], this.close, this);
  34. }
  35. SearchPad.$inject = [
  36. 'canvas',
  37. 'eventBus',
  38. 'overlays',
  39. 'selection'
  40. ];
  41. /**
  42. * Binds and keeps track of all event listereners
  43. */
  44. SearchPad.prototype._bindEvents = function() {
  45. var self = this;
  46. function listen(el, selector, type, fn) {
  47. self._eventMaps.push({
  48. el: el,
  49. type: type,
  50. listener: domDelegate.bind(el, selector, type, fn)
  51. });
  52. }
  53. // close search on clicking anywhere outside
  54. listen(document, 'html', 'click', function(e) {
  55. self.close();
  56. }, true);
  57. // stop event from propagating and closing search
  58. // focus on input
  59. listen(this._container, SearchPad.INPUT_SELECTOR, 'click', function(e) {
  60. e.stopPropagation();
  61. e.delegateTarget.focus();
  62. });
  63. // preselect result on hover
  64. listen(this._container, SearchPad.RESULT_SELECTOR, 'mouseover', function(e) {
  65. e.stopPropagation();
  66. self._scrollToNode(e.delegateTarget);
  67. self._preselect(e.delegateTarget);
  68. });
  69. // selects desired result on mouse click
  70. listen(this._container, SearchPad.RESULT_SELECTOR, 'click', function(e) {
  71. e.stopPropagation();
  72. self._select(e.delegateTarget);
  73. });
  74. // prevent cursor in input from going left and right when using up/down to
  75. // navigate results
  76. listen(this._container, SearchPad.INPUT_SELECTOR, 'keydown', function(e) {
  77. // up
  78. if (e.keyCode === 38) {
  79. e.preventDefault();
  80. }
  81. // down
  82. if (e.keyCode === 40) {
  83. e.preventDefault();
  84. }
  85. });
  86. // handle keyboard input
  87. listen(this._container, SearchPad.INPUT_SELECTOR, 'keyup', function(e) {
  88. // escape
  89. if (e.keyCode === 27) {
  90. return self.close();
  91. }
  92. // enter
  93. if (e.keyCode === 13) {
  94. var selected = self._getCurrentResult();
  95. return selected ? self._select(selected) : self.close();
  96. }
  97. // up
  98. if (e.keyCode === 38) {
  99. return self._scrollToDirection(true);
  100. }
  101. // down
  102. if (e.keyCode === 40) {
  103. return self._scrollToDirection();
  104. }
  105. // left && right
  106. // do not search while navigating text input
  107. if (e.keyCode === 37 || e.keyCode === 39) {
  108. return;
  109. }
  110. // anything else
  111. self._search(e.delegateTarget.value);
  112. });
  113. };
  114. /**
  115. * Unbinds all previously established listeners
  116. */
  117. SearchPad.prototype._unbindEvents = function() {
  118. this._eventMaps.forEach(function(m) {
  119. domDelegate.unbind(m.el, m.type, m.listener);
  120. });
  121. };
  122. /**
  123. * Performs a search for the given pattern.
  124. *
  125. * @param {String} pattern
  126. */
  127. SearchPad.prototype._search = function(pattern) {
  128. var self = this;
  129. this._clearResults();
  130. // do not search on empty query
  131. if (!pattern || pattern === '') {
  132. return;
  133. }
  134. var searchResults = this._searchProvider.find(pattern);
  135. if (!searchResults.length) {
  136. return;
  137. }
  138. // append new results
  139. searchResults.forEach(function(result) {
  140. var id = result.element.id;
  141. var node = self._createResultNode(result, id);
  142. self._results[id] = {
  143. element: result.element,
  144. node: node
  145. };
  146. });
  147. // preselect first result
  148. var node = domQuery(SearchPad.RESULT_SELECTOR, this._resultsContainer);
  149. this._scrollToNode(node);
  150. this._preselect(node);
  151. };
  152. /**
  153. * Navigate to the previous/next result. Defaults to next result.
  154. * @param {Boolean} previous
  155. */
  156. SearchPad.prototype._scrollToDirection = function(previous) {
  157. var selected = this._getCurrentResult();
  158. if (!selected) {
  159. return;
  160. }
  161. var node = previous ? selected.previousElementSibling : selected.nextElementSibling;
  162. if (node) {
  163. this._scrollToNode(node);
  164. this._preselect(node);
  165. }
  166. };
  167. /**
  168. * Scroll to the node if it is not visible.
  169. *
  170. * @param {Element} node
  171. */
  172. SearchPad.prototype._scrollToNode = function(node) {
  173. if (!node || node === this._getCurrentResult()) {
  174. return;
  175. }
  176. var nodeOffset = node.offsetTop;
  177. var containerScroll = this._resultsContainer.scrollTop;
  178. var bottomScroll = nodeOffset - this._resultsContainer.clientHeight + node.clientHeight;
  179. if (nodeOffset < containerScroll) {
  180. this._resultsContainer.scrollTop = nodeOffset;
  181. } else if (containerScroll < bottomScroll) {
  182. this._resultsContainer.scrollTop = bottomScroll;
  183. }
  184. };
  185. /**
  186. * Clears all results data.
  187. */
  188. SearchPad.prototype._clearResults = function() {
  189. domClear(this._resultsContainer);
  190. this._results = [];
  191. this._resetOverlay();
  192. this._eventBus.fire('searchPad.cleared');
  193. };
  194. /**
  195. * Get currently selected result.
  196. *
  197. * @return {Element}
  198. */
  199. SearchPad.prototype._getCurrentResult = function() {
  200. return domQuery(SearchPad.RESULT_SELECTED_SELECTOR, this._resultsContainer);
  201. };
  202. /**
  203. * Create result DOM element within results container
  204. * that corresponds to a search result.
  205. *
  206. * 'result' : one of the elements returned by SearchProvider
  207. * 'id' : id attribute value to assign to the new DOM node
  208. * return : created DOM element
  209. *
  210. * @param {SearchResult} result
  211. * @param {String} id
  212. * @return {Element}
  213. */
  214. SearchPad.prototype._createResultNode = function(result, id) {
  215. var node = domify(SearchPad.RESULT_HTML);
  216. // create only if available
  217. if (result.primaryTokens.length > 0) {
  218. createInnerTextNode(node, result.primaryTokens, SearchPad.RESULT_PRIMARY_HTML);
  219. }
  220. // secondary tokens (represent element ID) are allways available
  221. createInnerTextNode(node, result.secondaryTokens, SearchPad.RESULT_SECONDARY_HTML);
  222. domAttr(node, SearchPad.RESULT_ID_ATTRIBUTE, id);
  223. this._resultsContainer.appendChild(node);
  224. return node;
  225. };
  226. /**
  227. * Register search element provider.
  228. *
  229. * SearchProvider.find - provides search function over own elements
  230. * (pattern) => [{ text: <String>, element: <Element>}, ...]
  231. *
  232. * @param {SearchProvider} provider
  233. */
  234. SearchPad.prototype.registerProvider = function(provider) {
  235. this._searchProvider = provider;
  236. };
  237. /**
  238. * Open search pad.
  239. */
  240. SearchPad.prototype.open = function() {
  241. if (!this._searchProvider) {
  242. throw new Error('no search provider registered');
  243. }
  244. if (this.isOpen()) {
  245. return;
  246. }
  247. this._bindEvents();
  248. this._open = true;
  249. domClasses(this._container).add('open');
  250. this._searchInput.focus();
  251. this._eventBus.fire('searchPad.opened');
  252. };
  253. /**
  254. * Close search pad.
  255. */
  256. SearchPad.prototype.close = function() {
  257. if (!this.isOpen()) {
  258. return;
  259. }
  260. this._unbindEvents();
  261. this._open = false;
  262. domClasses(this._container).remove('open');
  263. this._clearResults();
  264. this._searchInput.value = '';
  265. this._searchInput.blur();
  266. this._resetOverlay();
  267. this._eventBus.fire('searchPad.closed');
  268. };
  269. /**
  270. * Toggles search pad on/off.
  271. */
  272. SearchPad.prototype.toggle = function() {
  273. this.isOpen() ? this.close() : this.open();
  274. };
  275. /**
  276. * Report state of search pad.
  277. */
  278. SearchPad.prototype.isOpen = function() {
  279. return this._open;
  280. };
  281. /**
  282. * Preselect result entry.
  283. *
  284. * @param {Element} element
  285. */
  286. SearchPad.prototype._preselect = function(node) {
  287. var selectedNode = this._getCurrentResult();
  288. // already selected
  289. if (node === selectedNode) {
  290. return;
  291. }
  292. // removing preselection from current node
  293. if (selectedNode) {
  294. domClasses(selectedNode).remove(SearchPad.RESULT_SELECTED_CLASS);
  295. }
  296. var id = domAttr(node, SearchPad.RESULT_ID_ATTRIBUTE);
  297. var element = this._results[id].element;
  298. domClasses(node).add(SearchPad.RESULT_SELECTED_CLASS);
  299. this._resetOverlay(element);
  300. this._centerViewbox(element);
  301. this._selection.select(element);
  302. this._eventBus.fire('searchPad.preselected', element);
  303. };
  304. /**
  305. * Select result node.
  306. *
  307. * @param {Element} element
  308. */
  309. SearchPad.prototype._select = function(node) {
  310. var id = domAttr(node, SearchPad.RESULT_ID_ATTRIBUTE);
  311. var element = this._results[id].element;
  312. this.close();
  313. this._resetOverlay();
  314. this._centerViewbox(element);
  315. this._selection.select(element);
  316. this._eventBus.fire('searchPad.selected', element);
  317. };
  318. /**
  319. * Center viewbox on the element middle point.
  320. *
  321. * @param {Element} element
  322. */
  323. SearchPad.prototype._centerViewbox = function(element) {
  324. var viewbox = this._canvas.viewbox();
  325. var box = getBoundingBox(element);
  326. var newViewbox = {
  327. x: (box.x + box.width/2) - viewbox.outer.width/2,
  328. y: (box.y + box.height/2) - viewbox.outer.height/2,
  329. width: viewbox.outer.width,
  330. height: viewbox.outer.height
  331. };
  332. this._canvas.viewbox(newViewbox);
  333. this._canvas.zoom(viewbox.scale);
  334. };
  335. /**
  336. * Reset overlay removes and, optionally, set
  337. * overlay to a new element.
  338. *
  339. * @param {Element} element
  340. */
  341. SearchPad.prototype._resetOverlay = function(element) {
  342. if (this._overlayId) {
  343. this._overlays.remove(this._overlayId);
  344. }
  345. if (element) {
  346. var box = getBoundingBox(element);
  347. var overlay = constructOverlay(box);
  348. this._overlayId = this._overlays.add(element, overlay);
  349. }
  350. };
  351. /**
  352. * Construct overlay object for the given bounding box.
  353. *
  354. * @param {BoundingBox} box
  355. * @return {Object}
  356. */
  357. function constructOverlay(box) {
  358. var offset = 6;
  359. var w = box.width + offset * 2;
  360. var h = box.height + offset * 2;
  361. var styles = [
  362. 'width: '+ w +'px',
  363. 'height: '+ h + 'px'
  364. ].join('; ');
  365. return {
  366. position: {
  367. bottom: h - offset,
  368. right: w - offset
  369. },
  370. show: true,
  371. html: '<div style="' + styles + '" class="' + SearchPad.OVERLAY_CLASS + '"></div>'
  372. };
  373. }
  374. /**
  375. * Creates and appends child node from result tokens and HTML template.
  376. *
  377. * @param {Element} node
  378. * @param {Array<Object>} tokens
  379. * @param {String} template
  380. */
  381. function createInnerTextNode(parentNode, tokens, template) {
  382. var text = createHtmlText(tokens);
  383. var childNode = domify(template);
  384. childNode.innerHTML = text;
  385. parentNode.appendChild(childNode);
  386. }
  387. /**
  388. * Create internal HTML markup from result tokens.
  389. * Caters for highlighting pattern matched tokens.
  390. *
  391. * @param {Array<Object>} tokens
  392. * @return {String}
  393. */
  394. function createHtmlText(tokens) {
  395. var htmlText = '';
  396. tokens.forEach(function(t) {
  397. if (t.matched) {
  398. htmlText += '<strong class="' + SearchPad.RESULT_HIGHLIGHT_CLASS + '">' + escapeHTML(t.matched) + '</strong>';
  399. } else {
  400. htmlText += escapeHTML(t.normal);
  401. }
  402. });
  403. return htmlText !== '' ? htmlText : null;
  404. }
  405. /**
  406. * CONSTANTS
  407. */
  408. SearchPad.CONTAINER_SELECTOR = '.djs-search-container';
  409. SearchPad.INPUT_SELECTOR = '.djs-search-input input';
  410. SearchPad.RESULTS_CONTAINER_SELECTOR = '.djs-search-results';
  411. SearchPad.RESULT_SELECTOR = '.djs-search-result';
  412. SearchPad.RESULT_SELECTED_CLASS = 'djs-search-result-selected';
  413. SearchPad.RESULT_SELECTED_SELECTOR = '.' + SearchPad.RESULT_SELECTED_CLASS;
  414. SearchPad.RESULT_ID_ATTRIBUTE = 'data-result-id';
  415. SearchPad.RESULT_HIGHLIGHT_CLASS = 'djs-search-highlight';
  416. SearchPad.OVERLAY_CLASS = 'djs-search-overlay';
  417. SearchPad.BOX_HTML =
  418. '<div class="djs-search-container djs-draggable djs-scrollable">' +
  419. '<div class="djs-search-input">' +
  420. '<input type="text"/>' +
  421. '</div>' +
  422. '<div class="djs-search-results"></div>' +
  423. '</div>';
  424. SearchPad.RESULT_HTML =
  425. '<div class="djs-search-result"></div>';
  426. SearchPad.RESULT_PRIMARY_HTML =
  427. '<div class="djs-search-result-primary"></div>';
  428. SearchPad.RESULT_SECONDARY_HTML =
  429. '<p class="djs-search-result-secondary"></p>';