@openrfid/ui 0.1.0 → 1.0.0
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 +83 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="https://raw.githubusercontent.com/rfidsoftwares/openrfid-simulator/main/assets/logo.svg" alt="OpenRFID Simulator Logo" width="180" />
|
|
4
|
+
|
|
5
|
+
# `@openrfid/ui`
|
|
6
|
+
|
|
7
|
+
### Shared React Component Library & Visual Theme Tokens for OpenRFID Simulator
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@openrfid/ui)
|
|
10
|
+
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://rfidsoftwares.com)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 Overview
|
|
18
|
+
|
|
19
|
+
`@openrfid/ui` is the shared React component library powering the **OpenRFID Simulator** web SPA console and Tauri desktop application. Built with **React 18**, **Tailwind CSS**, and **Lucide Icons**, it provides accessible dashboard widgets, reader configuration forms, real-time tag scan monitors, and antenna power tuning sliders.
|
|
20
|
+
|
|
21
|
+
Developed & Maintained by **[RFID Software India Private Limited](https://rfidsoftwares.com)**.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 📦 Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# npm
|
|
29
|
+
npm install @openrfid/ui
|
|
30
|
+
|
|
31
|
+
# pnpm
|
|
32
|
+
pnpm add @openrfid/ui
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 💻 Code Example
|
|
38
|
+
|
|
39
|
+
```tsx
|
|
40
|
+
import React from 'react';
|
|
41
|
+
import { StatCard, StatusBadge, Button } from '@openrfid/ui';
|
|
42
|
+
|
|
43
|
+
export function DashboardOverview() {
|
|
44
|
+
return (
|
|
45
|
+
<div className="grid grid-cols-3 gap-4 p-6">
|
|
46
|
+
<StatCard
|
|
47
|
+
title="Active Readers"
|
|
48
|
+
value="4 Online"
|
|
49
|
+
subtitle="16 Antennas Configured"
|
|
50
|
+
/>
|
|
51
|
+
<StatCard
|
|
52
|
+
title="Read Throughput"
|
|
53
|
+
value="5,240 / sec"
|
|
54
|
+
subtitle="Peak Read Cycle Rate"
|
|
55
|
+
/>
|
|
56
|
+
<div className="flex items-center gap-2">
|
|
57
|
+
<StatusBadge status="online" label="Engine Active" />
|
|
58
|
+
<Button variant="primary" onClick={() => console.log('Start')}>
|
|
59
|
+
Start Simulation
|
|
60
|
+
</Button>
|
|
61
|
+
</div>
|
|
62
|
+
</div>
|
|
63
|
+
);
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 🌐 Monorepo Ecosystem
|
|
70
|
+
|
|
71
|
+
| Package | Description |
|
|
72
|
+
| :--- | :--- |
|
|
73
|
+
| [`@openrfid/shell`](https://www.npmjs.com/package/@openrfid/shell) | Cross-platform application integration shell |
|
|
74
|
+
| [`@openrfid/simulator`](https://www.npmjs.com/package/@openrfid/simulator) | High-throughput inventory simulation engine |
|
|
75
|
+
| [`@openrfid/core`](https://www.npmjs.com/package/@openrfid/core) | Core EventBus, Config, & SQLite persistence |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 📄 License & Corporate Support
|
|
80
|
+
|
|
81
|
+
Licensed under the **MIT License**.
|
|
82
|
+
Brought to you by **RFID Software India Private Limited**.
|
|
83
|
+
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit **[rfidsoftwares.com](https://rfidsoftwares.com)**.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openrfid/ui",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Shared React UI component library for OpenRFID Simulator.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,12 +13,13 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
20
|
"react": "^18.2.0",
|
|
20
21
|
"react-dom": "^18.2.0",
|
|
21
|
-
"@openrfid/core": "
|
|
22
|
+
"@openrfid/core": "1.0.0"
|
|
22
23
|
},
|
|
23
24
|
"devDependencies": {
|
|
24
25
|
"@types/react": "^18.2.66",
|