Filters Building

Filters Building Skill

Filter Types Quick Reference

type FilterType =
  | "simple-select"              // Constants (single)
  | "multi-select"               // Constants (multiple)
  | "model-select"               // Model relationship (small lists)
  | "model-multi-select"         // Model relationships (small lists)
  | "model-search-select"        // Model relationship (large lists)
  | "model-search-multi-select"  // Model relationships (large lists)
  | "text"                       // Text input
  | "email"                      // Email input
  | "number"                     // Number input
  | "checkbox"                   // Boolean 0/1
  | "date-range"                 // Date range picker
  | "gap";                       // Visual spacing

Field Definition

Field can be string OR object:

// Simple string - used for all three
field: "organization_id"

// Complex object for custom queries
field: {
  queryParam: "organization_type_id",       // URL query param
  postgresColumn: "organizations.type",     // Postgres column
  elasticsearchColumn: "organization_type_id" // ES column
}

Supported Query Patterns

Gap (Section Separator)

{
  type: "gap",
  placeholder: "",
  label: "Organization Filters",
  field: "",
}

Text Filter

{
  placeholder: "Search Name",
  type: "text",
  field: "name", // Uses q:name for ILIKE search
}

Checkbox Filter

{
  placeholder: "Is Active",
  type: "checkbox",
  field: "is_active",
  checkedValue: "1",
  uncheckedValue: "",
}

Simple Select (Constants)

import { constants } from "@/models/constants";

{
  placeholder: "Status",
  type: "simple-select",
  field: "status",
  options: constants.asset.status,
}

Multi Select (Constants)

{
  placeholder: "Organization Type",
  type: "multi-select",
  field: {
    queryParam: "organization_type_id",
    postgresColumn: "organizations.type",
    elasticsearchColumn: "organization_type_id",
  },
  options: constants.organization.type,
}

Model Select (Small Lists)

For < 50 options:

{
  placeholder: "Organization",
  type: "model-select",
  field: "organization_id",
  modelName: "organization",
  modelDisplayField: "label",
  modelSearchFilters: { disabled: "0" },
}

Model Multi Select (Small Lists)

{
  placeholder: "Tags",
  type: "model-multi-select",
  field: "tag_ids",
  modelName: "tag",
  modelDisplayField: "label",
  modelSearchFilters: { disabled: "0" },
}

Model Search Select (Large Lists)

For > 50 options:

{
  placeholder: "Organization",
  type: "model-search-select",
  field: "organization_id",
  modelName: "organization",
  modelDisplayField: "label",
  modelSearchParam: "q",
  modelSearchFilters: { disabled: "0" },
}

Model Search Multi Select (Large Lists)

{
  placeholder: "Organizations",
  type: "model-search-multi-select",
  field: "organization_id",
  modelName: "organization",
  modelDisplayField: "label",
  modelSearchParam: "q",
  modelSearchFilters: { disabled: "0" },
}

Date Range Filter

{
  placeholder: "Created Date",
  type: "date-range",
  field: "created_at",
}

Complete Example

import { IFilterField } from "@/ui/common/components/types/filters";
import { constants } from "@/models/constants";

export const assetFilters: IFilterField[] = [
  // Section 1: Basic Filters
  {
    placeholder: "Search Name",
    type: "text",
    field: "name",
  },
  {
    placeholder: "Status",
    type: "multi-select",
    field: "status",
    options: constants.asset.status,
  },
  {
    placeholder: "Is Active",
    type: "checkbox",
    field: "is_active",
    checkedValue: "1",
    uncheckedValue: "",
  },

  // Gap for visual separation
  {
    type: "gap",
    placeholder: "",
    label: "Organization Filters",
    field: "",
  },

  // Section 2: Relationships
  {
    placeholder: "Organization",
    type: "model-search-multi-select",
    field: "organization_id",
    modelName: "organization",
    modelDisplayField: "label",
    modelSearchParam: "q",
    modelSearchFilters: { disabled: "0" },
  },
  {
    placeholder: "Organization Type",
    type: "multi-select",
    field: {
      queryParam: "organization_type_id",
      postgresColumn: "organizations.type",
      elasticsearchColumn: "organization_type_id",
    },
    options: constants.organization.type,
  },

  // Gap for dates section
  {
    type: "gap",
    placeholder: "",
    label: "Date Filters",
    field: "",
  },

  // Section 3: Dates
  {
    placeholder: "Created Date",
    type: "date-range",
    field: "created_at",
  },
];

Best Practices

1. Group related filters with gap separators
2. Use search variants for lists > 50 items
3. Always use label as modelDisplayField (modify model if needed)
4. Always use q as modelSearchParam for consistency
5. Add modelSearchFilters to exclude disabled/archived records
6. Use field objects only when postgres/ES columns differ from query param
7. Constants are model-specific: constants.{model}.{field}

Filter Selection Guide

Key Rules

1. Use gaps to separate logical filter sections
2. Model filters should always filter out disabled records
3. Use search variants for better UX with large datasets
4. Field objects allow custom query building (see Go controller docs)
5. Keep placeholder text concise and descriptive