Typesense Search PluginLightning-fast search for Payload CMS

Quick Start ​

Get up and running in minutes with our simple setup:

# Install the plugin
pnpm add typesense-search-plugin

# Add to your Payload config
import { typesenseSearch } from 'typesense-search-plugin'

export default buildConfig({
  plugins: [
    typesenseSearch({
      typesense: {
        apiKey: 'xyz',
        nodes: [{ host: 'localhost', port: 8108, protocol: 'http' }],
      },
      collections: {
        posts: {
          enabled: true,
          searchFields: ['title', 'content'],
          facetFields: ['category', 'status'],
          displayName: 'Blog Posts',
          icon: '📝'
        },
        portfolio: {
          enabled: true,
          searchFields: ['title', 'description'],
          facetFields: ['status', 'featured'],
          displayName: 'Portfolio',
          icon: '💼'
        },
        products: {
          enabled: true,
          searchFields: ['name', 'description'],
          facetFields: ['category', 'inStock'],
          displayName: 'Products',
          icon: '🛍️'
        }
      }
    })
  ]
})

Why Choose Typesense Search Plugin? ​

• Zero Configuration: Works out of the box with sensible defaults
• TypeScript Native: Full TypeScript support with comprehensive type definitions
• Headless Components: Single component supporting single, multiple, or universal collection search
• 🎨 Theme System: 5 pre-built themes with unlimited customization options
• Caching: Built-in search result caching for optimal performance
• Flexible: Highly customizable search behavior and result rendering
• Scalable: Handles millions of documents with ease

🎨 Theme System ​

The plugin includes a powerful theme system with 5 pre-built themes and unlimited customization:

• Modern Theme - Clean and professional (default)
• Minimal Theme - Flat design with minimal styling
• Elegant Theme - Sophisticated with gradients
• Dark Theme - Perfect for dark mode
• Colorful Theme - Vibrant and modern

📖 View Complete Theme Documentation - Learn about custom themes, color customization, performance options, and more.

Community ​

Join our growing community of developers building amazing search experiences:

• GitHub Repository
• Report Issues
• NPM Package