home / skills / ancoleman / ai-design-components / implementing-search-filter

implementing-search-filter skill

/skills/implementing-search-filter

This skill helps you implement end-to-end search and filtering across frontend and backend, including debouncing, faceted UI, and optimized queries.

npx playbooks add skill ancoleman/ai-design-components --skill implementing-search-filter

Review the files below or copy the command above to add this skill to your agents.

Files (21)
SKILL.md
6.2 KB
---
name: implementing-search-filter
description: Implements search and filter interfaces for both frontend (React/TypeScript) and backend (Python) with debouncing, query management, and database integration. Use when adding search functionality, building filter UIs, implementing faceted search, or optimizing search performance.
---

# Search & Filter Implementation

Implement search and filter interfaces with comprehensive frontend components and backend query optimization.

## Purpose

This skill provides production-ready patterns for implementing search and filtering functionality across the full stack. It covers React/TypeScript components for the frontend (search inputs, filter UIs, autocomplete) and Python patterns for the backend (SQLAlchemy queries, Elasticsearch integration, API design). The skill emphasizes performance optimization, accessibility, and user experience.

## When to Use

- Building product search with category and price filters
- Implementing autocomplete/typeahead search
- Creating faceted search interfaces with dynamic counts
- Adding search to data tables or lists
- Building advanced boolean search for power users
- Implementing backend search with SQLAlchemy or Django ORM
- Integrating Elasticsearch for full-text search
- Optimizing search performance with debouncing and caching
- Creating accessible search experiences

## Core Components

### Frontend Search Patterns

**Search Input with Debouncing**
- Implement 300ms debounce for performance
- Show loading states during search
- Clear button (X) for resetting
- Keyboard shortcuts (Cmd/Ctrl+K)
- See `references/search-input-patterns.md`

**Autocomplete/Typeahead**
- Suggestion dropdown with keyboard navigation
- Highlight matched text in suggestions
- Recent searches and popular items
- Prevent request flooding with debouncing
- See `references/autocomplete-patterns.md`

**Filter UI Components**
- Checkbox filters for multi-select
- Range sliders for numerical values
- Dropdown filters for single selection
- Filter chips showing active selections
- See `references/filter-ui-patterns.md`

### Backend Query Patterns

**Database Query Building**
- Dynamic query construction with SQLAlchemy
- Django ORM filter chaining
- Index optimization for search columns
- Full-text search in PostgreSQL
- See `references/database-querying.md`

**Elasticsearch Integration**
- Document indexing strategies
- Query DSL for complex searches
- Faceted aggregations
- Relevance scoring and boosting
- See `references/elasticsearch-integration.md`

**API Design**
- RESTful search endpoints
- Query parameter validation
- Pagination with cursor/offset
- Response caching strategies
- See `references/api-design.md`

## Implementation Workflows

### Client-Side Search (<1000 items)

1. Load data into memory
2. Implement filter functions in JavaScript
3. Apply debounced search on text input
4. Update results instantly
5. Maintain filter state in React

### Server-Side Search (>1000 items)

1. Design search API endpoint
2. Validate and sanitize query parameters
3. Build database query dynamically
4. Apply pagination
5. Return results with metadata
6. Cache frequent queries

### Hybrid Approach

1. Use client-side filtering for immediate feedback
2. Fetch server results in background
3. Merge and deduplicate results
4. Update UI progressively
5. Cache recent searches locally

## Performance Optimization

### Frontend Optimization

**Debouncing Implementation**
- Use `debounce` from lodash or custom implementation
- Cancel pending requests on new input
- Show skeleton loaders during fetch
- Script: `scripts/debounce_calculator.js`

**Query Parameter Management**
- Sync filters with URL for shareable searches
- Use React Router or Next.js for URL state
- Compress complex queries
- See `references/query-parameter-management.md`

### Backend Optimization

**Query Optimization**
- Create appropriate database indexes
- Use query analyzers to identify bottlenecks
- Implement query result caching
- Script: `scripts/generate_filter_query.py`

**Validation & Security**
- Sanitize all search inputs
- Prevent SQL injection
- Rate limit search endpoints
- Script: `scripts/validate_search_params.py`

## Accessibility Requirements

### ARIA Patterns

