Home > widget-integration > CollectionFilterValue

CollectionFilterValue type

Collection filter value with extended metadata.

Used specifically for collection-type filters that include Shopify collection data like handles, tags, images, and HTML descriptions.

Signature:

export type CollectionFilterValue = BaseFilterValue & {
	key: string;
	label: string;
	displayName: string;
	handle: string;
	tags: string[];
	sort_order: string;
	body_html: string | null;
	image: string | null;
	isDisabled: boolean;
};

References: BaseFilterValue

Example

const collectionValue: CollectionFilterValue = {
  key: 'summer-collection',
  label: 'Summer Collection',
  displayName: 'Summer 2024',
  handle: 'summer-2024',
  tags: ['seasonal', 'new'],
  sort_order: 'best-selling',
  body_html: '<p>Summer collection description</p>',
  image: 'https://cdn.shopify.com/...',
  isDisabled: false,
  doc_count: 156
};