bonfire-app/Bonfire.Tag.Autocomplete.html
2024-04-16 21:21:08 +00:00

839 lines
24 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.2">
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
<title>Bonfire.Tag.Autocomplete — bonfire_umbrella v0.9.10-cooperation-beta.62</title>
<link rel="stylesheet" href="dist/html-elixir-JKHCEBPC.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-A7S2WMC7.js"></script>
<script src="dist/sidebar_items-0AD831F9.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JRPQ5PR6.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="https://bonfirenetworks.org" class="sidebar-projectImage">
<img src="assets/logo.png" alt="bonfire_umbrella" />
</a>
<div>
<a href="https://bonfirenetworks.org" class="sidebar-projectName" translate="no">
bonfire_umbrella
</a>
<div class="sidebar-projectVersion" translate="no">
v0.9.10-cooperation-beta.62
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of bonfire_umbrella</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Bonfire.Tag.Autocomplete</span>
<small class="app-vsn" translate="no">(bonfire_umbrella v0.9.10-cooperation-beta.62)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#api_tag_lookup/3" translate="no">api_tag_lookup(tag_search, prefix, consumer)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#api_tag_lookup_public/4" translate="no">api_tag_lookup_public(tag_search, prefix, consumer, index_type)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#filter_results/1" translate="no">filter_results(res)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#find_all_tags/1" translate="no">find_all_tags(content)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#maybe_find_tags/2" translate="no">maybe_find_tags(tag_search, index_type)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#maybe_search/4" translate="no">maybe_search(tag_search, facets \\ nil, prefix \\ nil, consumer \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#prefix_index/1" translate="no">prefix_index(prefix)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#search_or_lookup/3" translate="no">search_or_lookup(tag_search, index, facets \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#search_prefix/2" translate="no">search_prefix(tag_search, prefix)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#search_type/2" translate="no">search_type(tag_search, type)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_add_field/4" translate="no">tag_add_field(hit, consumer, prefix, username)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_hit_prepare/4" translate="no">tag_hit_prepare(hit, tag_search, prefix, consumer)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_lookup_public/4" translate="no">tag_lookup_public(tag_search, index_type, prefix \\ nil, consumer \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_search/2" translate="no">tag_search(tag_search, tag_prefix)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_search_from_tags/1" translate="no">tag_search_from_tags(text)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tag_search_from_text/2" translate="no">tag_search_from_text(text, prefix)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tags_split/1" translate="no">tags_split(text)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#try_all_prefixes/1" translate="no">try_all_prefixes(content)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#try_prefixes/1" translate="no">try_prefixes(content)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#try_tag_search/1" translate="no">try_tag_search(content)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#try_tag_search/2" translate="no">try_tag_search(tag_prefix, words)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="api_tag_lookup/3">
<div class="detail-header">
<a href="#api_tag_lookup/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">api_tag_lookup(tag_search, prefix, consumer)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L35" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="api_tag_lookup_public/4">
<div class="detail-header">
<a href="#api_tag_lookup_public/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">api_tag_lookup_public(tag_search, prefix, consumer, index_type)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L47" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="filter_results/1">
<div class="detail-header">
<a href="#filter_results/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">filter_results(res)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L199" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="find_all_tags/1">
<div class="detail-header">
<a href="#find_all_tags/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">find_all_tags(content)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L174" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="maybe_find_tags/2">
<div class="detail-header">
<a href="#maybe_find_tags/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">maybe_find_tags(tag_search, index_type)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L59" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="maybe_search/4">
<span id="maybe_search/1"></span>
<span id="maybe_search/2"></span>
<span id="maybe_search/3"></span>
<div class="detail-header">
<a href="#maybe_search/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">maybe_search(tag_search, facets \\ nil, prefix \\ nil, consumer \\ nil)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L82" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="prefix_index/1">
<div class="detail-header">
<a href="#prefix_index/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">prefix_index(prefix)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L17" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="search_or_lookup/3">
<span id="search_or_lookup/2"></span>
<div class="detail-header">
<a href="#search_or_lookup/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">search_or_lookup(tag_search, index, facets \\ nil)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L65" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="search_prefix/2">
<div class="detail-header">
<a href="#search_prefix/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">search_prefix(tag_search, prefix)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L39" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="search_type/2">
<div class="detail-header">
<a href="#search_type/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">search_type(tag_search, type)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L43" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_add_field/4">
<div class="detail-header">
<a href="#tag_add_field/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_add_field(hit, consumer, prefix, username)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L161" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_hit_prepare/4">
<div class="detail-header">
<a href="#tag_hit_prepare/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_hit_prepare(hit, tag_search, prefix, consumer)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L136" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_lookup_public/4">
<span id="tag_lookup_public/2"></span>
<span id="tag_lookup_public/3"></span>
<div class="detail-header">
<a href="#tag_lookup_public/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_lookup_public(tag_search, index_type, prefix \\ nil, consumer \\ nil)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L51" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_search/2">
<div class="detail-header">
<a href="#tag_search/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_search(tag_search, tag_prefix)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L253" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_search_from_tags/1">
<div class="detail-header">
<a href="#tag_search_from_tags/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_search_from_tags(text)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L290" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tag_search_from_text/2">
<div class="detail-header">
<a href="#tag_search_from_text/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tag_search_from_text(text, prefix)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L268" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="tags_split/1">
<div class="detail-header">
<a href="#tags_split/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">tags_split(text)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L282" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="try_all_prefixes/1">
<div class="detail-header">
<a href="#try_all_prefixes/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">try_all_prefixes(content)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L216" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="try_prefixes/1">
<div class="detail-header">
<a href="#try_prefixes/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">try_prefixes(content)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L226" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="try_tag_search/1">
<div class="detail-header">
<a href="#try_tag_search/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">try_tag_search(content)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L245" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="try_tag_search/2">
<div class="detail-header">
<a href="#try_tag_search/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">try_tag_search(tag_prefix, words)</h1>
<a href="https://github.com/bonfire-networks/bonfire_tag/blob/main/lib/autocomplete.ex#L231" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="bonfire_umbrella.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>