FormKit ships with internationalization support for all of its interfaces and validation messages. Currently, FormKit supports the following languages (in the
Although flags are poor representations of languages (flags indicate a geographic nation, while languages can be spoken in many ares of the world), we use the flags in the list above to indicate the location of the contributor who created that particular locale.
defaultConfig includes the english locale by default — to add an additional locale, import it from
@formkit/i18n and append it to the
locales option when you initialized the FormKit plugin. To set the active locale specify it with the
There are two ways to change your active locale:
this.$formkit.setLocale()from the Vue plugin (best for options API).
configobject (best for composition API).
When using Vue’s options API, you have access to
this.$formkit which contains
setLocale('de') — a purpose-built method that globally changes the current locale:
When using the composition API, you won’t have access to
this.$formkit. Instead, you can fetch and modify the root FormKit configuration object. This is made available globally via Vue’s
inject mechanism and a unique Symbol:
If you find a phrase in your locale isn’t worded the way you prefer, you can override those individual messages globally in your configuration. You can do this by providing a
messages object to the
validationproperty. To see a full list of keys and messages checkout the english locale.
Writing a locale for a language you know is a great way to contribute to FormKit and an easy way to get started with open source too! We are always eager to see pull requests for new locales. To support this effort, we’ve created a locale builder — a small web app to make the translation process as easy as possible.
Of course, you are not required to use our locale builder to submit a language, and are more than welcome to submit a standard pull request with your locale included.
en-GB), please feel free to submit your localized language.