@webority/chat-react 0.30.0 → 0.32.0

package/README.md

@@ -119,10 +119,11 @@ Otherwise the response is `text/event-stream`:
 
 Exactly one `done` or `error` ends each stream.
 
-### Read endpoints the product implements
+### Read endpoints
 
-The chat endpoint writes one turn. The product hosts these beside it, in this shape, for the
-allowance, past chats and ratings:
+The chat endpoint writes one turn. `MapAiChat` from `Webority.Ai.Chat.AspNetCore` 0.11.0 maps
+these beside it, under the same prefix, for the allowance, past chats and ratings. They are the
+shape the client reads:
 
 | Request | Response |
 |---|---|
@@ -142,6 +143,17 @@ A support card's Confirm calls the `confirmAction(token)` it is given. With
 `POST {supportBase}/actions/confirm` with `{ token }` and resolves to the ticket it acted on. Nothing
 reaches support until the person confirms.
 
+## On a Razor site
+
+A server-rendered Razor site uses `<app-chat base="/api/assistant" />` from `Webority.Ui.Razor`
+instead. It wraps the `<wui-chat>` element from `@webority/ui-elements/chat`, which reads the same
+routes with this package's client, labels and reply parser, and shows the launcher, the panel and
+the conversation. Its attributes are this package's props in kebab case: `base`, `position`,
+`icon`, `compact`, `panel-title`, `disclaimer`, `max-length`, `allowance-threshold`, `rating`,
+`labels` (JSON) and `page-context` (JSON). `title` is `panel-title` there, because `title` is a
+global HTML attribute. The past-chats list, support action cards, the rating note, `linkComponent`
+and `renderReply` are not in the element.
+
 ## The hook
 
 `useChat({ client, pageContext })` returns:
@@ -172,9 +184,20 @@ Every component takes `labels`, any subset of `DEFAULT_CHAT_LABELS`, to change i
 ### `<ChatLauncher />`
 
 The floating pill that opens the panel. `onClick`, `open` (announced on the button), `position`
-(`end` or `start`, the bottom corner), `icon`, and `className` and `style` on the floating
-wrapper to move it clear of other fixed controls, such as `ReportIssue`. The launcher is left out
-of `ReportIssue`'s page capture.
+(`end` or `start`, the bottom corner), `icon`, `compact`, and `className` and `style` on the
+floating wrapper to move it clear of other fixed controls, such as `ReportIssue`. The launcher is
+left out of `ReportIssue`'s page capture.
+
+`compact` makes it a 48px icon-only circle with the label as its tooltip and accessible name. It
+joins the shared floating stack (`useFloatingStack` from `@webority/ui-react`), one fixed container
+per corner that the compact `ReportIssue` from `@webority/support-react` also uses: the launcher
+sits in the corner and the report button stacks above it with a gap, so neither needs an offset.
+`className` and `style` then land on the item inside the stack, which is not itself fixed.
+
+```jsx
+<ChatLauncher compact open={open} onClick={() => setOpen(true)} />
+<ReportIssue floating compact />
+```
 
 ### `<ChatPanel />`