Skip to content

Replace jQuery with vanilla JavaScript #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 14, 2023
Merged

Replace jQuery with vanilla JavaScript #160

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f720a9
Replace jQuery with vanilla JavaScript
hugovk Jul 13, 2023
8d9964a
Revert test change
hugovk Jul 13, 2023
d189df4
Fix quoting
hugovk Jul 14, 2023
6829b35
Fix indent
hugovk Jul 14, 2023
1988613
Replace all matching placeholders, not just the first
hugovk Jul 14, 2023
21c3749
Switch 'var' to 'const' or 'let'
hugovk Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 76 additions & 61 deletions templates/switchers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,52 @@
if (!String.prototype.startsWith) {
Object.defineProperty(String.prototype, 'startsWith', {
value: function(search, rawPos) {
var pos = rawPos > 0 ? rawPos|0 : 0;
const pos = rawPos > 0 ? rawPos|0 : 0;
return this.substring(pos, pos + search.length) === search;
}
});
}

// Parses versions in URL segments like:
// "3", "dev", "release/2.7" or "3.6rc2"
var version_regexs = [
const version_regexs = [
'(?:\\d)',
'(?:\\d\\.\\d[\\w\\d\\.]*)',
'(?:dev)',
'(?:release/\\d.\\d[\\x\\d\\.]*)'];

var all_versions = $VERSIONS;
var all_languages = $LANGUAGES;
const all_versions = $VERSIONS;
const all_languages = $LANGUAGES;

function quote_attr(str) {
return '"' + str.replace('"', '\\"') + '"';
}

function build_version_select(release) {
var buf = ['<select id="version_select">'];
var major_minor = release.split(".").slice(0, 2).join(".");
let buf = ['<select id="version_select">'];
const major_minor = release.split(".").slice(0, 2).join(".");

$.each(all_versions, function(version, title) {
if (version == major_minor)
Object.entries(all_versions).forEach(function([version, title]) {
if (version === major_minor) {
buf.push('<option value=' + quote_attr(version) + ' selected="selected">' + release + '</option>');
else
} else {
buf.push('<option value=' + quote_attr(version) + '>' + title + '</option>');
}
});

buf.push('</select>');
return buf.join('');
}

function build_language_select(current_language) {
var buf = ['<select id="language_select">'];
let buf = ['<select id="language_select">'];

$.each(all_languages, function(language, title) {
if (language == current_language)
buf.push('<option value="' + language + '" selected="selected">' +
all_languages[current_language] + '</option>');
else
Object.entries(all_languages).forEach(function([language, title]) {
if (language === current_language) {
buf.push('<option value="' + language + '" selected="selected">' + title + '</option>');
} else {
buf.push('<option value="' + language + '">' + title + '</option>');
}
});
if (!(current_language in all_languages)) {
// In case we're browsing a language that is not yet in all_languages.
Expand All @@ -62,29 +63,31 @@

function navigate_to_first_existing(urls) {
// Navigate to the first existing URL in urls.
var url = urls.shift();
const url = urls.shift();
if (urls.length == 0 || url.startsWith("file:///")) {
window.location.href = url;
return;
}
$.ajax({
url: url,
success: function() {
window.location.href = url;
},
error: function() {
fetch(url)
.then(function(response) {
if (response.ok) {
window.location.href = url;
} else {
navigate_to_first_existing(urls);
}
})
.catch(function(error) {
navigate_to_first_existing(urls);
}
});
});
}

function on_version_switch() {
var selected_version = $(this).children('option:selected').attr('value') + '/';
var url = window.location.href;
var current_language = language_segment_from_url();
var current_version = version_segment_from_url();
var new_url = url.replace('/' + current_language + current_version,
'/' + current_language + selected_version);
const selected_version = this.options[this.selectedIndex].value + '/';
const url = window.location.href;
const current_language = language_segment_from_url();
const current_version = version_segment_from_url();
const new_url = url.replace('/' + current_language + current_version,
'/' + current_language + selected_version);
if (new_url != url) {
navigate_to_first_existing([
new_url,
Expand All @@ -98,13 +101,13 @@
}

function on_language_switch() {
var selected_language = $(this).children('option:selected').attr('value') + '/';
var url = window.location.href;
var current_language = language_segment_from_url();
var current_version = version_segment_from_url();
if (selected_language == 'en/') // Special 'default' case for english.
let selected_language = this.options[this.selectedIndex].value + '/';
const url = window.location.href;
const current_language = language_segment_from_url();
const current_version = version_segment_from_url();
if (selected_language == 'en/') // Special 'default' case for English.
selected_language = '';
var new_url = url.replace('/' + current_language + current_version,
let new_url = url.replace('/' + current_language + current_version,
'/' + selected_language + current_version);
if (new_url != url) {
navigate_to_first_existing([
Expand All @@ -117,9 +120,9 @@
// Returns the path segment of the language as a string, like 'fr/'
// or '' if not found.
function language_segment_from_url() {
var path = window.location.pathname;
var language_regexp = '/((?:' + Object.keys(all_languages).join("|") + ')/)'
var match = path.match(language_regexp);
const path = window.location.pathname;
const language_regexp = '/((?:' + Object.keys(all_languages).join("|") + ')/)'
const match = path.match(language_regexp);
if (match !== null)
return match[1];
return '';
Expand All @@ -128,35 +131,36 @@
// Returns the path segment of the version as a string, like '3.6/'
// or '' if not found.
function version_segment_from_url() {
var path = window.location.pathname;
var language_segment = language_segment_from_url();
var version_segment = '(?:(?:' + version_regexs.join('|') + ')/)';
var version_regexp = language_segment + '(' + version_segment + ')';
var match = path.match(version_regexp);
const path = window.location.pathname;
const language_segment = language_segment_from_url();
const version_segment = '(?:(?:' + version_regexs.join('|') + ')/)';
const version_regexp = language_segment + '(' + version_segment + ')';
const match = path.match(version_regexp);
if (match !== null)
return match[1];
return ''
}

function create_placeholders_if_missing() {
var version_segment = version_segment_from_url();
var language_segment = language_segment_from_url();
var index = "/" + language_segment + version_segment;
const version_segment = version_segment_from_url();
const language_segment = language_segment_from_url();
const index = "/" + language_segment + version_segment;

if ($('.version_switcher_placeholder').length)
if (document.querySelectorAll('.version_switcher_placeholder').length > 0) {
return;
}

var html = '<span class="language_switcher_placeholder"></span> \
const html = '<span class="language_switcher_placeholder"></span> \
<span class="version_switcher_placeholder"></span> \
<a href="/" id="indexlink">Documentation</a> &#187;';

var probable_places = [
const probable_places = [
"body>div.related>ul>li:not(.right):contains('Documentation'):first",
"body>div.related>ul>li:not(.right):contains('documentation'):first",
];

for (var i = 0; i < probable_places.length; i++) {
var probable_place = $(probable_places[i]);
for (let i = 0; i < probable_places.length; i++) {
let probable_place = $(probable_places[i]);
if (probable_place.length == 1) {
probable_place.html(html);
document.getElementById('indexlink').href = index;
Expand All @@ -165,18 +169,29 @@
}
}

$(document).ready(function() {
var language_segment = language_segment_from_url();
var current_language = language_segment.replace(/\/+$/g, '') || 'en';
var version_select = build_version_select(DOCUMENTATION_OPTIONS.VERSION);
document.addEventListener('DOMContentLoaded', function() {
const language_segment = language_segment_from_url();
const current_language = language_segment.replace(/\/+$/g, '') || 'en';
const version_select = build_version_select(DOCUMENTATION_OPTIONS.VERSION);

create_placeholders_if_missing();
$('.version_switcher_placeholder').html(version_select);
$('.version_switcher_placeholder select').bind('change', on_version_switch);

var language_select = build_language_select(current_language);
let placeholders = document.querySelectorAll('.version_switcher_placeholder');
placeholders.forEach(function(placeholder) {
placeholder.innerHTML = version_select;

$('.language_switcher_placeholder').html(language_select);
$('.language_switcher_placeholder select').bind('change', on_language_switch);
let selectElement = placeholder.querySelector('select');
selectElement.addEventListener('change', on_version_switch);
});

const language_select = build_language_select(current_language);

placeholders = document.querySelectorAll('.language_switcher_placeholder');
placeholders.forEach(function(placeholder) {
placeholder.innerHTML = language_select;

let selectElement = placeholder.querySelector('select');
selectElement.addEventListener('change', on_language_switch);
});
});
})();