element-plus/docs/en-US/component/config-provider.md

47 lines
2.6 KiB
Markdown

---
title: Config Provider
lang: en-US
---
# Config Provider
Config Provider is used for providing global configurations, which enables your entire application to access these configurations everywhere
## i18n related configurations
Configure i18n related properties via Config Provider, to get language switching feature
:::demo Use two attributes to provide i18n related config
config-provider/usage
:::
## button configurations
:::demo
config-provider/button
:::
## Config Provider Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | ----------------------- |
| locale | Locale Object | Object\<Language\> | [languages](https://github.com/element-plus/element-plus/tree/dev/packages/locale/lang) | English |
| i18n | External translator, when this attribute is provided, it will be used at first, and it will fallback to default translator when this method returns nullish value | Function\<(...args: []) =\> string\> | - | - |
| button | button related configuration, [see the following table](#button-attributes) | ButtonGlobalConfig | - | see the following table |
## Button Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------------- | ----------------------------------------------------------- | ------- | --------------- | ------- |
| autoInsertSpace | automatically insert a space between two chinese characters | boolean | - | false |
## ConfigProvider Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |