@larose-ui/network 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/package.json +9 -4
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @larose-ui/network
|
|
2
|
+
|
|
3
|
+
> Network condition detection for adaptive UI.
|
|
4
|
+
|
|
5
|
+
Part of **[laRose UI](https://github.com/hamdymohamedak/larose-ui)** — the UI Operating System for modern SaaS applications.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @larose-ui/network
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @larose-ui/network
|
|
13
|
+
# or
|
|
14
|
+
yarn add @larose-ui/network
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Quick start
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { createNetworkMonitor, shouldUseSkeleton } from '@larose-ui/network';
|
|
23
|
+
|
|
24
|
+
const monitor = createNetworkMonitor();
|
|
25
|
+
monitor.subscribe((state) => console.log(state.condition));
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Features
|
|
29
|
+
|
|
30
|
+
- Online, offline, slow, and high-latency detection
|
|
31
|
+
- Navigator connection API integration
|
|
32
|
+
- Skeleton vs spinner recommendations
|
|
33
|
+
|
|
34
|
+
## Related packages
|
|
35
|
+
|
|
36
|
+
| Layer | Packages |
|
|
37
|
+
|-------|----------|
|
|
38
|
+
| Foundation | `@larose-ui/core`, `@larose-ui/tokens`, `@larose-ui/react` |
|
|
39
|
+
| Runtime | `@larose-ui/runtime`, `@larose-ui/network`, `@larose-ui/offline` |
|
|
40
|
+
| Intelligence | `@larose-ui/data`, `@larose-ui/forms`, `@larose-ui/permissions` |
|
|
41
|
+
| Platform | `@larose-ui/observability`, `@larose-ui/enterprise`, `@larose-ui/ai` |
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
- [Monorepo README](https://github.com/hamdymohamedak/larose-ui#readme)
|
|
46
|
+
- [Architecture](https://github.com/hamdymohamedak/larose-ui/blob/main/docs/architecture/ARCHITECTURE.md)
|
|
47
|
+
- [Roadmap](https://github.com/hamdymohamedak/larose-ui/blob/main/docs/ROADMAP.md)
|
|
48
|
+
- [Report an issue](https://github.com/hamdymohamedak/larose-ui/issues)
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT © [laRose UI](https://github.com/hamdymohamedak/larose-ui)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@larose-ui/network",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Network condition detection for laRose UI platform",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -13,10 +13,11 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
|
-
"@larose-ui/core": "0.1.
|
|
20
|
+
"@larose-ui/core": "0.1.2"
|
|
20
21
|
},
|
|
21
22
|
"devDependencies": {
|
|
22
23
|
"tsup": "^8.3.5",
|
|
@@ -29,7 +30,7 @@
|
|
|
29
30
|
},
|
|
30
31
|
"repository": {
|
|
31
32
|
"type": "git",
|
|
32
|
-
"url": "https://github.com/larose-ui
|
|
33
|
+
"url": "git+https://github.com/hamdymohamedak/larose-ui.git",
|
|
33
34
|
"directory": "packages/network"
|
|
34
35
|
},
|
|
35
36
|
"keywords": [
|
|
@@ -39,6 +40,10 @@
|
|
|
39
40
|
"design-system",
|
|
40
41
|
"saas"
|
|
41
42
|
],
|
|
43
|
+
"homepage": "https://github.com/hamdymohamedak/larose-ui/blob/main/packages/network#readme",
|
|
44
|
+
"bugs": {
|
|
45
|
+
"url": "https://github.com/hamdymohamedak/larose-ui/issues"
|
|
46
|
+
},
|
|
42
47
|
"scripts": {
|
|
43
48
|
"build": "tsup src/index.ts --format esm --dts --clean",
|
|
44
49
|
"dev": "tsup src/index.ts --format esm --dts --watch",
|