Автоматичний -Aktualізація частинних aktualizaторів з Alpine.js та HTMX
Введение
Отже, у проекті, який перетворюється на серію, я хотів додати здатність до автоматизації частинної передачі даних на певний час.
Ось як я це зробив, використовуючи Alpine.js та HTMX
Требування
Я хотів, щоб це було
- відновлюваний; так, що він має бути простим і самодостатнім
- Він має враховувати існуючі параметри Url
- Це має бути відчутним Serwer Side (in ASP.NET Core в цьому випадку
- Якщо він вмикається, він має бути вłączony для цього кінцевого пункту і це має бути запам 'ятововано між запитими.
- Він повинен миттєво зробити оновлення, коли включений ( так що пользователь знає, як він виглядає
- Він повинен бути в змозі відключитися користувачам
- Це повинно бути просто ввести в сторінку.
З таким уявленням я вирішила побудувати маленький модуль JS, використовуючи Alpine.js та HTMX.
Зверніть увагу
Ви можете зробити автоматичні оновлення без ' ввімкнуто і вимкнутеM SK1 та ' пам 'ятайте' funkcji досить просто, лише з HTMX Наприклад,; використовує Триггери HTMX ви дійсно можете робити багато речей.
<div id="campaignemail-request-list" hx-get="@Url.Action("List", "CampaignEmailRequest")" hx-trigger="every 30s" hx-swap="innerHTML">
<partial name="_List" model="@Model"/>
</div>
Дякую @KhalidАbuhakmeh для того, щоб показати це.
Цей код насправді використовує hx-trigger для налаштування авто-update. Просто використовуючи AlpineM SK2js, щоб налагодити атрибути HTMX
Це і є причиною того, що HTMX з Alpine.js є таким потужним комбінатором ; HT MX управляє усіма інтерактивами серверів та AJAX-заказами , тоді як Alpine~.js управлятию станом і інтерактивом з боку клієнта МSK5 Чи можна зробити це також в програмі Vanilla JS?
Код
Код для цього справді досить компактний. МСК0, МСК1, розділений на дві головні частини: МСК2, ДС-модуль, МSK3, обладначі подій і HTML
Модуль
Модуль - це простий Java-модуль, який використовує Alpine.js для управління станом автоматизованої передачі даних.
Він приймає параметри :
endpointId- id елементу, який треба оновитиactionUrl- URL, який треба викликати для оновлення елементуinitialInterval- початковий відрізок, який треба використати для автоM SK1aktualізації по замовчуванню - МSK3 секунди МSK4
Ми також бачимо, що він використовує декілька ключів; вони використовуються для локального зберігання, щоб запам 'ятати стан автоM SK1update.
Як бачите, я використовую actionurl як частину ключа, щоб зробити цей кінцевий пункт специфічним.
export function autoUpdateController(endpointId, actionUrl, initialInterval = 30) {
const keyPrefix = `autoUpdate:${actionUrl}`;
const enabledKey = `${keyPrefix}:enabled`;
return {
autoUpdate: false,
interval: initialInterval,
toggleAutoUpdate() {
const el = document.getElementById(endpointId);
if (!el) return;
const url = new URL(window.location.href);
const query = url.searchParams.toString();
const fullUrl = query ? `${actionUrl}?${query}` : actionUrl;
const wasPreviouslyEnabled = localStorage.getItem(enabledKey) === 'true';
if (this.autoUpdate) {
el.setAttribute('hx-trigger', `every ${this.interval}s`);
el.setAttribute('hx-swap', 'innerHTML');
el.setAttribute('hx-get', fullUrl);
el.setAttribute('hx-headers', JSON.stringify({ AutoPoll: 'auto' }));
localStorage.setItem(enabledKey, 'true');
htmx.process(el); // rebind with updated attributes
if (!wasPreviouslyEnabled) {
htmx.ajax('GET', fullUrl, {
target: el,
swap: 'innerHTML',
headers: {AutoPoll: 'auto'}
});
}
} else {
el.removeAttribute('hx-trigger');
el.removeAttribute('hx-get');
el.removeAttribute('hx-swap');
el.removeAttribute('hx-headers');
localStorage.removeItem(enabledKey);
htmx.process(el);
}
},
init() {
this.autoUpdate = localStorage.getItem(enabledKey) === 'true';
this.toggleAutoUpdate();
}
};
}
toggleAutoUpdate() Metodа
Цей метод дозволяє або блокує автоматичне голосування цільового HTML елементу за допомогою HTMX.
Подібність
- Вибирає елемент за його
endpointId. - Збудовує URL запиту (
fullUrl), поєднуючи даніactionUrlз теперішньою сторінкою'с строком запитуM SK1 - Проверяє, чи голосування було раніше включено, читаючи
localStorage( ভালো, бо він запам 'ятовується між сеансами браузера ).
Коли this.autoUpdate є true МSK0i.eM SK2 запущено голосування
- Встановлює атрибути HTMX на elemenті:
hx-triggerдля опитування кожногоintervalсекундhx-swap="innerHTML"щоб замінити зміст elementu’hx-getдля того, щоб звернути увагу на URLhx-headersдля додавання на замовлення"AutoPoll": "auto"заголовок
- Заощаджує включений стан до
localStorage - Виклики
htmx.process(el)щоб дозволити HTMX розпізнавати нові атрибути - Якщо це було раніше відключено, миттєво запускає запрос HTMX через
htmx.ajax()(не потрібне підключення до HTMX
Коли this.autoUpdate є false МSK0i.eM SK2 голосування неможливе
- Removes the above HTMX attributes
- Виczyści заpisane налаштування з
localStorage - Виклики
htmx.process(el)знову, щоб оновити поведінку HTMX
Автопитування, коли вперше ввімкнуто
У нас також є гілка, яка виконує автоматичний-полюс, коли він вперше включенийM SK1
const wasPreviouslyEnabled = localStorage.getItem(enabledKey) === 'true';
if (!wasPreviouslyEnabled) {
htmx.ajax('GET', fullUrl, {
target: el,
swap: 'innerHTML',
headers: {AutoPoll: 'auto'}
});
}
Це виконує запрос HTMX до fullUrl і оновлює об 'єкт з відповіддю. Це корисно для того, щоб показати користувача, як виглядатиме автоматичнийM SK1update, коли вони його ввімкнуть.
Заголовки
Ви помітите, що ми також надсилаємо заголовок HTMX з запитом. Це важливо, бо це дозволяє нам розпізнати stronę сервера запиту
el.setAttribute('hx-headers', JSON.stringify({ AutoPoll: 'auto' }));
headers: {AutoPoll: 'auto'}
На моєму сервері я виявляю, що цей заголовок встановлений за допомогою
if (Request.Headers.TryGetValue("AutoPoll", out _))
{
var utcDate = DateTime.UtcNow;
var parisTz = TimeZoneInfo.FindSystemTimeZoneById("Europe/Paris");
var parisTime = TimeZoneInfo.ConvertTimeFromUtc(utcDate, parisTz);
var timeStr = parisTime.ToString("yyyy-MM-dd HH:mm:ss");
Response.ShowToast($"Auto Update Last updated: {timeStr} (paris)",true);
return PartialView("_List", requests);
}
Ви побачите, що я просто шукаю заголовок з Request.Headers.TryGetValue("AutoPoll", out _) і якщо там - ', я знаю, що це - МSK1 - автоматичний запрос
Тоді я візьму теперішнє ім 'я (itM SK1s для французького клієнта ,, тож я перетворюю на паризький час МSK3 і показую тост з часом МСК4
Подивіться
І ShowToast метод - це простий розширений метод, який встановлює триггер, щоб сказати HTMX показати тостову інформацію.
public static void ShowToast(this HttpResponse response, string message, bool success = true)
{
response.Headers.Append("HX-Trigger", JsonSerializer.Serialize(new
{
showToast = new
{
toast = message,
issuccess =success
}
}));
}
Це потім виявляється моєю HTMX тостовою компонентою, яка показує повідомлення.
document.body.addEventListener("showToast", (event) => {
const { toast, issuccess } = event.detail || {};
const type = issuccess === false ? 'error' : 'success';
showToast(toast || 'Done!', 3000, type);
});
Це веде до мого Toast компоненту I написав про це тут .
Заповнюючи його
Це "'" досить просто під 'єднати цей модуль до МСК1 в головному блоці . ".", js index, мск4 , що завгодно, просто внести його і під' єднати до Window
import './auto-actions';
window.autoUpdateController = autoUpdateController; //note this isn't strictly necessary but it makes it easier to use in the HTML
//Where we actually hook it up to Alpine.js
document.addEventListener('alpine:init', () => {
Alpine.data('autoUpdate', function () {
const endpointId = this.$el.dataset.endpointId;
const actionUrl = this.$el.dataset.actionUrl;
const interval = parseInt(this.$el.dataset.interval || '30', 10); // default to 30s
return autoUpdateController(endpointId, actionUrl, interval);
});
});
Тоді ми називаємо ініт-metodу в ASP.NET Разор-код:
ASP.NET Разор код
Щоб зробити це якомога меншим і відновлюваним, код Razor досить простий.
Тут ви бачите, що я вказую на атрибути даних Alpine.js для створення автоM SK1update.
- x-dataM SK1 Тут ми створили об 'єкт даних Alpine
- x-init: Тут ми називаємо метод введення на авто-контроллері
- x-наM SK1заміняти: Тут ми називаємо те, щоб вмикатиMethodуAutoUpdate на автоcontrollerі
- data-endpointM SK1id: Це іденція елементу, який треба оновити
- data-actionM SK1url: Це url, який треба викликати, щоб оновити елемент
- data-interval: Це відстані, що треба використати для автоM SK2update MSC3default is 30 secondsMST5
Ви побачите, що ми встановили ціль для використання для запиту на campaignemail-request-list елемент. Це елемент, який буде обновлений з новим змістом
І те, що МСК0 потім включено SOMEWHERE на сторінці ".".
Тепер, коли перевіряється флажок, він автоматично оновлює список щоразу 30 секундM SK1
<div class=" px-4 py-2 bg-base-100 border border-base-300 rounded-box"
x-data="autoUpdate()"
x-init="init"
x-on:change="toggleAutoUpdate"
data-endpoint-id="campaignemail-request-list"
data-action-url="@Url.Action("List", "CampaignEmailRequest")"
data-interval="30"
>
<label class="flex items-center gap-2">
<input type="checkbox" x-model="autoUpdate" class="toggle toggle-sm" />
<span class="label-text">
Auto update every <span x-text="$data.interval"></span>s
</span>
</label>
</div>
<!-- Voucher List -->
<div id="campaignemail-request-container">
<div
id="campaignemail-request-list">
<partial name="_List" model="@Model"/>
</div>
</div>
На завершення
І це – МСК0. Це – МSK1. Дуже просто, правильно. МSK2. Використовуючи HTMX та Альпіний, МSK3, я створюю простий автоматичний компонент, який ми можемо легко використовувати з ASP.