-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Use htmx with various haskell libraries
--   
--   Please see the README on GitHub at
--   <a>https://github.com/JonathanLorimer/htmx#readme</a>
@package htmx
@version 0.1.0.2


-- | This module defines a typeclass that doesn't have the historical
--   baggage or connotations of other text serialization typeclasses (like
--   <a>Show</a> or Display). The semantics of this class are supposed to
--   be HTMX specific, i.e. serializing attribute values
module Htmx.Render

-- | A typeclass for rendering domain types into attribute values
class Render a
render :: Render a => a -> Text


-- | This module defines a sum type that represents the "included" HTMX
--   extensions <a>https://htmx.org/extensions/#included</a>
module Htmx.Extension

-- | <a>https://htmx.org/extensions/</a>
--   
--   htmx includes a set of extensions out of the box that address common
--   developer needs. These extensions are tested against htmx in each
--   distribution.
--   
--   You can find the source for the bundled extensions at
--   <a>https://unpkg.com/</a> browse<i>htmx.org@1.9.12</i>dist<i>ext</i>.
--   You will need to include the javascript file for the extension and
--   then install it using the hx-ext attributes. See the individual
--   extension documentation for more details.
data HtmxExtension

-- | <a>https://htmx.org/extensions/ajax-header/</a> includes the
--   commonly-used X-Requested-With header that identifies ajax requests in
--   many backend frameworks
AjaxHeader :: HtmxExtension

-- | <a>https://htmx.org/extensions/alpine-morph/</a> an extension for
--   using the Alpine.js morph plugin as the swapping mechanism in htmx.
AlpineMorph :: HtmxExtension

-- | <a>https://htmx.org/extensions/class-tools/</a> an extension for
--   manipulating timed addition and removal of classes on HTML elements
ClassTools :: HtmxExtension

-- | <a>https://htmx.org/extensions/client-side-templates/</a> support for
--   client side template processing of JSON/XML responses
ClientSideTemplates :: HtmxExtension

-- | <a>https://htmx.org/extensions/debug/</a> an extension for debugging
--   of a particular element using htmx
Debug :: HtmxExtension

-- | <a>https://htmx.org/extensions/event-header/</a> includes a JSON
--   serialized version of the triggering event, if any
EventHeader :: HtmxExtension

-- | <a>https://htmx.org/extensions/head-support/</a> support for merging
--   the head tag from responses into the existing documents head
HeadSupport :: HtmxExtension

-- | <a>https://htmx.org/extensions/include-vals/</a> allows you to include
--   additional values in a request
IncludeVals :: HtmxExtension

-- | <a>https://htmx.org/extensions/json-enc/</a> use JSON encoding in the
--   body of requests, rather than the default x-www-form-urlencoded
JsonEnc :: HtmxExtension

-- | <a>https://htmx.org/extensions/idiomorph/</a> an extension for using
--   the idiomorph morphing algorithm as a swapping mechanism
Idiomorph :: HtmxExtension

-- | <a>https://htmx.org/extensions/loding-states/</a> allows you to
--   disable inputs, add and remove CSS classes to any element while a
--   request is in-flight.
LoadingStates :: HtmxExtension

-- | <a>https://htmx.org/extensions/method-override/</a> use the
--   X-HTTP-Method-Override header for non-GET and POST requests
MethodOverride :: HtmxExtension

-- | <a>https://htmx.org/extensions/morphdom-swap/</a> an extension for
--   using the morphdom library as the swapping mechanism in htmx.
MorphdomSwap :: HtmxExtension

-- | <a>https://htmx.org/extensions/multi-swap/</a> allows to swap multiple
--   elements with different swap methods
MultiSwap :: HtmxExtension

-- | <a>https://htmx.org/extensions/path-deps/</a> an extension for
--   expressing path-based dependencies similar to intercoolerjs
PathDeps :: HtmxExtension

-- | <a>https://htmx.org/extensions/preload/</a> preloads selected href and
--   hx-get targets based on rules you control.
Preload :: HtmxExtension

-- | <a>https://htmx.org/extensions/remove-me/</a> allows you to remove an
--   element after a given amount of time
RemoveMe :: HtmxExtension

-- | <a>https://htmx.org/extensions/response-targets/</a> allows to specify
--   different target elements to be swapped when different HTTP response
--   codes are received
ResponseTargets :: HtmxExtension

-- | <a>https://htmx.org/extensions/restored/</a> allows you to trigger
--   events when the back button has been pressed
Restored :: HtmxExtension

-- | <a>https://htmx.org/extensions/server-sent-events/</a> uni-directional
--   server push messaging via EventSource
ServerSentEvents :: HtmxExtension

-- | <a>https://htmx.org/extensions/web-sockets/</a> bi-directional
--   connection to WebSocket servers
WebSockets :: HtmxExtension

-- | <a>https://htmx.org/extensions/path-params/</a> allows to use
--   parameters for path variables instead of sending them in query or body
PathParams :: HtmxExtension
instance GHC.Show.Show Htmx.Extension.HtmxExtension
instance GHC.Classes.Ord Htmx.Extension.HtmxExtension
instance GHC.Classes.Eq Htmx.Extension.HtmxExtension
instance Htmx.Render.Render Htmx.Extension.HtmxExtension


-- | This module defines a type that represents events that originate from
--   the HTMX library itself <a>https://htmx.org/reference/#events</a>
module Htmx.Event

