@internetarchive/bookreader 5.0.0-6-14 → 5.0.0-60

package/src/dragscrollable-br.js

@@ -1,261 +0,0 @@
-/*
- * jQuery dragscrollable Plugin
- * version: 1.0 (25-Jun-2009)
- * Copyright (c) 2009 Miquel Herrera
- *
- * Portions Copyright (c) 2010 Reg Braithwaite
- *          Copyright (c) 2010 Internet Archive / Michael Ang
- *          Copyright (c) 2016 Internet Archive / Richard Caceres
- *
- * Dual licensed under the MIT and GPL licenses:
- *   http://www.opensource.org/licenses/mit-license.php
- *   http://www.gnu.org/licenses/gpl.html
- *
- * Modified by richard@archive.org 2016
- * - Added check to disable on touch enabled devices
- * - Change dragend handler to bind using event "capturing" instead of "bubbling"
- */
-(function($) { // secure $ jQuery alias
-
-  /**
- * Adds the ability to manage elements scroll by dragging
- * one or more of its descendant elements. Options parameter
- * allow to specifically select which inner elements will
- * respond to the drag events.
- *
- * options properties:
- * ------------------------------------------------------------------------
- *  dragSelector         | jquery selector to apply to each wrapped element
- *                       | to find which will be the dragging elements.
- *                       | Defaults to '>:first' which is the first child of
- *                       | scrollable element
- * ------------------------------------------------------------------------
- *  acceptPropagatedEvent| Will the dragging element accept propagated
- *	                     | events? default is yes, a propagated mouse event
- *	                     | on a inner element will be accepted and processed.
- *	                     | If set to false, only events originated on the
- *	                     | draggable elements will be processed.
- * ------------------------------------------------------------------------
- *  preventDefault       | Prevents the event to propagate further effectivey
- *                       | disabling other default actions. Defaults to true
- * ------------------------------------------------------------------------
- *  scrollWindow         | Scroll the window rather than the element
- *                       | Defaults to false
- * ------------------------------------------------------------------------
- *
- *  usage examples:
- *
- *  To add the scroll by drag to the element id=viewport when dragging its
- *  first child accepting any propagated events
- *	$('#viewport').dragscrollable();
- *
- *  To add the scroll by drag ability to any element div of class viewport
- *  when dragging its first descendant of class dragMe responding only to
- *  evcents originated on the '.dragMe' elements.
- *	$('div.viewport').dragscrollable({dragSelector:'.dragMe:first',
- *									  acceptPropagatedEvent: false});
- *
- *  Notice that some 'viewports' could be nested within others but events
- *  would not interfere as acceptPropagatedEvent is set to false.
- *
- */
-
-  var append_namespace = function (string_of_events, ns) {
-
-    /* IE doesn't have map
-	return string_of_events
-		.split(' ')
-			.map(function (name) { return name + ns; })
-				.join(' ');
-    */
-    var pieces = string_of_events.split(' ');
-    var ret = new Array();
-    for (var i = 0; i < pieces.length; i++) {
-      ret.push(pieces[i] + ns);
-    }
-    return ret.join(' ');
-  };
-
-  var left_top = function(event) {
-
-    var x;
-    var y;
-    if (typeof(event.clientX) != 'undefined') {
-      x = event.clientX;
-      y = event.clientY;
-    }
-    else if (typeof(event.screenX) != 'undefined') {
-      x = event.screenX;
-      y = event.screenY;
-    }
-    else if (typeof(event.targetTouches) != 'undefined') {
-      x = event.targetTouches[0].pageX;
-      y = event.targetTouches[0].pageY;
-    }
-    else if (typeof(event.originalEvent) == 'undefined') {
-      var str = '';
-      for (const i in event) {
-        str += ', ' + i + ': ' + event[i];
-      }
-      console.error("don't understand x and y for " + event.type + ' event: ' + str);
-    }
-    else if (typeof(event.originalEvent.clientX) != 'undefined') {
-      x = event.originalEvent.clientX;
-      y = event.originalEvent.clientY;
-    }
-    else if (typeof(event.originalEvent.screenX) != 'undefined') {
-      x = event.originalEvent.screenX;
-      y = event.originalEvent.screenY;
-    }
-    else if (typeof(event.originalEvent.targetTouches) != 'undefined') {
-      x = event.originalEvent.targetTouches[0].pageX;
-      y = event.originalEvent.targetTouches[0].pageY;
-    }
-
-    return {left: x, top:y};
-  };
-
-  $.fn.dragscrollable = function( options ) {
-
-    var handling_element = $(this);
-
-    var settings = $.extend(
-      {
-        dragSelector:'>:first',
-        acceptPropagatedEvent: true,
-        preventDefault: true,
-        dragstart: 'mousedown touchstart',
-        dragcontinue: 'mousemove touchmove',
-        dragend: 'mouseup touchend', // mouseleave
-        dragMinDistance: 5,
-        namespace: '.ds',
-        scrollWindow: false,
-      },options || {});
-
-    settings.dragstart = append_namespace(settings.dragstart, settings.namespace);
-    settings.dragcontinue = append_namespace(settings.dragcontinue, settings.namespace);
-    //settings.dragend = append_namespace(settings.dragend, settings.namespace);
-
-    var shouldAbort = function() {
-      var isTouchDevice = !!('ontouchstart' in window) || !!('msmaxtouchpoints' in window.navigator);
-      return isTouchDevice;
-    };
-
-    var dragContinueHandlerProxy;
-
-    var dragscroll = {
-      dragStartHandler : function(event) {
-        if (shouldAbort()) { return true; }
-
-        // mousedown, left click, check propagation
-        if (event.which > 1 ||
-				(!event.data.acceptPropagatedEvent && event.target != this)) {
-          return false;
-        }
-
-        event.data.firstCoord = left_top(event);
-        // Initial coordinates will be the last when dragging
-        event.data.lastCoord = event.data.firstCoord;
-
-        handling_element
-          .bind(settings.dragcontinue, event.data, dragscroll.dragContinueHandler)
-        //.bind(settings.dragend, event.data, dragscroll.dragEndHandler)
-        ;
-
-        // Note, we bind using addEventListener so we can use "capture" binding
-        // instead of "bubble" binding
-        dragContinueHandlerProxy = function(e) {
-          e.data = event.data;
-          dragscroll.dragEndHandler(e);
-        };
-        $.each(settings.dragend.split(' '), function(idx, val) {
-          handling_element.get(0).addEventListener(val, dragContinueHandlerProxy, true);
-        });
-
-        if (event.data.preventDefault) {
-          event.preventDefault();
-          return false;
-        }
-      },
-      dragContinueHandler : function(event) { // User is dragging
-        // console.log('drag continue');
-        if (shouldAbort()) { return true; }
-
-        var lt = left_top(event);
-
-        // How much did the mouse move?
-        var delta = {left: (lt.left - event.data.lastCoord.left),
-          top: (lt.top - event.data.lastCoord.top)};
-
-        var scrollTarget = event.data.scrollable;
-        if (event.data.scrollWindow) {
-          scrollTarget = $(window);
-        }
-        // Set the scroll position relative to what ever the scroll is now
-        scrollTarget.scrollLeft( scrollTarget.scrollLeft() - delta.left );
-        scrollTarget.scrollTop(	scrollTarget.scrollTop() - delta.top );
-
-        // Save where the cursor is
-        event.data.lastCoord = lt;
-
-        if (event.data.preventDefault) {
-          event.preventDefault();
-          return false;
-        }
-      },
-      dragEndHandler : function(event) { // Stop scrolling
-        //console.log('dragEndHandler');
-
-        if (shouldAbort()) { return true; }
-
-        handling_element
-          .unbind(settings.dragcontinue)
-        // Note, for some reason, even though I removeEventListener below,
-        // this call to unbind is still necessary. I don't know why.
-          .unbind(settings.dragend)
-        ;
-
-        // Note, we bind using addEventListener so we can use "capture" binding
-        // instead of "bubble" binding
-        $.each(settings.dragend.split(' '), function(idx, val) {
-          handling_element.get(0).removeEventListener(val, dragContinueHandlerProxy, true);
-        });
-
-        // How much did the mouse move total?
-        var delta = {left: Math.abs(event.data.lastCoord.left - event.data.firstCoord.left),
-          top: Math.abs(event.data.lastCoord.top - event.data.firstCoord.top)};
-        var distance = Math.max(delta.left, delta.top);
-
-        // Allow event to propagate if min distance was not achieved
-        if (event.data.preventDefault && distance > settings.dragMinDistance) {
-          event.preventDefault();
-          event.stopImmediatePropagation();
-          event.stopPropagation();
-          return false;
-        }
-      }
-    };
-
-    // set up the initial events
-    return this.each(function() {
-      // closure object data for each scrollable element
-      var data = {scrollable : $(this),
-        acceptPropagatedEvent : settings.acceptPropagatedEvent,
-        preventDefault : settings.preventDefault,
-        scrollWindow : settings.scrollWindow };
-      // Set mouse initiating event on the desired descendant
-      $(this).find(settings.dragSelector).
-        bind(settings.dragstart, data, dragscroll.dragStartHandler);
-    });
-  }; //end plugin dragscrollable
-
-  // Note, this probably doesn't work anymore with our modifications - Nov/8/2016
-  $.fn.removedragscrollable = function (namespace) {
-    if (typeof(namespace) == 'undefined')
-      namespace = '.ds';
-    return this.each(function() {
-      $(document).find('*').andSelf().unbind(namespace);
-    });
-  };
-
-})( jQuery ); // confine scope

