Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package dream-htmx
This module provides utilities to deal with Htmx requests/responses.
Requests
val is_htmx : Dream.request -> boolis_htmx request will be true if the request has been issued by htmx.
val trigger : Dream.request -> string optiontrigger request gives the id of the element which trigger the request if available.
val trigger_name : Dream.request -> string optiontrigger_name request gives the name of the element which trigger the request if available.
val target : Dream.request -> string optiontarget request gives the id of the target element if available.
val prompt : Dream.request -> string optionprompt request is the value entered by the user when prompted via hx-prompt.
Responses
val push : string -> Dream.response -> unitpush url pushes a new URL into the browser’s address bar.
val redirect : string -> Dream.response -> unitredirect url triggers a client-side redirect to a new location.
val set_location : string -> Dream.response -> unitset_location url triggers a client-side redirect to a new location that acts as a swap.
val refresh : Dream.response -> unitrefresh triggers a client side full refresh of the page.
val set_trigger : string -> Dream.response -> unitset_trigger event triggers a client side event.
val set_trigger_after_swap : string -> Dream.response -> unitset_trigger_after_swap event triggers a client side event after the swap step.
val set_trigger_after_settle : string -> Dream.response -> unitset_trigger_after_settle event triggers a client side event after the settle step.