Skip to content

Commit

Permalink
docs: update API and Component Config for XProvider
Browse files Browse the repository at this point in the history
  • Loading branch information
YumoImer committed Sep 20, 2024
1 parent eb58a03 commit 1d2000b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
13 changes: 12 additions & 1 deletion components/x-provider/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,15 @@ If you are already using `ConfigProvider` from `antd`, please make the following

## API

Props ref:[Antd ConfigProvider](https://ant-design.antgroup.com/components/config-provider-cn#api)
`XProvider` fully extends `antd`'s `ConfigProvider`. Props ref:[Antd ConfigProvider](https://ant-design.antgroup.com/components/config-provider-cn#api)

### Component Config

| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| bubble | Global configuration for the Bubble component | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| conversations | Global configuration for the Conversations component | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| prompts | Global configuration for the Prompts component | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| sender | Global configuration for the Sender component | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| suggestion | Global configuration for the Suggestion component | 'className' \| 'style' | - | |
| thoughtChain | Global configuration for the ThoughtChain component | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
13 changes: 12 additions & 1 deletion components/x-provider/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,15 @@ demo:

## API

属性参考:[Antd ConfigProvider](https://ant-design.antgroup.com/components/config-provider-cn#api)
`XProvider` 完全继承 `antd``ConfigProvider`, 属性参考:[Antd ConfigProvider](https://ant-design.antgroup.com/components/config-provider-cn#api)

### 组件配置

| 属性 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| bubble | 气泡组件的全局配置 | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| conversations | 会话组件的全局配置 | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| prompts | 提示集组件的全局配置 | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| sender | 输入框组件的全局配置 | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |
| suggestion | 建议组件的全局配置 | 'className' \| 'style' | - | |
| thoughtChain | 思维链组件的全局配置 | 'classNames' \| 'styles' \| 'className' \| 'style' | - | |

0 comments on commit 1d2000b

Please sign in to comment.