8000 docs(bubble): update content and messageRender type by wzc520pyfm · Pull Request #814 · ant-design/x · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs(bubble): update content and messageRender type #814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
May 15, 2025
Merged

docs(bubble): update content and messageRender type #814

merged 4 commits into from
May 15, 2025

Conversation

wzc520pyfm
Copy link
Contributor
@wzc520pyfm wzc520pyfm commented May 11, 2025 •
edited by coderabbitai bot
Loading

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

  • Describe the source of related requirements, such as links to relevant issue discussions.
  • For example: close #xxxx, fix #xxxx

💡 Background and Solution

  • The specific problem to be addressed.
  • List the final API implementation and usage if needed.
  • If there are UI/interaction changes, consider providing screenshots or GIFs.

📝 Change Log

Language Changelog
🇺🇸 English
🇨🇳 Chinese

Summary by CodeRabbit

  • 文档
    • 更新了 Bubble 组件 API 中 content 属性的类型说明，由简单的字符串类型调整为更复杂的 BubbleContentType，提升了类型描述的准确性和一致性。
    • 优化了 messageRender 属性的类型说明，支持更灵活的泛型内容渲染回调。

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 11, 2025 •
edited
Loading
📝 Walkthrough 
## Walkthrough

此次更改将 Bubble 组件 API 文档中 `content` 属性的类型由 `string` 更新为更为具体的 `BubbleContentType`，并将 `messageRender` 的类型改为泛型函数以支持更灵活的内容渲染。

## Changes

| 文件路径                           | 变更摘要                                                                                   |
|------------------------------------|--------------------------------------------------------------------------------------------|
| components/bubble/index.zh-CN.md   | 将 `content` 属性类型从 `string` 改为 `BubbleContentType`，`messageRender` 类型改为泛型函数，关联源码定义。 |
| components/bubble/index.en-US.md   | 将 `content` 属性类型从 `string` 改为 `BubbleContentType`，`messageRender` 类型改为泛型函数，关联源码定义。 |

## Possibly related PRs

- ant-design/x#403：该 PR 引入并定义了 `BubbleContentType`，与本次 PR 中 `content` 属性类型的更新直接相关。

## Suggested reviewers

- afc163

## Poem

> 🐇  
> 气泡内容新类型，  
> 文档更新显神奇。  
> 不再只是字符串，  
> 明确类型更安心。  
> 代码小兔乐开怀，  
> 共赏进步每一笔！  
>

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4aef923 and 034cab1.

📒 Files selected for processing (2)
  • components/bubble/index.en-US.md (2 hunks)
  • components/bubble/index.zh-CN.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/bubble/index.zh-CN.md
  • components/bubble/index.en-US.md
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test / react component workflow
  • GitHub Check: build preview
  • GitHub Check: size

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions GitHub Actions
Copy link
Contributor
github-actions bot commented May 11, 2025 •
edited
Loading

Preview is ready

@codecov Codecov
Copy link
codecov bot commented May 11, 2025 •
edited
Loading

Bundle Report

Bundle size has no change ✅

@dosubot dosubot bot added the documentation Improvements or additions to documentation label May 11, 2025
coderabbitai[bot]
coderabbitai bot reviewed May 11, 2025
View reviewed changes
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

< 8000 p class="mb-3"> The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 116d833 and f0d14df.

📒 Files selected for processing (1)
  • components/bubble/index.zh-CN.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test / react component workflow
  • GitHub Check: build preview
  • GitHub Check: size
🔇 Additional comments (2)
components/bubble/index.zh-CN.md (2)

47-47: 文档更新：content 类型从 string 改为 BubbleContentType
此修改使文档与源码中 Bubble 组件的实际类型定义保持一致，提升了 API 文档的准确性。

47-47: 请同步更新英文文档
请确认 components/bubble/index.en-US.md 中的 content 类型标注是否已从 string 更新至 BubbleContentType，确保中英文文档内容一致。

@wzc520pyfm wzc520pyfm force-pushed the docs/update-bubble-content-type branch from f0d14df to 4aef923 Compare May 11, 2025 03:48
@wzc520pyfm wzc520pyfm changed the title docs(bubble): update content type docs(bubble): update content and messageRender type May 11, 2025
@afc163
Copy link
Member
afc163 commented May 12, 2025

ci 挂了

@wzc520pyfm
Copy link
Contributor Author

ci 挂了

抱歉，我尚不清楚test执行失败的原因，但从报错内容看，似乎和pr改动无关，也许是bun的近期的发行版和现有ci配置不兼容？

@codecov Codecov
Copy link
codecov bot commented May 15, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.35%. Comparing base (a3205c1) to head (c1eff81).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #814   +/-   ##
=======================================
  Coverage   92.35%   92.35%           
