Skip to content

The Open Standard for Generative UI

fix: provide theme for assistant-ui renderers (#983)

Visharad Kashyap1ac616630f17
diff --git a/packages/assistant-ui/README.md b/packages/assistant-ui/README.md
index d82d44d87..1cc223922 100644
--- a/packages/assistant-ui/README.md
+++ b/packages/assistant-ui/README.md
@@ -11,9 +11,16 @@ pnpm add @openuidev/assistant-ui @assistant-ui/react @openuidev/react-ui @openui
Import the OpenUI styles once in your app:
```css
+@layer theme, base, openui, components, utilities;
+
@import "@openuidev/react-ui/layered/styles/index.css";
```
+The layer declaration keeps OpenUI above Tailwind's reset and below application
+components and utilities. The tool renderers include OpenUI's light
+`ThemeProvider` by default so their design tokens match a light assistant-ui
+shell.
+
## Register the tools and instructions
```tsx
@@ -88,7 +95,17 @@ const openui = createOpenUIIntegration({
The result exposes `toolkit`, `instructions`, and the resolved `toolNames`.
`createOpenUIIntegration` also accepts custom descriptions, prompt options,
-renderer props, error handling, and an error fallback.
+renderer props, theming, error handling, and an error fallback. Pass theme props
+through the integration factory to customize the rendered tools:
+
+```tsx
+const openui = createOpenUIIntegration({
+ theme: { mode: "dark" },
+});
+```
+
+If the application already wraps assistant-ui in an OpenUI `ThemeProvider`, set
+`disableThemeProvider: true` and let the host provider own the theme.
## Human-tool continuation
diff --git a/packages/assistant-ui/package.json b/packages/assistant-ui/package.json
index c04dc971d..be9c194b5 100644
--- a/packages/assistant-ui/package.json
+++ b/packages/assistant-ui/package.json
@@ -1,6 +1,6 @@
{
"name": "@openuidev/assistant-ui",
- "version": "0.0.1",
+ "version": "0.0.2",
"description": "OpenUI Lang tool renderers and instruction wiring for assistant-ui",
"license": "MIT",
"engines": {
diff --git a/packages/assistant-ui/src/__tests__/renderers.test.tsx b/packages/assistant-ui/src/__tests__/renderers.test.tsx
index 36fffa532..d26994425 100644
--- a/packages/assistant-ui/src/__tests__/renderers.test.tsx
+++ b/packages/assistant-ui/src/__tests__/renderers.test.tsx
@@ -1,6 +1,5 @@
// @vitest-environment jsdom
-import { ThemeProvider } from "@openuidev/react-ui";
import { act, type ComponentProps } from "react";
import { createRoot, type Root } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
@@ -54,14 +53,22 @@ describe("OpenUIPrompt", () => {
const renderPrompt = async (props: PromptProps) => {
await act(async () => {
- root.render(
- <ThemeProvider mode="light">
- <OpenUIPrompt {...props} />
- </ThemeProvider>,
- );
+ root.render(<OpenUIPrompt {...props} />);
});
};
+ it("provides OpenUI theme tokens by default", async () => {
+ await renderPrompt(makeProps());
+
+ expect(document.head.querySelector("style[data-openui-theme]")).not.toBeNull();
+ });
+
+ it("can defer theming to a host provider", async () => {
+ await renderPrompt(makeProps({ disableThemeProvider: true }));
+
+ expect(document.head.querySelector("style[data-openui-theme]")).toBeNull();
+ });
+
it("submits once and restores the completed form state", async () => {
const addResult = vi.fn();
await renderPrompt(makeProps({ addResult }));
diff --git a/packages/assistant-ui/src/renderers.tsx b/packages/assistant-ui/src/renderers.tsx
index 7458b11a4..e06796247 100644
--- a/packages/assistant-ui/src/renderers.tsx
+++ b/packages/assistant-ui/src/renderers.tsx
@@ -9,7 +9,7 @@ import {
type OpenUIError,
type RendererProps,
} from "@openuidev/react-lang";
-import { openuiChatLibrary } from "@openuidev/react-ui";
+import { openuiChatLibrary, ThemeProvider, type ThemeProps } from "@openuidev/react-ui";
import { useCallback, useRef, useState, type ComponentType } from "react";
export interface OpenUIToolArgs extends Record<string, unknown> {
@@ -40,6 +40,10 @@ export type OpenUIRendererProps = Omit<
export interface OpenUIToolUIOptions {
library?: Library;
rendererProps?: OpenUIRendererProps;
+ /** Theme props passed to <ThemeProvider>. */
+ theme?: ThemeProps;
+ /** When true, skips wrapping in <ThemeProvider>. */
+ disableThemeProvider?: boolean;
ErrorFallback?: OpenUIErrorFallback | null;
onError?: (errors: OpenUIError[]) => void;
}
@@ -62,6 +66,8 @@ export function OpenUIContent({
onAction,
library = openuiChatLibrary,
rendererProps,
+ theme,
+ disableThemeProvider,
ErrorFallback = DefaultOpenUIErrorFallback,
onError,
}: OpenUIContentProps) {
@@ -74,7 +80,7 @@ export function OpenUIContent({
[onError],
);
- return (
+ const content = (
<>
<Renderer
{...rendererProps}
@@ -90,6 +96,8 @@ export function OpenUIContent({
)}
</>
);
+
+ return disableThemeProvider ? content : <ThemeProvider {...theme}>{content}</ThemeProvider>;
}
export type OpenUIPresentProps = ToolCallMessagePartProps<OpenUIToolArgs, OpenUIPresentResult> &