GitHub

ShopifyFilterValue

interface

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

A selectable value within a filter.

interface ShopifyFilterValue {
  __typename: "FilterValue"
  count: number
  id: string
  image: ShopifyMediaImage
  input: Scalars['JSON']['output']
  label: string
  swatch: ShopifySwatch
}

Properties

__typename
"FilterValue"
count
number

The number of results that match this filter value.

id
string

A unique identifier.

image
ShopifyMediaImage

The visual representation when the filter's presentation is IMAGE.

input
Scalars['JSON']['output']

An input object that can be used to filter by this value on the parent field.

The value is provided as a helper for building dynamic filtering UI. For example, if you have a list of selected FilterValue objects, you can combine their respective input values to use in a subsequent query.

label
string

A human-friendly string for this filter value.

swatch
ShopifySwatch

The visual representation when the filter's presentation is SWATCH.