View Source Hypa

Elixir build Hex.pm Version Hex.pm License hexdocs.pm

Useful functions for Elixir applications using htmx.

Offers a Plug that performs a few tasks:

  • Parses HX-* headers into conn.assigns
  • Adds HTMX to your cache-control headers
  • Controls the rendering of layouts, hiding them for HTMX requests while showing them for non-HTMX requests.

Installation

This library is available in Hex, and the package can be installed by adding hypa to your list of dependencies in mix.exs:

def deps do
  [
    {:hypa, "~> 0.1.0"}
  ]
end

Documentation can be found at https://hexdocs.pm/hypa.

Usage

Add Hypa.Plug to your Plug pipeline like this:

plug Hypa.Plug

See the docs for more information.

License

Copyright © 2024 Rosa Richter

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.