https://github.com/easywebapp/web-utility
Web front-end toolkit based on TypeScript
https://github.com/easywebapp/web-utility
Last synced: 11 months ago
JSON representation
Web front-end toolkit based on TypeScript
- Host: GitHub
- URL: https://github.com/easywebapp/web-utility
- Owner: EasyWebApp
- Created: 2020-03-03T13:05:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-20T15:05:12.000Z (about 1 year ago)
- Last Synced: 2025-03-24T09:11:38.152Z (11 months ago)
- Language: TypeScript
- Homepage: https://web-cell.dev/web-utility/
- Size: 714 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: ReadMe.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Web utility
**Web front-end** toolkit based on [TypeScript][1]
[][2]
[][3]
[][4]
[][5]
## Installation
```shell
npm install web-utility
```
### `index.html`
```html
```
### `tsconfig.json`
```json
{
"compilerOptions": {
"module": "ES2021",
"moduleResolution": "Node",
"downlevelIteration": true,
"lib": ["ES2021", "DOM", "DOM.Iterable"]
}
}
```
## Usage
[API document](https://web-cell.dev/web-utility/)
### CSS Animation
1. [Watch Swipe](https://github.com/EasyWebApp/BootCell/blob/11c5d6f/source%2FMedia%2FCarousel.tsx#L200-L218)
2. [Simple Hover](https://github.com/EasyWebApp/BootCell/blob/a41bbc1/source/Prompt/Tooltip.tsx#L38-L43)
3. [Switch with `await`](https://github.com/EasyWebApp/BootCell/blob/a41bbc1/source/Content/TabList.tsx#L77-85)
4. [Toggle with Inline Styles](https://github.com/EasyWebApp/BootCell/blob/a41bbc1/source/Content/Collapse.tsx#L19-L38)
5. [Work with Existed Classes](https://github.com/EasyWebApp/BootCell/blob/a41bbc1/source/Content/Carousel.tsx#L82-L99)
### Function Cache
```typescript
import { cache } from 'web-utility';
const getToken = cache(async (cleaner, code) => {
const { access_token, expires_in } = await (
await fetch(`https://example.com/access_token?code=${code}`)
).json();
setTimeout(cleaner, expires_in * 1000);
return access_token;
}, 'Get Token');
Promise.all([getToken('xxx'), getToken('yyy')]).then(([first, second]) =>
console.assert(
first === second,
'Getting token for many times should return the same before deadline'
)
);
```
### DOM operation
```javascript
import { parseDOM, walkDOM, stringifyDOM } from 'web-utility';
const [root] = parseDOM('Hello, Web!');
var count = 0;
for (const { nodeName, nodeType, dataset } of walkDOM(root)) {
console.log(nodeName);
if (nodeType === Node.ELEMENT_NODE) dataset.id = ++count;
}
console.log(stringifyDOM(root)); // 'Hello, Web!'
```
### jQuery-like DOM event delegation
```javascript
import { delegate } from 'web-utility';
document.addEventListener(
'click',
delegate('a[href]', (event, link) => {
event.preventDefault();
console.log(link.href);
})
);
```
### Message Channel
#### `index.ts`
```typescript
import { createMessageServer } from 'web-utility';
createMessageServer({
preset: () => ({ test: 1 })
});
```
#### `iframe.ts`
```typescript
import { createMessageClient } from 'web-utility';
const request = createMessageClient(globalThis.parent);
request('preset').then(console.log); // { test: 1 }
```
### Service Worker updating
```javascript
import { serviceWorkerUpdate } from 'web-utility';
const { serviceWorker } = window.navigator;
serviceWorker
?.register('/sw.js')
.then(serviceWorkerUpdate)
.then(worker => {
if (window.confirm('New version of this Web App detected, update now?'))
// Trigger the message callback listened in the Service Worker
// generated by Workbox CLI
worker.postMessage({ type: 'SKIP_WAITING' });
});
serviceWorker?.addEventListener('controllerchange', () =>
window.location.reload()
);
```
### Internationalization
Migrate to [MobX i18n][9] since v4.
### Test scripts
If you are looking for a simple alternative of [Mocha][6] or [Jest][7], just use these **Test Utility** methods with [`ts-node`][8]:
```shell
npx ts-node index.spec.ts
```
#### `index.spec.ts`
```typescript
import { describe, it } from 'web-utility';
class App {
name = 'test';
static create() {
return new App();
}
}
describe('My module', async () => {
const app = await it('should create an App object', async expect => {
const app = App.create();
expect(app instanceof App);
return app;
});
await it('should init an App name', expect => {
expect(app.name === 'test');
});
});
```
[1]: https://www.typescriptlang.org/
[2]: https://libraries.io/npm/web-utility
[3]: https://github.com/EasyWebApp/web-utility/actions/workflows/main.yml
[4]: https://open.vscode.dev/EasyWebApp/web-utility
[5]: https://nodei.co/npm/web-utility/
[6]: https://mochajs.org/
[7]: https://jestjs.io/
[8]: https://typestrong.org/ts-node/
[9]: https://github.com/idea2app/MobX-i18n