chore: update documentation

This commit is contained in:
Jacob Heun 2020-07-14 00:46:36 +02:00
parent f88399daba
commit 35052b22de
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
3 changed files with 1471 additions and 6423 deletions

View File

@ -6,7 +6,7 @@
/* eslint-env amd, node */ /* eslint-env amd, node */
// https://github.com/umdjs/umd/blob/master/templates/returnExports.js // https://github.com/umdjs/umd/blob/master/templates/returnExports.js
(function (root, factory) { (function(root, factory) {
'use strict'; 'use strict';
if (typeof define === 'function' && define.amd) { if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module. // AMD. Register as an anonymous module.
@ -21,7 +21,7 @@
root.AnchorJS = factory(); root.AnchorJS = factory();
root.anchors = new root.AnchorJS(); root.anchors = new root.AnchorJS();
} }
})(this, function () { })(this, function() {
'use strict'; 'use strict';
function AnchorJS(options) { function AnchorJS(options) {
this.options = options || {}; this.options = options || {};
@ -51,7 +51,7 @@
* https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40 * https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40
* @returns {Boolean} - true if the current device supports touch. * @returns {Boolean} - true if the current device supports touch.
*/ */
this.isTouchDevice = function () { this.isTouchDevice = function() {
return !!( return !!(
'ontouchstart' in window || 'ontouchstart' in window ||
(window.DocumentTouch && document instanceof DocumentTouch) (window.DocumentTouch && document instanceof DocumentTouch)
@ -64,7 +64,7 @@
* to. Also accepts an array or nodeList containing the relavant elements. * to. Also accepts an array or nodeList containing the relavant elements.
* @returns {this} - The AnchorJS object * @returns {this} - The AnchorJS object
*/ */
this.add = function (selector) { this.add = function(selector) {
var elements, var elements,
elsWithIds, elsWithIds,
idList, idList,
@ -193,7 +193,7 @@
* OR a nodeList / array containing the DOM elements. * OR a nodeList / array containing the DOM elements.
* @returns {this} - The AnchorJS object * @returns {this} - The AnchorJS object
*/ */
this.remove = function (selector) { this.remove = function(selector) {
var index, var index,
domAnchor, domAnchor,
elements = _getElements(selector); elements = _getElements(selector);
@ -216,7 +216,7 @@
/** /**
* Removes all anchorjs links. Mostly used for tests. * Removes all anchorjs links. Mostly used for tests.
*/ */
this.removeAll = function () { this.removeAll = function() {
this.remove(this.elements); this.remove(this.elements);
}; };
@ -229,7 +229,7 @@
* @param {String} text - Any text. Usually pulled from the webpage element we are linking to. * @param {String} text - Any text. Usually pulled from the webpage element we are linking to.
* @returns {String} - hyphen-delimited text for use in IDs and URLs. * @returns {String} - hyphen-delimited text for use in IDs and URLs.
*/ */
this.urlify = function (text) { this.urlify = function(text) {
// Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\ // Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\
var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g, var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g,
urlText; urlText;
@ -260,7 +260,7 @@
* @param {HTMLElemnt} el - a DOM node * @param {HTMLElemnt} el - a DOM node
* @returns {Boolean} true/false * @returns {Boolean} true/false
*/ */
this.hasAnchorJSLink = function (el) { this.hasAnchorJSLink = function(el) {
var hasLeftAnchor = var hasLeftAnchor =
el.firstChild && el.firstChild &&
(' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1, (' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1,

View File

@ -7,7 +7,7 @@ anchors.add('h3');
// Filter UI // Filter UI
var tocElements = document.getElementById('toc').getElementsByTagName('li'); var tocElements = document.getElementById('toc').getElementsByTagName('li');
document.getElementById('filter-input').addEventListener('keyup', function (e) { document.getElementById('filter-input').addEventListener('keyup', function(e) {
var i, element, children; var i, element, children;
// enter key // enter key
@ -22,14 +22,14 @@ document.getElementById('filter-input').addEventListener('keyup', function (e) {
} }
} }
var match = function () { var match = function() {
return true; return true;
}; };
var value = this.value.toLowerCase(); var value = this.value.toLowerCase();
if (!value.match(/^\s*$/)) { if (!value.match(/^\s*$/)) {
match = function (element) { match = function(element) {
var html = element.firstChild.innerHTML; var html = element.firstChild.innerHTML;
return html && html.toLowerCase().indexOf(value) !== -1; return html && html.toLowerCase().indexOf(value) !== -1;
}; };
@ -114,12 +114,12 @@ var cw_without_sb = split_left.clientWidth;
split_left.style.overflow = ''; split_left.style.overflow = '';
Split(['#split-left', '#split-right'], { Split(['#split-left', '#split-right'], {
elementStyle: function (dimension, size, gutterSize) { elementStyle: function(dimension, size, gutterSize) {
return { return {
'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)' 'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
}; };
}, },
gutterStyle: function (dimension, gutterSize) { gutterStyle: function(dimension, gutterSize) {
return { return {
'flex-basis': gutterSize + 'px' 'flex-basis': gutterSize + 'px'
}; };
@ -152,9 +152,9 @@ function loadState(ev) {
} }
} }
window.addEventListener('load', function () { window.addEventListener('load', function() {
// Restore after Firefox scrolls to hash. // Restore after Firefox scrolls to hash.
setTimeout(function () { setTimeout(function() {
loadState(); loadState();
// Update with initial scroll position. // Update with initial scroll position.
updateState(); updateState();

7862
index.html

File diff suppressed because it is too large Load Diff