Skip to content

lambdaisland/hiccup

Repository files navigation

hiccup

CircleCI cljdoc badge Clojars Project

Enlive-backed Hiccup implementation (clj-only)

Features

  • Auto-escape strings
  • Fragments ([:<> ...])
  • Components ([my-fn ...])
  • Style maps ([:div {:style {:color "blue"}}])
  • Insert pre-rendered HTML with [::hiccup/unsafe-html "your html"]
  • Convert multi-word attributes to the appropriate case, matching Reagent + React's behaviour (:tab-index -> "tabIndex"; "fontStyle" -> "font-style"); you should be able to use :kebab-case keywords and get what you expect
  • wrap-render Ring middleware with content negotiation

These features make its behavior closely follow how Hiccup works in Reagent, reducing cognitive overhead when doing cross-platform development.

Installation

To use the latest release, add the following to your deps.edn (Clojure CLI)

com.lambdaisland/hiccup {:mvn/version "0.10.51"}

or add the following to your project.clj (Leiningen)

[com.lambdaisland/hiccup "0.10.51"]

Usage

(require '[lambdaisland.hiccup :as h])

(h/render [:html [:body ...]])

Lambda Island Open Source

 

hiccup is part of a growing collection of quality Clojure libraries created and maintained by the fine folks at Gaiwan.

Pay it forward by becoming a backer on our Open Collective, so that we may continue to enjoy a thriving Clojure ecosystem.

You can find an overview of our projects at lambdaisland/open-source.

 

 

Contributing

Everyone has a right to submit patches to hiccup, and thus become a contributor.

Contributors MUST

  • adhere to the LambdaIsland Clojure Style Guide
  • write patches that solve a problem. Start by stating the problem, then supply a minimal solution. *
  • agree to license their contributions as MPL 2.0.
  • not break the contract with downstream consumers. **
  • not break the tests.

Contributors SHOULD

  • update the CHANGELOG and README.
  • add tests for new functionality.

If you submit a pull request that adheres to these rules, then it will almost certainly be merged immediately. However some things may require more consideration. If you add new dependencies, or significantly increase the API surface, then we need to decide if these changes are in line with the project's goals. In this case you can start by writing a pitch, and collecting feedback on it.

* This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.

** As long as this project has not seen a public release (i.e. is not on Clojars) we may still consider making breaking changes, if there is consensus that the changes are justified.

License

Copyright © 2021 Arne Brasseur and Contributors

Licensed under the term of the Mozilla Public License 2.0, see LICENSE.