@awc-ui/angular 1.0.0-beta.9 → 1.0.1

package/README.md

@@ -1,43 +1,65 @@
 # Angular Web Components and Angular SSR — @awc-ui/angular
 
-Angular 17+ components for [AWC UI](https://www.npmjs.com/package/@awc-ui/core) — accessible Material Design 3 Web Components with directives that bridge Angular templates, `ngModel`, reactive forms, and Angular SSR.
+Angular 20.3.31+ integration for AWC UI.
 
-## Install
+The wrapper is built with the patched Angular 20 compiler. Applications must use
+Angular 20.3.31 or newer; upgrade Angular before updating this package from a
+version that supported Angular 17–19.
+
+`@awc-ui/angular` provides standalone component proxies and Angular form value
+accessors. Imports register their custom elements automatically.
 
 ```bash
 npm install @awc-ui/angular @awc-ui/core
 ```
 
-Requires Angular 17+.
+Load the theme once in your application entry:
+
+```ts
+import '@awc-ui/core/css/tokens.css';
+```
 
-## Usage
+For a standalone component, import the controls and accessors into its template
+scope, alongside Angular's forms module:
 
 ```ts
-// NgModule apps
-import { AwcUiModule } from "@awc-ui/angular";
+import { Component } from '@angular/core';
+import { FormsModule } from '@angular/forms';
+import { MdButton, MdTextField, TextValueAccessor } from '@awc-ui/angular';
 
-@NgModule({
-  imports: [AwcUiModule],
+@Component({
+  selector: 'app-root',
+  standalone: true,
+  imports: [FormsModule, MdButton, MdTextField, TextValueAccessor],
+  template: `
+    <md-text-field label="Email" type="email" [(ngModel)]="email"></md-text-field>
+    <md-button variant="filled">Continue</md-button>
+  `,
 })
-export class AppModule {}
+export class AppComponent {
+  email = '';
+}
 ```
 
-```ts
-// Standalone apps
-import { importProvidersFrom } from "@angular/core";
-import { AwcUiModule, provideAwcUi } from "@awc-ui/angular";
+For convenience, `imports: [FormsModule, AwcUiModule]` supplies every component
+and accessor. Use `ReactiveFormsModule` for `formControl` and `formControlName`.
+NgModule applications also put `AwcUiModule` in `imports`.
 
-bootstrapApplication(AppComponent, {
-  providers: [provideAwcUi(), importProvidersFrom(AwcUiModule)],
-});
-```
+`importProvidersFrom(AwcUiModule)` does not add directives to a standalone
+component's template scope. `provideAwcUi()` is only needed for applications
+using the lazy loader with raw tags; imported proxies already register themselves.
+
+Radio controls bind the selected option's `value`, preserving each radio's
+identity. Import both `MdRadio` and `RadioValueAccessor` for individual imports:
 
 ```html
-<md-button variant="filled">Click me</md-button>
+<md-radio name="plan" value="basic" [(ngModel)]="plan">Basic</md-radio>
+<md-radio name="plan" value="pro" [(ngModel)]="plan">Pro</md-radio>
 ```
 
-## Documentation
+Initialize `plan` to `'basic'` or `'pro'`; resetting the form to `null` clears the
+selection. Multi-select accessors normalize a form reset to an empty array.
 
-[Angular and Angular SSR guide](https://awc-ui.dev/frameworks/angular/) · [All component docs](https://awc-ui.dev/components/)
+## Server rendering
 
-Component manuals and AI-readable documentation also ship with [`@awc-ui/core`](https://www.npmjs.com/package/@awc-ui/core).
+See the [Angular SSR guide](https://awc-ui.dev/frameworks/angular/) for the shared hydration lifecycle and reference application.