]> BookStack Code Mirror - bookstack/blob - resources/js/services/dom.js
Added code editor changes mobile design handling
[bookstack] / resources / js / services / dom.js
1 /**
2  * Run the given callback against each element that matches the given selector.
3  * @param {String} selector
4  * @param {Function<Element>} callback
5  */
6 export function forEach(selector, callback) {
7     const elements = document.querySelectorAll(selector);
8     for (let element of elements) {
9         callback(element);
10     }
11 }
12
13 /**
14  * Helper to listen to multiple DOM events
15  * @param {Element} listenerElement
16  * @param {Array<String>} events
17  * @param {Function<Event>} callback
18  */
19 export function onEvents(listenerElement, events, callback) {
20     for (let eventName of events) {
21         listenerElement.addEventListener(eventName, callback);
22     }
23 }
24
25 /**
26  * Helper to run an action when an element is selected.
27  * A "select" is made to be accessible, So can be a click, space-press or enter-press.
28  * @param {HTMLElement|Array} elements
29  * @param {function} callback
30  */
31 export function onSelect(elements, callback) {
32     if (!Array.isArray(elements)) {
33         elements = [elements];
34     }
35
36     for (const listenerElement of elements) {
37         listenerElement.addEventListener('click', callback);
38         listenerElement.addEventListener('keydown', (event) => {
39             if (event.key === 'Enter' || event.key === ' ') {
40                 event.preventDefault();
41                 callback(event);
42             }
43         });
44     }
45 }
46
47 /**
48  * Listen to enter press on the given element(s).
49  * @param {HTMLElement|Array} elements
50  * @param {function} callback
51  */
52 export function onEnterPress(elements, callback) {
53     if (!Array.isArray(elements)) {
54         elements = [elements];
55     }
56
57     const listener = event => {
58         if (event.key === 'Enter') {
59             callback(event);
60         }
61     }
62
63     elements.forEach(e => e.addEventListener('keypress', listener));
64 }
65
66 /**
67  * Set a listener on an element for an event emitted by a child
68  * matching the given childSelector param.
69  * Used in a similar fashion to jQuery's $('listener').on('eventName', 'childSelector', callback)
70  * @param {Element} listenerElement
71  * @param {String} childSelector
72  * @param {String} eventName
73  * @param {Function} callback
74  */
75 export function onChildEvent(listenerElement, childSelector, eventName, callback) {
76     listenerElement.addEventListener(eventName, function(event) {
77         const matchingChild = event.target.closest(childSelector);
78         if (matchingChild) {
79             callback.call(matchingChild, event, matchingChild);
80         }
81     });
82 }
83
84 /**
85  * Look for elements that match the given selector and contain the given text.
86  * Is case insensitive and returns the first result or null if nothing is found.
87  * @param {String} selector
88  * @param {String} text
89  * @returns {Element}
90  */
91 export function findText(selector, text) {
92     const elements = document.querySelectorAll(selector);
93     text = text.toLowerCase();
94     for (let element of elements) {
95         if (element.textContent.toLowerCase().includes(text)) {
96             return element;
97         }
98     }
99     return null;
100 }
101
102 /**
103  * Show a loading indicator in the given element.
104  * This will effectively clear the element.
105  * @param {Element} element
106  */
107 export function showLoading(element) {
108     element.innerHTML = `<div class="loading-container"><div></div><div></div><div></div></div>`;
109 }
110
111 /**
112  * Remove any loading indicators within the given element.
113  * @param {Element} element
114  */
115 export function removeLoading(element) {
116     const loadingEls = element.querySelectorAll('.loading-container');
117     for (const el of loadingEls) {
118         el.remove();
119     }
120 }
Morty Proxy This is a proxified and sanitized view of the page, visit original site.