package/src/plugins/menu_toggle/plugin.menu_toggle.js

@@ -1,324 +0,0 @@
-
-/* global BookReader */
-/**
- * Plugin for managing menu visibility
- * Enabling this plug-in:
- * + removes the "menu tab" triangle
- * + toggles nav at: book center tap/click
- * + toggles nav at: black background tap/click
- *
- * Handles to events at CAPTURE phase
- *
- * This uses core BookReader functions and parameters to check its UI state:
- * - br.refs = (at best) ui references that are present at any given time
- * - br.navigationIsVisible() - checks using refs to confirm the navbar's presence
- * - br.showNavigation() & br.hideNavigation()
- * - br.constMode1up checks against br.mode;
- *
- * The list of BookReader custom events this plugin taps into are mainly
- * listed in the `.init` function
- */
-
-(function addMenuToggler() {
-  jQuery.extend(BookReader.defaultOptions, {
-    enableMenuToggle: true
-  });
-
-  /**
-     * `holdOffOnToggle` is used in fn `toggleRouter`
-     * to determine if menu toggle should happen
-     * set by `registerDragHandlers`
-     */
-  let holdOffOnToggle = false;
-
-  /**
-     * Hides Nav arrow tab
-     *
-     * @param { object } br - BookReader instance
-     */
-  function hideArrow(br) {
-    if (!br.refs || !br.refs.$BRnav) {
-      return;
-    }
-    const $menuTab = br.refs.$BRnav.children('.BRnavCntl');
-    $menuTab.css('display', 'none');
-  }
-
-  /**
-     * Sets up nav - hides arrow tab & adds click events
-     *
-     * @param { object } br - BookReader instance
-     */
-  function setupNavForToggle(br) {
-    hideArrow(br);
-    registerClickHandlers(br);
-  }
-
-  /**
-     * Resets nav to always show
-     * hides arrow tab, removes click events, shows nav chrome
-     *
-     * @param { object } br - BookReader instance
-     */
-  function alwaysShowNav(br) {
-    hideArrow(br);
-    removeClickHandlers(br);
-    br.showNavigation();
-  }
-
-  /**
-     * Removes click handlers on elements that house the book pages
-     *
-     * @param { object } br - BookReader instance
-     */
-  const removeClickHandlers = function removeClickHandlers(br) {
-    if (br.refs.$brPageViewEl) {
-      br.refs.$brPageViewEl[0].removeEventListener('click', onBookClick, true);
-    }
-    if (br.refs.$brTwoPageView) {
-      br.refs.$brTwoPageView[0].removeEventListener('click', onBookClick, true);
-    }
-  }
-
-  /**
-     * Toggle functionality
-     * Responsible for calling native functions `hideNavigation` & `showNavigation`
-     * Makes sure only 1 toggle action is taken at a time using `togglingNav` switch.
-     *
-     * @params { object } br - bookreader instance
-     */
-  let togglingNav = false; /* flag to make sure animations only fire once */
-  const toggleNav = function toggleNav(br) {
-    if (togglingNav) {
-      return;
-    }
-
-    togglingNav = true;
-    const navToggled = function navToggled() {
-      togglingNav = false;
-      window.removeEventListener('BookReader:navToggled', navToggled);
-    };
-    $(document).on('BookReader:navToggled', navToggled);
-
-    const menuIsShowing = br.navigationIsVisible();
-    if (menuIsShowing) {
-      br.hideNavigation();
-    } else {
-      br.showNavigation();
-    }
-  }
-
-  /**
-     * Check if div `BRcontainer` is scrollable.
-     * This normally happens when bookreader is zoomed in.
-     * not using br.refs, because `scrollWidth` & `offsetWidth` is not easily accessible.
-     */
-  const isBRcontainerScrollable = function isBRcontainerScrollable() {
-    const brContainer = document.querySelector('.BRcontainer');
-    const scrollWidth = brContainer.scrollWidth;
-    const offsetWidth = brContainer.offsetWidth;
-
-    return scrollWidth > offsetWidth;
-  }
-
-  /**
-     * Confirms whether or not the click happened in the nav toggle zone
-     *
-     * @param { MouseEvent } event - JS click event object
-     * @param { DOM } book - DOM element that represents book
-     */
-  const isCenterClick = function isCenterClick(event, book) {
-    const clickPosition = event.clientX;
-    const bookWidth = book.offsetWidth;
-    const leftOffset = book.offsetLeft
-    const bookEndPageFlipArea = Math.round(bookWidth / 3);
-    const leftThreshold = Math.round(bookEndPageFlipArea + leftOffset); // without it, the click area is small
-    const rightThreshold = Math.round(bookWidth - bookEndPageFlipArea + leftOffset);
-    const isOkOnRight = clickPosition > leftThreshold;
-    const isOkOnLeft = clickPosition < rightThreshold;
-    const isCenterClick = isOkOnRight && isOkOnLeft;
-
-    return isCenterClick;
-  }
-
-  /**
-     * Confirms whether or not the click happened in the background
-     *
-     * @param { DOM } element
-     */
-  const isBackground = function isBackground(element) {
-    const isBackgroundClick = $(element).hasClass('BookReader')
-        || $(element).hasClass('BRcontainer') /* main black theatre */
-        || $(element).hasClass('BRemptypage') /* empty page placeholder */
-        || $(element).hasClass('BRpageview') /* empty page placeholder, 1up */
-        || $(element).hasClass('BRtwopageview'); /* empty page placeholder, 2up */
-    return isBackgroundClick;
-  };
-
-  /**
-     * Main hook into toggle functionality
-     * This is the only function that should be called by the event handlers
-     *
-     * @param { object } br - BookReader instance
-     * @param { MouseEvent } e - JS event object
-     * @param { boolean } atBookCenter - optional
-     */
-  const toggleRouter = function toggleRouter (br, e, atBookCenter) {
-    if (holdOffOnToggle) {
-      return;
-    }
-
-    const book = isBRcontainerScrollable() ? br.refs.$brContainer[0] : e.currentTarget;
-    const is1UpMode = br.constMode1up === br.mode;
-    const validBookClick = is1UpMode || isCenterClick(e, book);
-    const isValidClickArea = atBookCenter ? validBookClick : isBackground(e.target);
-    if (isValidClickArea) {
-      toggleNav(br, atBookCenter);
-
-      if (atBookCenter) {
-        e.stopPropagation(); // don't turn the page. this takes prescendence
-      }
-    }
-  }
-
-  /**
-     * background click event handler
-     * @param { object } br - BookReader instance
-     * @param { MouseEvent } e - JS event object
-     */
-  function onBackgroundClick(br, e) {
-    toggleRouter(br, e);
-  }
-
-  /**
-     * actual book container click event handler
-     *
-     * @param { object } br - BookReader instance
-     * @param { MouseEvent } e - JS event object
-     */
-  function onBookClick(br, e) {
-
-    const atBookCenter = true;
-    toggleRouter(br, e, atBookCenter);
-  }
-
-  let initialX;
-  let initialY;
-  /**
-     * attaches mouseup & mousedown event handlers to assess if user is dragging
-     * sets `initialX`, `initialY`, and `holdOffOnToggle`
-     */
-  function registerDragHandlers() {
-    const background = document.querySelector('.BookReader');
-    if (!background) {
-      return;
-    }
-
-    background.addEventListener('mousedown', function (e) {
-      initialX = e.screenX;
-      initialY = e.screenY;
-
-      holdOffOnToggle = true;
-    }, true);
-    background.addEventListener('mouseup', function (e) {
-      const isDrag = (Math.abs(initialX - e.screenX) > 5 || Math.abs(initialY - e.screenY) > 5);
-
-      if (!isDrag) {
-        holdOffOnToggle = false;
-        initialX = 0;
-        initialY = 0;
-      }
-    }, true);
-  }
-
-  /**
-     * attaches click handlers to background & book
-     * @param { object } br - BookReader instance
-     */
-  function registerClickHandlers(br) {
-    const background = document.querySelector('.BookReader');
-    if (!background) {
-      return;
-    }
-
-    background.addEventListener('click', onBackgroundClick.bind(null, br), { capture: true, passive: true });
-
-    const desk = document.querySelector('.BRcontainer') || {};
-    const book = desk.firstChild;
-
-    if (book) {
-      book.addEventListener('click', onBookClick.bind(null, br), true);
-      registerDragHandlers();
-    }
-  }
-
-  /**
-     * Install menu toggle
-     * attaches event handlers, sets up DOM on load
-     */
-  const installMenuToggle = function installMenuToggle(br) {
-    let hasNav = false;
-
-    try {
-      hasNav = br.navigationIsVisible();
-    } catch (error) {
-      hasNav = false;
-    }
-
-    if (!hasNav) {
-      return;
-    }
-
-    const menuToggleEventRegister = function menuToggleEventRegister(e) {
-      registerClickHandlers(br);
-    };
-
-    const setupDOMandHandlers = function setupDOMandHandlers(e) {
-      setupNavForToggle(br);
-    };
-
-    const persistNav = function persistNav(e) {
-      alwaysShowNav(br);
-    };
-
-    const whenToToggleNav = [
-      'BookReader:1PageViewSelected',
-      'BookReader:2PageViewSelected',
-      'BookReader:zoomIn',
-      'BookReader:zoomOut',
-      'BookReader:resize'
-    ];
-
-    const whenTolwaysShowNavWhen = [
-      'BookReader:3PageViewSelected'
-    ];
-
-    $(document).on(whenTolwaysShowNavWhen.join(' '), persistNav);
-    $(document).on(whenToToggleNav.join(' '), menuToggleEventRegister);
-    $(window).on('orientationchange', menuToggleEventRegister);
-    $(document).on('BookReader:fullscreenToggled', setupDOMandHandlers);
-    $(window).on('DOMContentLoaded', setupDOMandHandlers);
-    setupDOMandHandlers();
-  };
-
-  /**
-     * Add to BookReader
-     */
-  BookReader.prototype.setup = (function(super_) {
-    return function(options) {
-      super_.call(this, options);
-    };
-  })(BookReader.prototype.setup);
-
-  /**
-     * Initialize plugin
-     */
-  BookReader.prototype.init = (function(super_) {
-    return function() {
-      super_.call(this);
-      if (this.options.enableMenuToggle) {
-        installMenuToggle(this);
-      }
-    };
-  })(BookReader.prototype.init);
-})();