forked from nicojs/typed-html
-
-
Notifications
You must be signed in to change notification settings - Fork 28
/
Copy pathhtmx.d.ts
526 lines (465 loc) · 13.5 KB
/
htmx.d.ts
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
// This file is a result from https://github.com/Desdaemon/typed-htmx and https://htmx.org
// Missing something? Please submit a issue report or a PR:
// https://github.com/kitajs/html
declare namespace JSX {
interface HtmlTag extends Htmx.Attributes {}
}
declare namespace Htmx {
/** Either `true`, `false`, `"true"` or `"false"`. */
type BoolStr = boolean | 'true' | 'false';
type AnyStr = string & {};
type HxSwap =
| 'innerHTML'
| 'outerHTML'
| 'beforebegin'
| 'afterbegin'
| 'beforeend'
| 'afterend'
| 'delete'
| 'none'
| 'morph'
| 'morphdom';
/**
* Either `this` which refers to the element itself, or a modifier followed by a CSS
* selector, e.g. `closest form`.
*/
type HxTarget = 'this' | 'closest ' | 'find ' | 'next ' | 'previous ';
/** A CSS selector, followed by one of these sync strategies, e.g. `form:abort`. */
type HxSync =
| ':drop'
| ':abort'
| ':replace'
| ':queue'
| ':queue first'
| ':queue last'
| ':queue all';
/** Evaluate the values given, you can prefix the values with javascript: or js:. */
type HxHeaders = AnyStr | 'javascript:' | 'js:';
/** An event followed by one of these modifiers, e.g. `click once`. */
type HxTriggerModifier =
| ' once'
| ' changed'
| ' delay:'
| ' throttle:'
| ' from:'
| ' target:'
| ' consume'
| ' queue:first'
| ' queue:last'
| ' queue:all'
| ' queue:none';
/**
* An extensible directory of htmx extensions.
*
* ## Declaring a new extension
*
* ```tsx
* declare global {
* namespace JSX {
* interface HtmxExtensions {
* myExtension: "my-extension";
* }
* interface HtmlTag {
* ["my-extension-attr"]?: string
* // Add any other attributes your extension uses here
* }
* }
* }
*
* <div hx-ext="my-extension">
* <span my-extension-attr="foo">Hello</span>
* </div>
* ```
*/
interface Extensions {
/**
* Includes the commonly-used `X-Requested-With` header that identifies ajax requests
* in many backend frameworks.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/ajax-header.js
*
* @see https://htmx.org/extensions/ajax-header/
*/
ajaxHeaders: 'ajax-headers';
/**
* Server-Sent Events.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/sse.js
*
* @see https://htmx.org/extensions/server-sent-events/
*/
serverSentEvents: 'sse';
/**
* WebSockets support.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/ws.js
*
* @see https://htmx.org/extensions/web-sockets/
*/
ws: 'ws';
/**
* Class utilities.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/class-tools.js
*
* @see https://htmx.org/extensions/class-tools/
*/
classTools: 'class-tools';
/**
* Tool for debugging htmx requests.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/debug.js
*
* @see https://htmx.org/extensions/debug/
*/
debug: 'debug';
/**
* Disable elements during requests.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/disable-element.js
*
* @see https://htmx.org/extensions/disable-element/
*/
disableElement: 'disable-element';
/**
* Includes a JSON serialized version of the triggering event, if any.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/event-header.js
*
* @see https://htmx.org/extensions/event-header/
*/
eventHeader: 'event-header';
/**
* Support for adding tags to `<head>`.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/head-support.js
*
* @see https://htmx.org/extensions/head-support/
*/
headSupport: 'head-support';
/**
* Support for [Idiomorph](https://github.com/bigskysoftware/idiomorph), an
* alternative swapping mechanism for htmx.
*
* CDN: https://unpkg.com/idiomorph/dist/idiomorph-ext.min.js
*
* @see https://github.com/bigskysoftware/idiomorph#htmx
*/
idiomorph: 'morph';
/**
* Use JSON encoding in the body of requests, rather than the default
* `x-www-form-urlencoded`.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/json-enc.js
*
* @see https://htmx.org/extensions/json-enc/
*/
jsonEncode: 'json-enc';
/**
* Support for inflight loading states.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/loading-states.js
*
* @see https://htmx.org/extensions/loading-states/
*/
loadingStates: 'loading-states';
/**
* Support for [morphdom](https://github.com/patrick-steele-idem/morphdom), an
* alternative swapping mechanism for htmx.
*
* CDN: https://unpkg.com/htmx.org/dist/ext/morphdom-swap.js
*
* @see https://htmx.org/extensions/morphdom-swap/
*/
morphdom: 'morphdom';
}
/** Definitions for htmx attributes up to 1.9.3. */
interface Attributes {
/**
* Issues a `GET` to the specified URL.
*
* @see https://htmx.org/attributes/hx-get/
*/
['hx-get']?: string;
/**
* Issues a `POST` to the specified URL.
*
* @see https://htmx.org/attributes/hx-post/
*/
['hx-post']?: string;
/**
* Issues a `PUT` to the specified URL.
*
* @see https://htmx.org/attributes/hx-put/
*/
['hx-put']?: string;
/**
* Issues a `DELETE` to the specified URL.
*
* @see https://htmx.org/attributes/hx-delete/
*/
['hx-delete']?: string;
/**
* Issues a `PATCH` to the specified URL.
*
* @see https://htmx.org/attributes/hx-patch/
*/
['hx-patch']?: string;
/**
* Add or remove [progressive enhancement] for links and forms.
*
* @see https://htmx.org/attributes/hx-boost/
*
* [progressive enhancement]: https://developer.mozilla.org/en-US/docs/Glossary/Progressive_Enhancement
*/
['hx-boost']?: BoolStr;
/**
* Handle any event with a script inline.
*
* @remarks
* Event listeners on htmx-specific events need to be specified with a spread
* attribute, and are otherwise not supported in vanilla JSX.
*
* ```jsx
* <div {...{ 'hx-on::before-request': '...' }} />;
* ```
* @since 1.9.3
* @see https://htmx.org/attributes/hx-on/
*/
[`hx-on:`]?: string;
/**
* Handle any event with a script inline. Each listener is specified on a separate
* line.
*
* @remarks
* Superseded by `hx-on:$event`, unless IE11 support is required.
* @since 1.9.0
* @see https://htmx.org/attributes/hx-on/
*/
['hx-on']?: string;
/**
* Pushes the URL into the browser location bar, creating a new history entry.
*
* @see https://htmx.org/attributes/hx-push-url/
*/
['hx-push-url']?: BoolStr | AnyStr;
/**
* Select content to swap in from a response.
*
* @see https://htmx.org/attributes/hx-select/
*/
['hx-select']?: string;
/**
* Select content to swap in from a response, out of band (somewhere other than the
* target).
*
* @see https://htmx.org/attributes/hx-select-oob/
*/
['hx-select-oob']?: string;
/**
* Controls how content is swapped in (`outerHTML`, `beforeend`, `afterend`, …).
*
* @remarks
* - `morph` swaps are part of the {@linkcode Extensions.idiomorph idiomorph} extension.
* - `morphdom` swaps are part of the {@linkcode Extensions.morphdom morphdom} extension.
*
* @see https://htmx.org/attributes/hx-swap/
* @see {@linkcode InsertPosition} which is used in [{@linkcode Element.insertAdjacentHTML}](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
*/
['hx-swap']?: HxSwap | AnyStr;
/**
* Marks content in a response to be out of band (should swap in somewhere other than
* the target).
*
* @see https://htmx.org/attributes/hx-swap-oob/
*/
['hx-swap-oob']?: 'true' | HxSwap | AnyStr;
/**
* Specifies the target element to be swapped.
*
* @see https://htmx.org/attributes/hx-target/
*/
['hx-target']?: HxTarget | AnyStr;
/**
* Specifies the event that triggers the request.
*
* @see https://htmx.org/attributes/hx-trigger/
*/
['hx-trigger']?: 'every ' | HxTriggerModifier | AnyStr;
/**
* Adds values to the parameters to submit with the request (JSON-formatted).
*
* @see https://htmx.org/attributes/hx-vals/
*/
['hx-vals']?: HxHeaders;
/**
* Shows a `confirm()` dialog before issuing a request.
*
* @see https://htmx.org/attributes/hx-confirm/
*/
['hx-confirm']?: string;
/**
* Disables htmx processing for the given node and any children nodes.
*
* @see https://htmx.org/attributes/hx-disable/
*/
['hx-disable']?: boolean;
/**
* Control and disable automatic attribute inheritance for child nodes.
*
* @see https://htmx.org/attributes/hx-disinherit/
*/
['hx-disinherit']?: '*' | AnyStr;
/**
* Changes the request encoding type.
*
* @see https://htmx.org/attributes/hx-encoding/
*/
['hx-encoding']?: 'multipart/form-data';
/**
* Extensions to use for this element.
*
* @see https://htmx.org/attributes/hx-ext/
* @see {@linkcode Extensions} for how to declare extensions in JSX.
*/
['hx-ext']?: Htmx.Extensions[keyof Htmx.Extensions] | 'ignore:' | AnyStr;
/**
* Adds to the headers that will be submitted with the request.
*
* @see https://htmx.org/attributes/hx-headers/
*/
['hx-headers']?: HxHeaders | AnyStr;
/**
* Prevent sensitive data being saved to the history cache.
*
* @see https://htmx.org/attributes/hx-history/
*/
['hx-history']?: 'false';
/**
* The element to snapshot and restore during history navigation.
*
* @see https://htmx.org/attributes/hx-history-elt/
*/
['hx-history-elt']?: boolean;
/**
* Include additional data in requests.
*
* @see https://htmx.org/attributes/hx-include/
*/
['hx-include']?: string;
/**
* The element to put the `htmx-request` class on during the request.
*
* @see https://htmx.org/attributes/hx-indicator/
*/
['hx-indicator']?: string;
/**
* Filters the parameters that will be submitted with a request.
*
* @see https://htmx.org/attributes/hx-params/
*/
['hx-params']?: '*' | 'none' | 'not ' | AnyStr;
/**
* Specifies elements to keep unchanged between requests.
*
* @remarks
* `true` is only observed by the `head-support` extension, where it prevents an
* element from being removed from the `<head>`.
* @see https://htmx.org/attributes/hx-preserve/
*/
['hx-preserve']?: boolean | 'true';
/**
* Shows a `prompt()` before submitting a request.
*
* @see https://htmx.org/attributes/hx-prompt/
*/
['hx-prompt']?: string;
/**
* Replace the URL in the browser location bar.
*
* @see https://htmx.org/attributes/hx-replace-url/
*/
['hx-replace-url']?: BoolStr | AnyStr;
/**
* Configures various aspects of the request.
*
* @see https://htmx.org/attributes/hx-request/
*/
['hx-request']?: `"timeout": ` | `"credentials": ` | `"noHeaders": ` | HxHeaders;
/**
* Control how requests made by different elements are synchronized.
*
* @see https://htmx.org/attributes/hx-sync/
*/
['hx-sync']?: HxSync;
/**
* Force elements to validate themselves before a request.
*
* @see https://htmx.org/attributes/hx-validate/
*/
['hx-validate']?: boolean;
/**
* Adds values dynamically to the parameters to submit with the request.
*
* @deprecated Superseded by `hx-vals`
*/
['hx-vars']?: AnyStr;
/**
* The URL of the SSE server.
*
* @see https://htmx.org/extensions/server-sent-events/
*/
['sse-connect']?: string;
/**
* The name of the message to swap into the DOM.
*
* @see https://htmx.org/extensions/server-sent-events/
*/
['sse-swap']?: string;
/**
* A URL to establish a WebSocket connection against.
*
* @see https://htmx.org/extensions/web-sockets/
*/
['ws-connect']?: string;
/**
* Sends a message to the nearest websocket based on the trigger value for the
* element.
*
* @see https://htmx.org/extensions/web-sockets/
*/
['ws-send']?: boolean;
/**
* Apply class transitions on this element.
*
* @see https://htmx.org/extensions/class-tools/
*/
['classes']?: `add ` | `remove ` | `toggle ` | AnyStr;
/**
* The element or elements to disable during requests. Accepts CSS selectors. This
* extensions functionality has been folded into the core of htmx via the
* hx-disabled-elt attribute
*
* @see https://htmx.org/extensions/disable-element/
*/
['hx-disable-element']?: 'self' | AnyStr;
/**
* The element or elements to disable during requests. Accepts CSS selectors.
*
* @see https://htmx.org/attributes/hx-disabled-elt/
*/
['hx-disabled-elt']?: 'this' | AnyStr;
/**
* The strategy for merging new head content.
*
* @see https://htmx.org/extensions/head-support/
*/
['hx-head']?: 'merge' | 'append' | 're-eval';
/**
* Hyperscript expression
*
* @see https://hyperscript.org/
*/
_?: string;
}
}