@kouji-ui/core 0.0.2 → 0.0.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.
@@ -1,5 +1,5 @@
1
1
 
2
- > @kouji-ui/core@0.0.2 build /home/runner/work/kouji-ui/kouji-ui/packages/core
2
+ > @kouji-ui/core@0.0.3 build /home/runner/work/kouji-ui/kouji-ui/packages/core
3
3
  > ng-packagr -p ng-package.json
4
4
 
5
5
  Building Angular Package
@@ -23,5 +23,5 @@ Built Angular Package
23
23
  - to: /home/runner/work/kouji-ui/kouji-ui/dist/kj-core
24
24
  ------------------------------------------------------------------------------
25
25
 
26
- Build at: 2026-05-04T20:37:30.262Z - Time: 4059ms
26
+ Build at: 2026-05-04T21:22:08.979Z - Time: 4682ms
27
27
 
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @kouji-ui/core
2
2
 
3
+ ## 0.0.3
4
+
5
+ ### Patch Changes
6
+
7
+ - c177d1e: Rewrite README with real install/usage docs, primitive index, and design principles. Replaces the Angular CLI scaffold placeholder.
8
+
3
9
  ## 0.0.2
4
10
 
5
11
  ### Patch Changes
package/README.md CHANGED
@@ -1,64 +1,96 @@
1
- # KjCore
1
+ # @kouji-ui/core
2
2
 
3
- This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.0.
3
+ Headless Angular 21 UI primitives directives over CDK with WCAG 2.1 AAA semantics and zero CSS.
4
4
 
5
- ## Code scaffolding
5
+ You write the markup. You write the styles. The library wires up keyboard navigation, ARIA, focus management, and state.
6
6
 
7
- Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
7
+ [Documentation](https://kouji-ui.onrender.com) · [GitHub](https://github.com/kouji-dev/kouji-ui)
8
8
 
9
- ```bash
10
- ng generate component component-name
11
- ```
12
-
13
- For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
14
-
15
- ```bash
16
- ng generate --help
17
- ```
18
-
19
- ## Building
20
-
21
- To build the library, run:
9
+ ## Install
22
10
 
23
11
  ```bash
24
- ng build kj-core
12
+ pnpm add @kouji-ui/core @angular/cdk
25
13
  ```
26
14
 
27
- This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
15
+ Peer dependencies: `@angular/common` `@angular/core` `@angular/cdk` all `^21.0.0`.
28
16
 
29
- ### Publishing the Library
17
+ ## Quick start
30
18
 
31
- Once the project is built, you can publish your library by following these steps:
19
+ Every primitive is a standalone directive. Import it where you use it.
32
20
 
33
- 1. Navigate to the `dist` directory:
21
+ ```ts
22
+ import { Component } from '@angular/core';
23
+ import { KjButton } from '@kouji-ui/core';
34
24
 
35
- ```bash
36
- cd dist/kj-core
37
- ```
25
+ @Component({
26
+ selector: 'app-example',
27
+ imports: [KjButton],
28
+ template: `<button kjButton (click)="save()">Save</button>`,
29
+ })
30
+ export class ExampleComponent {
31
+ save() { /* ... */ }
32
+ }
33
+ ```
38
34
 
39
- 2. Run the `npm publish` command to publish your library to the npm registry:
40
- ```bash
41
- npm publish
42
- ```
35
+ The directive owns the keyboard contract, ARIA roles, and focus ring not the look. Style the host element however you want.
36
+
37
+ ### A more involved example: dialog
38
+
39
+ ```ts
40
+ import { Component } from '@angular/core';
41
+ import {
42
+ KjDialog,
43
+ KjDialogTrigger,
44
+ KjDialogOverlay,
45
+ KjDialogTitle,
46
+ KjDialogClose,
47
+ } from '@kouji-ui/core';
48
+
49
+ @Component({
50
+ selector: 'app-confirm',
51
+ imports: [KjDialog, KjDialogTrigger, KjDialogOverlay, KjDialogTitle, KjDialogClose],
52
+ template: `
53
+ <button [kjDialogTrigger]="confirm">Delete</button>
54
+
55
+ <ng-template #confirm>
56
+ <div kjDialog>
57
+ <div kjDialogOverlay></div>
58
+ <h2 kjDialogTitle>Delete this item?</h2>
59
+ <p>This action cannot be undone.</p>
60
+ <button kjDialogClose>Cancel</button>
61
+ <button kjDialogClose (click)="delete()">Delete</button>
62
+ </div>
63
+ </ng-template>
64
+ `,
65
+ })
66
+ export class ConfirmComponent {
67
+ delete() { /* ... */ }
68
+ }
69
+ ```
43
70
 
44
- ## Running unit tests
71
+ Focus trap, Escape-to-close, scroll lock, ARIA wiring — all handled.
45
72
 
46
- To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
73
+ ## What's included
47
74
 
48
- ```bash
49
- ng test
50
- ```
75
+ | Domain | Primitives |
76
+ | --------------- | ----------------------------------------------------------- |
77
+ | Buttons & inputs | `KjButton`, `KjInput`, `KjCheckbox`, `KjRadio`, `KjToggle`, `KjSelect` |
78
+ | Form composition | `KjFormField`, `KjFormLabel`, `KjFormError` |
79
+ | Overlays | `KjDialog`, `KjPopover`, `KjTooltip`, `KjToast`, `KjMenu` |
80
+ | Navigation | `KjTabs`, `KjAccordion` |
81
+ | Data display | `KjTable`, `KjBadge`, `KjAvatar`, `KjChart` |
82
+ | A11y primitives | `KjFocusTrap`, `KjFocusRing`, `KjLiveRegion`, `KjRovingTabindex`, `KjVisuallyHidden`, `KjAriaDescribedBy` |
51
83
 
52
- ## Running end-to-end tests
84
+ Every primitive ships with examples and an inputs reference at [kouji-ui.onrender.com](https://kouji-ui.onrender.com).
53
85
 
54
- For end-to-end (e2e) testing, run:
55
-
56
- ```bash
57
- ng e2e
58
- ```
86
+ ## Design principles
59
87
 
60
- Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
88
+ - **Headless** directives, not components. You own the DOM and CSS.
89
+ - **WCAG 2.1 AAA target** — keyboard contracts, focus management, ARIA, and contrast all designed for AAA.
90
+ - **CDK-aligned** — wraps `@angular/cdk` primitives where it makes sense (overlay, focus-trap), never reimplements from scratch.
91
+ - **Signals-first** — public APIs use `input()` / `signal()` / `effect()`.
92
+ - **Zero runtime CSS** — no shipped stylesheet. Bring your own design system.
61
93
 
62
- ## Additional Resources
94
+ ## License
63
95
 
64
- For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
96
+ MIT © [kouji-dev](https://github.com/kouji-dev)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kouji-ui/core",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "Headless Angular 21 UI primitives — directives over CDK with WCAG 2.1 AAA semantics and zero CSS.",
5
5
  "license": "MIT",
6
6
  "repository": {