mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-06-21 04:49:54 +00:00
268 lines
8.9 KiB
JavaScript
268 lines
8.9 KiB
JavaScript
/*\
|
|
title: $:/plugins/tiddlywiki/dynaview/dynaview.js
|
|
type: application/javascript
|
|
module-type: startup
|
|
|
|
Zoom everything
|
|
|
|
\*/
|
|
(function(){
|
|
|
|
/*jslint node: true, browser: true */
|
|
/*global $tw: false */
|
|
"use strict";
|
|
|
|
// Export name and synchronous status
|
|
exports.name = "dynaview";
|
|
exports.platforms = ["browser"];
|
|
exports.before = ["story"];
|
|
exports.synchronous = true;
|
|
|
|
var STATE_OUT_OF_VIEW = "0",
|
|
STATE_NEAR_VIEW = "1",
|
|
STATE_IN_VIEW = "2";
|
|
|
|
var isWaitingForAnimationFrame = 0, // Bitmask:
|
|
ANIM_FRAME_CAUSED_BY_LOAD = 1, // Animation frame was requested because of page load
|
|
ANIM_FRAME_CAUSED_BY_SCROLL = 2, // Animation frame was requested because of page scroll
|
|
ANIM_FRAME_CAUSED_BY_RESIZE = 4; // Animation frame was requested because of window resize
|
|
|
|
var LOCAL_STORAGE_KEY_PREFIX = "tw5-dynaview-scroll-position#";
|
|
|
|
var hasRestoredScrollPosition = false;
|
|
|
|
var localStorageHasFailed = false;
|
|
|
|
exports.startup = function() {
|
|
var topmost = null, lastScrollY;
|
|
$tw.boot.disableStartupNavigation = true;
|
|
window.addEventListener("load",onLoad,false);
|
|
window.addEventListener("scroll",onScroll,false);
|
|
window.addEventListener("resize",onResize,false);
|
|
$tw.hooks.addHook("th-page-refreshing",function() {
|
|
if(!hasRestoredScrollPosition) {
|
|
topmost = restoreScrollPosition();
|
|
} else if(shouldPreserveScrollPosition()) {
|
|
topmost = findTopmostTiddler();
|
|
}
|
|
lastScrollY = window.scrollY;
|
|
});
|
|
$tw.hooks.addHook("th-page-refreshed",function() {
|
|
if(lastScrollY === window.scrollY) { // Don't do scroll anchoring if the scroll position got changed
|
|
if(shouldPreserveScrollPosition() || !hasRestoredScrollPosition) {
|
|
scrollToTiddler(topmost);
|
|
hasRestoredScrollPosition = true;
|
|
}
|
|
}
|
|
updateAddressBar();
|
|
saveScrollPosition();
|
|
checkVisibility();
|
|
saveViewportDimensions();
|
|
});
|
|
};
|
|
|
|
function onLoad(event) {
|
|
if(!isWaitingForAnimationFrame) {
|
|
window.requestAnimationFrame(worker);
|
|
}
|
|
isWaitingForAnimationFrame |= ANIM_FRAME_CAUSED_BY_LOAD;
|
|
}
|
|
|
|
function onScroll(event) {
|
|
if(!isWaitingForAnimationFrame) {
|
|
window.requestAnimationFrame(worker);
|
|
}
|
|
isWaitingForAnimationFrame |= ANIM_FRAME_CAUSED_BY_SCROLL;
|
|
}
|
|
|
|
function onResize(event) {
|
|
if(!isWaitingForAnimationFrame) {
|
|
window.requestAnimationFrame(worker);
|
|
}
|
|
isWaitingForAnimationFrame |= ANIM_FRAME_CAUSED_BY_RESIZE;
|
|
}
|
|
|
|
function worker() {
|
|
if(isWaitingForAnimationFrame & (ANIM_FRAME_CAUSED_BY_RESIZE | ANIM_FRAME_CAUSED_BY_LOAD)) {
|
|
saveViewportDimensions();
|
|
}
|
|
setZoomClasses();
|
|
updateAddressBar();
|
|
saveScrollPosition();
|
|
checkVisibility();
|
|
isWaitingForAnimationFrame = 0;
|
|
}
|
|
|
|
function setZoomClasses() {
|
|
var zoomFactor = document.body.scrollWidth / window.innerWidth,
|
|
classList = document.body.classList;
|
|
classList.add("tc-dynaview");
|
|
classList.toggle("tc-dynaview-zoom-factor-1",zoomFactor <= 2);
|
|
classList.toggle("tc-dynaview-zoom-factor-1-and-above",zoomFactor >= 1);
|
|
classList.toggle("tc-dynaview-zoom-factor-1a-and-above",zoomFactor >= 1.14);
|
|
classList.toggle("tc-dynaview-zoom-factor-1b-and-above",zoomFactor >= 1.33);
|
|
classList.toggle("tc-dynaview-zoom-factor-1c-and-above",zoomFactor >= 1.6);
|
|
classList.toggle("tc-dynaview-zoom-factor-2",zoomFactor >= 2 && zoomFactor <= 3);
|
|
classList.toggle("tc-dynaview-zoom-factor-2-and-above",zoomFactor >= 2);
|
|
classList.toggle("tc-dynaview-zoom-factor-2a-and-above",zoomFactor >= 2.66);
|
|
classList.toggle("tc-dynaview-zoom-factor-3",zoomFactor >= 3 && zoomFactor <= 4);
|
|
classList.toggle("tc-dynaview-zoom-factor-3-and-above",zoomFactor >= 3);
|
|
classList.toggle("tc-dynaview-zoom-factor-4",zoomFactor >= 4);
|
|
classList.toggle("tc-dynaview-zoom-factor-4-and-above",zoomFactor >= 4);
|
|
}
|
|
|
|
function checkVisibility() {
|
|
var elements = document.querySelectorAll(".tc-dynaview-track-tiddler-when-visible");
|
|
$tw.utils.each(elements,function(element) {
|
|
// Calculate whether the element is visible
|
|
var elementRect = element.getBoundingClientRect(),
|
|
viewportWidth = window.innerWidth || document.documentElement.clientWidth,
|
|
viewportHeight = window.innerHeight || document.documentElement.clientHeight,
|
|
viewportRect = {
|
|
left: 0,
|
|
right: viewportWidth,
|
|
top: 0,
|
|
bottom: viewportHeight
|
|
},
|
|
title = element.getAttribute("data-dynaview-track-tiddler");
|
|
if(title) {
|
|
var currValue = $tw.wiki.getTiddlerText(title),
|
|
newValue = currValue;
|
|
// Within viewport
|
|
if(!(elementRect.left > viewportRect.right ||
|
|
elementRect.right < viewportRect.left ||
|
|
elementRect.top > viewportRect.bottom ||
|
|
elementRect.bottom < viewportRect.top)) {
|
|
newValue = STATE_IN_VIEW;
|
|
// Near viewport
|
|
} else if(!(elementRect.left > (viewportRect.right + viewportWidth) ||
|
|
elementRect.right < (viewportRect.left - viewportWidth) ||
|
|
elementRect.top > (viewportRect.bottom + viewportHeight) ||
|
|
elementRect.bottom < (viewportRect.top - viewportHeight))) {
|
|
newValue = STATE_NEAR_VIEW;
|
|
} else {
|
|
// Outside viewport
|
|
if(currValue !== undefined) {
|
|
newValue = STATE_OUT_OF_VIEW;
|
|
}
|
|
}
|
|
if(newValue !== currValue) {
|
|
$tw.wiki.addTiddler(new $tw.Tiddler({title: title, text: newValue}));
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
function updateAddressBar() {
|
|
if($tw.wiki.getTiddlerText("$:/config/DynaView/UpdateAddressBar") === "yes") {
|
|
var top = findTopmostTiddler();
|
|
if(top.element) {
|
|
var hash = "#" + encodeURIComponent(top.title) + ":" + encodeURIComponent("[list[$:/StoryList]]");
|
|
if(title && $tw.locationHash !== hash) {
|
|
$tw.locationHash = hash;
|
|
window.location.hash = hash;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function saveScrollPosition() {
|
|
if(!localStorageHasFailed) {
|
|
if(hasRestoredScrollPosition && $tw.wiki.getTiddlerText("$:/config/DynaView/RestoreScrollPositionAtStartup") === "yes") {
|
|
var top = findTopmostTiddler();
|
|
if(top.element) {
|
|
try {
|
|
window.localStorage.setItem(LOCAL_STORAGE_KEY_PREFIX + window.location.pathname,JSON.stringify({
|
|
title: top.title,
|
|
offset: top.offset
|
|
}));
|
|
} catch(e) {
|
|
localStorageHasFailed = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function restoreScrollPosition() {
|
|
var json;
|
|
if(!localStorageHasFailed) {
|
|
try {
|
|
json = JSON.parse(window.localStorage.getItem(LOCAL_STORAGE_KEY_PREFIX + window.location.pathname));
|
|
} catch(e) {
|
|
localStorageHasFailed = true;
|
|
};
|
|
}
|
|
return json;
|
|
}
|
|
|
|
/*
|
|
tiddlerDetails: {title: <title of tiddler to scroll to>, offset: <offset in pixels from the top of the tiddler>}
|
|
*/
|
|
function scrollToTiddler(tiddlerDetails) {
|
|
if(!$tw.pageScroller.isScrolling() && tiddlerDetails) {
|
|
var elements = document.querySelectorAll(".tc-tiddler-frame[data-tiddler-title]"),
|
|
topmostTiddlerElement = null;
|
|
$tw.utils.each(elements,function(element) {
|
|
if(element.getAttribute("data-tiddler-title") === tiddlerDetails.title) {
|
|
topmostTiddlerElement = element;
|
|
}
|
|
});
|
|
if(topmostTiddlerElement) {
|
|
var rect = topmostTiddlerElement.getBoundingClientRect(),
|
|
scrollY = Math.round(window.scrollY + rect.top + tiddlerDetails.offset);
|
|
if(scrollY !== window.scrollY) {
|
|
window.scrollTo(window.scrollX,scrollY);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function shouldPreserveScrollPosition() {
|
|
return $tw.wiki.getTiddlerText("$:/config/DynaView/PreserveScrollPosition") === "yes";
|
|
}
|
|
|
|
function findTopmostTiddler() {
|
|
var elements = document.querySelectorAll(".tc-tiddler-frame[data-tiddler-title]"),
|
|
topmostElement = null,
|
|
topmostElementTop = 1 * 1000 * 1000;
|
|
$tw.utils.each(elements,function(element) {
|
|
// Check if the element is visible
|
|
var elementRect = element.getBoundingClientRect();
|
|
if((elementRect.top < topmostElementTop) && (elementRect.bottom > 0)) {
|
|
topmostElement = element;
|
|
topmostElementTop = elementRect.top;
|
|
}
|
|
});
|
|
return {
|
|
element: topmostElement,
|
|
offset: -topmostElementTop,
|
|
title: topmostElement ? topmostElement.getAttribute("data-tiddler-title") : null
|
|
};
|
|
}
|
|
|
|
var previousViewportWidth, previousViewportHeight;
|
|
|
|
function saveViewportDimensions() {
|
|
var viewportWidth = window.innerWidth || document.documentElement.clientWidth,
|
|
viewportHeight = window.innerHeight || document.documentElement.clientHeight;
|
|
if(document.querySelector(".tc-dynaview-request-refresh-on-resize")) {
|
|
if(previousViewportWidth !== viewportWidth || previousViewportHeight !== viewportHeight) {
|
|
var count = parseInt($tw.wiki.getTiddlerText("$:/state/DynaView/ViewportDimensions/ResizeCount","0"),10) || 0;
|
|
$tw.wiki.addTiddler(new $tw.Tiddler({title: "$:/state/DynaView/ViewportDimensions/ResizeCount", text: (count + 1) + ""}));
|
|
previousViewportWidth = viewportWidth;
|
|
previousViewportHeight = viewportHeight;
|
|
}
|
|
}
|
|
if($tw.wiki.getTiddlerText("$:/config/DynaView/ViewportDimensions") === "yes") {
|
|
if($tw.wiki.getTiddlerText("$:/state/DynaView/ViewportDimensions/Width") !== viewportWidth.toString()) {
|
|
$tw.wiki.setText("$:/state/DynaView/ViewportDimensions/Width",undefined,undefined,viewportWidth.toString(),undefined);
|
|
}
|
|
if($tw.wiki.getTiddlerText("$:/state/DynaView/ViewportDimensions/Height") !== viewportHeight.toString()) {
|
|
$tw.wiki.setText("$:/state/DynaView/ViewportDimensions/Height",undefined,undefined,viewportHeight.toString(),undefined);
|
|
}
|
|
}
|
|
}
|
|
|
|
})();
|