mirror of
https://github.com/tenrok/vue-select.git
synced 2026-06-07 07:12:23 +03:00
update docs
This commit is contained in:
@@ -37,7 +37,7 @@ module.exports = {
|
||||
collapsable: false,
|
||||
children: [
|
||||
['guide/accessibility', 'WAI-ARIA Spec'],
|
||||
['guide/localization', 'Localization / i18n'],
|
||||
['guide/localization', 'Localization'],
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@@ -342,6 +342,29 @@ label: {
|
||||
},
|
||||
```
|
||||
|
||||
## locale <Badge text="v3.13.0+" />
|
||||
|
||||
The locale function receives the default english translations object for the component. This allows
|
||||
you to override the whole object, or change just the values you need. Can be used to localize the
|
||||
component to different languages, or just replace text to your liking throughout the component.
|
||||
|
||||
See [localization guide](/guide/localization.html) for more details and examples.
|
||||
|
||||
```js
|
||||
/**
|
||||
* @since 3.13.0
|
||||
* @see https://vue-select.org/guide/localization.html
|
||||
*/
|
||||
locale: {
|
||||
type: Function,
|
||||
/**
|
||||
* @return {Object}
|
||||
* @param localeStrings
|
||||
*/
|
||||
default: (localeStrings) => localeStrings,
|
||||
},
|
||||
```
|
||||
|
||||
|
||||
## maxHeight
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Localization / i18n
|
||||
|
||||
# Translations <Badge text="v3.13.0+" />
|
||||
|
||||
There are a number of strings used within the component that can all be translated. Out of the box,
|
||||
@@ -8,8 +10,9 @@ in [`src/locales`](https://github.com/sagalbot/vue-select/tree/master/src/locale
|
||||
- [French](https://github.com/sagalbot/vue-select/tree/master/src/locales/fr.js)
|
||||
- [Spanish](https://github.com/sagalbot/vue-select/tree/master/src/locales/es.js)
|
||||
|
||||
Translations can be set on for each component instance, or globally for all instances in your app.
|
||||
Both methods will use the `locale` prop to determine the text to be used throughout the component.
|
||||
Translations can be set individually for each component instance, or globally for all instances in
|
||||
your app. Both methods will use the `locale` prop to determine the text to be used throughout the
|
||||
component.
|
||||
|
||||
**Locale Prop**
|
||||
|
||||
@@ -25,6 +28,8 @@ the english locale that ships with Vue Select:
|
||||
|
||||
<<< @/../src/locales/en.js
|
||||
|
||||
[View this file on GitHub ](https://github.com/sagalbot/vue-select/tree/master/src/locales/en.js)
|
||||
|
||||
# Examples
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user