ShopifyFilter

Type

import { ShopifyFilter } from '@daffodil/driver/shopify'

A filter option available on collection and search results pages. Each filter includes a type, display label, and selectable values that customers can use to narrow down products.

The FilterValue objects contain an input field that you can combine to build dynamic filtering queries. Merchants configure available filters using the Shopify Search & Discovery app.

interface ShopifyFilter {
  __typename: "Filter"
  id: string
  label: string
  presentation: ShopifyFilterPresentation
  type: ShopifyFilterType
  values: ShopifyFilterValue[]
}

Properties

__typename `"Filter"`

id `string`
A unique identifier.

label `string`
A human-friendly string for this filter.

presentation `ShopifyFilterPresentation`
Describes how to present the filter values. Returns a value only for filters of type `LIST`. Returns null for other types.

type `ShopifyFilterType`
An enumeration that denotes the type of data this filter represents.

values `ShopifyFilterValue[]`
The list of values for this filter.