-- | <a>https://htmx.org/reference/#events</a> A sum type that represents
--   possible events originating from the HTMX javascript library
data HtmxEvent

-- | send this event to an element to abort a request
Abort :: HtmxEvent

-- | triggered after an AJAX request has completed processing a successful
--   response
AfterOnLoad :: HtmxEvent

-- | triggered after htmx has initialized a node
AfterProcessNode :: HtmxEvent

-- | triggered after an AJAX request has completed
AfterRequest :: HtmxEvent

-- | triggered after the DOM has settled
AfterSettle :: HtmxEvent

-- | triggered after new content has been swapped in
AfterSwap :: HtmxEvent

-- | triggered before htmx disables an element or removes it from the DOM
BeforeCleanupElement :: HtmxEvent

-- | triggered before any response processing occurs
BeforeOnLoad :: HtmxEvent

-- | triggered before htmx initializes a node
BeforeProcessNode :: HtmxEvent

-- | triggered before an AJAX request is made
BeforeRequest :: HtmxEvent

-- | triggered before a swap is done, allows you to configure the swap
BeforeSwap :: HtmxEvent

-- | triggered just before an ajax request is sent
BeforeSend :: HtmxEvent

-- | triggered before the request, allows you to customize parameters,
--   headers
ConfigRequest :: HtmxEvent

-- | triggered after a trigger occurs on an element, allows you to cancel
--   (or delay) issuing the AJAX request
Confirm :: HtmxEvent

-- | triggered on an error during cache writing
HistoryCacheError :: HtmxEvent

-- | triggered on a cache miss in the history subsystem
HistoryCacheMiss :: HtmxEvent

-- | triggered on a unsuccessful remote retrieval
HistoryCacheMissError :: HtmxEvent

-- | triggered on a successful remote retrieval
HistoryCacheMissLoad :: HtmxEvent

-- | triggered when htmx handles a history restoration action
HistoryRestore :: HtmxEvent

-- | triggered before content is saved to the history cache
BeforeHistorySave :: HtmxEvent

-- | triggered when new content is added to the DOM
Load :: HtmxEvent

-- | triggered when an element refers to a SSE event in its trigger, but no
--   parent SSE source has been defined
NoSSESourceError :: HtmxEvent

-- | triggered when an exception occurs during the onLoad handling in htmx
OnLoadError :: HtmxEvent

-- | triggered after an out of band element as been swapped in
OobAfterSwap :: HtmxEvent

-- | triggered before an out of band element swap is done, allows you to
--   configure the swap
OobBeforeSwap :: HtmxEvent

-- | triggered when an out of band element does not have a matching ID in
--   the current DOM
OobErrorNoTarget :: HtmxEvent

-- | triggered after a prompt is shown
Prompt :: HtmxEvent

-- | triggered after an url is pushed into history
PushedIntoHistory :: HtmxEvent

-- | triggered when an HTTP response error (non-200 or 300 response code)
--   occurs
ResponseError :: HtmxEvent

-- | triggered when a network error prevents an HTTP request from happening
SendError :: HtmxEvent

-- | triggered when an error occurs with a SSE source
SseError :: HtmxEvent

-- | triggered when a SSE source is opened
SseOpen :: HtmxEvent

-- | triggered when an error occurs during the swap phase
SwapError :: HtmxEvent

-- | triggered when an invalid target is specified
TargetError :: HtmxEvent

-- | triggered when a request timeout occurs
Timeout :: HtmxEvent

-- | triggered before an element is validated
ValidationValidate :: HtmxEvent

-- | triggered when an element fails validation
ValidationFailed :: HtmxEvent

-- | triggered when a request is halted due to validation errors
ValidationHalted :: HtmxEvent

-- | triggered when an ajax request aborts
XhrAbort :: HtmxEvent

-- | triggered when an ajax request ends
XhrLoadend :: HtmxEvent

-- | triggered when an ajax request starts
XhrLoadstart :: HtmxEvent

-- | triggered periodically during an ajax request that supports progress
--   events
XhrProgress :: HtmxEvent
instance Htmx.Render.Render Htmx.Event.HtmxEvent


-- | Provides a type and utilities for the "swap style" for hx-swap
--   <a>https://htmx.org/attributes/hx-swap/</a>
module Htmx.Swap

-- | <a>https://htmx.org/attributes/hx-swap/</a> The different styles that
--   can be used for swapping in content. Usually defaults to
--   <a>InnerHTML</a>
data Swap

-- | Replace the inner html of the target element
InnerHTML :: Swap

-- | Replace the entire target element with the response
OuterHTML :: Swap

-- | Replace the text content of the target element, without parsing the
--   response as HTML
TextContent :: Swap

-- | Insert the response before the target element
BeforeBegin :: Swap

-- | Insert the response before the first child of the target element
AfterBegin :: Swap

-- | Insert the response after the last child of the target element
BeforeEnd :: Swap

-- | Insert the response after the target element
AfterEnd :: Swap

-- | Deletes the target element regardless of the response
Delete :: Swap

-- | Does not append content from response (out of band items will still be
--   processed).
None :: Swap
instance Htmx.Render.Render Htmx.Swap.Swap
instance Web.Internal.HttpApiData.ToHttpApiData Htmx.Swap.Swap
instance Web.Internal.HttpApiData.FromHttpApiData Htmx.Swap.Swap