Spaces:
Running
Running
File size: 35,767 Bytes
34044ef |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 |
const kQueryArg = "q";
const kResultsArg = "show-results";
// If items don't provide a URL, then both the navigator and the onSelect
// function aren't called (and therefore, the default implementation is used)
//
// We're using this sentinel URL to signal to those handlers that this
// item is a more item (along with the type) and can be handled appropriately
const kItemTypeMoreHref = "0767FDFD-0422-4E5A-BC8A-3BE11E5BBA05";
window.document.addEventListener("DOMContentLoaded", function (_event) {
// Ensure that search is available on this page. If it isn't,
// should return early and not do anything
var searchEl = window.document.getElementById("quarto-search");
if (!searchEl) return;
const { autocomplete } = window["@algolia/autocomplete-js"];
let quartoSearchOptions = {};
let language = {};
const searchOptionEl = window.document.getElementById(
"quarto-search-options"
);
if (searchOptionEl) {
const jsonStr = searchOptionEl.textContent;
quartoSearchOptions = JSON.parse(jsonStr);
language = quartoSearchOptions.language;
}
// note the search mode
if (quartoSearchOptions.type === "overlay") {
searchEl.classList.add("type-overlay");
} else {
searchEl.classList.add("type-textbox");
}
// Used to determine highlighting behavior for this page
// A `q` query param is expected when the user follows a search
// to this page
const currentUrl = new URL(window.location);
const query = currentUrl.searchParams.get(kQueryArg);
const showSearchResults = currentUrl.searchParams.get(kResultsArg);
const mainEl = window.document.querySelector("main");
// highlight matches on the page
if (query && mainEl) {
// perform any highlighting
highlight(escapeRegExp(query), mainEl);
// fix up the URL to remove the q query param
const replacementUrl = new URL(window.location);
replacementUrl.searchParams.delete(kQueryArg);
window.history.replaceState({}, "", replacementUrl);
}
// function to clear highlighting on the page when the search query changes
// (e.g. if the user edits the query or clears it)
let highlighting = true;
const resetHighlighting = (searchTerm) => {
if (mainEl && highlighting && query && searchTerm !== query) {
clearHighlight(query, mainEl);
highlighting = false;
}
};
// Clear search highlighting when the user scrolls sufficiently
const resetFn = () => {
resetHighlighting("");
window.removeEventListener("quarto-hrChanged", resetFn);
window.removeEventListener("quarto-sectionChanged", resetFn);
};
// Register this event after the initial scrolling and settling of events
// on the page
window.addEventListener("quarto-hrChanged", resetFn);
window.addEventListener("quarto-sectionChanged", resetFn);
// Responsively switch to overlay mode if the search is present on the navbar
// Note that switching the sidebar to overlay mode requires more coordinate (not just
// the media query since we generate different HTML for sidebar overlays than we do
// for sidebar input UI)
const detachedMediaQuery =
quartoSearchOptions.type === "overlay" ? "all" : "(max-width: 991px)";
// If configured, include the analytics client to send insights
const plugins = configurePlugins(quartoSearchOptions);
let lastState = null;
const { setIsOpen, setQuery, setCollections } = autocomplete({
container: searchEl,
detachedMediaQuery: detachedMediaQuery,
defaultActiveItemId: 0,
panelContainer: "#quarto-search-results",
panelPlacement: quartoSearchOptions["panel-placement"],
debug: false,
openOnFocus: true,
plugins,
classNames: {
form: "d-flex",
},
placeholder: language["search-text-placeholder"],
translations: {
clearButtonTitle: language["search-clear-button-title"],
detachedCancelButtonText: language["search-detached-cancel-button-title"],
submitButtonTitle: language["search-submit-button-title"],
},
initialState: {
query,
},
getItemUrl({ item }) {
return item.href;
},
onStateChange({ state }) {
// If this is a file URL, note that
// Perhaps reset highlighting
resetHighlighting(state.query);
// If the panel just opened, ensure the panel is positioned properly
if (state.isOpen) {
if (lastState && !lastState.isOpen) {
setTimeout(() => {
positionPanel(quartoSearchOptions["panel-placement"]);
}, 150);
}
}
// Perhaps show the copy link
showCopyLink(state.query, quartoSearchOptions);
lastState = state;
},
reshape({ sources, state }) {
return sources.map((source) => {
try {
const items = source.getItems();
// Validate the items
validateItems(items);
// group the items by document
const groupedItems = new Map();
items.forEach((item) => {
const hrefParts = item.href.split("#");
const baseHref = hrefParts[0];
const isDocumentItem = hrefParts.length === 1;
const items = groupedItems.get(baseHref);
if (!items) {
groupedItems.set(baseHref, [item]);
} else {
// If the href for this item matches the document
// exactly, place this item first as it is the item that represents
// the document itself
if (isDocumentItem) {
items.unshift(item);
} else {
items.push(item);
}
groupedItems.set(baseHref, items);
}
});
const reshapedItems = [];
let count = 1;
for (const [_key, value] of groupedItems) {
const firstItem = value[0];
reshapedItems.push({
...firstItem,
type: kItemTypeDoc,
});
const collapseMatches = quartoSearchOptions["collapse-after"];
const collapseCount =
typeof collapseMatches === "number" ? collapseMatches : 1;
if (value.length > 1) {
const target = `search-more-${count}`;
const isExpanded =
state.context.expanded &&
state.context.expanded.includes(target);
const remainingCount = value.length - collapseCount;
for (let i = 1; i < value.length; i++) {
if (collapseMatches && i === collapseCount) {
reshapedItems.push({
target,
title: isExpanded
? language["search-hide-matches-text"]
: remainingCount === 1
? `${remainingCount} ${language["search-more-match-text"]}`
: `${remainingCount} ${language["search-more-matches-text"]}`,
type: kItemTypeMore,
href: kItemTypeMoreHref,
});
}
if (isExpanded || !collapseMatches || i < collapseCount) {
reshapedItems.push({
...value[i],
type: kItemTypeItem,
target,
});
}
}
}
count += 1;
}
return {
...source,
getItems() {
return reshapedItems;
},
};
} catch (error) {
// Some form of error occurred
return {
...source,
getItems() {
return [
{
title: error.name || "An Error Occurred While Searching",
text:
error.message ||
"An unknown error occurred while attempting to perform the requested search.",
type: kItemTypeError,
},
];
},
};
}
});
},
navigator: {
navigate({ itemUrl }) {
if (itemUrl !== offsetURL(kItemTypeMoreHref)) {
window.location.assign(itemUrl);
}
},
navigateNewTab({ itemUrl }) {
if (itemUrl !== offsetURL(kItemTypeMoreHref)) {
const windowReference = window.open(itemUrl, "_blank", "noopener");
if (windowReference) {
windowReference.focus();
}
}
},
navigateNewWindow({ itemUrl }) {
if (itemUrl !== offsetURL(kItemTypeMoreHref)) {
window.open(itemUrl, "_blank", "noopener");
}
},
},
getSources({ state, setContext, setActiveItemId, refresh }) {
return [
{
sourceId: "documents",
getItemUrl({ item }) {
if (item.href) {
return offsetURL(item.href);
} else {
return undefined;
}
},
onSelect({
item,
state,
setContext,
setIsOpen,
setActiveItemId,
refresh,
}) {
if (item.type === kItemTypeMore) {
toggleExpanded(item, state, setContext, setActiveItemId, refresh);
// Toggle more
setIsOpen(true);
}
},
getItems({ query }) {
if (query === null || query === "") {
return [];
}
const limit = quartoSearchOptions.limit;
if (quartoSearchOptions.algolia) {
return algoliaSearch(query, limit, quartoSearchOptions.algolia);
} else {
// Fuse search options
const fuseSearchOptions = {
isCaseSensitive: false,
shouldSort: true,
minMatchCharLength: 2,
limit: limit,
};
return readSearchData().then(function (fuse) {
return fuseSearch(query, fuse, fuseSearchOptions);
});
}
},
templates: {
noResults({ createElement }) {
const hasQuery = lastState.query;
return createElement(
"div",
{
class: `quarto-search-no-results${
hasQuery ? "" : " no-query"
}`,
},
language["search-no-results-text"]
);
},
header({ items, createElement }) {
// count the documents
const count = items.filter((item) => {
return item.type === kItemTypeDoc;
}).length;
if (count > 0) {
return createElement(
"div",
{ class: "search-result-header" },
`${count} ${language["search-matching-documents-text"]}`
);
} else {
return createElement(
"div",
{ class: "search-result-header-no-results" },
``
);
}
},
footer({ _items, createElement }) {
if (
quartoSearchOptions.algolia &&
quartoSearchOptions.algolia["show-logo"]
) {
const libDir = quartoSearchOptions.algolia["libDir"];
const logo = createElement("img", {
src: offsetURL(
`${libDir}/quarto-search/search-by-algolia.svg`
),
class: "algolia-search-logo",
});
return createElement(
"a",
{ href: "http://www.algolia.com/" },
logo
);
}
},
item({ item, createElement }) {
return renderItem(
item,
createElement,
state,
setActiveItemId,
setContext,
refresh,
quartoSearchOptions
);
},
},
},
];
},
});
window.quartoOpenSearch = () => {
setIsOpen(false);
setIsOpen(true);
focusSearchInput();
};
document.addEventListener("keyup", (event) => {
const { key } = event;
const kbds = quartoSearchOptions["keyboard-shortcut"];
const focusedEl = document.activeElement;
const isFormElFocused = [
"input",
"select",
"textarea",
"button",
"option",
].find((tag) => {
return focusedEl.tagName.toLowerCase() === tag;
});
if (
kbds &&
kbds.includes(key) &&
!isFormElFocused &&
!document.activeElement.isContentEditable
) {
event.preventDefault();
window.quartoOpenSearch();
}
});
// Remove the labeleledby attribute since it is pointing
// to a non-existent label
if (quartoSearchOptions.type === "overlay") {
const inputEl = window.document.querySelector(
"#quarto-search .aa-Autocomplete"
);
if (inputEl) {
inputEl.removeAttribute("aria-labelledby");
}
}
function throttle(func, wait) {
let waiting = false;
return function () {
if (!waiting) {
func.apply(this, arguments);
waiting = true;
setTimeout(function () {
waiting = false;
}, wait);
}
};
}
// If the main document scrolls dismiss the search results
// (otherwise, since they're floating in the document they can scroll with the document)
window.document.body.onscroll = throttle(() => {
// Only do this if we're not detached
// Bug #7117
// This will happen when the keyboard is shown on ios (resulting in a scroll)
// which then closed the search UI
if (!window.matchMedia(detachedMediaQuery).matches) {
setIsOpen(false);
}
}, 50);
if (showSearchResults) {
setIsOpen(true);
focusSearchInput();
}
});
function configurePlugins(quartoSearchOptions) {
const autocompletePlugins = [];
const algoliaOptions = quartoSearchOptions.algolia;
if (
algoliaOptions &&
algoliaOptions["analytics-events"] &&
algoliaOptions["search-only-api-key"] &&
algoliaOptions["application-id"]
) {
const apiKey = algoliaOptions["search-only-api-key"];
const appId = algoliaOptions["application-id"];
// Aloglia insights may not be loaded because they require cookie consent
// Use deferred loading so events will start being recorded when/if consent
// is granted.
const algoliaInsightsDeferredPlugin = deferredLoadPlugin(() => {
if (
window.aa &&
window["@algolia/autocomplete-plugin-algolia-insights"]
) {
window.aa("init", {
appId,
apiKey,
useCookie: true,
});
const { createAlgoliaInsightsPlugin } =
window["@algolia/autocomplete-plugin-algolia-insights"];
// Register the insights client
const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({
insightsClient: window.aa,
onItemsChange({ insights, insightsEvents }) {
const events = insightsEvents.flatMap((event) => {
// This API limits the number of items per event to 20
const chunkSize = 20;
const itemChunks = [];
const eventItems = event.items;
for (let i = 0; i < eventItems.length; i += chunkSize) {
itemChunks.push(eventItems.slice(i, i + chunkSize));
}
// Split the items into multiple events that can be sent
const events = itemChunks.map((items) => {
return {
...event,
items,
};
});
return events;
});
for (const event of events) {
insights.viewedObjectIDs(event);
}
},
});
return algoliaInsightsPlugin;
}
});
// Add the plugin
autocompletePlugins.push(algoliaInsightsDeferredPlugin);
return autocompletePlugins;
}
}
// For plugins that may not load immediately, create a wrapper
// plugin and forward events and plugin data once the plugin
// is initialized. This is useful for cases like cookie consent
// which may prevent the analytics insights event plugin from initializing
// immediately.
function deferredLoadPlugin(createPlugin) {
let plugin = undefined;
let subscribeObj = undefined;
const wrappedPlugin = () => {
if (!plugin && subscribeObj) {
plugin = createPlugin();
if (plugin && plugin.subscribe) {
plugin.subscribe(subscribeObj);
}
}
return plugin;
};
return {
subscribe: (obj) => {
subscribeObj = obj;
},
onStateChange: (obj) => {
const plugin = wrappedPlugin();
if (plugin && plugin.onStateChange) {
plugin.onStateChange(obj);
}
},
onSubmit: (obj) => {
const plugin = wrappedPlugin();
if (plugin && plugin.onSubmit) {
plugin.onSubmit(obj);
}
},
onReset: (obj) => {
const plugin = wrappedPlugin();
if (plugin && plugin.onReset) {
plugin.onReset(obj);
}
},
getSources: (obj) => {
const plugin = wrappedPlugin();
if (plugin && plugin.getSources) {
return plugin.getSources(obj);
} else {
return Promise.resolve([]);
}
},
data: (obj) => {
const plugin = wrappedPlugin();
if (plugin && plugin.data) {
plugin.data(obj);
}
},
};
}
function validateItems(items) {
// Validate the first item
if (items.length > 0) {
const item = items[0];
const missingFields = [];
if (item.href == undefined) {
missingFields.push("href");
}
if (!item.title == undefined) {
missingFields.push("title");
}
if (!item.text == undefined) {
missingFields.push("text");
}
if (missingFields.length === 1) {
throw {
name: `Error: Search index is missing the <code>${missingFields[0]}</code> field.`,
message: `The items being returned for this search do not include all the required fields. Please ensure that your index items include the <code>${missingFields[0]}</code> field or use <code>index-fields</code> in your <code>_quarto.yml</code> file to specify the field names.`,
};
} else if (missingFields.length > 1) {
const missingFieldList = missingFields
.map((field) => {
return `<code>${field}</code>`;
})
.join(", ");
throw {
name: `Error: Search index is missing the following fields: ${missingFieldList}.`,
message: `The items being returned for this search do not include all the required fields. Please ensure that your index items includes the following fields: ${missingFieldList}, or use <code>index-fields</code> in your <code>_quarto.yml</code> file to specify the field names.`,
};
}
}
}
let lastQuery = null;
function showCopyLink(query, options) {
const language = options.language;
lastQuery = query;
// Insert share icon
const inputSuffixEl = window.document.body.querySelector(
".aa-Form .aa-InputWrapperSuffix"
);
if (inputSuffixEl) {
let copyButtonEl = window.document.body.querySelector(
".aa-Form .aa-InputWrapperSuffix .aa-CopyButton"
);
if (copyButtonEl === null) {
copyButtonEl = window.document.createElement("button");
copyButtonEl.setAttribute("class", "aa-CopyButton");
copyButtonEl.setAttribute("type", "button");
copyButtonEl.setAttribute("title", language["search-copy-link-title"]);
copyButtonEl.onmousedown = (e) => {
e.preventDefault();
e.stopPropagation();
};
const linkIcon = "bi-clipboard";
const checkIcon = "bi-check2";
const shareIconEl = window.document.createElement("i");
shareIconEl.setAttribute("class", `bi ${linkIcon}`);
copyButtonEl.appendChild(shareIconEl);
inputSuffixEl.prepend(copyButtonEl);
const clipboard = new window.ClipboardJS(".aa-CopyButton", {
text: function (_trigger) {
const copyUrl = new URL(window.location);
copyUrl.searchParams.set(kQueryArg, lastQuery);
copyUrl.searchParams.set(kResultsArg, "1");
return copyUrl.toString();
},
});
clipboard.on("success", function (e) {
// Focus the input
// button target
const button = e.trigger;
const icon = button.querySelector("i.bi");
// flash "checked"
icon.classList.add(checkIcon);
icon.classList.remove(linkIcon);
setTimeout(function () {
icon.classList.remove(checkIcon);
icon.classList.add(linkIcon);
}, 1000);
});
}
// If there is a query, show the link icon
if (copyButtonEl) {
if (lastQuery && options["copy-button"]) {
copyButtonEl.style.display = "flex";
} else {
copyButtonEl.style.display = "none";
}
}
}
}
/* Search Index Handling */
// create the index
var fuseIndex = undefined;
var shownWarning = false;
async function readSearchData() {
// Initialize the search index on demand
if (fuseIndex === undefined) {
if (window.location.protocol === "file:" && !shownWarning) {
window.alert(
"Search requires JavaScript features disabled when running in file://... URLs. In order to use search, please run this document in a web server."
);
shownWarning = true;
return;
}
// create fuse index
const options = {
keys: [
{ name: "title", weight: 20 },
{ name: "section", weight: 20 },
{ name: "text", weight: 10 },
],
ignoreLocation: true,
threshold: 0.1,
};
const fuse = new window.Fuse([], options);
// fetch the main search.json
const response = await fetch(offsetURL("search.json"));
if (response.status == 200) {
return response.json().then(function (searchDocs) {
searchDocs.forEach(function (searchDoc) {
fuse.add(searchDoc);
});
fuseIndex = fuse;
return fuseIndex;
});
} else {
return Promise.reject(
new Error(
"Unexpected status from search index request: " + response.status
)
);
}
}
return fuseIndex;
}
function inputElement() {
return window.document.body.querySelector(".aa-Form .aa-Input");
}
function focusSearchInput() {
setTimeout(() => {
const inputEl = inputElement();
if (inputEl) {
inputEl.focus();
}
}, 50);
}
/* Panels */
const kItemTypeDoc = "document";
const kItemTypeMore = "document-more";
const kItemTypeItem = "document-item";
const kItemTypeError = "error";
function renderItem(
item,
createElement,
state,
setActiveItemId,
setContext,
refresh,
quartoSearchOptions
) {
switch (item.type) {
case kItemTypeDoc:
return createDocumentCard(
createElement,
"file-richtext",
item.title,
item.section,
item.text,
item.href,
item.crumbs,
quartoSearchOptions
);
case kItemTypeMore:
return createMoreCard(
createElement,
item,
state,
setActiveItemId,
setContext,
refresh
);
case kItemTypeItem:
return createSectionCard(
createElement,
item.section,
item.text,
item.href
);
case kItemTypeError:
return createErrorCard(createElement, item.title, item.text);
default:
return undefined;
}
}
function createDocumentCard(
createElement,
icon,
title,
section,
text,
href,
crumbs,
quartoSearchOptions
) {
const iconEl = createElement("i", {
class: `bi bi-${icon} search-result-icon`,
});
const titleEl = createElement("p", { class: "search-result-title" }, title);
const titleContents = [iconEl, titleEl];
const showParent = quartoSearchOptions["show-item-context"];
if (crumbs && showParent) {
let crumbsOut = undefined;
const crumbClz = ["search-result-crumbs"];
if (showParent === "root") {
crumbsOut = crumbs.length > 1 ? crumbs[0] : undefined;
} else if (showParent === "parent") {
crumbsOut = crumbs.length > 1 ? crumbs[crumbs.length - 2] : undefined;
} else {
crumbsOut = crumbs.length > 1 ? crumbs.join(" > ") : undefined;
crumbClz.push("search-result-crumbs-wrap");
}
const crumbEl = createElement(
"p",
{ class: crumbClz.join(" ") },
crumbsOut
);
titleContents.push(crumbEl);
}
const titleContainerEl = createElement(
"div",
{ class: "search-result-title-container" },
titleContents
);
const textEls = [];
if (section) {
const sectionEl = createElement(
"p",
{ class: "search-result-section" },
section
);
textEls.push(sectionEl);
}
const descEl = createElement("p", {
class: "search-result-text",
dangerouslySetInnerHTML: {
__html: text,
},
});
textEls.push(descEl);
const textContainerEl = createElement(
"div",
{ class: "search-result-text-container" },
textEls
);
const containerEl = createElement(
"div",
{
class: "search-result-container",
},
[titleContainerEl, textContainerEl]
);
const linkEl = createElement(
"a",
{
href: offsetURL(href),
class: "search-result-link",
},
containerEl
);
const classes = ["search-result-doc", "search-item"];
if (!section) {
classes.push("document-selectable");
}
return createElement(
"div",
{
class: classes.join(" "),
},
linkEl
);
}
function createMoreCard(
createElement,
item,
state,
setActiveItemId,
setContext,
refresh
) {
const moreCardEl = createElement(
"div",
{
class: "search-result-more search-item",
onClick: (e) => {
// Handle expanding the sections by adding the expanded
// section to the list of expanded sections
toggleExpanded(item, state, setContext, setActiveItemId, refresh);
e.stopPropagation();
},
},
item.title
);
return moreCardEl;
}
function toggleExpanded(item, state, setContext, setActiveItemId, refresh) {
const expanded = state.context.expanded || [];
if (expanded.includes(item.target)) {
setContext({
expanded: expanded.filter((target) => target !== item.target),
});
} else {
setContext({ expanded: [...expanded, item.target] });
}
refresh();
setActiveItemId(item.__autocomplete_id);
}
function createSectionCard(createElement, section, text, href) {
const sectionEl = createSection(createElement, section, text, href);
return createElement(
"div",
{
class: "search-result-doc-section search-item",
},
sectionEl
);
}
function createSection(createElement, title, text, href) {
const descEl = createElement("p", {
class: "search-result-text",
dangerouslySetInnerHTML: {
__html: text,
},
});
const titleEl = createElement("p", { class: "search-result-section" }, title);
const linkEl = createElement(
"a",
{
href: offsetURL(href),
class: "search-result-link",
},
[titleEl, descEl]
);
return linkEl;
}
function createErrorCard(createElement, title, text) {
const descEl = createElement("p", {
class: "search-error-text",
dangerouslySetInnerHTML: {
__html: text,
},
});
const titleEl = createElement("p", {
class: "search-error-title",
dangerouslySetInnerHTML: {
__html: `<i class="bi bi-exclamation-circle search-error-icon"></i> ${title}`,
},
});
const errorEl = createElement("div", { class: "search-error" }, [
titleEl,
descEl,
]);
return errorEl;
}
function positionPanel(pos) {
const panelEl = window.document.querySelector(
"#quarto-search-results .aa-Panel"
);
const inputEl = window.document.querySelector(
"#quarto-search .aa-Autocomplete"
);
if (panelEl && inputEl) {
panelEl.style.top = `${Math.round(panelEl.offsetTop)}px`;
if (pos === "start") {
panelEl.style.left = `${Math.round(inputEl.left)}px`;
} else {
panelEl.style.right = `${Math.round(inputEl.offsetRight)}px`;
}
}
}
/* Highlighting */
// highlighting functions
function highlightMatch(query, text) {
if (text) {
const start = text.toLowerCase().indexOf(query.toLowerCase());
if (start !== -1) {
const startMark = "<mark class='search-match'>";
const endMark = "</mark>";
const end = start + query.length;
text =
text.slice(0, start) +
startMark +
text.slice(start, end) +
endMark +
text.slice(end);
const startInfo = clipStart(text, start);
const endInfo = clipEnd(
text,
startInfo.position + startMark.length + endMark.length
);
text =
startInfo.prefix +
text.slice(startInfo.position, endInfo.position) +
endInfo.suffix;
return text;
} else {
return text;
}
} else {
return text;
}
}
function clipStart(text, pos) {
const clipStart = pos - 50;
if (clipStart < 0) {
// This will just return the start of the string
return {
position: 0,
prefix: "",
};
} else {
// We're clipping before the start of the string, walk backwards to the first space.
const spacePos = findSpace(text, pos, -1);
return {
position: spacePos.position,
prefix: "",
};
}
}
function clipEnd(text, pos) {
const clipEnd = pos + 200;
if (clipEnd > text.length) {
return {
position: text.length,
suffix: "",
};
} else {
const spacePos = findSpace(text, clipEnd, 1);
return {
position: spacePos.position,
suffix: spacePos.clipped ? "…" : "",
};
}
}
function findSpace(text, start, step) {
let stepPos = start;
while (stepPos > -1 && stepPos < text.length) {
const char = text[stepPos];
if (char === " " || char === "," || char === ":") {
return {
position: step === 1 ? stepPos : stepPos - step,
clipped: stepPos > 1 && stepPos < text.length,
};
}
stepPos = stepPos + step;
}
return {
position: stepPos - step,
clipped: false,
};
}
// removes highlighting as implemented by the mark tag
function clearHighlight(searchterm, el) {
const childNodes = el.childNodes;
for (let i = childNodes.length - 1; i >= 0; i--) {
const node = childNodes[i];
if (node.nodeType === Node.ELEMENT_NODE) {
if (
node.tagName === "MARK" &&
node.innerText.toLowerCase() === searchterm.toLowerCase()
) {
el.replaceChild(document.createTextNode(node.innerText), node);
} else {
clearHighlight(searchterm, node);
}
}
}
}
function escapeRegExp(string) {
return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
}
// highlight matches
function highlight(term, el) {
const termRegex = new RegExp(term, "ig");
const childNodes = el.childNodes;
// walk back to front avoid mutating elements in front of us
for (let i = childNodes.length - 1; i >= 0; i--) {
const node = childNodes[i];
if (node.nodeType === Node.TEXT_NODE) {
// Search text nodes for text to highlight
const text = node.nodeValue;
let startIndex = 0;
let matchIndex = text.search(termRegex);
if (matchIndex > -1) {
const markFragment = document.createDocumentFragment();
while (matchIndex > -1) {
const prefix = text.slice(startIndex, matchIndex);
markFragment.appendChild(document.createTextNode(prefix));
const mark = document.createElement("mark");
mark.appendChild(
document.createTextNode(
text.slice(matchIndex, matchIndex + term.length)
)
);
markFragment.appendChild(mark);
startIndex = matchIndex + term.length;
matchIndex = text.slice(startIndex).search(new RegExp(term, "ig"));
if (matchIndex > -1) {
matchIndex = startIndex + matchIndex;
}
}
if (startIndex < text.length) {
markFragment.appendChild(
document.createTextNode(text.slice(startIndex, text.length))
);
}
el.replaceChild(markFragment, node);
}
} else if (node.nodeType === Node.ELEMENT_NODE) {
// recurse through elements
highlight(term, node);
}
}
}
/* Link Handling */
// get the offset from this page for a given site root relative url
function offsetURL(url) {
var offset = getMeta("quarto:offset");
return offset ? offset + url : url;
}
// read a meta tag value
function getMeta(metaName) {
var metas = window.document.getElementsByTagName("meta");
for (let i = 0; i < metas.length; i++) {
if (metas[i].getAttribute("name") === metaName) {
return metas[i].getAttribute("content");
}
}
return "";
}
function algoliaSearch(query, limit, algoliaOptions) {
const { getAlgoliaResults } = window["@algolia/autocomplete-preset-algolia"];
const applicationId = algoliaOptions["application-id"];
const searchOnlyApiKey = algoliaOptions["search-only-api-key"];
const indexName = algoliaOptions["index-name"];
const indexFields = algoliaOptions["index-fields"];
const searchClient = window.algoliasearch(applicationId, searchOnlyApiKey);
const searchParams = algoliaOptions["params"];
const searchAnalytics = !!algoliaOptions["analytics-events"];
return getAlgoliaResults({
searchClient,
queries: [
{
indexName: indexName,
query,
params: {
hitsPerPage: limit,
clickAnalytics: searchAnalytics,
...searchParams,
},
},
],
transformResponse: (response) => {
if (!indexFields) {
return response.hits.map((hit) => {
return hit.map((item) => {
return {
...item,
text: highlightMatch(query, item.text),
};
});
});
} else {
const remappedHits = response.hits.map((hit) => {
return hit.map((item) => {
const newItem = { ...item };
["href", "section", "title", "text", "crumbs"].forEach(
(keyName) => {
const mappedName = indexFields[keyName];
if (
mappedName &&
item[mappedName] !== undefined &&
mappedName !== keyName
) {
newItem[keyName] = item[mappedName];
delete newItem[mappedName];
}
}
);
newItem.text = highlightMatch(query, newItem.text);
return newItem;
});
});
return remappedHits;
}
},
});
}
function fuseSearch(query, fuse, fuseOptions) {
return fuse.search(query, fuseOptions).map((result) => {
const addParam = (url, name, value) => {
const anchorParts = url.split("#");
const baseUrl = anchorParts[0];
const sep = baseUrl.search("\\?") > 0 ? "&" : "?";
anchorParts[0] = baseUrl + sep + name + "=" + value;
return anchorParts.join("#");
};
return {
title: result.item.title,
section: result.item.section,
href: addParam(result.item.href, kQueryArg, query),
text: highlightMatch(query, result.item.text),
crumbs: result.item.crumbs,
};
});
}
|