import { DaffFilterBase } from '@daffodil/core'
The base type of a filter.
interface DaffFilterBase {
label: string
name: string
type: DaffFilterType
options: Record<string, DaffFilterOptionBase>
}
label string |
|---|
The end-user facing string that explains the filter e.g. "Color". |
name string |
|---|
The name of the filter e.g. "color". |
type DaffFilterType |
|---|
The type of the filter. This is used to determine the specific behavior of the filter. |
options Record<string, DaffFilterOptionBase> |
|---|
The available options by which to filter a collection entity, e.g. "red", "blue", or "green". The type of options changes per type of filter. |