Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Replace `<datalist>` with `@knadh/autocomp.js` in list/campaign selector for better UX.

Kailash Nadh33fa6d68b40e
diff --git a/static/admin/assets/css/style.css b/static/admin/assets/css/style.css
index aa938002..c641f24a 100644
--- a/static/admin/assets/css/style.css
+++ b/static/admin/assets/css/style.css
@@ -227,6 +227,24 @@ ot-tabs:not(:defined) {
}
}
+.autocomp {
+ background: var(--card);
+ color: var(--foreground);
+ border: 1px solid var(--border);
+ border-radius: var(--radius-medium);
+ box-shadow: var(--shadow-medium);
+
+ .autocomp-item {
+ padding: var(--space-2) var(--space-3);
+ cursor: pointer;
+
+ &:hover,
+ &[aria-selected="true"] {
+ background: var(--accent);
+ }
+ }
+}
+
fieldset {
&.card {
padding-block-start: var(--space-4);
diff --git a/static/admin/assets/js/main.js b/static/admin/assets/js/main.js
index 0a43e156..d079e33a 100644
--- a/static/admin/assets/js/main.js
+++ b/static/admin/assets/js/main.js
@@ -1,5 +1,6 @@
import '@knadh/oat';
import Alpine from 'alpinejs';
+import { tagAutocomplete, tagNode } from './tag-selector.js';
import { I18n } from './i18n.js';
import { register as registerTable } from './table.js';
import * as u from './utils.js';
@@ -27,6 +28,7 @@ function setupAlpine() {
isLoading,
copyToClipboard: u.copyToClipboard,
listAutocomplete,
+ listTagNode,
theme: localStorage.getItem('theme') || 'auto',
@@ -148,21 +150,18 @@ export class ListTag {
}
}
-// listAutocomplete populates the <ot-taginput> list selector's suggestions with lists.
+// List selector rendering and its locally available suggestions.
+export function listTagNode(list, small = false) {
+ return tagNode(list, 'list', small);
+}
+
export function listAutocomplete(el) {
- const ti = el.closest('ot-taginput');
- const chosen = new Set((ti ? ti.value : []).map((l) => l.id));
- const q = el.value.toLowerCase();
-
- el.list.replaceChildren(...(window._lists || [])
- .filter((l) => !chosen.has(l.id) && l.name.toLowerCase().includes(q))
- // Cap suggestions (so focusing with an empty input still shows a usable list of items).
- .slice(0, 10)
- .map((l) => {
- const o = new Option(l.name);
- o.data = new ListTag(l);
- return o;
- }));
+ tagAutocomplete(el, {
+ render: listTagNode,
+ query: (q) => (window._lists || [])
+ .filter((l) => l.name.toLowerCase().includes(q.toLowerCase()))
+ .map((l) => new ListTag(l)),
+ });
}
// Returns true if the given named api() call is currently loading.
diff --git a/static/admin/assets/js/tag-selector.js b/static/admin/assets/js/tag-selector.js
new file mode 100644
index 00000000..00ca165d
--- /dev/null
+++ b/static/admin/assets/js/tag-selector.js
@@ -0,0 +1,55 @@
+import { autocomp } from '@knadh/autocomp';
+
+// Get the key of a tag, either .id for an object or the string itself.
+function tagKey(tag) {
+ const item = tag.item ?? tag;
+ return typeof item === 'string' ? item : item.id;
+}
+
+// Render a resource + avatar from objects.
+export function tagNode(item, kind, small = false, label = item.name) {
+ if (typeof item === 'string') return item;
+ const row = document.createElement('span');
+ row.className = small ? 'avatar xsmall center' : 'avatar';
+ row.item = item;
+ row.innerHTML = `<span class="avatar-icon avatar-${kind}"><span class="avatar-initials" aria-hidden="true"></span></span><span class="avatar-label"></span>`;
+
+ // Match the initials used by the server-rendered avatars.
+ const words = item.name.match(/[\p{L}\p{Nd}]+/gu) || [];
+ const initials = words.length > 1
+ ? [...words[0]][0] + [...words[1]][0]
+ : [...(words[0] || '?')].slice(0, 2).join('');
+ row.querySelector('.avatar-initials').textContent = initials.toUpperCase();
+ row.querySelector('.avatar-label').textContent = label;
+ return row;
+}
+
+// Attach string or object suggestions to Oat taginput.
+export function tagAutocomplete(el, { query, render = (item) => item, debounce = 0 }) {
+ const ti = el.closest('ot-taginput');
+ autocomp(el, {
+ debounce,
+ async onQuery(q) {
+ const results = await query(q);
+ const chosen = new Set(ti.value.map(tagKey));
+ return results.filter((item) => !chosen.has(tagKey(item))).slice(0, 10);
+ },
+
+ onRender(item) {
+ const node = render(item, false);
+ return typeof node === 'string' ? document.createTextNode(node) : node;
+ },
+
+ onSelect(item) {
+ if (!ti.value.some((tag) => tagKey(tag) === tagKey(item))) {
+ ti.add(render(item, true));
+ }
+ return '';
+ },
+ });
+
+ // Show suggestions before the user starts typing.
+ ['focus', 'click'].forEach((event) => {
+ el.addEventListener(event, () => el.dispatchEvent(new Event('input')));
+ });
+}
diff --git a/static/admin/assets/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
index 22b6376d..2b583b7d 100644
--- a/static/admin/assets/js/views/analytics.js
+++ b/static/admin/assets/js/views/analytics.js
@@ -2,6 +2,7 @@ import Alpine from 'alpinejs';
import Chart from 'chart.js/auto';
import { api } from '../main.js';
+import { tagAutocomplete, tagNode } from '../tag-selector.js';
const chartColorRed = '#ee7d5b';
const chartColors = [
@@ -120,14 +121,12 @@ class AnalyticsTag {
}
toString() {
- return `#${this.id}: ${this.name}`;
+ return this.name;
}
}
// analyticsForm is the Alpine component for the analytics page.
function analyticsForm(from, to) {
- let queryTimer = null;
-
return {
items: (window._selectedItems || []).map((c) => new AnalyticsTag(c)),
@@ -172,31 +171,32 @@ function analyticsForm(from, to) {
this.$nextTick(() => this.$root.requestSubmit());
},
- // Populate the selector's suggestions with the resource API.
- onQuery(el) {
- clearTimeout(queryTimer);
- queryTimer = setTimeout(async () => {
- const ti = el.closest('ot-taginput');
- const chosen = new Set((ti ? ti.value : []).map((c) => c.id));
- const params = new URLSearchParams({
- query: el.value.trim(),
- order_by: 'created_at',
- order: 'DESC',
- no_body: 'true',
- per_page: '10',
- });
-
- try {
- const data = await api(`analytics.${window._analyticsResource}`, `/${window._analyticsResource}?${params.toString()}`, 'GET');
- el.list.replaceChildren(...(data.results || [])
- .filter((c) => !chosen.has(c.id))
- .map((c) => {
- const o = new Option(`#${c.id}: ${c.name}`);
- o.data = new AnalyticsTag(c);
- return o;
- }));
- } catch (err) { /* api() shows a toast. */ }
- }, 200);
+ itemNode(item, small = false) {
+ return tagNode(item, window._analyticsResource === 'lists' ? 'list' : 'campaign', small, String(item));
+ },
+
+ autocomplete(el) {
+ tagAutocomplete(el, {
+ render: (item, small) => this.itemNode(item, small),
+ debounce: 200,
+ query: async (q) => {
+ const params = new URLSearchParams({
+ query: q.trim(),
+ order_by: 'created_at',
+ order: 'DESC',
+ no_body: 'true',
+ per_page: '10',
+ });
+
+ try {
+ const data = await api(`analytics.${window._analyticsResource}`, `/${window._analyticsResource}?${params}`, 'GET');
+ return (data.results || []).map((c) => new AnalyticsTag(c));
+ } catch {
+ // api() shows a toast; dismiss suggestions on failure.
+ return [];
+ }
+ },
+ });
},
};
}
diff --git a/static/admin/bun.lock b/static/admin/bun.lock
index 638b28cc..5081b508 100644
--- a/static/admin/bun.lock
+++ b/static/admin/bun.lock
@@ -14,7 +14,8 @@
"@codemirror/search": "^6.7.1",
"@codemirror/state": "^6.7.0",
"@codemirror/view": "^6.43.4",
- "@knadh/oat": "^1.0.0",
+ "@knadh/autocomp": "^2.0.0",
+ "@knadh/oat": "^1.1.0",
"@lezer/highlight": "^1.2.3",
"alpinejs": "^3.15.12",
"altcha": "^3.4.1",
@@ -46,7 +47,9 @@
"@codemirror/view": ["@codemirror/[email protected]", "", { "dependencies": { "@codemirror/state": "^6.7.0", "crelt": "^1.0.6", "style-mod": "^4.1.0", "w3c-keyname": "^2.2.4" } }, "sha512-YImu23iyKfncJzT7sRy+rEqEhSc8RhOHqDxwy4WzXRKJwYm6iwf/9OJk5ctCAdZ6yi2ZqaGEvmf55fSVqMDrgg=="],
- "@knadh/oat": ["@knadh/[email protected]", "", {}, "sha512-8+ZoFS08UFVgcm8CZwW9ehELvELBxxaKFGE3S+n8nOTeUplIumwhe5ov66izL4peBOmiQU6cJ9zk5Z77Vh/nDQ=="],
+ "@knadh/autocomp": ["@knadh/[email protected]", "", {}, "sha512-wOWxeiman3jvtLrLqwfa7RO8+JW43KhgZ0vZGLWJraGW+cgjKm0KV/z6TLQENfEfDFptmyuP6dHsA4S2Z/vK9A=="],
+
+ "@knadh/oat": ["@knadh/[email protected]", "", {}, "sha512-6nYrV+a5qiLmcyUeQmvbs6xNECaqRI37x9Ds9K8SN5jgKvJxFL+AlZQDHLELtdtp1wD1pUul29XNv8GI69gzUw=="],
"@kurkle/color": ["@kurkle/[email protected]", "", {}, "sha512-M5UknZPHRu3DEDWoipU6sE8PdkZ6Z/S+v4dD+Ke8IaNlpdSQah50lz1KtcFBa2vsdOnwbbnxJwVM4wty6udA5w=="],
diff --git a/static/admin/package.json b/static/admin/package.json
index 04e06dde..e0255d83 100644
--- a/static/admin/package.json
+++ b/static/admin/package.json
@@ -18,7 +18,8 @@
"@codemirror/search": "^6.7.1",
"@codemirror/state": "^6.7.0",
"@codemirror/view": "^6.43.4",
- "@knadh/oat": "^1.0.0",
+ "@knadh/autocomp": "^2.0.0",
+ "@knadh/oat": "^1.1.0",
"@lezer/highlight": "^1.2.3",
"alpinejs": "^3.15.12",
"altcha": "^3.4.1",
diff --git a/static/admin/partials/list-selector.html b/static/admin/partials/list-selector.html
index 66dacd70..0f54d243 100644
--- a/static/admin/partials/list-selector.html
+++ b/static/admin/partials/list-selector.html
@@ -3,12 +3,11 @@
{{- $model := .Model -}}
{{- $listID := .ListID -}}
{{- $disabled := .Disabled -}}
-<label data-field>
- {{ if .Label }}{{ $root.L.T .Label }}{{ end }}
- <ot-taginput x-model="{{ $model }}" {{ if $disabled }}:disabled="{{ $disabled }}"{{ end -}}>
- <input list="{{ $listID }}" placeholder="{{ $root.L.T .Placeholder }}" @input="listAutocomplete($el)" @pointerdown="listAutocomplete($el)" @focus="listAutocomplete($el)" />
- <datalist id="{{ $listID }}"></datalist>
+<div data-field>
+ {{ if .Label }}<label for="{{ $listID }}">{{ $root.L.T .Label }}</label>{{ end }}
+ <ot-taginput x-effect="$el.value = {{ $model }}.map((list) => listTagNode(list, true))" @input="{{ $model }} = $el.value.map((tag) => tag.item || tag)" {{ if $disabled }}:disabled="{{ $disabled }}"{{ end -}}>
+ <input id="{{ $listID }}" aria-label="{{ $root.L.T .Placeholder }}" placeholder="{{ $root.L.T .Placeholder }}" x-init="listAutocomplete($el)" />
</ot-taginput>
<small data-hint>{{ $root.L.T "subscribers.listsHelp" }}</small>
-</label>
+</div>
{{- end }}
diff --git a/static/admin/views/analytics.html b/static/admin/views/analytics.html
index 0f9191f7..c588f4f3 100644
--- a/static/admin/views/analytics.html
+++ b/static/admin/views/analytics.html
@@ -20,13 +20,12 @@
<h4 class="title">{{ .L.T "globals.terms.analytics" }}</h4>
<div class="row">
<div class="col-5">
- <label data-field>
- {{ .L.T (printf "globals.terms.%s" $d.Resource) }}
- <ot-taginput x-model="items">
- <input list="analytics-items" placeholder="{{ .L.T (printf "globals.terms.%s" $d.Resource) }}" @input="onQuery($el)" @pointerdown="onQuery($el)" @focus="onQuery($el)" />
- <datalist id="analytics-items"></datalist>
+ <div data-field>
+ <label for="analytics-items">{{ .L.T (printf "globals.terms.%s" $d.Resource) }}</label>
+ <ot-taginput x-effect="$el.value = items.map((item) => itemNode(item, true))" @input="items = $el.value.map((tag) => tag.item || tag)">
+ <input id="analytics-items" placeholder="{{ .L.T (printf "globals.terms.%s" $d.Resource) }}" x-init="autocomplete($el)" />
</ot-taginput>
- </label>
+ </div>
<template x-for="c in items" :key="c.id">
<input type="hidden" name="id" :value="c.id" />
</template>