@tanstack/create 0.61.4 → 0.61.6

package/src/frameworks/react/add-ons/strapi/README.md

@@ -1,14 +1,164 @@
-## Setting up Strapi
+## Strapi CMS Integration
 
-The current setup shows an example of how to use Strapi with an articles collection which is part of the example structure & data.
+This add-on integrates Strapi CMS with your TanStack Start application using the official Strapi Client SDK.
 
-- Create a local running copy of the strapi admin
+### Features
 
+- Article listing with search and pagination
+- Article detail pages with dynamic block rendering
+- Rich text, quotes, media, and image slider blocks
+- Markdown content rendering with GitHub Flavored Markdown
+- Responsive image handling with error fallbacks
+- URL-based search and pagination (shareable/bookmarkable)
+- Graceful error handling with helpful setup instructions
+
+### Project Structure
+
+```
+parent/
+├── client/                 # TanStack Start frontend (your project name)
+│   ├── src/
+│   │   ├── components/
+│   │   │   ├── blocks/     # Block rendering components
+│   │   │   ├── markdown-content.tsx
+│   │   │   ├── pagination.tsx
+│   │   │   ├── search.tsx
+│   │   │   └── strapi-image.tsx
+│   │   ├── data/
+│   │   │   ├── loaders/    # Server functions
+│   │   │   └── strapi-sdk.ts
+│   │   ├── lib/
+│   │   │   └── strapi-utils.ts
+│   │   ├── routes/demo/
+│   │   │   ├── strapi.tsx              # Articles list
+│   │   │   └── strapi.$articleId.tsx   # Article detail
+│   │   └── types/
+│   │       └── strapi.ts
+│   ├── .env.local
+│   └── package.json
+└── server/                 # Strapi CMS backend (create manually or use hosted Strapi)
+    ├── src/api/            # Content types
+    ├── config/             # Strapi configuration
+    └── package.json
+```
+
+### Quick Start
+
+Create your Strapi project separately (or use an existing hosted Strapi instance), then point this app to it with `VITE_STRAPI_URL`.
+
+**1. Set up Strapi:**
+
+Follow the Strapi quick-start guide to create a local project, or use your existing Strapi deployment:
+
+- https://docs.strapi.io/dev-docs/quick-start
+
+If you created a local Strapi project in a sibling `server` directory, continue with:
+
+```bash
+cd ../server
+npm install    # or pnpm install / yarn install
+```
+
+**2. Start the Strapi server:**
+
+```bash
+npm run develop    # Starts at http://localhost:1337
+```
+
+**3. Create an admin account:**
+
+Open http://localhost:1337/admin and create your first admin user.
+
+**4. Create content:**
+
+In the Strapi admin panel, go to Content Manager > Article and create some articles.
+
+**5. Start your TanStack app (in another terminal):**
+
+```bash
+cd ../client   # or your project name
+npm run dev    # Starts at http://localhost:3000
+```
+
+**6. View the demo:**
+
+Navigate to http://localhost:3000/demo/strapi to see your articles.
+
+### Environment Variables
+
+The following environment variable is pre-configured in `.env.local`:
+
+```bash
+VITE_STRAPI_URL="http://localhost:1337"
+```
+
+For production, update this to your deployed Strapi URL.
+
+### Demo Pages
+
+| URL | Description |
+|-----|-------------|
+| `/demo/strapi` | Articles list with search and pagination |
+| `/demo/strapi/:articleId` | Article detail with block rendering |
+
+### Search and Pagination
+
+- **Search**: Type in the search box to filter articles by title or description
+- **Pagination**: Navigate between pages using the pagination controls
+- **URL State**: Search and page are stored in the URL (`?query=term&page=2`)
+
+### Block Types Supported
+
+| Block | Component | Description |
+|-------|-----------|-------------|
+| `shared.rich-text` | RichText | Markdown content |
+| `shared.quote` | Quote | Blockquote with author |
+| `shared.media` | Media | Single image/video |
+| `shared.slider` | Slider | Image gallery grid |
+
+### Dependencies
+
+| Package | Purpose |
+|---------|---------|
+| `@strapi/client` | Official Strapi SDK |
+| `react-markdown` | Markdown rendering |
+| `remark-gfm` | GitHub Flavored Markdown |
+| `use-debounce` | Debounced search input |
+
+### Running Both Servers
+
+Open two terminal windows from the parent directory:
+
+**Terminal 1 - Strapi:**
 ```bash
-pnpm dlx create-strapi@latest my-strapi-project
-cd my-strapi-project
-pnpm dev
+cd server && npm run develop
 ```
 
