element-plus/docs/en-US/component/config-provider.md
btea 70fa3e7f26
feat(components): [el-message] config-provider message max attr (#5063)
* feat(components): [el-message] config-provider message max attr

* chore: update test

* feat: update test and message-method

* chore: format config-provider.md

* test: add multiple config-provider

* test: config-provider nesting
2022-01-08 20:03:13 +08:00

63 lines
3.0 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
:::
## message configurations
:::demo
config-provider/message
:::
## 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 |
| size | global component size | string | large / default /small | default |
| zIndex | global Initial zIndex | number | - | - |
| button | button related configuration, [see the following table](#button-attributes) | ButtonGlobalConfig | - | see the following table |
| message | message related configuration, [see the following table](#message-attributes) | MessageGlobalConfig | - | see the following table |
## Button Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------------- | ----------------------------------------------------------- | ------- | --------------- | ------- |
| autoInsertSpace | automatically insert a space between two chinese characters | boolean | - | false |
## Message Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | --------------------------------------------------------------------- | ------ | --------------- | ------- |
| max | the maximum number of messages that can be displayed at the same time | number | - | - |
## ConfigProvider Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |