mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-12-05 15:53:37 +08:00
09c6a3c240
- Updates old components to newer format, removes legacy component support. - Makes component registration easier and less duplicated. - Adds base component class to extend for better editor support. - Aligns global window exposure usage and aligns with other service names.
133 lines
3.8 KiB
JavaScript
133 lines
3.8 KiB
JavaScript
/**
|
|
* Run the given callback against each element that matches the given selector.
|
|
* @param {String} selector
|
|
* @param {Function<Element>} callback
|
|
*/
|
|
export function forEach(selector, callback) {
|
|
const elements = document.querySelectorAll(selector);
|
|
for (let element of elements) {
|
|
callback(element);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper to listen to multiple DOM events
|
|
* @param {Element} listenerElement
|
|
* @param {Array<String>} events
|
|
* @param {Function<Event>} callback
|
|
*/
|
|
export function onEvents(listenerElement, events, callback) {
|
|
for (let eventName of events) {
|
|
listenerElement.addEventListener(eventName, callback);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper to run an action when an element is selected.
|
|
* A "select" is made to be accessible, So can be a click, space-press or enter-press.
|
|
* @param {HTMLElement|Array} elements
|
|
* @param {function} callback
|
|
*/
|
|
export function onSelect(elements, callback) {
|
|
if (!Array.isArray(elements)) {
|
|
elements = [elements];
|
|
}
|
|
|
|
for (const listenerElement of elements) {
|
|
listenerElement.addEventListener('click', callback);
|
|
listenerElement.addEventListener('keydown', (event) => {
|
|
if (event.key === 'Enter' || event.key === ' ') {
|
|
event.preventDefault();
|
|
callback(event);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Listen to enter press on the given element(s).
|
|
* @param {HTMLElement|Array} elements
|
|
* @param {function} callback
|
|
*/
|
|
export function onEnterPress(elements, callback) {
|
|
if (!Array.isArray(elements)) {
|
|
elements = [elements];
|
|
}
|
|
|
|
const listener = event => {
|
|
if (event.key === 'Enter') {
|
|
callback(event);
|
|
}
|
|
}
|
|
|
|
elements.forEach(e => e.addEventListener('keypress', listener));
|
|
}
|
|
|
|
/**
|
|
* Set a listener on an element for an event emitted by a child
|
|
* matching the given childSelector param.
|
|
* Used in a similar fashion to jQuery's $('listener').on('eventName', 'childSelector', callback)
|
|
* @param {Element} listenerElement
|
|
* @param {String} childSelector
|
|
* @param {String} eventName
|
|
* @param {Function} callback
|
|
*/
|
|
export function onChildEvent(listenerElement, childSelector, eventName, callback) {
|
|
listenerElement.addEventListener(eventName, function(event) {
|
|
const matchingChild = event.target.closest(childSelector);
|
|
if (matchingChild) {
|
|
callback.call(matchingChild, event, matchingChild);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Look for elements that match the given selector and contain the given text.
|
|
* Is case insensitive and returns the first result or null if nothing is found.
|
|
* @param {String} selector
|
|
* @param {String} text
|
|
* @returns {Element}
|
|
*/
|
|
export function findText(selector, text) {
|
|
const elements = document.querySelectorAll(selector);
|
|
text = text.toLowerCase();
|
|
for (let element of elements) {
|
|
if (element.textContent.toLowerCase().includes(text)) {
|
|
return element;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Show a loading indicator in the given element.
|
|
* This will effectively clear the element.
|
|
* @param {Element} element
|
|
*/
|
|
export function showLoading(element) {
|
|
element.innerHTML = `<div class="loading-container"><div></div><div></div><div></div></div>`;
|
|
}
|
|
|
|
/**
|
|
* Remove any loading indicators within the given element.
|
|
* @param {Element} element
|
|
*/
|
|
export function removeLoading(element) {
|
|
const loadingEls = element.querySelectorAll('.loading-container');
|
|
for (const el of loadingEls) {
|
|
el.remove();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert the given html data into a live DOM element.
|
|
* Initiates any components defined in the data.
|
|
* @param {String} html
|
|
* @returns {Element}
|
|
*/
|
|
export function htmlToDom(html) {
|
|
const wrap = document.createElement('div');
|
|
wrap.innerHTML = html;
|
|
window.$components.init(wrap);
|
|
return wrap.children[0];
|
|
} |