htmx/www/reference.md
2020-05-10 08:45:28 -07:00

90 lines
3.8 KiB
Markdown

---
layout: layout.njk
title: </> kutty - Attributes
---
## Attribute Reference
| Attribute | Description |
|-----------|-------------|
| [kt-boost](/attributes/kt-boost) | converts anchors and forms to use AJAX requests
| [kt-classes](/attributes/kt-classes) | timed modification of classes on an element
| [kt-confirm](/attributes/kt-confirm) | shows a confim() dialog before issuing a request
| [kt-delete](/attributes/kt-delete) | issues a `DELETE` to the specified URL
| [kt-error-url](/attributes/kt-error-url) | a URL to send client-side errors to
| [kt-get](/attributes/kt-get) | issues a `GET` to the specified URL
| [kt-history-elt](/attributes/kt-history-elt) | the element to snapshot and restore during history navigation
| [kt-include](/attributes/kt-include) | includes additional data in AJAX requests
| [kt-indicator](/attributes/kt-indicator) | the element to put the `kutty-request` class on during the AJAX request
| [kt-patch](/attributes/kt-patch) | issues a `PATCH` to the specified URL
| [kt-params](/attributes/kt-params) | filters the parameters that will be submitted with a request
| [kt-post](/attributes/kt-post) | issues a `POST` to the specified URL
| [kt-prompt](/attributes/kt-prompt) | shows a prompt before submitting a request
| [kt-push-url](/attributes/kt-push-url) | pushes the URL into the location bar, creating a new history entry
| [kt-put](/attributes/kt-put) | issues a `PUT` to the specified URL
| [kt-select](/attributes/kt-select) | selects a subset of the server response to process
| [kt-sse-src](/attributes/kt-sse-src) | establishes an [SSE](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) source for events
| [kt-swap](/attributes/kt-swap) | controls how the response content is swapped into the DOM (e.g. 'outerHTML' or 'beforeEnd')
| [kt-swap-oob](/attributes/kt-swap) | marks content in a response as being "Out of Band", i.e. swapped somewhere other than the target
| [kt-target](/attributes/kt-target) | specifies the target element to be swapped
| kt-trigger | TODO - Description
## CSS Class Reference
| Class | Description |
|-----------|-------------|
| kutty-request | TODO
| kutty-indicator | TODO
| kutty-swapping | TODO
| kutty-settling | TODO
## HTTP Header Reference
### Request Headers
| Header | Description |
|-------|-------------|
| X-HTTP-Method-Override | TODO - Description
| X-KT-Request | TODO - Description
| X-KT-Trigger-Id | TODO - Description
| X-KT-Trigger-Name | TODO - Description
| X-KT-Target-Id | TODO - Description
| X-KT-Current-URL | TODO - Description
| X-KT-Prompt | TODO - Description
| X-KT-Event-Target | TODO - Description
| X-KT-Active-Element | TODO - Description
| X-KT-Active-Element-Value | TODO - Description
### Response Headers
| Header | Description |
|-------|-------------|
| X-KT-Trigger | TODO - Description
| X-KT-Push | TODO - Description
## Event Reference
| Event | Description |
|-------|-------------|
| afterOnLoad.kutty | TODO - Description
| afterSettle.kutty | TODO - Description
| afterSettle.kutty | TODO - Description
| afterSwap.kutty | TODO - Description
| beforeOnLoad.kutty | TODO - Description
| beforeRequest.kutty | TODO - Description
| beforeSwap.kutty | TODO - Description
| historyCacheMiss.kutty | TODO - Description
| historyCacheMissLoad.kutty | TODO - Description
| historyRestore.kutty | TODO - Description
| historyUpdate.kutty | TODO - Description
| initSSE.kutty | TODO - Description
| load.kutty | TODO - Description
| noSSESourceError.kutty | TODO - Description
| onLoadError.kutty | TODO - Description
| oobErrorNoTarget.kutty | TODO - Description
| prompt.kutty | TODO - Description
| responseError.kutty | TODO - Description
| sendError.kutty | TODO - Description
| sseError.kutty | TODO - Description
| swapError.kutty | TODO - Description
| values.kutty | TODO - Description