Deprecate <Tokens /> (#1308)

vercel · Apr 9, 2024 · 149fe26 · 149fe26
1 parent a6b2500
commit 149fe26
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/.changeset/popular-cherries-invite.md b/.changeset/popular-cherries-invite.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+Deprecate <Tokens/>
diff --git a/docs/pages/docs/api-reference/tokens.mdx b/docs/pages/docs/api-reference/tokens.mdx
@@ -9,6 +9,14 @@ layout:
 The Tokens component is a React Server Component for streaming in tokens in a React Component.
 You can view a live demo with Next.js [here](https://rsc-llm-on-the-edge.vercel.app)
 
+<Callout>
+  <strong>
+    This API has been deprecated and will be removed in a future release. See
+    [Generative UI](/docs/concepts/ai-rsc) for the recommended approach to
+    streaming React UI.
+  </strong>
+</Callout>
+
 ## Props
 
 ```typescript

diff --git a/packages/core/react/tokens.tsx b/packages/core/react/tokens.tsx
@@ -8,8 +8,10 @@ type Props = {
 };
 
 /**
- * A React Server Component that recursively renders a stream of tokens.
- * Can only be used inside of server components.
+A React Server Component that recursively renders a stream of tokens.
+Can only be used inside of server components.
+
+@deprecated Use RSCs / Generative AI instead.
  */
 export async function Tokens(props: Props) {
   const { stream } = props;