mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-29 12:16:04 +08:00
Removed jquery usage from page-display
This commit is contained in:
parent
7634a84334
commit
fdd34a74ed
|
@ -1,6 +1,7 @@
|
||||||
import MarkdownIt from "markdown-it";
|
import MarkdownIt from "markdown-it";
|
||||||
import mdTasksLists from 'markdown-it-task-lists';
|
import mdTasksLists from 'markdown-it-task-lists';
|
||||||
import code from '../services/code';
|
import code from '../services/code';
|
||||||
|
import {debounce} from "../services/util";
|
||||||
|
|
||||||
import DrawIO from "../services/drawio";
|
import DrawIO from "../services/drawio";
|
||||||
|
|
||||||
|
@ -104,14 +105,11 @@ class MarkdownEditor {
|
||||||
}
|
}
|
||||||
|
|
||||||
onMarkdownScroll(lineCount) {
|
onMarkdownScroll(lineCount) {
|
||||||
let elems = this.display.children;
|
const elems = this.display.children;
|
||||||
if (elems.length <= lineCount) return;
|
if (elems.length <= lineCount) return;
|
||||||
|
|
||||||
let topElem = (lineCount === -1) ? elems[elems.length-1] : elems[lineCount];
|
const topElem = (lineCount === -1) ? elems[elems.length-1] : elems[lineCount];
|
||||||
// TODO - Replace jQuery
|
topElem.scrollIntoView({ block: 'start', inline: 'nearest', behavior: 'smooth'});
|
||||||
$(this.display).animate({
|
|
||||||
scrollTop: topElem.offsetTop
|
|
||||||
}, {queue: false, duration: 200, easing: 'linear'});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
codeMirrorSetup() {
|
codeMirrorSetup() {
|
||||||
|
@ -160,8 +158,7 @@ class MarkdownEditor {
|
||||||
this.updateAndRender();
|
this.updateAndRender();
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle scroll to sync display view
|
const onScrollDebounced = debounce((instance) => {
|
||||||
cm.on('scroll', instance => {
|
|
||||||
// Thanks to http://liuhao.im/english/2015/11/10/the-sync-scroll-of-markdown-editor-in-javascript.html
|
// Thanks to http://liuhao.im/english/2015/11/10/the-sync-scroll-of-markdown-editor-in-javascript.html
|
||||||
let scroll = instance.getScrollInfo();
|
let scroll = instance.getScrollInfo();
|
||||||
let atEnd = scroll.top + scroll.clientHeight === scroll.height;
|
let atEnd = scroll.top + scroll.clientHeight === scroll.height;
|
||||||
|
@ -176,6 +173,11 @@ class MarkdownEditor {
|
||||||
let doc = parser.parseFromString(this.markdown.render(range), 'text/html');
|
let doc = parser.parseFromString(this.markdown.render(range), 'text/html');
|
||||||
let totalLines = doc.documentElement.querySelectorAll('body > *');
|
let totalLines = doc.documentElement.querySelectorAll('body > *');
|
||||||
this.onMarkdownScroll(totalLines.length);
|
this.onMarkdownScroll(totalLines.length);
|
||||||
|
}, 100);
|
||||||
|
|
||||||
|
// Handle scroll to sync display view
|
||||||
|
cm.on('scroll', instance => {
|
||||||
|
onScrollDebounced(instance);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Handle image paste
|
// Handle image paste
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
import Clipboard from "clipboard/dist/clipboard.min";
|
import Clipboard from "clipboard/dist/clipboard.min";
|
||||||
import Code from "../services/code";
|
import Code from "../services/code";
|
||||||
|
import * as DOM from "../services/dom";
|
||||||
|
|
||||||
class PageDisplay {
|
class PageDisplay {
|
||||||
|
|
||||||
|
@ -9,7 +10,6 @@ class PageDisplay {
|
||||||
|
|
||||||
Code.highlight();
|
Code.highlight();
|
||||||
this.setupPointer();
|
this.setupPointer();
|
||||||
this.setupStickySidebar();
|
|
||||||
this.setupNavHighlighting();
|
this.setupNavHighlighting();
|
||||||
|
|
||||||
// Check the hash on load
|
// Check the hash on load
|
||||||
|
@ -19,167 +19,130 @@ class PageDisplay {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sidebar page nav click event
|
// Sidebar page nav click event
|
||||||
$('.sidebar-page-nav').on('click', 'a', event => {
|
const sidebarPageNav = document.querySelector('.sidebar-page-nav');
|
||||||
|
DOM.onChildEvent(sidebarPageNav, 'a', 'click', (event, child) => {
|
||||||
window.components['tri-layout'][0].showContent();
|
window.components['tri-layout'][0].showContent();
|
||||||
this.goToText(event.target.getAttribute('href').substr(1));
|
this.goToText(child.getAttribute('href').substr(1));
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
goToText(text) {
|
goToText(text) {
|
||||||
let idElem = document.getElementById(text);
|
const idElem = document.getElementById(text);
|
||||||
$('.page-content [data-highlighted]').attr('data-highlighted', '').css('background-color', '');
|
|
||||||
|
DOM.forEach('.page-content [data-highlighted]', elem => {
|
||||||
|
elem.removeAttribute('data-highlighted');
|
||||||
|
elem.style.backgroundColor = null;
|
||||||
|
});
|
||||||
|
|
||||||
if (idElem !== null) {
|
if (idElem !== null) {
|
||||||
window.scrollAndHighlight(idElem);
|
window.scrollAndHighlight(idElem);
|
||||||
} else {
|
} else {
|
||||||
$('.page-content').find(':contains("' + text + '")').smoothScrollTo();
|
const textElem = DOM.findText('.page-content > div > *', text);
|
||||||
|
if (textElem) {
|
||||||
|
window.scrollAndHighlight(textElem);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
setupPointer() {
|
setupPointer() {
|
||||||
if (document.getElementById('pointer') === null) return;
|
let pointer = document.getElementById('pointer');
|
||||||
|
if (!pointer) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// Set up pointer
|
// Set up pointer
|
||||||
let $pointer = $('#pointer').detach();
|
pointer = pointer.parentNode.removeChild(pointer);
|
||||||
|
const pointerInner = pointer.querySelector('div.pointer');
|
||||||
|
|
||||||
|
// Instance variables
|
||||||
let pointerShowing = false;
|
let pointerShowing = false;
|
||||||
let $pointerInner = $pointer.children('div.pointer').first();
|
|
||||||
let isSelection = false;
|
let isSelection = false;
|
||||||
let pointerModeLink = true;
|
let pointerModeLink = true;
|
||||||
let pointerSectionId = '';
|
let pointerSectionId = '';
|
||||||
|
|
||||||
// Select all contents on input click
|
// Select all contents on input click
|
||||||
$pointer.on('click', 'input', event => {
|
DOM.onChildEvent(pointer, 'input', 'click', (event, input) => {
|
||||||
$(this).select();
|
input.select();
|
||||||
event.stopPropagation();
|
event.stopPropagation();
|
||||||
});
|
});
|
||||||
|
|
||||||
$pointer.on('click focus', event => {
|
// Prevent closing pointer when clicked or focused
|
||||||
|
DOM.onEvents(pointer, ['click', 'focus'], event => {
|
||||||
event.stopPropagation();
|
event.stopPropagation();
|
||||||
});
|
});
|
||||||
|
|
||||||
// Pointer mode toggle
|
// Pointer mode toggle
|
||||||
$pointer.on('click', 'span.icon', event => {
|
DOM.onChildEvent(pointer, 'span.icon', 'click', (event, icon) => {
|
||||||
event.stopPropagation();
|
event.stopPropagation();
|
||||||
let $icon = $(event.currentTarget);
|
|
||||||
pointerModeLink = !pointerModeLink;
|
pointerModeLink = !pointerModeLink;
|
||||||
$icon.find('[data-icon="include"]').toggle(!pointerModeLink);
|
icon.querySelector('[data-icon="include"]').style.display = (!pointerModeLink) ? 'inline' : 'none';
|
||||||
$icon.find('[data-icon="link"]').toggle(pointerModeLink);
|
icon.querySelector('[data-icon="link"]').style.display = (pointerModeLink) ? 'inline' : 'none';
|
||||||
updatePointerContent();
|
updatePointerContent();
|
||||||
});
|
});
|
||||||
|
|
||||||
// Set up clipboard
|
// Set up clipboard
|
||||||
let clipboard = new Clipboard($pointer[0].querySelector('button'));
|
new Clipboard(pointer.querySelector('button'));
|
||||||
|
|
||||||
// Hide pointer when clicking away
|
// Hide pointer when clicking away
|
||||||
$(document.body).find('*').on('click focus', event => {
|
DOM.onEvents(document.body, ['click', 'focus'], event => {
|
||||||
if (!pointerShowing || isSelection) return;
|
if (!pointerShowing || isSelection) return;
|
||||||
$pointer.detach();
|
pointer = pointer.parentElement.removeChild(pointer);
|
||||||
pointerShowing = false;
|
pointerShowing = false;
|
||||||
});
|
});
|
||||||
|
|
||||||
let updatePointerContent = ($elem) => {
|
let updatePointerContent = (element) => {
|
||||||
let inputText = pointerModeLink ? window.baseUrl(`/link/${this.pageId}#${pointerSectionId}`) : `{{@${this.pageId}#${pointerSectionId}}}`;
|
let inputText = pointerModeLink ? window.baseUrl(`/link/${this.pageId}#${pointerSectionId}`) : `{{@${this.pageId}#${pointerSectionId}}}`;
|
||||||
if (pointerModeLink && inputText.indexOf('http') !== 0) inputText = window.location.protocol + "//" + window.location.host + inputText;
|
if (pointerModeLink && !inputText.startsWith('http')) {
|
||||||
|
inputText = window.location.protocol + "//" + window.location.host + inputText;
|
||||||
|
}
|
||||||
|
|
||||||
$pointer.find('input').val(inputText);
|
pointer.querySelector('input').value = inputText;
|
||||||
|
|
||||||
// update anchor if present
|
// Update anchor if present
|
||||||
const $editAnchor = $pointer.find('#pointer-edit');
|
const editAnchor = pointer.querySelector('#pointer-edit');
|
||||||
if ($editAnchor.length !== 0 && $elem) {
|
if (editAnchor && element) {
|
||||||
const editHref = $editAnchor.data('editHref');
|
const editHref = editAnchor.dataset.editHref;
|
||||||
const element = $elem[0];
|
|
||||||
const elementId = element.id;
|
const elementId = element.id;
|
||||||
|
|
||||||
// get the first 50 characters.
|
// get the first 50 characters.
|
||||||
let queryContent = element.textContent && element.textContent.substring(0, 50);
|
const queryContent = element.textContent && element.textContent.substring(0, 50);
|
||||||
$editAnchor[0].href = `${editHref}?content-id=${elementId}&content-text=${encodeURIComponent(queryContent)}`;
|
editAnchor.href = `${editHref}?content-id=${elementId}&content-text=${encodeURIComponent(queryContent)}`;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// Show pointer when selecting a single block of tagged content
|
// Show pointer when selecting a single block of tagged content
|
||||||
$('.page-content [id^="bkmrk"]').on('mouseup keyup', function (e) {
|
DOM.forEach('.page-content [id^="bkmrk"]', bookMarkElem => {
|
||||||
e.stopPropagation();
|
DOM.onEvents(bookMarkElem, ['mouseup', 'keyup'], event => {
|
||||||
|
event.stopPropagation();
|
||||||
let selection = window.getSelection();
|
let selection = window.getSelection();
|
||||||
if (selection.toString().length === 0) return;
|
if (selection.toString().length === 0) return;
|
||||||
|
|
||||||
// Show pointer and set link
|
// Show pointer and set link
|
||||||
let $elem = $(this);
|
pointerSectionId = bookMarkElem.id;
|
||||||
pointerSectionId = $elem.attr('id');
|
updatePointerContent(bookMarkElem);
|
||||||
updatePointerContent($elem);
|
|
||||||
|
|
||||||
$elem.before($pointer);
|
bookMarkElem.parentNode.insertBefore(pointer, bookMarkElem);
|
||||||
$pointer.show();
|
pointer.style.display = 'block';
|
||||||
pointerShowing = true;
|
pointerShowing = true;
|
||||||
|
isSelection = true;
|
||||||
|
|
||||||
// Set pointer to sit near mouse-up position
|
// Set pointer to sit near mouse-up position
|
||||||
let pointerLeftOffset = (e.pageX - $elem.offset().left - ($pointerInner.width() / 2));
|
requestAnimationFrame(() => {
|
||||||
if (pointerLeftOffset < 0) pointerLeftOffset = 0;
|
const bookMarkBounds = bookMarkElem.getBoundingClientRect();
|
||||||
let pointerLeftOffsetPercent = (pointerLeftOffset / $elem.width()) * 100;
|
let pointerLeftOffset = (event.pageX - bookMarkBounds.left - 164);
|
||||||
$pointerInner.css('left', pointerLeftOffsetPercent + '%');
|
if (pointerLeftOffset < 0) {
|
||||||
|
pointerLeftOffset = 0
|
||||||
|
}
|
||||||
|
const pointerLeftOffsetPercent = (pointerLeftOffset / bookMarkBounds.width) * 100;
|
||||||
|
|
||||||
|
pointerInner.style.left = pointerLeftOffsetPercent + '%';
|
||||||
|
|
||||||
isSelection = true;
|
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
isSelection = false;
|
isSelection = false;
|
||||||
}, 100);
|
}, 100);
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
setupStickySidebar() {
|
});
|
||||||
// Make the sidebar stick in view on scroll
|
|
||||||
const $window = $(window);
|
|
||||||
const $sidebar = $("#sidebar .scroll-body");
|
|
||||||
const $sidebarContainer = $sidebar.parent();
|
|
||||||
const sidebarHeight = $sidebar.height() + 32;
|
|
||||||
|
|
||||||
// Check the page is scrollable and the content is taller than the tree
|
|
||||||
const pageScrollable = ($(document).height() > ($window.height() + 40)) && (sidebarHeight < $('.page-content').height());
|
|
||||||
|
|
||||||
// Get current tree's width and header height
|
|
||||||
const headerHeight = $("#header").height() + $(".toolbar").height();
|
|
||||||
let isFixed = $window.scrollTop() > headerHeight;
|
|
||||||
|
|
||||||
// Fix the tree as a sidebar
|
|
||||||
function stickTree() {
|
|
||||||
$sidebar.width($sidebarContainer.width() + 15);
|
|
||||||
$sidebar.addClass("fixed");
|
|
||||||
isFixed = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Un-fix the tree back into position
|
|
||||||
function unstickTree() {
|
|
||||||
$sidebar.css('width', 'auto');
|
|
||||||
$sidebar.removeClass("fixed");
|
|
||||||
isFixed = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Checks if the tree stickiness state should change
|
|
||||||
function checkTreeStickiness(skipCheck) {
|
|
||||||
let shouldBeFixed = $window.scrollTop() > headerHeight;
|
|
||||||
if (shouldBeFixed && (!isFixed || skipCheck)) {
|
|
||||||
stickTree();
|
|
||||||
} else if (!shouldBeFixed && (isFixed || skipCheck)) {
|
|
||||||
unstickTree();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// The event ran when the window scrolls
|
|
||||||
function windowScrollEvent() {
|
|
||||||
checkTreeStickiness(false);
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the page is scrollable and the window is wide enough listen to scroll events
|
|
||||||
// and evaluate tree stickiness.
|
|
||||||
if (pageScrollable && $window.width() > 1000) {
|
|
||||||
$window.on('scroll', windowScrollEvent);
|
|
||||||
checkTreeStickiness(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle window resizing and switch between desktop/mobile views
|
|
||||||
$window.on('resize', event => {
|
|
||||||
if (pageScrollable && $window.width() > 1000) {
|
|
||||||
$window.on('scroll', windowScrollEvent);
|
|
||||||
checkTreeStickiness(true);
|
|
||||||
} else {
|
|
||||||
$window.off('scroll', windowScrollEvent);
|
|
||||||
unstickTree();
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -222,10 +185,9 @@ class PageDisplay {
|
||||||
}
|
}
|
||||||
|
|
||||||
function toggleAnchorHighlighting(elementId, shouldHighlight) {
|
function toggleAnchorHighlighting(elementId, shouldHighlight) {
|
||||||
const anchorsToHighlight = pageNav.querySelectorAll('a[href="#' + elementId + '"]');
|
DOM.forEach('a[href="#' + elementId + '"]', anchor => {
|
||||||
for (let anchor of anchorsToHighlight) {
|
|
||||||
anchor.closest('li').classList.toggle('current-heading', shouldHighlight);
|
anchor.closest('li').classList.toggle('current-heading', shouldHighlight);
|
||||||
}
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
59
resources/assets/js/services/dom.js
Normal file
59
resources/assets/js/services/dom.js
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
/**
|
||||||
|
* 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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
}
|
27
resources/assets/js/services/util.js
Normal file
27
resources/assets/js/services/util.js
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a function, that, as long as it continues to be invoked, will not
|
||||||
|
* be triggered. The function will be called after it stops being called for
|
||||||
|
* N milliseconds. If `immediate` is passed, trigger the function on the
|
||||||
|
* leading edge, instead of the trailing.
|
||||||
|
* @attribution https://davidwalsh.name/javascript-debounce-function
|
||||||
|
* @param func
|
||||||
|
* @param wait
|
||||||
|
* @param immediate
|
||||||
|
* @returns {Function}
|
||||||
|
*/
|
||||||
|
export function debounce(func, wait, immediate) {
|
||||||
|
let timeout;
|
||||||
|
return function() {
|
||||||
|
const context = this, args = arguments;
|
||||||
|
const later = function() {
|
||||||
|
timeout = null;
|
||||||
|
if (!immediate) func.apply(context, args);
|
||||||
|
};
|
||||||
|
const callNow = immediate && !timeout;
|
||||||
|
clearTimeout(timeout);
|
||||||
|
timeout = setTimeout(later, wait);
|
||||||
|
if (callNow) func.apply(context, args);
|
||||||
|
};
|
||||||
|
};
|
Loading…
Reference in New Issue
Block a user