Home > widget-integration > FilterTranslationService > buildTranslationKey

FilterTranslationService.buildTranslationKey() method

Builds a standardized translation key for a filter option.

Constructs a key in the format 'filterOption|{filterId}|{optionKey}' used to look up translations in the filterOptions translation object.

Signature:

buildTranslationKey(filterId: string, optionKey: string): string;

Parameters

Parameter

Type

Description

filterId

string

The unique identifier of the filter

optionKey

string

The option key within the filter

Returns:

string

Translation key string in format 'filterOption|filterId|optionKey'

Example 1

const key = this.buildTranslationKey('color', 'red');
// Returns: "filterOption|color|red"

Example 2

Extend to use custom key format:

window.boostWidgetIntegration.extend('FilterTranslationService', (FilterTranslationService) => {
  return class CustomFilterTranslationService extends FilterTranslationService {
    buildTranslationKey(filterId, optionKey) {
      // Use shop's custom key format
      return `custom.filter.${filterId}.${optionKey}`;
    }
  };
});