@vention/machine-ui 3.29.1 → 3.30.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 +49 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,39 +1,65 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Machine UI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Machine UI is Vention's component library for building applications and Human-Machine Interfaces (HMIs). This is the same library that Vention uses internally to build our own applications, now available for you to build custom applications for your Vention machines.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
Detailed documentation can be found [here](https://machine-ui.vention-aws.net/?path=/docs/guides-introduction--documentation).
|
|
5
|
+
## 📚 Documentation
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
Complete documentation, including component examples, design system guidelines, and usage instructions, can be found at:
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
**[https://assets.vention.com/machine-ui-storybook/](https://assets.vention.com/machine-ui-storybook/index.html?path=/docs/guides-introduction--documentation)**
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
- **Minor versions** (e.g., 1.1.x → 1.2.x) will introduce new features while maintaining backward compatibility
|
|
14
|
-
- **Patch versions** (e.g., 1.1.1 → 1.1.2) will contain bug fixes and internal improvements
|
|
11
|
+
## 🚀 Installation
|
|
15
12
|
|
|
16
|
-
|
|
13
|
+
Install Machine UI via npm:
|
|
17
14
|
|
|
18
|
-
|
|
15
|
+
```bash
|
|
16
|
+
npm install @vention/machine-ui
|
|
17
|
+
```
|
|
19
18
|
|
|
20
|
-
|
|
19
|
+
For the latest version and release notes, visit the [npm package page](https://www.npmjs.com/package/@vention/machine-ui).
|
|
21
20
|
|
|
22
|
-
##
|
|
21
|
+
## 📖 Quick Start
|
|
23
22
|
|
|
24
|
-
|
|
23
|
+
```javascript
|
|
24
|
+
import { VentionButton } from "@vention/machine-ui"
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
function App() {
|
|
27
|
+
return (
|
|
28
|
+
<VentionButton variant="contained" color="primary">
|
|
29
|
+
Hello World
|
|
30
|
+
</VentionButton>
|
|
31
|
+
)
|
|
32
|
+
}
|
|
33
|
+
```
|
|
27
34
|
|
|
28
|
-
|
|
29
|
-
`npm run nx -- open-coverage machine-ui`
|
|
35
|
+
For detailed installation instructions, including font setup and prerequisites, see the [Installation and Usage guide](https://assets.vention.com/machine-ui-storybook/index.html?path=/docs/guides-installation-and-usage--documentation).
|
|
30
36
|
|
|
31
|
-
##
|
|
37
|
+
## 📋 Versioning Policy
|
|
32
38
|
|
|
33
|
-
1.
|
|
34
|
-
2. Add the .svg file to `libs/machine-ui/src/lib/components/vention-icon/svg` (or `libs/machine-ui/src/lib/components/vention-icon/duotone-svg` for a duotone icon)
|
|
35
|
-
3. Run the following command: `npm run nx -- generate-icons machine-ui`
|
|
39
|
+
Starting with version 1.0.0, Machine UI follows strict semantic versioning:
|
|
36
40
|
|
|
37
|
-
|
|
38
|
-
|
|
41
|
+
- **Major versions** (e.g., 1.x.x → 2.x.x): Breaking changes to component contracts, APIs, or behavior
|
|
42
|
+
- **Minor versions** (e.g., 1.1.x → 1.2.x): New features with backward compatibility
|
|
43
|
+
- **Patch versions** (e.g., 1.1.1 → 1.1.2): Bug fixes and internal improvements
|
|
39
44
|
|
|
45
|
+
Any breaking change, no matter how small, will require a major version bump. This ensures you can confidently upgrade patch and minor versions without unexpected breaking changes.
|
|
46
|
+
|
|
47
|
+
## 🏭 Building HMIs
|
|
48
|
+
|
|
49
|
+
Machine UI components work exceptionally well for industrial HMI applications. For guidelines on building touch-screen interfaces optimized for industrial environments, see our documentation on:
|
|
50
|
+
|
|
51
|
+
- Touch target sizing and spacing
|
|
52
|
+
- Readability at distance
|
|
53
|
+
- Color contrast requirements
|
|
54
|
+
- Simplified interactions for gloved operation
|
|
55
|
+
|
|
56
|
+
## 🛠️ Tech Stack
|
|
57
|
+
|
|
58
|
+
- **React**: UI framework
|
|
59
|
+
- **TypeScript**: Type safety
|
|
60
|
+
- **Material-UI (MUI v5)**: Base component library
|
|
61
|
+
- **TSS**: Styling solution
|
|
62
|
+
|
|
63
|
+
## 📄 License
|
|
64
|
+
|
|
65
|
+
This library is provided for use with Vention machines and applications.
|