- Use `role="search"` for search regions
- Implement `aria-live` for result updates
- Provide clear labels for filters
- Support keyboard-only navigation

### Keyboard Support

- Tab through all interactive elements
- Arrow keys for autocomplete navigation
- Escape to close dropdowns
- Enter to select/submit

## Technology Stack

### Frontend Libraries

**Primary: Downshift (Autocomplete)**
- Accessible autocomplete primitives
- Headless/unstyled for flexibility
- WAI-ARIA compliant
- Install: `npm install downshift`

**Alternative: React Select**
- Full-featured select/filter component
- Built-in async search
- Multi-select support

### Backend Technologies

**Python/SQLAlchemy**
- Dynamic query building
- Relationship loading optimization
- Query result pagination

**Python/Django**
- Django Filter backend
- Django REST Framework filters
- Full-text search with PostgreSQL

**Elasticsearch (Python)**
- elasticsearch-py client
- elasticsearch-dsl for query building

## Bundled Resources

### References
- `references/search-input-patterns.md` - Input implementations
- `references/autocomplete-patterns.md` - Typeahead patterns
- `references/filter-ui-patterns.md` - Filter components
- `references/database-querying.md` - SQL query patterns
- `references/elasticsearch-integration.md` - Elasticsearch setup
- `references/api-design.md` - API endpoint patterns
- `references/performance-optimization.md` - Performance tips
- `references/library-comparison.md` - Library evaluation

### Scripts
- `scripts/generate_filter_query.py` - Build SQL/ES queries
- `scripts/validate_search_params.py` - Validate inputs
- `scripts/debounce_calculator.js` - Calculate debounce timing

### Examples
- `examples/product-search.tsx` - E-commerce search
- `examples/autocomplete-search.tsx` - Autocomplete implementation
- `examples/sqlalchemy_search.py` - SQLAlchemy patterns
- `examples/fastapi_search.py` - FastAPI search endpoint
- `examples/django_filter_backend.py` - Django filters

### Assets
- `assets/filter-config-schema.json` - Filter configuration
- `assets/search-api-spec.json` - OpenAPI specification

Overview

This skill implements production-ready search and filter interfaces across frontend (React/TypeScript) and backend (Python). It delivers debounced inputs, autocomplete, faceted filters, and scalable query patterns with performance, accessibility, and UX in mind. Use it to add search to lists, tables, or product catalogs with integrated backend query building and caching.

How this skill works

On the frontend, the skill provides reusable React components: debounced search inputs, accessible autocomplete/typeahead, checkbox and range filters, and filter chips. Components manage URL-synced state, keyboard shortcuts, and loading states. On the backend, it supplies Python patterns for dynamic SQLAlchemy/Django ORM queries, PostgreSQL full-text or Elasticsearch integration, pagination, and response caching. The client-server workflow supports client-side, server-side, and hybrid approaches to balance responsiveness and scale.

When to use it

  • Adding product or catalog search with category, price, and attribute filters
  • Implementing autocomplete/typeahead with keyboard navigation and highlighting
  • Creating faceted search interfaces that display dynamic counts
  • Optimizing search performance for large datasets (>1000 items) with server-side queries
  • Building accessible search experiences for keyboard and screen reader users

Best practices

  • Debounce input (≈300ms) and cancel pending requests on new keystrokes
  • Sanitize and validate query parameters on the server to prevent injection
  • Index searchable columns and use full-text indexes or Elasticsearch for relevance
  • Sync filter state with URLs for shareable searches and back/forward navigation
  • Provide ARIA roles, aria-live updates, and keyboard support for autocomplete

Example use cases

  • E-commerce product search with multi-select category filters and range sliders for price
  • Admin data table with server-side filtering, cursor pagination, and column search
  • Typeahead address search integrated with backend geocoding and debounced queries
  • Faceted content browser using Elasticsearch aggregations for counts and relevance
  • Hybrid search that applies client-side filters for instant feedback while fetching server results

FAQ

Should I filter client-side or server-side?

Use client-side for small datasets (<1000 items) for instant UX; use server-side or hybrid for larger datasets to avoid memory and performance issues.

How do I prevent request flooding from autocomplete?

Debounce inputs, cancel previous requests, and implement rate limiting on the server. Cache popular suggestions where appropriate.