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.
Use two attributes to provide i18n related config
Button Configurations
Link Configurations 2.9.11
Message Configurations
Empty Values Configurations 2.7.0
Supported components list
- Cascader
- DatePicker
- Select
- SelectV2
- TimePicker
- TimeSelect
- TreeSelect
Set empty-values
to support empty values of components. The fallback value is ['', null, undefined]
. If you think the empty string is meaningful, write [undefined, null]
.
Set value-on-clear
to set the return value when cleared. The fallback value is undefined
. In the date component is null
. If you want to set undefined
, use () => undefined
.
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.
API
Config Provider Attributes
Name | Description | Type | Default |
---|---|---|---|
locale | Locale Object | object languages | en |
size | global component size | enum | default |
zIndex | global Initial zIndex | number | — |
namespace | global component className prefix (cooperated with $namespace) | string | el |
button | button related configuration, see the following table | object | see the following table |
link | link related configuration, see the following table | object | see the following table |
message | message related configuration, see the following table | object | see the following table |
experimental-features | features at experimental stage to be added, all features are default to be set to false | object | — |
empty-values 2.7.0 | global empty values of components | array | — |
value-on-clear 2.7.0 | global clear return value | string / number / boolean / Function | — |
Button Attribute
Attribute | Description | Type | Default |
---|---|---|---|
type 2.9.11 | button type, when setting color , the latter prevails | enum | — |
autoInsertSpace | automatically insert a space between two chinese characters(this will only take effect when the text length is 2 and all characters are in Chinese.) | boolean | false |
plain 2.9.11 | determine whether it's a plain button | boolean | false |
round 2.9.11 | determine whether it's a round button | boolean | false |
Link Attribute
Attribute | Description | Type | Default |
---|---|---|---|
type 2.9.11 | type | enum | default |
underline 2.9.11 | when underlines should appear | enum | hover |
Message Attribute
Attribute | Description | Type | Default |
---|---|---|---|
max | the maximum number of messages that can be displayed at the same time | number | — |
grouping 2.8.2 | merge messages with the same content, type of VNode message is not supported | boolean | — |
duration 2.8.2 | display duration, millisecond. If set to 0, it will not turn off automatically | number | — |
showClose 2.8.2 | whether to show a close button | boolean | — |
offset 2.8.2 | set the distance to the top of viewport | number | — |
plain 2.9.11 | whether message is plain | boolean | — |
Config Provider Slots
Name | Description | Scope |
---|---|---|
default | customize default content | config: provided global config (inherited from the top) |