postman/README.md

80 lines
1.8 KiB
Markdown
Raw Normal View History

2024-07-10 16:21:15 +02:00
## About
2024-07-10 16:30:01 +02:00
Postman delivers the assets of a web page. <br>
2024-07-10 22:01:06 +02:00
The library is typically paired with a progress
bar that reports progress to the client.
2024-07-10 16:21:15 +02:00
## Examples
### Progress bar
The following example delivers fonts, scripts, images
and stylesheets with the help of a progress bar. The
progress bar is removed once the delivery is complete:
**index.html**
```html
<!DOCTYPE html>
2024-07-10 16:30:01 +02:00
<html>
2024-07-10 16:21:15 +02:00
<head>
<title>Postman</title>
2024-07-12 07:26:46 +02:00
<script type="module" src="delivery.js"></script>
2024-07-10 16:21:15 +02:00
</head>
<body>
<div class="postman loader">
<progress value="0" max="100"></progress>
<span class="percentage"></span>
</div>
</div>
</body>
</html>
```
2024-07-12 07:26:46 +02:00
**delivery.js**
2024-07-10 16:21:15 +02:00
```typescript
import postman, { item } from "postman";
2024-07-10 16:30:01 +02:00
document.addEventListener("DOMContentLoaded", () => {
2024-07-10 22:22:17 +02:00
const bar = document.querySelector("progress");
2024-07-10 16:30:01 +02:00
const span = document.querySelector(".percentage");
2024-07-10 22:22:17 +02:00
const delivery = postman(
2024-07-10 16:30:01 +02:00
item.font("Kanit Regular", "url(/fonts/kanit-regular.ttf)"),
item.script("/js/app.js"),
item.image("/images/app.png"),
item.css("/css/app.css"),
item.progress((percent) => {
2024-07-10 22:22:17 +02:00
bar.value = percent;
2024-07-10 16:30:01 +02:00
span.innerText = `${percent}%`;
})
2024-07-10 22:22:17 +02:00
).deliver();
delivery.then((package) => {
/* Add page assets */
package.fonts.forEach((font) => documents.fonts.add(font));
package.scripts.forEach((script) => document.body.appendChild(script));
package.css.forEach((css) => document.head.appendChild(css));
/* Replace progress bar */
bar.remove();
span.remove();
});
2024-07-10 16:42:28 +02:00
});
2024-07-10 16:21:15 +02:00
```
2024-07-12 07:07:49 +02:00
## See also
* [https://al-quran.reflectslight.io/](https://al-quran.reflectslight.io) <br>
2024-07-12 07:30:23 +02:00
Delivers all of its assets with Postman
2024-07-12 07:07:49 +02:00
2024-07-10 16:44:55 +02:00
## Sources
* [GitHub](https://github.com/0x1eef/postman)
* [GitLab](https://gitlab.com/0x1eef/postman)
2024-07-10 16:21:15 +02:00
## License
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
<br>
See [LICENSE](./LICENSE)