element-plus/docs/en-US/component/config-provider.md
JeremyWuuuuu b051efd1b7
feat(components): [el-config-provider] experimental feature toggle (#6794)
- Add experimental feature toggle to config provider
- Add experimental feature toggle documentation
- Update test cases against feature toggle
2022-03-24 13:48:58 +08:00

5.3 KiB

title lang
Config Provider en-US

Config Provider

Config Provider is used for providing global configurations, which enables your entire application to access these configurations everywhere.

i18n 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

:::

Experimental features

In this section, you can learn how to use Config Provider to provide experimental features. For now, we haven't added any experimental features, but in the feature roadmap, we will add some experimental features. You can use this config to manage the features you want or not.

// TODO

Config Provider Attributes

Attribute Description Type Accepted Values Default
locale Locale Object Language languages English
size global component size string large / default /small default
zIndex global Initial zIndex number - -
button button related configuration, see the following table ButtonGlobalConfig - see the following table
message message related configuration, see the following table MessageGlobalConfig - see the following table
experimental-features features at experimental stage to be added, all features are default to be set to false Object - -

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 Scope
- customize default content config: provided global config (inherited from the top)