@jokkoo/sdk-react 0.1.0

package/LICENSE

@@ -0,0 +1,17 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2026 Jokkoo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,87 @@
+# @jokkoo/sdk-react
+
+Official Jokkoo client embed SDK for React web applications.
+
+Provides a floating support widget with conversation list, realtime chat, file
+attachments, voice messages, satisfaction rating, theming, and i18n (fr/en).
+
+## Install
+
+```bash
+pnpm add @jokkoo/sdk-react @jokkoo/sdk-web @tanstack/react-query
+# peer: react, react-dom >= 18
+```
+
+Import styles once in your app entry (or rely on the bundled CSS side-effect from the package entry):
+
+```ts
+import "@jokkoo/sdk-react/styles.css"
+```
+
+## Quick start
+
+```tsx
+import { JokkooProvider, JokkooWidget } from "@jokkoo/sdk-react"
+import "@jokkoo/sdk-react/styles.css"
+
+function App() {
+  return (
+    <JokkooProvider
+      clientToken="ct_..."
+      userTokenProvider={async () => {
+        const res = await fetch("/api/jokkoo-token")
+        const data = await res.json()
+        return data.token as string
+      }}
+      locale="fr"
+      theme={{ colors: { primary: "#1C1C1C" } }}
+    >
+      <JokkooWidget />
+    </JokkooProvider>
+  )
+}
+```
+
+Your tenant backend should sign short-lived user JWTs with
+[`@jokkoo/nodejs-server`](../nodejs-server) (or the Java server helper).
+
+## Web channel origins
+
+For `channelType === "web"`, the Jokkoo API validates the browser `Origin`
+against the channel's **allowed origins** configured in the Jokkoo dashboard.
+Add your production (and staging) origins before embedding the widget.
+
+## Architecture
+
+- `@jokkoo/sdk-web` — framework-agnostic core (API client, realtime, tokens, i18n, shared utils)
+- `@jokkoo/sdk-react` — React bindings + UI widget (this package)
+
+## Public API
+
+| Export | Description |
+|--------|-------------|
+| `JokkooProvider` | Initializes SDK, QueryClient, navigation, unread state |
+| `JokkooWidget` | Floating launcher + panel (request list + conversation) |
+| `JokkooButton` / `FloatingButton` | Standalone launcher button |
+| `useConversations` / `useMessages` | React Query data hooks |
+| `useRealtimeStatus` / `useSendMessage` / `useUnreadCount` | Supporting hooks |
+| `defaultTheme` / `mergeTheme` | Theming helpers |
+
+## Theming
+
+Pass a partial theme to `JokkooProvider`. Values map to CSS custom properties on
+`.jokkoo-widget` (e.g. `--jk-color-primary`).
+
+## Features
+
+- Realtime messaging (Socket.IO `/sdk`)
+- File attachments (presigned upload)
+- Voice messages (MediaRecorder)
+- Closed-conversation policy + resolved banner
+- Satisfaction rating
+- Fullscreen expand
+- Locales: `fr` (default), `en`
+
+## License
+
+Apache-2.0