Skip to content
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.

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

Search resource cleanup and style tweak #1434

Merged
merged 1 commit into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
353 changes: 168 additions & 185 deletions assets/js/offline-search.js
Original file line number Diff line number Diff line change
@@ -1,200 +1,183 @@
// Adapted from code by Matt Walters https://www.mattwalters.net/posts/2018-03-28-hugo-and-lunr/

(function ($) {
'use strict';
'use strict';

$(document).ready(function () {
const $searchInput = $('.td-search input');
$(document).ready(function () {
const $searchInput = $('.td-search input');

//
// Register handler
//
//
// Register handler
//

$searchInput.on('change', (event) => {
render($(event.target));
$searchInput.on('change', (event) => {
render($(event.target));

// Hide keyboard on mobile browser
$searchInput.blur();
});
// Hide keyboard on mobile browser
$searchInput.blur();
});

// Prevent reloading page by enter key on sidebar search.
$searchInput.closest('form').on('submit', () => {
return false;
});

// Prevent reloading page by enter key on sidebar search.
$searchInput.closest('form').on('submit', () => {
return false;
//
// Lunr
//

let idx = null; // Lunr index
const resultDetails = new Map(); // Will hold the data for the search results (titles and summaries)

// Set up for an Ajax call to request the JSON data file that is created by Hugo's build process
$.ajax($searchInput.data('offline-search-index-json-src')).then((data) => {
idx = lunr(function () {
this.ref('ref');

// If you added more searchable fields to the search index, list them here.
// Here you can specify searchable fields to the search index - e.g. individual toxonomies for you project
// With "boost" you can add weighting for specific (default weighting without boost: 1)
this.field('title', { boost: 5 });
this.field('categories', { boost: 3 });
this.field('tags', { boost: 3 });
// this.field('projects', { boost: 3 }); // example for an individual toxonomy called projects
this.field('description', { boost: 2 });
this.field('body');

data.forEach((doc) => {
this.add(doc);

resultDetails.set(doc.ref, {
title: doc.title,
excerpt: doc.excerpt,
});
});
});

//
// Lunr
//

let idx = null; // Lunr index
const resultDetails = new Map(); // Will hold the data for the search results (titles and summaries)

// Set up for an Ajax call to request the JSON data file that is created by Hugo's build process
$.ajax($searchInput.data('offline-search-index-json-src')).then(
(data) => {
idx = lunr(function () {
this.ref('ref');

// If you added more searchable fields to the search index, list them here.
// Here you can specify searchable fields to the search index - e.g. individual toxonomies for you project
// With "boost" you can add weighting for specific (default weighting without boost: 1)
this.field('title', { boost: 5 });
this.field('categories', { boost: 3 });
this.field('tags', { boost: 3 });
// this.field('projects', { boost: 3 }); // example for an individual toxonomy called projects
this.field('description', { boost: 2 });
this.field('body');

data.forEach((doc) => {
this.add(doc);

resultDetails.set(doc.ref, {
title: doc.title,
excerpt: doc.excerpt,
});
});
});

$searchInput.trigger('change');
}
);
$searchInput.trigger('change');
});

const render = ($targetSearchInput) => {
//
// Dispose existing popover
//

{
let popover = bootstrap.Popover.getInstance(
$targetSearchInput[0]
);
if (popover !== null) {
popover.dispose();
}
}

//
// Search
//

if (idx === null) {
return;
}

const searchQuery = $targetSearchInput.val();
if (searchQuery === '') {
return;
}

const results = idx
.query((q) => {
const tokens = lunr.tokenizer(searchQuery.toLowerCase());
tokens.forEach((token) => {
const queryString = token.toString();
q.term(queryString, {
boost: 100,
});
q.term(queryString, {
wildcard:
lunr.Query.wildcard.LEADING |
lunr.Query.wildcard.TRAILING,
boost: 10,
});
q.term(queryString, {
editDistance: 2,
});
});
})
.slice(
0,
$targetSearchInput.data('offline-search-max-results')
);

//
// Make result html
//

const $html = $('<div>');

$html.append(
$('<div>')
.css({
display: 'flex',
justifyContent: 'space-between',
marginBottom: '1em',
})
.append(
$('<span>')
.text('Search results')
.css({ fontWeight: 'bold' })
)
.append(
$('<span>').addClass(
'td-offline-search-results__close-button'
)
)
);

const $searchResultBody = $('<div>').css({
maxHeight: `calc(100vh - ${
$targetSearchInput.offset().top -
$(window).scrollTop() +
180
}px)`,
overflowY: 'auto',
const render = ($targetSearchInput) => {
//
// Dispose existing popover
//

{
let popover = bootstrap.Popover.getInstance($targetSearchInput[0]);
if (popover !== null) {
popover.dispose();
}
}

//
// Search
//

if (idx === null) {
return;
}

const searchQuery = $targetSearchInput.val();
if (searchQuery === '') {
return;
}

const results = idx
.query((q) => {
const tokens = lunr.tokenizer(searchQuery.toLowerCase());
tokens.forEach((token) => {
const queryString = token.toString();
q.term(queryString, {
boost: 100,
});
$html.append($searchResultBody);

if (results.length === 0) {
$searchResultBody.append(
$('<p>').text(`No results found for query "${searchQuery}"`)
);
} else {
results.forEach((r) => {
const doc = resultDetails.get(r.ref);
const href =
$searchInput.data('offline-search-base-href') +
r.ref.replace(/^\//, '');

const $entry = $('<div>').addClass('mt-4');

$entry.append(
$('<small>').addClass('d-block text-muted').text(r.ref)
);

$entry.append(
$('<a>')
.addClass('d-block')
.css({
fontSize: '1.2rem',
})
.attr('href', href)
.text(doc.title)
);

$entry.append($('<p>').text(doc.excerpt));

$searchResultBody.append($entry);
});
}

$targetSearchInput.one('shown.bs.popover', () => {
$('.td-offline-search-results__close-button').on(
'click',
() => {
$targetSearchInput.val('');
$targetSearchInput.trigger('change');
}
);
q.term(queryString, {
wildcard:
lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING,
boost: 10,
});

const popover = new bootstrap.Popover($targetSearchInput, {
content: $html[0],
html: true,
customClass: 'td-offline-search-results',
placement: 'bottom',
q.term(queryString, {
editDistance: 2,
});
popover.show();
};
});
});
})
.slice(0, $targetSearchInput.data('offline-search-max-results'));

//
// Make result html
//

const $html = $('<div>');

$html.append(
$('<div>')
.css({
display: 'flex',
justifyContent: 'space-between',
marginBottom: '1em',
})
.append(
$('<span>').text('Search results').css({ fontWeight: 'bold' })
)
.append(
$('<span>').addClass('td-offline-search-results__close-button')
)
);

const $searchResultBody = $('<div>').css({
maxHeight: `calc(100vh - ${
$targetSearchInput.offset().top - $(window).scrollTop() + 180
}px)`,
overflowY: 'auto',
});
$html.append($searchResultBody);

if (results.length === 0) {
$searchResultBody.append(
$('<p>').text(`No results found for query "${searchQuery}"`)
);
} else {
results.forEach((r) => {
const doc = resultDetails.get(r.ref);
const href =
$searchInput.data('offline-search-base-href') +
r.ref.replace(/^\//, '');

const $entry = $('<div>').addClass('mt-4');

$entry.append(
$('<small>').addClass('d-block text-muted').text(r.ref)
);

$entry.append(
$('<a>')
.addClass('d-block')
.css({
fontSize: '1.2rem',
})
.attr('href', href)
.text(doc.title)
);

$entry.append($('<p>').text(doc.excerpt));

$searchResultBody.append($entry);
});
}

$targetSearchInput.one('shown.bs.popover', () => {
$('.td-offline-search-results__close-button').on('click', () => {
$targetSearchInput.val('');
$targetSearchInput.trigger('change');
});
});

const popover = new bootstrap.Popover($targetSearchInput, {
content: $html[0],
html: true,
customClass: 'td-offline-search-results',
placement: 'bottom',
});
popover.show();
};
});
})(jQuery);
Loading