-- Login and publish the example articles to see them on the strapi demo page.
-- Set the `VITE_STRAPI_URL` environment variable in your `.env.local`. (For local it should be http://localhost:1337/api)
+**Terminal 2 - TanStack Start:**
+```bash
+cd client && npm run dev   # or your project name
+```
+
+### Customization
+
+**Change page size:**
+Edit `src/data/loaders/articles.ts` and modify `PAGE_SIZE`.
+
+**Add new block types:**
+1. Create component in `src/components/blocks/`
+2. Export from `src/components/blocks/index.ts`
+3. Add case to `block-renderer.tsx` switch statement
+4. Update populate in articles loader
+
+**Add new content types:**
+1. Add types to `src/types/strapi.ts`
+2. Create loader in `src/data/loaders/`
+3. Create route in `src/routes/demo/`
+
+### Learn More
+
+- [Strapi Documentation](https://docs.strapi.io/)
+- [Strapi Client SDK](https://www.npmjs.com/package/@strapi/client)
+- [Strapi Cloud Template Blog](https://github.com/strapi/strapi-cloud-template-blog)
+- [TanStack Start Documentation](https://tanstack.com/start/latest)
+- [TanStack Router Search Params](https://tanstack.com/router/latest/docs/framework/react/guide/search-params)

package/src/frameworks/react/add-ons/strapi/assets/_dot_env.local.append

@@ -1,2 +1,2 @@
 # Strapi configuration
-VITE_STRAPI_URL="http://localhost:1337/api"
+VITE_STRAPI_URL="http://localhost:1337"

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/block-renderer.tsx

@@ -0,0 +1,55 @@
+import { RichText } from "./rich-text";
+import { Quote } from "./quote";
+import { Media } from "./media";
+import { Slider } from "./slider";
+
+import type { IRichText } from "./rich-text";
+import type { IQuote } from "./quote";
+import type { IMedia } from "./media";
+import type { ISlider } from "./slider";
+
+// Union type of all block types
+export type Block = IRichText | IQuote | IMedia | ISlider;
+
+interface BlockRendererProps {
+  blocks: Array<Block>;
+}
+
+/**
+ * BlockRenderer - Renders dynamic content blocks from Strapi
+ *
+ * Usage:
+ * ```tsx
+ * <BlockRenderer blocks={article.blocks} />
+ * ```
+ */
+export function BlockRenderer({ blocks }: Readonly<BlockRendererProps>) {
+  if (!blocks || blocks.length === 0) return null;
+
+  const renderBlock = (block: Block) => {
+    switch (block.__component) {
+      case "shared.rich-text":
+        return <RichText {...block} />;
+      case "shared.quote":
+        return <Quote {...block} />;
+      case "shared.media":
+        return <Media {...block} />;
+      case "shared.slider":
+        return <Slider {...block} />;
+      default:
+        // Log unknown block types in development
+        console.warn("Unknown block type:", (block as any).__component);
+        return null;
+    }
+  };
+
+  return (
+    <div className="space-y-6">
+      {blocks.map((block, index) => (
+        <div key={`${block.__component}-${block.id}-${index}`}>
+          {renderBlock(block)}
+        </div>
+      ))}
+    </div>
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/index.ts

@@ -0,0 +1,14 @@
+export { BlockRenderer } from "./block-renderer";
+export type { Block } from "./block-renderer";
+
+export { RichText } from "./rich-text";
+export type { IRichText } from "./rich-text";
+
+export { Quote } from "./quote";
+export type { IQuote } from "./quote";
+
+export { Media } from "./media";
+export type { IMedia } from "./media";
+
+export { Slider } from "./slider";
+export type { ISlider } from "./slider";

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/media.tsx

@@ -0,0 +1,27 @@
+import { StrapiImage } from "@/components/strapi-image";
+import type { TImage } from "@/types/strapi";
+
+export interface IMedia {
+  __component: "shared.media";
+  id: number;
+  file?: TImage;
+}
+
+export function Media({ file }: Readonly<IMedia>) {
+  if (!file) return null;
+
+  return (
+    <figure className="my-8">
+      <StrapiImage
+        src={file.url}
+        alt={file.alternativeText || ""}
+        className="rounded-lg w-full"
+      />
+      {file.alternativeText && (
+        <figcaption className="mt-2 text-center text-sm text-gray-500">
+          {file.alternativeText}
+        </figcaption>
+      )}
+    </figure>
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/quote.tsx

@@ -0,0 +1,19 @@
+export interface IQuote {
+  __component: "shared.quote";
+  id: number;
+  body: string;
+  title?: string;
+}
+
+export function Quote({ body, title }: Readonly<IQuote>) {
+  return (
+    <blockquote className="border-l-4 border-cyan-400 pl-6 py-4 my-6 bg-slate-800/30 rounded-r-lg">
+      <p className="text-xl italic text-gray-300 leading-relaxed">{body}</p>
+      {title && (
+        <cite className="block mt-4 text-cyan-400 not-italic font-medium">
+          — {title}
+        </cite>
+      )}
+    </blockquote>
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/rich-text.tsx

@@ -0,0 +1,11 @@
+import { MarkdownContent } from "@/components/markdown-content";
+
+export interface IRichText {
+  __component: "shared.rich-text";
+  id: number;
+  body: string;
+}
+
+export function RichText({ body }: Readonly<IRichText>) {
+  return <MarkdownContent content={body} />;
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/blocks/slider.tsx

@@ -0,0 +1,28 @@
+import { StrapiImage } from "@/components/strapi-image";
+import type { TImage } from "@/types/strapi";
+
+export interface ISlider {
+  __component: "shared.slider";
+  id: number;
+  files?: Array<TImage>;
+}
+
+export function Slider({ files }: Readonly<ISlider>) {
+  if (!files || files.length === 0) return null;
+
+  return (
+    <div className="my-8">
+      <div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
+        {files.map((file, index) => (
+          <figure key={file.id || index}>
+            <StrapiImage
+              src={file.url}
+              alt={file.alternativeText || ""}
+              className="rounded-lg w-full h-48 object-cover"
+            />
+          </figure>
+        ))}
+      </div>
+    </div>
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/markdown-content.tsx

@@ -0,0 +1,74 @@
+import Markdown from "react-markdown";
+import remarkGfm from "remark-gfm";
+
+interface MarkdownContentProps {
+  content: string | undefined | null;
+  className?: string;
+}
+
+const styles = {
+  h1: "text-3xl font-bold mb-6 text-white",
+  h2: "text-2xl font-bold mb-4 text-white",
+  h3: "text-xl font-bold mb-3 text-white",
+  p: "mb-4 leading-relaxed text-gray-300",
+  a: "text-cyan-400 hover:underline",
+  ul: "list-disc pl-6 mb-4 space-y-2 text-gray-300",
+  ol: "list-decimal pl-6 mb-4 space-y-2 text-gray-300",
+  li: "leading-relaxed",
+  blockquote: "border-l-4 border-cyan-400 pl-4 italic text-gray-400 my-4",
+  code: "bg-slate-800 px-2 py-1 rounded text-cyan-400 text-sm font-mono",
+  pre: "bg-slate-800 p-4 rounded-lg overflow-x-auto mb-4",
+  table: "w-full border-collapse mb-4",
+  th: "border border-slate-700 p-2 bg-slate-800 text-left text-white",
+  td: "border border-slate-700 p-2 text-gray-300",
+  img: "max-w-full h-auto rounded-lg my-4",
+  hr: "border-slate-700 my-8",
+  strong: "text-white font-semibold",
+};
+
+export function MarkdownContent({ content, className = "" }: MarkdownContentProps) {
+  if (!content) return null;
+
+  return (
+    <div className={`prose prose-invert max-w-none ${className}`}>
+      <Markdown
+        remarkPlugins={[remarkGfm]}
+        components={{
+          h1: ({ children }) => <h1 className={styles.h1}>{children}</h1>,
+          h2: ({ children }) => <h2 className={styles.h2}>{children}</h2>,
+          h3: ({ children }) => <h3 className={styles.h3}>{children}</h3>,
+          p: ({ children }) => <p className={styles.p}>{children}</p>,
+          a: ({ href, children }) => (
+            <a href={href} className={styles.a} target="_blank" rel="noopener noreferrer">
+              {children}
+            </a>
+          ),
+          ul: ({ children }) => <ul className={styles.ul}>{children}</ul>,
+          ol: ({ children }) => <ol className={styles.ol}>{children}</ol>,
+          li: ({ children }) => <li className={styles.li}>{children}</li>,
+          blockquote: ({ children }) => <blockquote className={styles.blockquote}>{children}</blockquote>,
+          code: ({ className, children }) => {
+            const isCodeBlock = className?.includes("language-");
+            if (isCodeBlock) {
+              return (
+                <pre className={styles.pre}>
+                  <code className="text-sm font-mono text-gray-300">{children}</code>
+                </pre>
+              );
+            }
+            return <code className={styles.code}>{children}</code>;
+          },
+          pre: ({ children }) => <>{children}</>,
+          table: ({ children }) => <table className={styles.table}>{children}</table>,
+          th: ({ children }) => <th className={styles.th}>{children}</th>,
+          td: ({ children }) => <td className={styles.td}>{children}</td>,
+          img: ({ src, alt }) => <img src={src} alt={alt || ""} className={styles.img} />,
+          hr: () => <hr className={styles.hr} />,
+          strong: ({ children }) => <strong className={styles.strong}>{children}</strong>,
+        }}
+      >
+        {content}
+      </Markdown>
+    </div>
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/pagination.tsx

@@ -0,0 +1,120 @@
+import { useRouter, useSearch } from '@tanstack/react-router'
+import { ChevronLeft, ChevronRight } from 'lucide-react'
+
+interface PaginationProps {
+  pageCount: number
+  className?: string
+}
+
+export function Pagination({ pageCount, className = '' }: PaginationProps) {
+  const router = useRouter()
+  const search = useSearch({ strict: false })
+  const currentPage = Number((search as any)?.page) || 1
+
+  const handlePageChange = (page: number) => {
+    router.navigate({
+      to: '.',
+      search: (prev) => ({ ...prev, page }),
+      replace: true,
+    })
+  }
+
+  // Generate page numbers to display
+  const getPageNumbers = () => {
+    const pages: Array<number | 'ellipsis'> = []
+    const showEllipsis = pageCount > 7
+
+    if (showEllipsis) {
+      pages.push(1)
+
+      if (currentPage > 3) {
+        pages.push('ellipsis')
+      }
+
+      const start = Math.max(2, currentPage - 1)
+      const end = Math.min(pageCount - 1, currentPage + 1)
+
+      for (let i = start; i <= end; i++) {
+        pages.push(i)
+      }
+
+      if (currentPage < pageCount - 2) {
+        pages.push('ellipsis')
+      }
+
+      if (pageCount > 1) {
+        pages.push(pageCount)
+      }
+    } else {
+      for (let i = 1; i <= pageCount; i++) {
+        pages.push(i)
+      }
+    }
+
+    return pages
+  }
+
+  const pageNumbers = getPageNumbers()
+
+  if (pageCount <= 1) return null
+
+  return (
+    <nav className={`flex items-center justify-center gap-1 ${className}`}>
+      {/* Previous Button */}
+      <button
+        onClick={() => currentPage > 1 && handlePageChange(currentPage - 1)}
+        disabled={currentPage <= 1}
+        className={`flex items-center gap-1 px-3 py-2 rounded-lg text-sm font-medium transition-colors ${
+          currentPage <= 1
+            ? 'text-gray-600 cursor-not-allowed'
+            : 'text-gray-300 hover:bg-slate-700 hover:text-white'
+        }`}
+      >
+        <ChevronLeft className="w-4 h-4" />
+        <span className="hidden sm:inline">Previous</span>
+      </button>
+
+      {/* Page Numbers */}
+      <div className="flex items-center gap-1">
+        {pageNumbers.map((page, index) =>
+          page === 'ellipsis' ? (
+            <span
+              key={`ellipsis-${index}`}
+              className="px-2 py-2 text-gray-500 hidden md:block"
+            >
+              ...
+            </span>
+          ) : (
+            <button
+              key={page}
+              onClick={() => handlePageChange(page)}
+              className={`min-w-[40px] px-3 py-2 rounded-lg text-sm font-medium transition-colors ${
+                currentPage === page
+                  ? 'bg-cyan-500 text-white'
+                  : 'text-gray-300 hover:bg-slate-700 hover:text-white'
+              }`}
+            >
+              {page}
+            </button>
+          )
+        )}
+      </div>
+
+      {/* Next Button */}
+      <button
+        onClick={() =>
+          currentPage < pageCount && handlePageChange(currentPage + 1)
+        }
+        disabled={currentPage >= pageCount}
+        className={`flex items-center gap-1 px-3 py-2 rounded-lg text-sm font-medium transition-colors ${
+          currentPage >= pageCount
+            ? 'text-gray-600 cursor-not-allowed'
+            : 'text-gray-300 hover:bg-slate-700 hover:text-white'
+        }`}
+      >
+        <span className="hidden sm:inline">Next</span>
+        <ChevronRight className="w-4 h-4" />
+      </button>
+    </nav>
+  )
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/search.tsx

@@ -0,0 +1,35 @@
+import { useRouter, useSearch } from "@tanstack/react-router";
+import { useDebouncedCallback } from "use-debounce";
+
+interface SearchProps {
+  readonly className?: string;
+}
+
+export function Search({ className = "" }: SearchProps) {
+  const search = useSearch({ strict: false });
+  const router = useRouter();
+
+  const handleSearch = useDebouncedCallback((term: string) => {
+    router.navigate({
+      to: ".",
+      search: (prev) => ({
+        ...prev,
+        page: 1,
+        query: term || undefined,
+      }),
+      replace: true,
+    });
+  }, 300);
+
+  return (
+    <input
+      type="text"
+      placeholder="Search articles..."
+      onChange={(e: React.ChangeEvent<HTMLInputElement>) =>
+        handleSearch(e.target.value)
+      }
+      defaultValue={(search as any)?.query || ""}
+      className={`w-full px-4 py-3 bg-slate-800 border border-slate-700 rounded-lg text-white placeholder-gray-500 focus:outline-none focus:border-cyan-500 focus:ring-1 focus:ring-cyan-500 transition-colors ${className}`}
+    />
+  );
+}

package/src/frameworks/react/add-ons/strapi/assets/src/components/strapi-image.tsx

@@ -0,0 +1,47 @@
+import { useState } from "react";
+import { getStrapiMedia } from "@/lib/strapi-utils";
+
+interface StrapiImageProps {
+  src: string | undefined | null;
+  alt?: string | null;
+  className?: string;
+  width?: number | string;
+  height?: number | string;
+}
+
+export function StrapiImage({
+  src,
+  alt,
+  className = "",
+  width,
+  height,
+}: StrapiImageProps) {
+  const [hasError, setHasError] = useState(false);
+
+  if (!src) return null;
+
+  const imageUrl = getStrapiMedia(src);
+
+  if (hasError) {
+    return (
+      <div
+        className={`bg-slate-700 flex items-center justify-center text-slate-400 text-sm ${className}`}
+        style={{ width, height }}
+      >
+        <span>Image not available</span>
+      </div>
+    );
+  }
+
+  return (
+    <img
+      src={imageUrl}
+      alt={alt || ""}
+      width={width}
+      height={height}
+      loading="lazy"
+      className={`object-cover ${className}`}
+      onError={() => setHasError(true)}
+    />
+  );
+}