docs/en-US/component/config-provider.md
Config Provider is used for providing global configurations, which enables your entire application to access these configurations everywhere.
Configure i18n related properties via Config Provider, to get language switching feature.
:::demo Use two attributes to provide i18n related config
config-provider/usage
:::
:::demo
config-provider/button
:::
:::demo
config-provider/link
:::
:::demo
config-provider/card
:::
:::demo
config-provider/dialog
:::
:::demo
config-provider/message
:::
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
:::
:::demo
config-provider/table
:::
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 -->| 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, type?: string, plain?: boolean, text?: boolean, round?: boolean, dashed?: boolean} | see the following table |
| link | link related configuration, see the following table | ^[object]{type?: string, underline?: boolean | string} | see the following table |
| dialog ^(2.10.7) | dialog related configuration, see the following table | ^[object]{alignCenter?: boolean, draggable?: boolean, overflow?: boolean, transition?: DialogTransition} | 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] | — |
| table ^(2.13.3) | table related configuration, see the following table | ^[object]{showOverflowTooltip?: boolean | object, tooltipEffect?: string, tooltipOptions?: object, tooltipFormatter?: Function} | see the following table |
| Attribute | Description | Type | Default |
|---|---|---|---|
| type ^(2.9.11) | button type, when setting color, the latter prevails | ^[enum]'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text' (deprecated) | — |
| 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 |
| text ^(2.11.0) | determine whether it's a text button | ^[boolean] | false |
| round ^(2.9.11) | determine whether it's a round button | ^[boolean] | false |
| dashed ^(2.13.3) | determine whether it's a dashed button | ^[boolean] | false |
| Attribute | Description | Type | Default |
|---|---|---|---|
| type ^(2.9.11) | type | ^[enum]'primary' | 'success' | 'warning' | 'danger' | 'info' | 'default' | default |
| underline ^(2.9.11) | when underlines should appear | ^[enum]'always' | 'hover' | 'never' | boolean | hover |
| Attribute | Description | Type | Default |
|---|---|---|---|
| shadow ^(2.10.5) | when to show card shadows | ^[enum]always | never | hover | — |
| Attribute | Description | Type | Default |
|---|---|---|---|
| align-center ^(2.10.7) | whether to align the dialog both horizontally and vertically | ^[boolean] | false |
| draggable ^(2.10.7) | enable dragging feature for Dialog | ^[boolean] | false |
| overflow ^(2.10.7) | draggable Dialog can overflow the viewport long | ^[boolean] | false |
| transition ^(2.10.7) | custom transition configuration for dialog animation. Can be a string (transition name) or an object with Vue transition props | ^[string] / ^[object]TransitionProps | — |
| 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] | — |
| placement ^(2.11.0) | message placement position | ^[enum]'top' | 'top-left' | 'top-right' | 'bottom' | 'bottom-left' | 'bottom-right' | — |
| Attribute | Description | Type | Default |
|---|---|---|---|
| show-overflow-tooltip | whether to hide extra content and show them in a tooltip when hovering on the cell.It will affect all the table columns, refer to table tooltip-options | ^[boolean] / [object] | — |
| tooltip-effect | the effect of the overflow tooltip | ^[enum]'dark' | 'light' | dark |
| tooltip-options | the options for the overflow tooltip, see the following tooltip component | ^[object]Pick<ElTooltipProps, 'effect' | 'enterable' | 'hideAfter' | 'offset' | 'placement' | 'popperClass' | 'popperOptions' | 'showAfter' | 'showArrow'> | ^[object]{ enterable: true, placement: 'top', showArrow: true, hideAfter: 200, popperOptions: { strategy: 'fixed' } } |
| tooltip-formatter | customize tooltip content when using show-overflow-tooltip | ^[Function](data: { row: any, column: TableColumnCtx<T>, cellValue: any }) => VNode | string | — |
| Name | Description | Type |
|---|---|---|
| default | customize default content | config: provided global config (inherited from the top) |