@shineuix/react 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,40 @@
-# Temporary Holding Version
+# @shineuix/react
 
-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.
+React bindings for ShineUI, one component per element.
+
+```bash
+npm i @shineuix/core @shineuix/react
+```
+
+```jsx
+import { SuiButton, SuiInputText } from '@shineuix/react';
+import '@shineuix/core/shineui.css';
+
+<SuiButton variant="accent" label="Record payment" onClick={recordPayment} />
+<SuiInputText label="Customer email" required onSuiChange={(e) => save(e.detail)} />
+```
+
+Events: every core `suiX` custom event surfaces as an `onSuiX` prop; the payload is `event.detail`.
+Native events (click, focus) are ordinary React props. Complex data (`columns`, `rows`, `options`,
+render functions) pass as normal props; the binding assigns them as element properties, so a
+boolean prop is a property too and `disabled={false}` means enabled.
+
+Peer dependencies: React 18 or 19. Install `@shineuix/core` and this package at the same version;
+the bindings pin the core exactly. Vite needs no extra configuration; the package is pure ESM and
+tree-shakes per component, because each wrapper imports only its own element. The one runtime
+dependency is `@lit/react`. `require('@shineuix/react')` resolves through the `default` condition
+and loads on Node 20.19 and later; a Jest project in CommonJS mode also needs
+`transformIgnorePatterns` to let its transform reach `@shineuix`, as the Testing section of the
+[frameworks guide](https://shineui.dev/frameworks) shows.
+
+Server rendering: in a server-rendered app (Next.js, Remix) a component renders nothing on the
+server and while the page hydrates, and its element draws in the next render, so hydration reports
+no mismatch; an app that renders only in the browser sees the element in its first render. The
+elements draw into their own light DOM, which React counts among its own children, so markup the
+browser upgraded before React hydrated it would end in hydration error 418 and a rebuild of the
+whole tree. The components carry `'use client'`, so a Next.js App Router Server Component renders
+them directly. `@shineuix/ssr` renders the elements' own markup for pages without React.
+
+Documentation, live demos and the API of every element: [shineui.dev](https://shineui.dev).
+
+MIT. Copyright 2026 ShineUI contributors.