HtmxAjaxHelperContext typedef should have all optional fields (#2701)

* all fields of HtmxAjaxHelperContext should be optional * update docs for htmx.ajax to describe purpose of source field in context
bigskysoftware · Jul 8, 2024 · d9eb6d7 · d9eb6d7
1 parent 5f7e235
commit d9eb6d7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/htmx.d.ts b/src/htmx.d.ts
@@ -113,7 +113,7 @@ type HtmxAjaxHelperContext = {
     source?: Element | string;
     event?: Event;
     handler?: HtmxAjaxHandler;
-    target: Element | string;
+    target?: Element | string;
     swap?: HtmxSwapStyle;
     values?: any | FormData;
     headers?: Record<string, string>;

diff --git a/src/htmx.js b/src/htmx.js
@@ -5036,7 +5036,7 @@ var htmx = (function() {
  * @property {Element|string} [source]
  * @property {Event} [event]
  * @property {HtmxAjaxHandler} [handler]
- * @property {Element|string} target
+ * @property {Element|string} [target]
  * @property {HtmxSwapStyle} [swap]
  * @property {Object|FormData} [values]
  * @property {Record<string,string>} [headers]

diff --git a/www/content/api.md b/www/content/api.md
@@ -53,7 +53,7 @@ or
 * `verb` - 'GET', 'POST', etc.
 * `path` - the URL path to make the AJAX
 * `context` - a context object that contains any of the following
-    * `source` - the source element of the request
+    * `source` - the source element of the request, `hx-*` attrs which affect the request will be resolved against that element and its ancestors
     * `event` - an event that "triggered" the request
     * `handler` - a callback that will handle the response HTML
     * `target` - the target to swap the response into