mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
112 lines
3.7 KiB
JavaScript
112 lines
3.7 KiB
JavaScript
/*
|
|
* Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Class
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
export default class Position {
|
|
|
|
/**
|
|
* Set sidebars to locked state and limit height to parent node
|
|
*
|
|
* @constructor
|
|
*
|
|
* @property {HTMLElement} el_ - TODO
|
|
* @property {HTMLElement} parent_ - TODO
|
|
* @property {number} height_ - TODO
|
|
* @property {number} offset_ - TODO
|
|
*
|
|
* @param {(string|HTMLElement)} el - Selector or HTML element
|
|
*/
|
|
constructor(el) {
|
|
const ref = (typeof el === "string")
|
|
? document.querySelector(el)
|
|
: el
|
|
if (!(ref instanceof HTMLElement) ||
|
|
!(ref.parentNode instanceof HTMLElement))
|
|
throw new ReferenceError
|
|
this.el_ = ref
|
|
|
|
/* Initialize parent container and current height */
|
|
this.parent_ = ref.parentNode
|
|
this.height_ = 0
|
|
}
|
|
|
|
/**
|
|
* Initialize sidebar state
|
|
*/
|
|
setup() {
|
|
this.offset_ = this.el_.offsetTop - this.parent_.offsetTop
|
|
this.update()
|
|
}
|
|
|
|
/**
|
|
* Update locked state and height
|
|
*
|
|
* The inner height of the window (= the visible area) is the maximum
|
|
* possible height for the stretching sidebar. This height must be deducted
|
|
* by the top offset of the parent container, which accounts for the fixed
|
|
* header, setting the baseline. Depending on the page y-offset, the top
|
|
* offset of the sidebar must be taken into account, as well as the case
|
|
* where the window is scrolled beyond the sidebar container.
|
|
*/
|
|
update() {
|
|
const offset = window.pageYOffset
|
|
const visible = window.innerHeight
|
|
|
|
/* Calculate bounds of sidebar container */
|
|
const bounds = {
|
|
top: this.parent_.offsetTop,
|
|
bottom: this.parent_.offsetTop + this.parent_.offsetHeight
|
|
}
|
|
|
|
/* Calculate new offset and height */
|
|
const height = visible - bounds.top
|
|
- Math.max(0, this.offset_ - offset)
|
|
- Math.max(0, offset + visible - bounds.bottom)
|
|
|
|
/* If height changed, update element */
|
|
if (height !== this.height_)
|
|
this.el_.style.height = `${this.height_ = height}px`
|
|
|
|
/* Sidebar should be locked, as we're below parent offset */
|
|
if (offset >= this.offset_) {
|
|
if (this.el_.dataset.mdState !== "lock")
|
|
this.el_.dataset.mdState = "lock"
|
|
|
|
/* Sidebar should be unlocked, if locked */
|
|
} else if (this.el_.dataset.mdState === "lock") {
|
|
this.el_.dataset.mdState = ""
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Reset locked state and height
|
|
*/
|
|
reset() {
|
|
this.el_.dataset.mdState = ""
|
|
this.el_.style.height = ""
|
|
this.height_ = 0
|
|
}
|
|
}
|