1163d27f71
* feat(components): add empty values * feat(hooks): update * feat(components): update * feat(components): update * feat: update * feat(components): update * feat(components): update * feat(components): update * feat: update doc * feat: add doc
8.3 KiB
title, lang
| 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
:::
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.
:::demo
config-provider/empty-values
:::
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]{name: string, el: TranslatePair} languages |
en |
| size | global component size | ^[enum]'large' | 'default' | 'small' |
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]{autoInsertSpace?: boolean} |
see the following table |
| message | message related configuration, see the following table | ^[object]{max?: number} |
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 |
|---|---|---|---|
| autoInsertSpace | automatically insert a space between two chinese characters | ^[boolean] | false |
Message Attribute
| Attribute | Description | Type | Default |
|---|---|---|---|
| max | the maximum number of messages that can be displayed at the same time | ^[number] | — |
Config Provider Slots
| Name | Description | Scope |
|---|---|---|
| default | customize default content | config: provided global config (inherited from the top) |