@aleph-alpha/ui-library 1.0.0 → 1.1.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 +21 -5
- package/dist/system/index.d.ts +749 -77
- package/dist/system/lib.js +8566 -4612
- package/package.json +10 -3
package/README.md
CHANGED
|
@@ -1,11 +1,20 @@
|
|
|
1
1
|
# UI Library
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
📘 **[View Storybook](https://urban-broccoli-l1okew7.pages.github.io/ui-library)**
|
|
4
|
+
|
|
5
|
+
## External Resources
|
|
6
|
+
|
|
7
|
+
- [shadcn-vue](https://www.shadcn-vue.com/) — The component library we build upon
|
|
8
|
+
- [Radix Vue](https://www.radix-vue.com/) — Underlying accessible primitives
|
|
9
|
+
- [TanStack Table](https://tanstack.com/table/latest) — Headless table library (used in UiDataTable)
|
|
10
|
+
- [WAI-ARIA APG](https://www.w3.org/WAI/ARIA/apg/) — Accessibility patterns guide
|
|
11
|
+
- [WCAG 2.2](https://www.w3.org/TR/WCAG22/) — Web accessibility guidelines
|
|
4
12
|
|
|
5
13
|
## Documentation
|
|
6
14
|
|
|
7
15
|
- [Architecture](./docs/ARCHITECTURE.md) — Component structure and design decisions
|
|
8
16
|
- [Contribution Guidelines](./docs/CONTRIBUTION_GUIDELINES.md) — Accessibility requirements and patterns
|
|
17
|
+
- [Storybook Guidelines](./docs/STORYBOOK.md) — Story patterns and guidelines
|
|
9
18
|
- [Testing Strategy](./docs/TESTING.md) — What we test and where
|
|
10
19
|
|
|
11
20
|
## Getting Started
|
|
@@ -35,6 +44,7 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
|
|
|
35
44
|
```
|
|
36
45
|
|
|
37
46
|
**Types:**
|
|
47
|
+
|
|
38
48
|
- `feat`: A new feature
|
|
39
49
|
- `fix`: A bug fix
|
|
40
50
|
- `docs`: Documentation only changes
|
|
@@ -45,6 +55,7 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
|
|
|
45
55
|
- `chore`: Changes to the build process or auxiliary tools
|
|
46
56
|
|
|
47
57
|
**Examples:**
|
|
58
|
+
|
|
48
59
|
```bash
|
|
49
60
|
git commit -m "feat(button): add loading state"
|
|
50
61
|
git commit -m "fix(dropdown): resolve keyboard navigation issue"
|
|
@@ -60,6 +71,7 @@ pnpm dlx shadcn-vue@latest add [component]
|
|
|
60
71
|
```
|
|
61
72
|
|
|
62
73
|
Example:
|
|
74
|
+
|
|
63
75
|
```bash
|
|
64
76
|
pnpm dlx shadcn-vue@latest add tooltip
|
|
65
77
|
```
|
|
@@ -68,11 +80,11 @@ Please refer to [CONTRIBUTION_GUIDELINES.md](./docs/CONTRIBUTION_GUIDELINES.md)
|
|
|
68
80
|
|
|
69
81
|
## Testing
|
|
70
82
|
|
|
71
|
-
| Command
|
|
72
|
-
|
|
73
|
-
| `pnpm test`
|
|
83
|
+
| Command | Purpose |
|
|
84
|
+
| --------------------- | ----------------------------------- |
|
|
85
|
+
| `pnpm test` | Run unit tests |
|
|
74
86
|
| `pnpm test:storybook` | Run Storybook + accessibility tests |
|
|
75
|
-
| `pnpm lint`
|
|
87
|
+
| `pnpm lint` | Run linting including a11y rules |
|
|
76
88
|
|
|
77
89
|
See [Testing Strategy](./docs/TESTING.md) for details on what we test and where.
|
|
78
90
|
|
|
@@ -81,6 +93,7 @@ See [Testing Strategy](./docs/TESTING.md) for details on what we test and where.
|
|
|
81
93
|
This project uses `nx affected` in pre-commit hooks to ensure code quality. Because `lint` and `test` targets depend on `build`, commits might hang if the build cache is cold.
|
|
82
94
|
|
|
83
95
|
### If commit hangs:
|
|
96
|
+
|
|
84
97
|
Run a full build to populate the cache before committing:
|
|
85
98
|
|
|
86
99
|
```bash
|
|
@@ -90,8 +103,11 @@ pnpm nx run-many --target=build --all
|
|
|
90
103
|
Then try committing again. The pre-commit hook will hit the cache and finish quickly.
|
|
91
104
|
|
|
92
105
|
### Quick unblock (Emergency only)
|
|
106
|
+
|
|
93
107
|
If you need to bypass hooks:
|
|
108
|
+
|
|
94
109
|
```sh
|
|
95
110
|
git commit -m "Your message" --no-verify
|
|
96
111
|
```
|
|
112
|
+
|
|
97
113
|
Use this sparingly and ensure CI passes.
|