Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmpl-lang/hmpl
Template language for displaying UI from server to client
https://github.com/hmpl-lang/hmpl
fetch fetch-api hacktoberfest hacktoberfest2024 javascript language rest rest-api templates
Last synced: 3 months ago
JSON representation
Template language for displaying UI from server to client
- Host: GitHub
- URL: https://github.com/hmpl-lang/hmpl
- Owner: hmpl-lang
- License: mit
- Created: 2024-05-25T19:38:18.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-10-16T20:51:17.000Z (3 months ago)
- Last Synced: 2024-10-17T06:08:34.990Z (3 months ago)
- Topics: fetch, fetch-api, hacktoberfest, hacktoberfest2024, javascript, language, rest, rest-api, templates
- Language: TypeScript
- Homepage: https://hmpl-lang.github.io
- Size: 197 KB
- Stars: 56
- Watchers: 0
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- trackawesomelist - HMPL (⭐56) - first-issue)* <br> Template language for displaying UI from server to client. (Recently Updated / [Oct 20, 2024](/content/2024/10/20/README.md))
- awesome-for-beginners - HMPL
- fucking-awesome-for-beginners - HMPL
README
hmpl - template language for displaying UI from server to client
[](https://www.npmjs.com/package/hmpl-js)
[](https://bundlephobia.com/package/hmpl-js)
[](https://github.com/hmpl-lang/hmpl/issues)
[](https://www.npmjs.com/package/hmpl-js)
Best alternative to htmx and alpine.js
## About
🌐 hmpl is a small template language for displaying UI from server to client. It is based on requests sent to the server via [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and processed into ready-made HTML. Reduce the size of your javascript files and display the same UI as if it was written in a modern framework.
## Example #1
### HTML before
```html
const templateFn = hmpl.compile(
`<div>
{
{
"src": "http://localhost:8000/api/test"
}
}
</div>`
);
const wrapper = document.getElementById("wrapper");
const obj = templateFn();
/**
* obj = {
* response: div,
* status: 200
* }
*/
wrapper.appendChild(obj.response);
```
### API route - /api/test
```html
123
```
### HTML after
```html
123
```
## Example #2
```typescript
import { compile } from "hmpl-js";
const templateFn = compile(
`{
{
"src": "/api/test",
"indicators": [
{
"trigger": "pending",
"content": "
Loading..."
},
{
"trigger": "rejected",
"content": "Error"
}
]
}
}`
);
const wrapper = document.getElementById("wrapper");
const elementObj = templateFn({
credentials: "same-origin",
get: (prop, value) => {
if (prop === "response") {
if (value) {
wrapper.appendChild(value.content);
}
}
},
});
```
## Why hmpl?
The HMPL template language extends the capabilities of regular HTML by adding query objects to the markup to reduce the code on the client. When creating modern web applications, frameworks and libraries are used, which entail the need to write a bunch of boilerplate code, as well as connecting additional modules, which again make JavaScript files very large. If you recall the same SPA, then there js files can reach several hundred megabytes, which makes the first site load speed quite long. All this can be avoided by generating the markup on the server and then loading it on the client. Example of comparing the file size of a web application on Vue and HMPL.js:
```javascript
createApp({
setup() {
const count = ref(0);
return {
count,
};
},
template: `
Click!
Clicks: {{ count }}
`,
}).mount("#app");
```
> Size: **226** bytes (4KB on disk)
```javascript
document.querySelector("#app").append(
hmpl.compile(
`
Click!
Clicks: {{ "src": "/api/clicks", "after": "click:button" }}
`
)().response
);
```
> Size: **206** bytes (4KB on disk)
If we do not take into account that in one case we store the state on the client, and in the other on the server, as well as the response speed from the server, then we can see that with different file sizes we get the same interface. And this is only a small example. If we take large web applications, then the file sizes there can be several times smaller.
## Installation
hmpl can be installed in several ways, which are described in this article. 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.). 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.
### 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.
### 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.
## Getting started
After installation using any convenient method described in [Installation](https://hmpl-lang.github.io/installation.html), you can start working with the server in the following way:
```html
const templateFn = compile(
`{
{
"src": "/api/test"
}
}`
);
const elementObj = templateFn();
```
Or, if you need to work with hmpl as a module, there is a list of imported functions, such as `compile`:
```typescript
import { compile } from "hmpl-js";
const templateFn = compile(
`{
{
"src": "/api/test"
}
}`
);
const elementObj = templateFn();
```
These will be the two main ways to interact with the server. In future versions, the functionality will be expanded, but the methods themselves will not change.
## Webpack
Module has its own loader for files with the `.hmpl` extension. You can include [hmpl-loader](https://www.npmjs.com/package/hmpl-loader) and use the template language syntax in separate files:
### main.hmpl
```hmpl
{
{
"src": "/api/test"
}
}
```
### main.js
```javascript
const templateFn = require("./main.hmpl");
const elementObj = templateFn();
```
For the loader to work, it is better to use versions `0.0.2` or higher.
## Changelog
[Changelog](https://hmpl-lang.github.io/changelog.html)
## Inspiration
If you like hmpl, it will be very cool if you rate the repository with a star ★
## Contact
Email - [email protected]
## License
[Licensed under MIT](https://github.com/hmpl-lang/hmpl/blob/master/LICENSE)