68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
## About
|
|
|
|
Postman delivers the assets of a web page. <br>
|
|
The library is typically paired with a progress bar
|
|
that reports progress to the client.
|
|
|
|
## 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>
|
|
<html>
|
|
<head>
|
|
<title>Postman</title>
|
|
<script type="module" src="/postman.js"></script>
|
|
</head>
|
|
<body>
|
|
<div class="postman loader">
|
|
<progress value="0" max="100"></progress>
|
|
<span class="percentage"></span>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
**postman.js**
|
|
|
|
```typescript
|
|
import postman, { item } from "postman";
|
|
document.addEventListener("DOMContentLoaded", () => {
|
|
const progressBar = document.querySelector("progress")
|
|
const span = document.querySelector(".percentage");
|
|
postman(
|
|
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) => {
|
|
progressBar.value = percent;
|
|
span.innerText = `${percent}%`;
|
|
})
|
|
).fetch()
|
|
.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 */
|
|
progressBar.remove();
|
|
span.remove();
|
|
})
|
|
})
|
|
```
|
|
|
|
## License
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
|
|
<br>
|
|
See [LICENSE](./LICENSE)
|
|
|