=======================================
  Files          66       66           
  Lines        1492     1492           
  Branches      405      405           
=======================================
  Hits         1378     1378           
  Misses        114      114

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 15, 2025
@afc163 afc163 enabled auto-merge (squash) May 15, 2025 14:07
@afc163 afc163 merged commit 10e3cc2 into ant-design:main May 15, 2025
3 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 21, 2025
Merged
@kimteayon kimteayon mentioned this pull request May 21, 2025
Merged
kimteayon added a commit that referenced this pull request May 21, 2025
@kimteayon @wzc520pyfm
@coding-ice @ONLY-yours @github-actions @vanndxh @afc163 @zombieJ @L-Hknu
chore: sync main to next branch (#846)
64e3556 
* chore: sync main to feature branch  (#810)

* fix(attachment): fix image display style (#751)

* chore: update CodePreviewer to support React 19 (#758)

* docs: update a new contributions charts (#761)

* fix: fix some potential issue (#773)

* refactor: using setState function (#774)

Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>

* type: fix some potential issue (#775)

* fix: watch config three sub-items  (#777)

* feat: function setState

* fix: watch config

---------

Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>

* fix: fix Conversations ellipsis tooltip issues by removing it (#776)

* fix: fix Conversations ellipsis tooltip issues by removing it

* test: update snapshot

* style: use native text overflow style

* docs: changelog of 1.2.0 (#778)

* fix: fix some potential issue

* fix: fix some potential issue

* fix: fix some potential issue

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* 🏷️ type: add Conversation type export (#258)

Co-authored-by: afc163 <afc163@gmail.com>

* docs: fix the wrong docs of ThoughtChain (#781)

* fix: fix some potential issue

* fix: fix some potential issue

* fix: fix some potential issue

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: fix the wrong docs of ThoughtChain

* docs: optimize Bubble.List scoll position

* docs: fix thought-chain and changelog

* fix: Prompts scroll styles (#785)

* fix: Prompts srollX

* fix: Prompts srollX

* docs: optimize Bubble.List scroll bar position (#783)

* docs: optimize Bubble.List scoll position

* docs: optimize Bubble.List scoll position

* test: demo snap

* fix: Prompts srollX

* chore: sync main to feature branch

---------

Co-authored-by: wzc520pyfm <1528857653@qq.com>
Co-authored-by: ice <49827327+coding-ice@users.noreply.github.com>
Co-authored-by: Shinji-Li <1349021570@qq.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vanndxh <77873426+vanndxh@users.noreply.github.com>
Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>
Co-authored-by: afc163 <afc163@gmail.com>

* chore: fix  warning of deprecated API (#827)

* chore: fix  warning of deprecated API

* chore: fix ts

* chore: fix logic

* test: ignore legacy

* chore: delete webpack.config.js (#229)

* docs(bubble): update content and messageRender type (#814)

* docs: sender supplement documents to address user inquiries (#835)

* docs: supplement documents to address user inquiries

* docs: sender

* chore: sync main to feature branch

* feat:  make the Bubble foot and header to get from context  & Bubble can get key (#683)

* feat:  调整Bubble foot,header参数,支持头部获取上下文

* fix: # 支持useXAgent通过deps 获取最新状态

* fix: 剔多余提交

* fix: 英文文档格式修复

* fix  简化参数

* Update header-and-footer.tsx

fix: 调整用例

* feat: bubble's footer and header

* feat: bubble's footer and header

* test: bubble's footer and header

* fix: ts of key

* fix: ts of key

---------

Co-authored-by: Mickey <951203214@qq.com>

* fix: resolve the security issues of apikey (#840)

* fix: Resolve the security issues of apikey

* fix: Resolve the security issues of apikey

* test: update snap

* fix:api key and stream

* fix:api key and stream

* docs: modification tips (#844)

* docs: changelog of 1.3.0 (#845)

* test: sender

* test: delete

* docs: changelog of 1.3.0

* docs: changelog of 1.3.0

* docs: changelog of 1.3.0

---------

Co-authored-by: wzc520pyfm <1528857653@qq.com>
Co-authored-by: ice <49827327+coding-ice@users.noreply.github.com>
Co-authored-by: Shinji-Li <1349021570@qq.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vanndxh <77873426+vanndxh@users.noreply.github.com>
Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>
Co-authored-by: afc163 <afc163@gmail.com>
Co-authored-by: 二货爱吃白萝卜 <smith3816@gmail.com>
Co-authored-by: Lawliet <37376096+L-Hknu@users.noreply.github.com>
coding-ice pushed a commit to coding-ice/x that referenced this pull request Jun 17, 2025
@wzc520pyfm
docs(bubble): update content and messageRender type (ant-design#814)
f699a56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@afc163 afc163 afc163 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wzc520pyfm @afc163
0