https://github.com/hmpl-language/hmpl
🐜 Server-oriented customizable templating for JavaScript. Apply SSR, SSG, ISG without robot indexing on any sites without Next.js, Remix, Nuxt.js!
https://github.com/hmpl-language/hmpl
fetch fetch-api hmpl html javascript rest server-side ssr template-engine typescript
Last synced: 3 months ago
JSON representation
🐜 Server-oriented customizable templating for JavaScript. Apply SSR, SSG, ISG without robot indexing on any sites without Next.js, Remix, Nuxt.js!
- Host: GitHub
- URL: https://github.com/hmpl-language/hmpl
- Owner: hmpl-language
- License: mit
- Created: 2024-11-04T22:13:15.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-31T18:47:44.000Z (3 months ago)
- Last Synced: 2025-04-01T16:15:51.711Z (3 months ago)
- Topics: fetch, fetch-api, hmpl, html, javascript, rest, server-side, ssr, template-engine, typescript
- Language: TypeScript
- Homepage: https://hmpl-lang.dev
- Size: 8.38 MB
- Stars: 239
- Watchers: 3
- Forks: 25
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- trackawesomelist - HMPL (⭐8) - oriented customizable templating for JavaScript. (Recently Updated / [Nov 17, 2024](/content/2024/11/17/README.md))
README
[](https://www.npmjs.com/package/hmpl-js)
[](https://bundlephobia.com/package/hmpl-js)
[](https://codecov.io/github/hmpl-language/hmpl)
[](https://github.com/hmpl-language/hmpl/issues)
[](https://x.com/hmpljs)
[](https://discord.gg/KFunMep36n)
Website • Documentation • Demo Sandbox • Examples
hmpl is a small template language for displaying UI from server to client. It is based on customizable requests sent to the server via fetch and processed into ready-made HTML. The language is syntactically object-based and integrated with JSON5 and DOMPurify. Reduce the size of your javascript files and display the same UI as if it was written in a modern framework and apply Server-Side Rendering, Static Site Generation, Incremental Static Generation (SSR, SSG, ISG) without robot indexing on any sites without Next.js, Remix, Nuxt.js!
☆ If you find HMPL useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features.
## Usage
```javascript
import hmpl from "hmpl-js";
const templateFn = hmpl.compile(
`
Click!
Clicks: {{ src: "/api/clicks", after: "click:#btn" }}
`
);
const clicker = templateFn(({ request: { event } }) => ({
body: JSON.stringify({ action: event.target.getAttribute("data-action") })
})).response;
document.querySelector("#app").append(clicker);
```
Clarify this!
```js
import hmpl from "hmpl-js"; // Import the HMPL library
// Compile an HMPL template with dynamic behavior
const templateFn = hmpl.compile(
`
Click!
Clicks: {{ src: "/api/clicks", after: "click:#btn" }}
`
);
// Generate a response handler for the template
// In the original object, we will have the following: { response: div, status: 200 }
const clicker = templateFn(({ request: { event } }) => ({
// Send a JSON payload with the action from the button's data attribute
body: JSON.stringify({ action: event.target.getAttribute("data-action") })
})).response;
// Append the dynamically generated element to the #app container
document.querySelector("#app").append(clicker);
```
In this example, we create a dynamic clicker component in which, when a `button` is pressed, we will receive the value of the current clicks that will come from the server. The advantage of this approach is that we can take out not only data in the form of `Text`, but also entire components and even pages!
## Why HMPL?
Using template language capabilities, you can multiply reduce the size of the application bundle. Full customization of the request based on the modern `fetch` standard, as well as support for all the functionality necessary for modern work in applications (request indicator, sending by event, automatic generation of `body` for the `form`, caching) and the syntax of the object in the markup, which requires a minimum number of characters, will help to build interaction with the server and client as efficiently as possible. App size [comparison](https://github.com/hmpl-language/app-size-comparison) (bytes):
Also, HMPL can be a great alternative to popular tools such as HTMX and Alpine.js.
## Features
- **Customizable**: Send a custom request to the server when receiving the UI
- **Memory Preserving**: Reduce file sizes on the client by several times
- **Based on Fetch API**: Use a modern standard instead of `XMLHTTPRequest`
- **Server-oriented**: Work with the server directly through markup and with a little js
- **Generate thousands of DOM nodes from a single template**: Work with large components not only on the server but also on the client
- **Simple**: Get ready-made UI from the server by writing a couple of lines of familiar object syntax
- **Protected from XSS attacks**: Enable incoming server HTML sanitization with [DOMPurify](https://www.npmjs.com/package/dompurify) and work with it safely
- **Flexible**: Can be used in almost any project due to not only working through a script, but also working in files with the `.hmpl` extension
- **Integrated with JSON5**: Flexible writing of objects by [specs](https://spec.json5.org) as in vanilla js, as well as the reliability of the parser used by millions of people
- **Small bundle size**: Lots of functionality in a couple of kilobytes
## Installation
hmpl can be installed in several ways, which are described in this section. This tool is a simple javascript file that is connected in the usual way through a `script`, or using the `import` construct in an environment that supports this (webpack build, parcel build etc.). Also, starting with version `2.2.0`, the JSON5 module needs to be connected, and starting with version `2.2.5`, the DOMPurify module also needs to be connected. The first and easiest way is to install using a CDN.
### Package Manager
This method involves downloading through npm or other package managers.
```bash
npm i hmpl-js
```
> [Node.js](https://nodejs.org) is required for npm.
Along the path node-modules/hmpl/dist you can find two files that contain a regular js file and a minified one.
### CDN
This method involves connecting the file through a third-party resource, which provides the ability to obtain a javascript file from npm via a link.
```html
```
This resource could be unpkg, skypack or other resources. The examples include unpkg simply because it is one of the most popular and its url by characters is not so long.
### Manual download
You can install the package by simply [downloading](https://unpkg.com/hmpl-js/dist/hmpl.min.js) it as a file and moving it to the project folder.
```html
```
If, for some reason, you do not need the minified file, then you can download the full file from this [link](https://unpkg.com/hmpl-js/dist/hmpl.js).
```html
```
The non-minified file is larger in size, but it is there as it is with all the formatting.
## Ecosystem
## Community support
The [documentation](https://hmpl-lang.dev/introduction.html) contains main information on how the HMPL template language works. If you have any questions about how HMPL works, you can use the following resources:
- [Github](https://github.com/hmpl-language/hmpl) - In the discussion and issues sections you can ask any question you are interested in
- [Discord](https://discord.gg/KFunMep36n) - You can ask your question in the thematic channel "support"
- [𝕏 (Twitter)](https://x.com/hmpljs) - There is a lot of interesting stuff there, concerning the template language and not only :)
You can also ask your question on [Stack Overflow](https://stackoverflow.com/) and address it in the resources described above.
## Contribution
We have a [Contributing Guide](https://github.com/hmpl-language/hmpl/blob/main/CONTRIBUTING.md) that describes the main steps for contributing to the project.
Thank you to all the people who have already contributed to HMPL, or related projects!
## Roadmap
The project has a [roadmap](https://github.com/orgs/hmpl-language/projects/5) where you can see the plans for future development.
## Fossa status
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fhmpl-language%2Fhmpl?ref=badge_large&issueType=license)
Licensed under [MIT](https://github.com/hmpl-language/hmpl/blob/main/LICENSE)