@tedi-design-system/angular 8.0.1-rc.1 → 8.0.1-rc.3
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/community/index.d.ts.map +1 -1
- package/fesm2022/tedi-design-system-angular-community.mjs.map +1 -1
- package/fesm2022/tedi-design-system-angular-tedi.mjs +298 -218
- package/fesm2022/tedi-design-system-angular-tedi.mjs.map +1 -1
- package/fesm2022/tedi-design-system-angular.mjs.map +1 -1
- package/package.json +1 -28
- package/tedi/index.d.ts +10 -1
- package/tedi/index.d.ts.map +1 -1
- package/LICENSE +0 -21
- package/README.md +0 -79
package/README.md
DELETED
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# TEDI Design System for Angular
|
|
2
|
-
|
|
3
|
-
[](https://codecov.io/gh/TEHIK-EE/tedi-design-system)
|
|
4
|
-
[](https://github.com/semantic-release/semantic-release)
|
|
5
|
-
|
|
6
|
-
`@tedi-design-system/angular` is a library of Angular components implementing the TEDI Design System.
|
|
7
|
-
It provides reusable, accessible, and consistent UI components to streamline building Angular applications.
|
|
8
|
-
|
|
9
|
-
Usage instructions and detailed documentation can be found in the [TEDI Design System wiki](https://github.com/TEDI-Design-System/general).
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Installation
|
|
14
|
-
|
|
15
|
-
Install the dependencies for your Angular library:
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
npm run i
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Development Guide
|
|
24
|
-
|
|
25
|
-
### Running Storybook
|
|
26
|
-
|
|
27
|
-
To view and develop components in isolation, start Storybook for Angular:
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
npm run start
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Angular Version Support
|
|
34
|
-
|
|
35
|
-
The library supports the three latest Angular major versions. Angular releases a new major every 6 months and deprecates versions after 18 months. See the [Angular release schedule](https://angular.dev/reference/releases) for upcoming dates.
|
|
36
|
-
|
|
37
|
-
**Currently supported: Angular 20, 21, 22**
|
|
38
|
-
|
|
39
|
-
The library is built and tested against the base version pinned in `devDependencies`. In addition, the `compatibility` job in CI installs the built package into a fresh app for every supported Angular major to verify it is consumable.
|
|
40
|
-
|
|
41
|
-
### Adding a new Angular version
|
|
42
|
-
|
|
43
|
-
When a new Angular major is released (e.g. v23):
|
|
44
|
-
|
|
45
|
-
1. **`package.json`** — add `|| ^23.0.0` to every Angular peer dependency
|
|
46
|
-
2. **`.github/workflows/angular-test-and-lint.yml`** — add `23` to the `angular-version` matrix in the `compatibility` job
|
|
47
|
-
|
|
48
|
-
### Dropping a deprecated Angular version
|
|
49
|
-
|
|
50
|
-
When an Angular major reaches end-of-life (e.g. v20):
|
|
51
|
-
|
|
52
|
-
1. **`package.json`** — remove `^20.0.0 ||` from every Angular peer dependency
|
|
53
|
-
2. **`.github/workflows/angular-test-and-lint.yml`** — remove `20` from the `angular-version` matrix in the `compatibility` job
|
|
54
|
-
3. Bump `devDependencies` to the new minimum supported Angular version so the library is always built and developed against a supported release
|
|
55
|
-
|
|
56
|
-
## Contributing
|
|
57
|
-
|
|
58
|
-
Check the [wiki](https://github.com/TEDI-Design-System/general) for component guidelines and coding standards.
|
|
59
|
-
Report issues or contribute via [GitHub Issues](https://github.com/TEDI-Design-System/angular/issues).
|
|
60
|
-
|
|
61
|
-
## AI Skills
|
|
62
|
-
|
|
63
|
-
This project ships with AI agent skills to help both contributors and consumers work with TEDI components.
|
|
64
|
-
|
|
65
|
-
### For consumers — `tedi-angular`
|
|
66
|
-
|
|
67
|
-
Helps you build UIs with `@tedi-design-system/angular`: component usage, forms integration, theming, and translation setup.
|
|
68
|
-
|
|
69
|
-
### For contributors — `contributing`
|
|
70
|
-
|
|
71
|
-
Guides development inside this repo: creating new components, running tests/lint, WCAG audits, refactoring, and Storybook stories. Available as `/contributing` when working in this repository.
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
## Visual Testing
|
|
76
|
-
|
|
77
|
-
<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" width="153" height="30" alt="Chromatic" /></a>
|
|
78
|
-
|
|
79
|
-
We use [Chromatic](https://www.chromatic.com/) for visual testing, reviewing UI changes, and preventing visual regressions.
|