@shineuix/angular 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ShineUI contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# @shineuix/angular
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Angular standalone directives for ShineUI, one per element.
+
+```bash
+npm i @shineuix/core @shineuix/angular
+```
+
+```ts
+import { Component } from '@angular/core';
+import { FormsModule } from '@angular/forms';
+import { SuiButton, SuiInputText, TextValueAccessor } from '@shineuix/angular';
+
+@Component({
+  standalone: true,
+  imports: [FormsModule, SuiButton, SuiInputText, TextValueAccessor],
+  template: `
+    <sui-button variant="accent" label="Record payment" (click)="recordPayment()"></sui-button>
+    <sui-input-text label="Customer email" required [(ngModel)]="email"></sui-input-text>
+  `,
+})
+export class PaymentBar {
+  email = '';
+  recordPayment() {}
+}
+```
+
+Import `@shineuix/core/shineui.css` once in `styles.css` or `angular.json`. Each directive is
+exported by name, so an app that imports two of them ships two. No `CUSTOM_ELEMENTS_SCHEMA` is
+needed.
+
+`[(ngModel)]` and reactive forms bind through a `ControlValueAccessor` directive, and a standalone
+component applies only the directives in its own `imports`, so import the accessor beside the
+element. There are seven: `TextValueAccessor` for the text fields (input text, textarea, mask,
+password, icon field, float label, IFTA label, autocomplete, inplace), `NumericValueAccessor` for
+input number, slider, rating and knob, `BooleanValueAccessor` for checkbox, toggle switch, toggle
+button and radio button, `SelectValueAccessor` for the select family, the choice groups, the
+pickers, OTP, tags and the filter builder, `SuiHtmlValueAccessor` for the rich text editor and the
+edit box, `SuiFilterPanelValueAccessor` for the filter panel's `values` and
+`SuiSchedulerBuilderValueAccessor` for the scheduler builder's `config`. `VALUE_ACCESSORS` is the
+seven in one array for an `imports` list that binds many kinds of control. Leave the accessor out
+and every binding throws `NG01203`. A cleared number field gives the model `null`, so
+`Validators.required` fails it; a null model gives a list-valued field an empty list.
+
+Inputs and outputs are typed end to end under `strictTemplates`: `[variant]="'bogus'"`,
+`[size]="'xl'"`, `[columns]="42"` and `[disabled]="'yes'"` are compile errors, and so is a static
+`disabled="false"`, because that lands on the host as an attribute and a form-associated element is
+disabled while it carries the attribute, whatever its value, as a native input is. Write the
+boolean attribute bare (`<sui-button disabled>`) or bind it (`[disabled]="flag"`).
+
+Every element that changes its own state has an output named for the prop, so `[(open)]`,
+`[(expanded)]`, `[(selection)]` and the rest bind both ways. `<prop>Change` emits the new value; on
+an element that opens and closes, `openChange` (or `collapsedChange` on a panel) emits once
+`suiOpen` or an unrefused `suiClose` has run, so a close a `(suiClose)` handler vetoes leaves the
+model alone. The `sui<Prop>Change` outputs stay.
+
+The peer range is Angular 20, 21 and 22, each tested with zone.js, zoneless and server-rendered
+then hydrated. Install `@shineuix/core` and this package at the same version: the bindings pin the
+core exactly. Works with the default esbuild builder and with Vite through AnalogJS.
+
+Angular hydration stays on. The elements draw into their own light DOM as soon as they are
+defined, before Angular hydrates them, so a template that holds them fails to hydrate (NG0500 or
+NG0502 on Angular 22). Give each of your components that holds ShineUI elements
+`host: { ngSkipHydration: 'true' }`: Angular renders those afresh on the client and hydrates the
+rest of the page, incremental hydration included. Not on a `sui-` element itself: Angular keeps that
+node and empties it under an element that has already drawn.
+
+Documentation, live demos and the API of every element: [shineui.dev](https://shineui.dev).
+
+MIT. Copyright 2026 ShineUI contributors.