Language toggle
<gcds-lang-toggle>
Also called: language switch, language selector.
The language toggle is a link to the same content in the other Official Language.
-
Required on Canada.ca -
Required on GC sites
-
GitHub -
Figma
Language toggle component preview
On this page
Coding and accessibility for language toggle
- Place the language toggle in the top right of the header landmark for predictability and findability.
- Use the
href-attributeto set the url of the page in the other Official Language. - Set the
langattribute withento indicate the language toggle in French andfrwill indicate the language toggle in English.
Note: If using the header component, the language toggle can be assigned using the lang-href attribute.
In this section
href
The href attribute specifies the URL of the same page in another language, typically English or French. Use this attribute to provide a link that allows users to switch between available language versions.
<gcds-lang-toggle href="#">
</gcds-lang-toggle>
Code builder
Generate an instance of the component you need by selecting its code properties.
-
Explore by choosing different code values to generate the instance you want.
-
Get the code and pull it into your environment.
-
Add any copy you need to the component (like text for a label).
Note: The code builder uses English for all code elements, which follows standard practice.
Help us improve
Have questions or a request? Give feedback on our contact form.
Something's wrong? Raise it through GitHub with an