-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforge-htmx.html
More file actions
550 lines (527 loc) · 27 KB
/
Copy pathforge-htmx.html
File metadata and controls
550 lines (527 loc) · 27 KB
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
<!doctype html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Forge Kernel - ForgeHtmx</title>
<script src="https://cdn.tailwindcss.com"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
rel="stylesheet"
/>
<link rel="stylesheet" href="assets/css/docs.css" />
</head>
<body class="bg-gray-50 text-gray-900">
<!-- Navigation -->
<nav class="bg-white shadow-sm border-b">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex items-center">
<div class="flex-shrink-0">
<h1 class="text-xl font-bold text-gray-900">
Forge Kernel
</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a
href="index.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Home
</a>
<a
href="getting-started.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Getting Started
</a>
<a
href="core-concepts.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Core Concepts
</a>
<a
href="capabilities.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Capabilities
</a>
<a
href="api-reference.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
API Reference
</a>
<a
href="tutorial.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Tutorials
</a>
</div>
</div>
<div class="flex items-center sm:hidden">
<button
id="mobile-menu-button"
class="text-gray-700 hover:text-blue-600 p-2"
>
<i class="fas fa-bars text-xl"></i>
</button>
</div>
</div>
</div>
<div
id="mobile-menu"
class="sm:hidden hidden bg-white border-t border-gray-200"
>
<div class="px-2 pt-2 pb-3 space-y-1">
<a
href="index.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Home</a
>
<a
href="getting-started.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Getting Started</a
>
<a
href="core-concepts.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Core Concepts</a
>
<a
href="capabilities.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Capabilities</a
>
<a
href="api-reference.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>API Reference</a
>
<a
href="tutorial.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Tutorials</a
>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<div class="flex flex-col lg:flex-row gap-8">
<!-- Sidebar Navigation -->
<div id="sidebar-nav" class="lg:w-1/4">
<div class="bg-white rounded-lg shadow-sm p-6 sticky top-8">
<h3 class="text-lg font-semibold text-gray-900 mb-4">
ForgeHtmx
</h3>
<nav class="space-y-2">
<a
href="#overview"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Overview</a
>
<a
href="#integration"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Integration, Not a Rewrite</a
>
<a
href="#installation"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Installation</a
>
<a
href="#htmx-in-views"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>htmx in Your Views</a
>
<a
href="#response-helpers"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Response Helpers</a
>
<a
href="#partial-views"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Rendering Partials</a
>
<a
href="#csrf-and-assets"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>CSRF & Assets</a
>
</nav>
<div class="mt-6 pt-6 border-t border-gray-200">
<h4 class="font-semibold text-sm mb-3 text-blue-600">
Related
</h4>
<nav class="space-y-2">
<a
href="forge-wire.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeWire — reactive pages →</a
>
<a
href="capabilities.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>All capabilities →</a
>
</nav>
</div>
</div>
</div>
<!-- Main Content -->
<div class="lg:w-3/4">
<div class="bg-white rounded-lg shadow-sm p-8">
<h1 class="text-4xl font-bold text-gray-900 mb-6">
ForgeHtmx
</h1>
<p class="text-xl text-gray-600 mb-4">
A small tool <strong>your app</strong> uses to bring
htmx into its server-rendered pages — load the
client, keep CSRF working, and hand your controllers
helpers for responding with HTML fragments.
</p>
<!-- Overview -->
<section id="overview" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Overview
</h2>
<p class="text-gray-600 mb-4">
htmx is an HTML-attribute approach to AJAX: you
decorate your markup with attributes like
<code>hx-get</code> and <code>hx-target</code>,
and the htmx client turns those into requests that
swap fragments of the page — no JavaScript
framework required. ForgeHtmx is the piece that
makes that fit naturally into <em>your app</em>.
</p>
<p class="text-gray-600 mb-4">
It lives as a capability in the
<code>capabilities/</code> directory (the reference
layout for reusable building blocks), and is
scoped strictly to wiring: inject the client, keep
CSRF headers flowing, and give your controllers
concise helpers for returning partial HTML and the
htmx response headers your interactions need.
</p>
<div
class="bg-blue-50 border border-blue-200 rounded-lg p-6 mb-6"
>
<h3 class="font-semibold text-lg mb-4">
What it gives you
</h3>
<div class="grid md:grid-cols-2 gap-4 text-sm text-gray-700">
<ul class="space-y-2 list-disc list-inside">
<li>The htmx client, injected for you</li>
<li>Automatic CSRF token wiring</li>
<li>Partial-view rendering</li>
</ul>
<ul class="space-y-2 list-disc list-inside">
<li>Response helpers for htmx headers</li>
<li>hx-request detection</li>
</ul>
</div>
</div>
<div
class="bg-green-50 border-l-4 border-green-400 p-4"
>
<p class="text-sm text-green-700">
<strong>Prerequisites:</strong> ForgeHtmx
builds on the routing and view layers of your
app, so both need to be present. The page
source is in
<code>capabilities/ForgeHtmx</code>.
</p>
</div>
</section>
<!-- Integration, not a rewrite -->
<section
id="integration"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Integration, Not a Rewrite
</h2>
<p class="text-gray-600 mb-4">
ForgeHtmx doesn't reimplement htmx. The attribute
language itself — every <code>hx-*</code> in your
markup and the DOM swaps on the page — is htmx's
own client, loaded verbatim. ForgeHtmx only handles
the server-side fit:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-6">
<li>
It injects <code>htmx.min.js</code> into your
pages so the attributes work out of the box.
</li>
<li>
It notices when a request is an htmx partial
(via the <code>HX-Request</code> header), so
your app can respond with just the fragment.
</li>
<li>
It keeps CSRF working: every htmx request
carries your token automatically.
</li>
</ul>
<p class="text-gray-600">
You write your markup the htmx way, and your
controllers the way your app already works — the
capability is a thin, predictable seam between the
two.
</p>
</section>
<!-- Installation -->
<section id="installation" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Installation
</h2>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-bash">php forge.php package:install-module --module=ForgeHtmx</code></pre>
</div>
<p class="text-gray-600">
Installing links the client asset so
<code>htmx.min.js</code> is served to your pages,
and registers the request middleware. From there
the client is injected and the helpers are
available in your controllers.
</p>
</section>
<!-- htmx in Your Views -->
<section
id="htmx-in-views"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
htmx in Your Views
</h2>
<p class="text-gray-600 mb-4">
Once installed, decorate any element with htmx
attributes and the client does the rest — a button
or link that loads a fragment, a form posted in the
background, or a region that refreshes on an
interval:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-4"
>
<pre><code class="language-php"><!-- click the button, swap a comment list into the target, off the request path -->
<button hx-get="/comments" hx-target="#comments" hx-swap="innerHTML">
Load comments
</button>
<div id="comments"></div>
<!-- submit a form over AJAX and refresh the page if it succeeds -->
<form hx-post="/newsletter" hx-swap="none" hx-on::after-request="location.reload()">
<input name="email" type="email" />
<button type="submit">Subscribe</button>
</form></code></pre>
</div>
<p class="text-gray-600">
The attribute set is the standard htmx one —
<code>hx-get</code>, <code>hx-post</code>,
<code>hx-target</code>, <code>hx-swap</code>,
<code>hx-trigger</code>, <code>hx-push-url</code>,
and friends. ForgeHtmx is what makes those requests
reach your controllers and return clean fragments.
</p>
</section>
<!-- Response Helpers -->
<section
id="response-helpers"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Response Helpers
</h2>
<p class="text-gray-600 mb-4">
In a controller, compose the
<code>HtmxResponseHelper</code> trait to return the
response headers htmx understands. Instead of
hand-writing headers, use a method that says what
you mean:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Capability\ForgeHtmx\Traits\HtmxResponseHelper;
final class CommentController
{
use HtmxResponseHelper;
public function index(): mixed
{
// a plain HTML fragment to swap into the page
return $this->htmxFragment($this->view('partials/comments', $data));
}
public function store(): mixed
{
// after a form post, send the browser to a new URL
return $this->htmxRedirect('/comments');
}
public function refresh(): mixed
{
// have htmx reload the current page
return $this->htmxRefresh();
}
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
The fuller set covers everything htmx can act on
from response headers:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-6">
<li>
<code>htmxTrigger()</code>,
<code>htmxTriggerAfterSwap()</code>,
<code>htmxTriggerAfterSettle()</code> — emit
client-side events (with optional detail).
</li>
<li>
<code>htmxLocation()</code> — issue a client-side
navigation with context.
</li>
<li>
<code>htmxPushUrl()</code> / <code>htmxReplaceUrl()</code>
— update the browser history.
</li>
<li>
<code>htmxRetarget()</code> / <code>htmxReswap()</code>
— override where and how the swap happens.
</li>
<li>
<code>htmxStopPolling()</code> — tell a polling
region to stop.
</li>
</ul>
</section>
<!-- Rendering Partials -->
<section
id="partial-views"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Rendering Partials
</h2>
<p class="text-gray-600 mb-4">
A common pattern is one endpoint that serves both a
full page and the htmx fragment for it. The
<code>HtmxViewHelper</code> handles that in one
call — full view with layout for normal requests, a
focused partial without the layout when htmx asks:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Capability\ForgeHtmx\Traits\HtmxViewHelper;
final class DashboardController
{
use HtmxViewHelper;
public function show()
{
$data = ['metrics' => $this->metrics()];
// full page normally; just the 'partials/dashboard' view on htmx
return $this->htmxView('pages/dashboard', $data, 'partials/dashboard');
}
}</code></pre>
</div>
<p class="text-gray-600">
When the request carries <code>HX-Request</code>,
the layout is suppressed and only the partial view
is returned; otherwise your full page renders as
usual.
</p>
</section>
<!-- CSRF & Assets -->
<section
id="csrf-and-assets"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
CSRF & Assets
</h2>
<p class="text-gray-600 mb-4">
htmx-driven requests would otherwise omit the CSRF
protection your app expects. ForgeHtmx handles this
automatically: it injects a small script that reads
your CSRF token from the page and attaches it as an
<code>X-CSRF-TOKEN</code> header on every htmx
request, so your existing verification keeps
working with no extra ceremony.
</p>
<p class="text-gray-600">
Both the client script and this CSRF wiring are
injected only into real HTML pages — htmx partial
responses and JSON responses pass through clean,
without the surrounding page chrome.
</p>
</section>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="bg-gray-900 text-white py-8 mt-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<div class="mb-4">
<span class="text-lg font-bold">Forge Kernel</span>
</div>
<p class="text-gray-400">
A toolbox for builders who like to do things their way.
</p>
</div>
</footer>
<script>
document.querySelectorAll('a[href^="#"]').forEach((anchor) => {
anchor.addEventListener("click", function (e) {
e.preventDefault();
const target = document.querySelector(
this.getAttribute("href"),
);
if (target) {
target.scrollIntoView({
behavior: "smooth",
block: "start",
});
}
});
});
const mobileMenuButton =
document.getElementById("mobile-menu-button");
const mobileMenu = document.getElementById("mobile-menu");
if (mobileMenuButton && mobileMenu) {
mobileMenuButton.addEventListener("click", function () {
mobileMenu.classList.toggle("hidden");
});
}
window.addEventListener("scroll", function () {
const sections = document.querySelectorAll(".section-anchor");
const navLinks = document.querySelectorAll(".nav-link");
let current = "";
sections.forEach((section) => {
const sectionTop = section.offsetTop - 100;
if (window.pageYOffset >= sectionTop) {
current = section.getAttribute("id");
}
});
navLinks.forEach((link) => {
link.classList.remove("active");
if (link.getAttribute("href") === "#" + current) {
link.classList.add("active");
}
});
});
</script>
</body>
</html>