282 lines
8.2 KiB
TypeScript
Vendored
282 lines
8.2 KiB
TypeScript
Vendored
import * as React from 'react'
|
|
import { useState, type ReactNode } from 'react'
|
|
import { type Table } from '@tanstack/react-table'
|
|
import { ChevronDown, Loader2, X as Cross2Icon } from 'lucide-react'
|
|
import { useTranslation } from 'react-i18next'
|
|
import { cn } from '@/lib/utils'
|
|
import { Button } from '@/components/ui/button'
|
|
import { Input } from '@/components/ui/input'
|
|
import { DataTableFacetedFilter } from './faceted-filter'
|
|
import { DataTableViewOptions } from './view-options'
|
|
|
|
type FilterDef = {
|
|
columnId: string
|
|
title: string
|
|
options: {
|
|
label: string
|
|
value: string
|
|
icon?: React.ComponentType<{ className?: string }>
|
|
iconNode?: React.ReactNode
|
|
count?: number
|
|
}[]
|
|
singleSelect?: boolean
|
|
}
|
|
|
|
export type DataTableToolbarProps<TData> = {
|
|
table: Table<TData>
|
|
/**
|
|
* Placeholder for the default search input. Defaults to `t('Filter...')`.
|
|
*/
|
|
searchPlaceholder?: string
|
|
/**
|
|
* Column id to filter on. When provided, the search input filters
|
|
* a specific column. When omitted, the search input updates the
|
|
* table's `globalFilter`.
|
|
*/
|
|
searchKey?: string
|
|
/**
|
|
* Column-level filter chips (faceted multi-select / single-select).
|
|
*/
|
|
filters?: FilterDef[]
|
|
/**
|
|
* Replaces the default search input entirely. Use when the primary
|
|
* "search" is something custom — e.g. a date-time range picker.
|
|
*/
|
|
customSearch?: ReactNode
|
|
/**
|
|
* Extra inputs/selects displayed in the primary row alongside the
|
|
* search input and filter chips.
|
|
*/
|
|
additionalSearch?: ReactNode
|
|
/**
|
|
* Whether non-table filters (e.g. `additionalSearch` or `expandable`
|
|
* inputs) are currently active. Controls Reset button visibility
|
|
* when no column filters are set.
|
|
*/
|
|
hasAdditionalFilters?: boolean
|
|
/**
|
|
* Callback invoked when the user clicks Reset.
|
|
*/
|
|
onReset?: () => void
|
|
/**
|
|
* Additional filter inputs hidden behind an Expand/Collapse toggle.
|
|
* Inputs flow inline with the primary row when expanded.
|
|
*/
|
|
expandable?: ReactNode
|
|
/**
|
|
* When `expandable` is collapsed, highlights the toggle if any of
|
|
* the expandable inputs currently hold a value.
|
|
*/
|
|
hasExpandedActiveFilters?: boolean
|
|
/**
|
|
* Custom action buttons rendered BEFORE the built-in
|
|
* Reset / Search / View buttons.
|
|
*/
|
|
preActions?: ReactNode
|
|
/**
|
|
* Explicit "Search" / "Apply" callback. When provided the toolbar
|
|
* shows a primary Search button. Filters are committed only on click
|
|
* (form-mode workflow).
|
|
*/
|
|
onSearch?: () => void
|
|
/**
|
|
* Loading state for the explicit Search button.
|
|
*/
|
|
searchLoading?: boolean
|
|
/**
|
|
* Hide the View Options (column visibility) dropdown.
|
|
*/
|
|
hideViewOptions?: boolean
|
|
/**
|
|
* Content rendered on the LEFT side of the secondary action row. When
|
|
* provided the toolbar splits into two visual rows:
|
|
* Row 1: search inputs / filter chips …… Expand
|
|
* Row 2: expanded filters
|
|
* Row 3: leftActions …… Reset / Search / ViewOptions
|
|
*/
|
|
leftActions?: ReactNode
|
|
/**
|
|
* Outer wrapper className override.
|
|
*/
|
|
className?: string
|
|
}
|
|
|
|
/**
|
|
* Unified data-table filter panel — Ant Design Pro inspired.
|
|
*
|
|
* Layout (single flex-wrap row):
|
|
* - Filters (search input + additional inputs + filter chips + expandable
|
|
* inputs) flow horizontally and wrap as needed.
|
|
* - The action cluster (Reset / Search / View / Expand) hugs the right
|
|
* edge via `ms-auto`. When filters fill a row, the cluster naturally
|
|
* wraps to the next line — still right-aligned — matching the
|
|
* collapsed/expanded states from the user's reference design.
|
|
*
|
|
* No background panel, no row separators — relies on whitespace and the
|
|
* adjacent table border for visual hierarchy.
|
|
*/
|
|
export function DataTableToolbar<TData>(props: DataTableToolbarProps<TData>) {
|
|
const { t } = useTranslation()
|
|
const [expanded, setExpanded] = useState(false)
|
|
|
|
const filters = props.filters ?? []
|
|
const hasExpandable = props.expandable != null
|
|
const hasSearch = props.onSearch != null
|
|
|
|
const isFiltered =
|
|
props.table.getState().columnFilters.length > 0 ||
|
|
!!props.table.getState().globalFilter ||
|
|
!!props.hasAdditionalFilters
|
|
|
|
const placeholder = props.searchPlaceholder ?? t('Filter...')
|
|
|
|
const searchInput = props.searchKey ? (
|
|
<Input
|
|
placeholder={placeholder}
|
|
value={
|
|
(props.table.getColumn(props.searchKey)?.getFilterValue() as string) ??
|
|
''
|
|
}
|
|
onChange={(event) =>
|
|
props.table
|
|
.getColumn(props.searchKey!)
|
|
?.setFilterValue(event.target.value)
|
|
}
|
|
className='w-full sm:w-[200px] lg:w-[240px]'
|
|
/>
|
|
) : (
|
|
<Input
|
|
placeholder={placeholder}
|
|
value={props.table.getState().globalFilter ?? ''}
|
|
onChange={(event) => props.table.setGlobalFilter(event.target.value)}
|
|
className='w-full sm:w-[200px] lg:w-[240px]'
|
|
/>
|
|
)
|
|
|
|
const filterChips = filters.map((filter) => {
|
|
const column = props.table.getColumn(filter.columnId)
|
|
if (!column) return null
|
|
return (
|
|
<DataTableFacetedFilter
|
|
key={filter.columnId}
|
|
column={column}
|
|
title={filter.title}
|
|
options={filter.options}
|
|
singleSelect={filter.singleSelect}
|
|
/>
|
|
)
|
|
})
|
|
|
|
const handleReset = () => {
|
|
props.table.resetColumnFilters()
|
|
props.table.setGlobalFilter('')
|
|
props.onReset?.()
|
|
}
|
|
|
|
// Reset: outline text-only for form mode (always visible, disabled when
|
|
// nothing to reset); ghost text + X for filter-as-you-type mode (only
|
|
// visible when active filters exist).
|
|
const resetButton = hasSearch ? (
|
|
<Button variant='outline' onClick={handleReset} disabled={!isFiltered}>
|
|
{t('Reset')}
|
|
</Button>
|
|
) : isFiltered ? (
|
|
<Button
|
|
variant='ghost'
|
|
onClick={handleReset}
|
|
className='text-muted-foreground hover:text-foreground gap-1 px-2'
|
|
>
|
|
{t('Reset')}
|
|
<Cross2Icon />
|
|
</Button>
|
|
) : null
|
|
|
|
const searchButton = hasSearch ? (
|
|
<Button onClick={props.onSearch} disabled={props.searchLoading}>
|
|
{props.searchLoading && <Loader2 className='animate-spin' />}
|
|
{t('Search')}
|
|
</Button>
|
|
) : null
|
|
|
|
const viewOptionsNode = !props.hideViewOptions ? (
|
|
<DataTableViewOptions table={props.table} />
|
|
) : null
|
|
|
|
const expandToggle = hasExpandable ? (
|
|
<Button
|
|
variant='ghost'
|
|
onClick={() => setExpanded((p) => !p)}
|
|
aria-expanded={expanded}
|
|
className={cn(
|
|
'text-muted-foreground hover:text-foreground gap-1 px-2',
|
|
props.hasExpandedActiveFilters &&
|
|
!expanded &&
|
|
'text-primary hover:text-primary'
|
|
)}
|
|
>
|
|
{expanded ? t('Collapse') : t('Expand')}
|
|
<ChevronDown
|
|
className={cn(
|
|
'size-3.5 transition-transform duration-200',
|
|
expanded && 'rotate-180'
|
|
)}
|
|
/>
|
|
</Button>
|
|
) : null
|
|
|
|
const hasLeftActions = props.leftActions != null
|
|
|
|
if (hasLeftActions) {
|
|
return (
|
|
<div className={cn('flex flex-col gap-2', props.className)}>
|
|
<div className='flex flex-wrap items-center gap-2 sm:gap-3'>
|
|
{props.customSearch !== undefined ? props.customSearch : searchInput}
|
|
{props.additionalSearch}
|
|
{filterChips}
|
|
<div className='ms-auto flex shrink-0 items-center gap-1.5 sm:gap-2'>
|
|
{expandToggle}
|
|
</div>
|
|
</div>
|
|
|
|
{expanded && hasExpandable && (
|
|
<div className='flex flex-wrap items-center gap-2 sm:gap-3'>
|
|
{props.expandable}
|
|
</div>
|
|
)}
|
|
|
|
<div className='flex flex-wrap items-center gap-2 sm:gap-3'>
|
|
{props.leftActions}
|
|
<div className='ms-auto flex shrink-0 items-center gap-1.5 sm:gap-2'>
|
|
{props.preActions}
|
|
{resetButton}
|
|
{searchButton}
|
|
{viewOptionsNode}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
'flex flex-wrap items-center gap-2 sm:gap-3',
|
|
props.className
|
|
)}
|
|
>
|
|
{props.customSearch !== undefined ? props.customSearch : searchInput}
|
|
{props.additionalSearch}
|
|
{filterChips}
|
|
{expanded && hasExpandable && props.expandable}
|
|
|
|
<div className='ms-auto flex shrink-0 items-center gap-1.5 sm:gap-2'>
|
|
{props.preActions}
|
|
{resetButton}
|
|
{searchButton}
|
|
{viewOptionsNode}
|
|
{expandToggle}
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|