https://github.com/vtex-apps/locale-switcher

The Locale Switcher app provides a component capable of changing the current language of your store.
https://github.com/vtex-apps/locale-switcher

hacktoberfest store-framework vtex-io

Last synced: 6 months ago
JSON representation

The Locale Switcher app provides a component capable of changing the current language of your store.

• Host: GitHub
• URL: https://github.com/vtex-apps/locale-switcher
• Owner: vtex-apps
• Created: 2019-05-23T19:08:30.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-09T17:35:05.000Z (about 1 year ago)
• Last Synced: 2025-04-09T18:43:16.182Z (about 1 year ago)
• Topics: hacktoberfest, store-framework, vtex-io
• Language: TypeScript
• Homepage:
• Size: 516 KB
• Stars: 1
• Watchers: 41
• Forks: 5
• Open Issues: 19
• Metadata Files:
  • Readme: docs/README.md
  • Changelog: CHANGELOG.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
📢 Use this project, [contribute](https://github.com/vtex-apps/locale-switcher) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).

[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

# Locale Switcher

The Locale Switcher app provides a component capable of changing the current language of your store.

![img-locale-switcher](https://user-images.githubusercontent.com/27777263/74359290-c2b5f700-4da1-11ea-8612-c05ccf1988d5.png)

## Configuration

1. Add the Locale Switcher app to your theme's dependencies in the `manifest.json` file:

```diff

 "dependencies": {

+  "vtex.locale-switcher": "0.x"

 }

```

2. Add the `locale-switcher` block to your header. For example:

```jsonc

"header-row#desktop": {

  "children": [

    // (...)

    "locale-switcher",

    "login",

    "minicart.v2"

  ]

},

```

3. Open a ticket to our support team in order to adjust your store's binding with the desired languages. 

> ⚠️ ***Caution:** The third step is mandatory. If no ticket is opened requiring the desired languages, the selection list may not appear on the Locale Switcher component.*

## Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles         |

| :-----------------: |

| `button`            |

| `buttonText`        |

| `container`         |

| `list`              |

| `listElement`       |

| `localeIdText`      |

| `relativeContainer` |

## Contributors ✨

Thanks goes to these wonderful people:

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!