@oniratec/onira-react-ui 0.2.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.
Files changed (2) hide show
  1. package/README.md +117 -0
  2. package/package.json +78 -0
package/README.md ADDED
@@ -0,0 +1,117 @@
1
+ <p align="center">
2
+ <strong>@oniratec/onira-react-ui</strong><br/>
3
+ React UI component library for Onira products
4
+ </p>
5
+
6
+ <p align="center">
7
+ <a href="https://www.npmjs.com/package/@oniratec/onira-react-ui">
8
+ <img src="https://img.shields.io/npm/v/@oniratec/onira-react-ui.svg" alt="npm version" />
9
+ </a>
10
+ <img src="https://img.shields.io/badge/react-18-blue" alt="React 18" />
11
+ <img src="https://img.shields.io/badge/license-MIT-blue" alt="License" />
12
+ </p>
13
+
14
+ ---
15
+
16
+ ## โœจ Overview
17
+
18
+ **@oniratec/onira-react-ui** is the official React UI component library for Onira projects.
19
+
20
+ The library focuses on:
21
+
22
+ - predictable and explicit APIs
23
+ - accessibility by default
24
+ - strong TypeScript typing
25
+ - long-term maintainability
26
+ - automated quality and release processes
27
+
28
+ This repository is intended to be **shared, versioned, and contributed to safely**.
29
+
30
+ ---
31
+
32
+ ## ๐Ÿ“ฆ Installation
33
+
34
+ ```bash
35
+ npm install @oniratec/onira-react-ui
36
+ ```
37
+
38
+ ```bash
39
+ pnpm add @oniratec/onira-react-ui
40
+ ```
41
+
42
+ ---
43
+
44
+ ## ๐Ÿš€ Getting started
45
+
46
+ ```ts
47
+ import { Button } from '@oniratec/onira-react-ui';
48
+ ```
49
+
50
+ Component usage, props, and examples are documented in **Storybook**.
51
+
52
+ ---
53
+
54
+ ## ๐Ÿ“– Documentation
55
+
56
+ ### Project & usage
57
+ - ๐Ÿ“˜ Getting Started โ†’ docs/getting-started.md
58
+ - ๐Ÿงฉ Components overview โ†’ docs/components.md
59
+ - ๐ŸŽจ Theming โ†’ docs/theming.md
60
+ - โ™ฟ Accessibility โ†’ docs/accessibility.md
61
+
62
+ ### Quality & contribution
63
+ - ๐Ÿงช CI & Code Quality โ†’ docs/ci-quality.md
64
+ - ๐Ÿš€ Release process โ†’ docs/release-process.md
65
+ - ๐Ÿค Contributing โ†’ docs/contributing.md
66
+
67
+ ---
68
+
69
+ ## ๐Ÿงฉ Component documentation (Storybook)
70
+
71
+ This project uses **Storybook** as the source of truth for component documentation.
72
+
73
+ Local Storybook:
74
+
75
+ ```bash
76
+ npm install
77
+ npm run storybook
78
+ ```
79
+
80
+ Runs at http://localhost:6006
81
+
82
+ ---
83
+
84
+ ## ๐Ÿง  Versioning & releases
85
+
86
+ This library follows **Semantic Versioning** and uses **Changesets**.
87
+
88
+ - versions are bumped automatically
89
+ - changelogs are generated
90
+ - publishing is handled by GitHub Actions
91
+ - no package is published without an explicit version decision
92
+
93
+ Current version: **0.0.1** (alpha)
94
+
95
+ ---
96
+
97
+ ## ๐Ÿ› ๏ธ Development
98
+
99
+ ```bash
100
+ npm install
101
+ npm run lint
102
+ npm run typecheck
103
+ npm run test
104
+ npm run build
105
+ ```
106
+
107
+ ---
108
+
109
+ ## ๐Ÿค Contributing
110
+
111
+ Please read docs/contributing.md before opening a PR.
112
+
113
+ ---
114
+
115
+ ## ๐Ÿ“„ License
116
+
117
+ MIT
package/package.json ADDED
@@ -0,0 +1,78 @@
1
+ {
2
+ "name": "@oniratec/onira-react-ui",
3
+ "version": "0.2.0",
4
+ "main": "dist/index.umd.cjs",
5
+ "module": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "scripts": {
11
+ "dev": "vite",
12
+ "build": "vite build",
13
+ "storybook": "storybook dev -p 6006",
14
+ "build-storybook": "storybook build",
15
+ "commit": "cz",
16
+ "prepare": "husky",
17
+ "changeset": "changeset",
18
+ "version-packages": "changeset version",
19
+ "lint": "eslint .",
20
+ "lint:fix": "eslint . --fix",
21
+ "typecheck": "tsc --noEmit",
22
+ "test": "vitest",
23
+ "test:ci": "vitest run --environment node --passWithNoTests"
24
+ },
25
+ "peerDependencies": {
26
+ "react": "^18",
27
+ "react-dom": "^18"
28
+ },
29
+ "publishConfig": {
30
+ "access": "public"
31
+ },
32
+ "dependencies": {
33
+ "react": "^18",
34
+ "react-dom": "^18"
35
+ },
36
+ "devDependencies": {
37
+ "@changesets/cli": "^2.29.8",
38
+ "@chromatic-com/storybook": "^4.1.3",
39
+ "@commitlint/cli": "^20.3.0",
40
+ "@commitlint/config-conventional": "^20.3.0",
41
+ "@eslint/js": "^9.39.1",
42
+ "@storybook/addon-a11y": "^10.1.11",
43
+ "@storybook/addon-docs": "^10.1.11",
44
+ "@storybook/addon-vitest": "^10.1.11",
45
+ "@storybook/react-vite": "^10.1.11",
46
+ "@types/node": "^24.10.1",
47
+ "@types/react": "^19.2.5",
48
+ "@types/react-dom": "^19.2.3",
49
+ "@typescript-eslint/eslint-plugin": "^8.52.0",
50
+ "@typescript-eslint/parser": "^8.52.0",
51
+ "@vitejs/plugin-react": "^5.1.1",
52
+ "@vitest/browser-playwright": "^4.0.16",
53
+ "@vitest/coverage-v8": "^4.0.16",
54
+ "commitizen": "^4.3.1",
55
+ "cz-conventional-changelog": "^3.3.0",
56
+ "eslint": "^9.39.2",
57
+ "eslint-plugin-import": "^2.32.0",
58
+ "eslint-plugin-jsx-a11y": "^6.10.2",
59
+ "eslint-plugin-react": "^7.37.5",
60
+ "eslint-plugin-react-hooks": "^7.0.1",
61
+ "eslint-plugin-react-refresh": "^0.4.24",
62
+ "eslint-plugin-storybook": "^10.1.11",
63
+ "eslint-plugin-unused-imports": "^4.3.0",
64
+ "globals": "^16.5.0",
65
+ "husky": "^9.1.7",
66
+ "playwright": "^1.57.0",
67
+ "storybook": "^10.1.11",
68
+ "typescript": "~5.9.3",
69
+ "typescript-eslint": "^8.46.4",
70
+ "vite": "^7.2.4",
71
+ "vitest": "^4.0.16"
72
+ },
73
+ "config": {
74
+ "commitizen": {
75
+ "path": "cz-conventional-changelog"
76
+ }
77
+ }
78
+ }