Skip to main content
Version: 2.x

Query Parameter Translation

Translate the names (keys) of query parameters, not their values.

Enable​

provideNgxTranslateRoutes({
  enableQueryParamsTranslate: true,
})

Only active when the current language differs from the default language.

Translation File Structure​

Use the routeSuffixesWithQueryParams convention (defaults: route: 'root', params: 'params'):

en.json
{
  "routes": {
    "search": {
      "root": "search",
      "params": {
        "query": "query",
        "page": "page"
      }
    }
  }
}
es.json
{
  "routes": {
    "search": {
      "root": "buscar",
      "params": {
        "query": "consulta",
        "page": "pagina"
      }
    }
  }
}

Result​

LanguageURL
en/search?query=angular&page=1
es/buscar?consulta=angular&pagina=1

Custom Suffixes​

provideNgxTranslateRoutes({
  enableQueryParamsTranslate: true,
  routeSuffixesWithQueryParams: {
    route: 'path',    // default: 'root'
    params: 'query',  // default: 'params'
  },
})