Skip to content

Commit

Permalink
docs(ConfigProvider): add api docs (#1946)
Browse files Browse the repository at this point in the history
  • Loading branch information
anlyyao authored Sep 23, 2024
1 parent 4ef6efb commit a8244de
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/mobile/api_v2/config-provider.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Global property configuration"
description: "The global attribute configuration contains the text language configuration of each component and other common configurations to reduce duplicate common configurations."
isComponent: true
tdDocTabs: [{ tab: 'demo', name: '示例' }, { tab: 'api', name: 'API' }]
spline: 'explain'
---

### Internationalization

The supported language TDesign provided:

Language | File
-- | --
Chinese (Simplified) | `zh_CN`
Chinese (Traditional) | `zh_TW`
English | `en_US`
Korean | `ko_KR`
Japanese | `ja_JP`
Russian | `ru_RU`
Italian | `it_IT`
Arabic | `ar_KW`

If you want to contribute more language packs, please refer to [How to add a language pack](https://github.com/Tencent/tdesign-common/blob/develop/js/global-config/locale/CONTRIBUTING.md) PR.


### Upload

{{ upload-en }}

### Table

{{ table-en }}

### others

{{ other-en }}
92 changes: 92 additions & 0 deletions docs/mobile/api_v2/config-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: "全局特性配置"
description: "全局特性配置包含各个组件的文本语言配置及其他通用配置,可以减少重复的通用配置。"
isComponent: true
tdDocTabs: [{ tab: 'demo', name: '示例' }, { tab: 'api', name: 'API' }]
spline: 'explain'
---


### 国际化配置

TDesign 支持国际化/多语言配置,目前支持的语言包括:

语言 | 对应文件
-- | --
简体中文 | `zh_CN`
繁体中文 | `zh_TW`
英语 | `en_US`
韩语 | `ko_KR`
日语 | `ja_JP`
俄语 | `ru_RU`
意大利语 | `it_IT`
阿拉伯语 | `ar_KW`

如果你想贡献更多语言包,欢迎参考 [如何新增语言包](https://github.com/Tencent/tdesign-common/blob/develop/js/global-config/locale/CONTRIBUTING.md) 发起 PR。

### Upload 表格

{{ upload-en }}

### Table 表格

{{ table-en }}

### 其他组件

{{ other-en }}


### 全局组件前缀

TDesign 的组件前缀统一为`t`,在一些业务场景中,有需要改变组件前缀来满足业务的使用场景。
可以使用`esm`版本(保证您可以修改less vars),通过全局配置修改`classPrefix`,并配合 less-loader 修改`@prefix`这个 less vars 来保证组件样式的正常。

```js
import Vue from 'vue'
import TDesign from 'tdesign-vue-next/esm'

Vue.createApp({}).use(TDesign)

...

<t-config-provider :globalConfig="{ classPrefix: 'any'}">
<t-button>TDesign to any design</t-button>
</t-config-provider>
```

#### vue-cli
```js
// vue.config.js
{
css: {
loaderOptions: {
less: {
lessOptions: {
modifyVars: {
'@prefix': 'any',// 请注意需要与classPrefix保持一致
},
javascriptEnabled: true,
},
},
}
}
}
```

#### vite
```js
// vite.config.js
{
css: {
preprocessorOptions: {
less: {
modifyVars: {
'@prefix': 'any',// 请注意需要与classPrefix保持一致
},
javascriptEnabled: true,
},
}
}
}
```

0 comments on commit a8244de

Please sign in to comment.