feat: ✨ 文档示例项目支持国际化切换#992
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. 💤 Files selected but had no reviewable changes (1)
You can disable this status message by setting the Walkthrough本次提交移除了项目中 Vetur 相关的设置，并新增了一整套 i18n-ally 配置以增强国际化支持。同时更新了 README 文件及文档说明，新增了大量组件、钩子和指引文档。依赖版本和脚本命令也进行了调整，删除了旧的 changelog 脚本，新增了用于同步变更日志的新脚本。 Changes
Sequence Diagram(s)sequenceDiagram
participant User as 用户
participant FS as 文件系统
participant Sync as syncChangelog 脚本
participant Target as 目标目录
User->>Sync: 启动同步脚本
Sync->>FS: 同步读取 CHANGELOG.md
FS-->>Sync: 返回变更日志内容
loop 遍历各目标
Sync->>FS: 检查目标目录是否存在
alt 目录不存在且允许创建
FS->>Sync: 创建目录成功
end
Sync->>FS: 写入变更日志到目标路径
end
Sync->>User: 同步完成提示
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for wot-design-uni ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Deploying wot-design-uni with
|
| Latest commit: |
c864036
|
| Status: | ⚡️ Build in progress... |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 4
🧹 Nitpick comments (139)
docs/en-US/reward/reward.md (1)
1-37: 文件结构优化建议此文档存在几个可以优化的地方：
- 标题层级存在跳跃，从h1（#）直接跳到h3（###），应考虑添加h2层级标题保持层级连贯性。
- Afdian捐赠链接应使用Markdown链接格式而非裸URL。
- 图片缺少alt属性，这对于提高页面可访问性很重要。
建议应用以下修改：
- ### Afdian Donation + ## Afdian Donation - <a href="https://afdian.com/a/weisheng233">https://afdian.com/a/weisheng233</a> + [https://afdian.com/a/weisheng233](https://afdian.com/a/weisheng233) - <img style="width: 250px; height: 250px;" :src="WxQrcode" /> + <img style="width: 250px; height: 250px;" :src="WxQrcode" alt="WeChat Payment QR Code" /> - <img style="width: 250px; height: 250px;" :src="AlipayQrcode" /> + <img style="width: 250px; height: 250px;" :src="AlipayQrcode" alt="Alipay Payment QR Code" />🧰 Tools
🪛 LanguageTool
[style] ~6-~6: Consider using “email”.
Context: ...minder After making a donation, you can send an email to 1780903673@qq.com or contact through so...(SEND_AN_EMAIL)
🪛 markdownlint-cli2 (0.17.2)
6-6: Bare URL used
null(MD034, no-bare-urls)
9-9: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
16-16: Images should have alternate text (alt text)
null(MD045, no-alt-text)
21-21: Images should have alternate text (alt text)
null(MD045, no-alt-text)
docs/en-US/reward/donor.md (1)
1-36: 优化Markdown格式和Vue语法集成
- 邮箱地址在提示信息中以裸URL的形式出现，应考虑使用Markdown链接格式。
- Vue组件和指令在Markdown中的使用需确保与所使用的Markdown解析器兼容。
建议将邮箱地址格式化为Markdown链接：
- After making a donation, you can send an email to 1780903673@qq.com or contact through social platforms like GitHub or WeChat groups to provide your donor name, message, and link (the link can be your blog, GitHub, personal website, company product, etc.). If possible, please make sure to leave your Github username. + After making a donation, you can send an email to [1780903673@qq.com](mailto:1780903673@qq.com) or contact through social platforms like GitHub or WeChat groups to provide your donor name, message, and link (the link can be your blog, GitHub, personal website, company product, etc.). If possible, please make sure to leave your Github username.请确认Vue指令（v-if, v-for等）在当前的Markdown解析器配置下能正常工作，因为有些Markdown解析器可能会与Vue指令产生冲突。
🧰 Tools
🪛 LanguageTool
[style] ~6-~6: Consider using “email”.
Context: ...minder After making a donation, you can send an email to 1780903673@qq.com or contact through so...(SEND_AN_EMAIL)
🪛 markdownlint-cli2 (0.17.2)
6-6: Bare URL used
null(MD034, no-bare-urls)
docs/.vitepress/plugins/markdown-transform.ts (1)
4-5: 国际化实现方案可以更加健壮当前的国际化实现通过检查路径中是否包含"/en-US/"来决定语言，默认使用"zh-CN"。这种方法在仅支持两种语言时有效，但如果将来添加更多语言支持，可能需要调整实现方式。
建议考虑使用更灵活的语言检测方法，以便未来扩展：
- // 根据文件路径判断当前语言 - const lang = id.includes('/en-US/') ? 'en-US' : 'zh-CN' + // 根据文件路径提取语言代码 + const langMatch = id.match(/\/([a-z]{2}-[A-Z]{2})\//) + const lang = langMatch ? langMatch[1] : 'zh-CN'这种方式可以匹配形如"/zh-CN/"、"/en-US/"或任何其他符合"xx-XX"格式的语言代码，更有利于未来扩展。
Also applies to: 14-25
docs/en-US/guide/cases.md (2)
7-52: 案例展示的一致性和图片路径问题案例展示部分的实现整体良好，但存在几个可以改进的地方：
- 只有"随想小站"案例有描述说明，而其他案例没有，这会导致展示不一致。
- 图片使用了绝对路径（以"/"开头），需确保在部署时能正确解析。
建议为所有案例添加描述，或者统一移除描述，保持布局一致性。如果选择为所有案例添加描述，可以参考"随想小站"的格式：
<template #header> <span class="case-title">案例名称</span> <span class="case-description">案例简短描述</span> </template>请确认图片路径"/cases/xxx.jpg"或"/cases/xxx.png"在VitePress部署环境中能够正确解析。如果有问题，可能需要调整为相对路径或使用import导入图片。
79-80: 移除空的script标签当前script标签为空，没有实际内容，建议移除以减少不必要的代码。
-<script setup> -</script>docs/en-US/component/gap.md (2)
3-3: 修正标点符号使用原文中使用了分号后跟 "or"：
...replace margin or padding in page layout; or serve as a (bottom) placeholder element...
根据英文标点规则，分号后跟 "or" 不合适，建议使用逗号替代分号。
-Generally used to replace margin or padding in page layout; or serve as a (bottom) placeholder element. +Generally used to replace margin or padding in page layout, or serve as a (bottom) placeholder element.🧰 Tools
🪛 LanguageTool
[typographical] ~3-~3: Conjunctions like ‘or’ should not follow semicolons. Use a comma instead.
Context: ...replace margin or padding in page layout; or serve as a (bottom) placeholder element...(CONJUNCTION_AFTER_SEMICOLON)
1-43: 文档完善与翻译一致性英文版 Gap 组件文档内容结构清晰，示例丰富。但建议补充一下组件版本号标签（如 Overlay 组件文档所示），保持组件文档风格统一。另外，确保中文版的 Gap 组件文档与此英文版保持内容一致性。
🧰 Tools
🪛 LanguageTool
[typographical] ~3-~3: Conjunctions like ‘or’ should not follow semicolons. Use a comma instead.
Context: ...replace margin or padding in page layout; or serve as a (bottom) placeholder element...(CONJUNCTION_AFTER_SEMICOLON)
docs/en-US/component/overlay.md (1)
46-46: 属性表格中的选项值不完整
show属性的选项列仅显示 "true"，但根据描述，它应该是布尔值，即 "true/false"。-| show | Whether to show overlay| `boolean` | true | false | - | +| show | Whether to show overlay| `boolean` | true/false | false | - |docs/en-US/guide/typography.md (1)
127-137: 保持文档格式一致性根据国际化最佳实践，建议在英文文档中保持英文冒号前不加空格的风格，并确保中文文档使用中文标点符号规范。请确保在不同语言版本中遵循相应的标点符号使用规范。
🧰 Tools
🪛 LanguageTool
[uncategorized] ~127-~127: Les deux-points sont précédés d’une espace insécable.
Context: ...serif;## JD Zheng HT Font-family CDN:bash # CDN Address https://static....(FRENCH_WHITESPACE)
[uncategorized] ~137-~137: Les deux-points sont précédés d’une espace insécable.
Context: ...onts/JDZhengHT/JDZhengHT-Bold.woffUsage:scss @font-face { font-family: 'J...(FRENCH_WHITESPACE)
docs/.vitepress/theme/components/VPIframe.vue (2)
103-108: 建议重构消息发送功能
sendLanguageMessage和sendMessage函数非常相似，仅在发送的数据内容上有区别。建议重构为一个通用函数，可以处理不同类型的消息，提高代码复用性。-// 发送语言信息给iframe -function sendLanguageMessage() { - if (iframe.value?.contentWindow) { - iframe.value.contentWindow.postMessage(vitepressData.lang.value, href.value) - } -} +// 发送消息给iframe +function sendMessageToIframe(messageData: any) { + if (iframe.value?.contentWindow) { + iframe.value.contentWindow.postMessage(messageData, href.value) + } +} + +// 发送主题模式信息 +function sendMessage() { + sendMessageToIframe(vitepressData.isDark.value) +} + +// 发送语言信息 +function sendLanguageMessage() { + sendMessageToIframe(vitepressData.lang.value) +}
116-119: 添加错误处理机制iframe 加载事件监听没有错误处理机制。如果 iframe 加载失败，应用可能会出现异常行为。
// 监听 iframe 加载完成事件 iframe.value?.addEventListener('load', () => { sendMessage() sendLanguageMessage() }) + +// 监听 iframe 加载失败事件 +iframe.value?.addEventListener('error', (error) => { + console.error('iframe 加载失败:', error) + // 可以在此处添加重试逻辑或显示错误提示 +})docs/en-US/component/steps.md (1)
43-44: 建议增加"the"使表达更准确在英文表述中，建议修改为"If no title is set, the default text will be used"，增加定冠词使表达更符合英语语法规范。
-You can set the title and description of steps through `title` and `description`. If no title is set, default text will be used. +You can set the title and description of steps through `title` and `description`. If no title is set, the default text will be used.🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: You might be missing the article “the” here.
Context: ... anddescription. If no title is set, default text will be used. ```html <wd-steps :...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/en-US/component/rate.md (3)
21-24: 只读属性说明清晰
“Read-only” 部分通过简短文字说明了只读属性的作用。不过建议在后续版本中增加更多示例注释以帮助初学者理解。
29-33: 禁用状态示例可进一步完善
示例代码展示了如何设置disabled属性；建议补充disabled-color的示例，以使说明与文字描述完全对应。
70-86: 属性说明表格齐全
详细的属性表格列出了各个参数、类型、默认值和描述，有助于用户快速查阅；建议注意 Markdown 表格前后空行问题以提升格式一致性。docs/en-US/component/icon.md (3)
17-24: 图标颜色定制示例有效
示例代码展示了如何通过color属性实现图标颜色自定义，建议后续可增加更多配色实例。
55-58: 图标列表部分描述简洁
“Icon List” 作为示例标识组件展示，虽然信息较少，但能让用户初步了解其用途。
59-68: 属性说明表格完整
表格详细列出了所有图标组件相关属性，建议在前后各添加一个空行以满足 Markdownlint 规范。docs/en-US/component/loadmore.md (1)
120-129: 属性说明表格齐全
表格中详细说明了各项属性和默认值，建议前后加空行以满足 Markdownlint 格式要求。docs/en-US/component/password-input.md (2)
1-4: PasswordInput 组件标题与简介说明
标题中包含版本标记，简介清楚描述了组件用于输入密码、短信验证码等场景。
注意“in conjunction with”部分建议简化为“与…一起使用”，使语言更简洁。🧰 Tools
🪛 LanguageTool
[style] ~3-~3: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...odes, and other scenarios. Usually used in conjunction with the [number keyboard](./number-keyboard...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
78-89: 属性说明表格齐全
属性表格详细列出了所有相关参数，包括类型、描述和默认值；建议前后空行以满足 Markdown 格式要求。docs/en-US/component/tabbar.md (4)
41-51: Badge Tips 示例展示有效
HTML 示例展示了如何通过is-dot和value属性显示徽标提示，建议描述中可将 “small red dot” 修改为 “一个小红点” 以增强表述准确性。🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: Consider adding a hyphen.
Context: ... small red dot will be displayed in the upper right corner of the icon. ```html <wd-tabbar...(TOP_LEFT_CORNER)
59-70: Floating Tab Bar 示例描述清晰
示例代码展示了如何通过设置shape="round"实现浮动风格的 Tabbar，建议适当补充限定词以使描述更完整。🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: You might be missing the article “a” here.
Context: ... toround, you can set the tab bar to floating style. ```html <wd-tabbar shape="round...(AI_EN_LECTOR_MISSING_DETERMINER_A)
160-172: 属性说明表格齐全
详细列出了组件所有属性、类型、默认值及版本信息；建议在表格前后增加空行以符合 Markdownlint 要求。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
161-161: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
187-191: TabbarItem 属性说明全面
表格列出了 TabbarItem 的所有属性，包含 title、name 与 icon 信息；建议添加前后空行以满足 Markdown 文档格式要求。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
187-187: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
docs/en-US/component/pagination.md (3)
43-56: 属性表格格式改进建议
建议在表格上下各添加一个空行，以符合 markdownlint (MD058) 的要求，从而提高文档的可读性。
57-62: 事件表格清晰
事件说明部分展示了change事件及其参数，建议同样增加表格上下的空行以加强格式一致性。
63-67: 外部样式类表格建议统一格式
“External Classes” 表格内容完整，建议在表格前后加空行，便于阅读和维护。docs/en-US/component/slider.md (2)
57-68: 属性表格建议格式优化
属性表格已完整列出所有相关参数，建议在表格前后添加空行以满足 markdownlint 规范，从而提高整洁度。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
58-58: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
78-85: 方法与外部样式类部分完整
文档后续部分提供了方法和外部样式类的说明，内容详实，但建议同样为表格添加上下空行。docs/en-US/component/resize.md (1)
32-36: 事件表格格式优化建议
事件表格展示了resize事件及其参数，建议前后各添加一个空行以符合 markdownlint (MD058) 规范。docs/en-US/component/radio.md (3)
22-32: 修改图标形状示例全面
通过不同的shape属性展示了按钮样式与点状样式的不同效果，示例内容丰富，建议在注释中补充各自的适用场景以便进一步说明。
148-157: RadioGroup 属性表格格式优化
表格完整展示了 RadioGroup 的相关属性，建议在表格前后添加空行以提升可读性并符合 markdownlint 标准。
168-175: Radio 属性表格建议改进格式
建议在属性表格前后加空行，这有助于增强文档整体格式的一致性。docs/en-US/component/tabs.md (1)
101-111: 自动调整底部线宽说明建议
在“Auto Adjust Bottom Line Width” 部分，描述了auto-line-width属性的用途。建议检查“Bottom Line”表述是否统一使用连字符（如 “bottom-line”），以保持文档风格一致。🧰 Tools
🪛 LanguageTool
[uncategorized] ~101-~101: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... showZero: true } } ]) ``` ## Auto Adjust Bottom Line Width Set the `auto-line-w...(AUTO_HYPHEN)
[uncategorized] ~101-~101: The adjective “Bottom-Line” is spelled with a hyphen.
Context: ...: true } } ]) ``` ## Auto Adjust Bottom Line Width Set theauto-line-widthproper...(TOP_LINE_HYPHEN)
[uncategorized] ~103-~103: The adjective “bottom-line” is spelled with a hyphen.
Context: ...h` property to automatically adjust the bottom line width to match the text content width. ...(TOP_LINE_HYPHEN)
docs/en-US/component/use-message.md (2)
32-48: TypeScript 示例展示确认对话框的使用逻辑
链式调用及错误处理清晰，建议在捕获异常时可以适当添加错误提示信息，便于调试。
80-107: API 部分格式结构合理
表格中对各个方法（show、alert、confirm、prompt、close）及其参数的说明详细，建议检查表格在不同显示环境下的对齐情况。docs/en-US/component/input.md (2)
37-44: Label Width 示例有效
代码展示了如何自定义标签宽度。建议文档中能补充例如宽度推荐范围等参考说明。
222-258: 属性表格信息详实
详细列出了各属性及其描述、类型和默认值，方便开发者查阅。建议检查在不同终端上的响应式显示效果。🧰 Tools
🪛 LanguageTool
[misspelling] ~249-~249: This word is normally spelled as one.
Context: ...board when focused | number | 0 | - | | auto-focus | Whether to auto focus | boolean | fal...(EN_COMPOUNDS_AUTO_FOCUS)
[misspelling] ~249-~249: This word is normally spelled as one.
Context: ...ber | 0 | - | | auto-focus | Whether to auto focus | boolean | false | - | | always-embed ...(EN_COMPOUNDS_AUTO_FOCUS)
docs/en-US/component/card.md (2)
5-9: 基本用法部分说明到位
说明中提及了通过title属性设置标题以及使用默认和 footer 插槽，建议后续补充更多实际场景示例以供参考。
57-75: 样式代码定义合理
SCSS 部分定义了.content、.title及.title-tip的样式，建议后续增加注释说明各部分目的，便于维护。docs/en-US/component/skeleton.md (2)
10-18: 示例代码直观展示各类 Skeleton 样式
代码中对每种 Skeleton 风格的使用方式展示清楚，建议在代码中增加少量注释说明各种风格的适用场景。
88-88: 语言建议
描述中建议在“loading is set to false”后增加逗号，以增强语句结构清晰度。🧰 Tools
🪛 LanguageTool
[uncategorized] ~88-~88: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...e, the skeleton component will be hidden and the slot content will be displayed. ``...(COMMA_COMPOUND_SENTENCE_2)
docs/en-US/component/use-upload.md (1)
68-80: ChooseFileOption 表格需要调整
静态分析工具提示此处表格列数不足，建议检查并调整表格格式，确保所有单元格数据显示完整。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
80-80: Table column count
Expected: 5; Actual: 4; Too few cells, row will be missing data(MD056, table-column-count)
docs/en-US/guide/locale.md (3)
1-4: 整体介绍和语句润色建议文档开头已清晰介绍国际化功能及版本信息，但第3行的描述“if you want to use other languages, you can refer to the solutions below.” 建议采用更正式、礼貌的措辞，例如“如果您需要使用其他语言，请参阅以下解决方案”，以提升文档整体的正式度和用户体验。
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a more polite wording.
Context: ...pports multi-language switching. If you want to use other languages, you can refer t...(IF_YOU_WANT)
8-20: Vite 配置代码示例说明代码块展示了如何在
vite.config.ts中通过optimizeDeps.exclude排除wot-design-uni模块，非常直观。建议在示例代码中增加简要注释，说明为何需要在开发环境下排除预构建依赖，有助于初学者快速理解。
56-75: 支持语言表格表格详细列出了各语言及其对应的版本信息，有助于用户了解内置多语言支持情况。建议核实版本号是否与项目实际发布版本保持一致，并可在后续版本中考虑添加关于如何贡献其他语言包的补充说明。
docs/en-US/component/swiper.md (1)
144-161: 卡片样式 SCSS 说明SCSS 代码示例展示了如何通过 CSS 变量和
:deep选择器覆盖默认样式。注意使用!important时应谨慎，建议确认是否符合项目的设计规范。docs/en-US/component/tag.md (3)
102-119: 动态标签（Add Tag）示例示例展示了如何使用
dynamic属性及confirm事件实现可添加标签的效果，同时提供了自定义“添加”样式插槽。建议对提示语或按钮文字进行细微调整，以提升用户体验。🧰 Tools
🪛 LanguageTool
[style] ~110-~110: Consider using a more polite wording.
Context: ...rm="handleConfirm"> ``` If you want to customize the add style, you can use...(IF_YOU_WANT)
120-132: 动态标签状态管理代码TypeScript 示例中通过
ref管理标签数组，并定义了handleClose与handleConfirm方法。逻辑清晰，建议在处理新增标签时增加基本的错误检测或空值防护，以避免潜在问题。
140-157: 事件处理代码示例示例代码中演示了如何处理标签的点击与关闭事件，建议在日志输出中增加更多上下文信息，以便调试时能快速定位问题。
docs/en-US/guide/introduction.md (3)
33-42: 功能特性列表功能列表涵盖了组件库的主要优势和特性，建议在后续更新中进一步丰富各功能描述，使信息更具体。
51-56: 赞助信息描述“Sponsor Us” 部分语气友好，但建议将“please feel free to”替换为更正式的措辞，例如“欢迎”，以增强专业感。
78-81: 许可证说明许可证部分说明了 MIT 协议，建议调整措辞使得语气更正式，例如将“please feel free to enjoy and participate”修改为“您可自由使用及参与”。
🧰 Tools
🪛 LanguageTool
[style] ~80-~80: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ikipedia.org/wiki/MIT_License) license. Please feel free to enjoy and participate in open source. ...(FEEL_FREE_TO_STYLE_ME)
docs/en-US/component/progress.md (1)
30-37: 修改颜色示例说明示例展示了如何使用
color属性修改进度条颜色，同时说明支持传入数组或函数形式。静态分析工具建议补全说明句子（例如在描述中加入主语“该属性”），以构成完整句子。docs/en-US/component/sort-button.md (1)
1-64: 文档内容完整，但需要优化格式SortButton组件的英文文档内容详细，包含了基本用法、按钮重置、排序优先级切换和隐藏下划线等功能说明，以及完整的属性表和事件表。
在第62行的表格前后应该添加空行，以符合Markdown格式规范：
## External Style Classes + | Class Name | Description | Version | |------------|-------------|----------| | custom-class | Root node style | - | +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
docs/en-US/component/calendar-view.md (1)
138-138: 句子结构需要优化这里的句子结构有些问题，建议使用分号或调整句子结构。
-Set the `formatter` parameter, its value is a function type that receives an `object` parameter and returns an object whose properties remain consistent with the input parameters. +Set the `formatter` parameter; its value is a function type that receives an `object` parameter and returns an object whose properties remain consistent with the input parameters.或者:
-Set the `formatter` parameter, its value is a function type that receives an `object` parameter and returns an object whose properties remain consistent with the input parameters. +Set the `formatter` parameter. This parameter is a function type that receives an `object` parameter and returns an object whose properties remain consistent with the input parameters.🧰 Tools
🪛 LanguageTool
[uncategorized] ~138-~138: Possible missing comma found.
Context: ...ate Set theformatterparameter, its value is a function type that receives an `ob...(AI_HYDRA_LEO_MISSING_COMMA)
docs/en-US/component/img-cropper.md (3)
28-56: Vue 代码示例编写规范。
通过 ref 定义响应式变量并在上传图片后更新状态，逻辑清晰。建议在实际业务中补充错误处理，增强健壮性。
117-163: 上传逻辑处理较为合理。
对上传成功、错误和进度回调均已处理，建议在 catch 块中补充更多错误信息以便调试。
165-204: 属性与方法说明详尽。
表格详细列出了组件的属性、事件和公开方法，但其中 “setRoate” 方法命名疑似拼写错误（应为 setRotate？），建议确认 API 命名的一致性。docs/en-US/component/transition.md (2)
25-32: 自定义动画描述详实。
文档说明了如何通过各个动画类名配置自定义动画效果。建议优化语言表达，比如将“enter”替换为“进入”，以提升专业性。🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: The verb ‘enter’ does not usually follow articles like ‘the’. Check that ‘enter’ is spelled correctly; using ‘enter’ as a noun may be non-standard.
Context: ...enter-active-classstyles. Therefore, the enter animation transitions from the `enter-c...(A_INFINITIVE)
75-105: 属性和事件说明全面。
详细列出了 Transition 组件的所有配置项、事件及外部样式类。建议在表格前后增加空行以符合 Markdown 规范。docs/en-US/component/curtain.md (1)
85-127: 属性、事件与插槽说明详尽。
各个属性、事件和插槽均有详细介绍，信息量充足。建议检查表格格式，适当在表格前后添加空行以符合 Markdownlint 规范。docs/en-US/component/select-picker.md (2)
106-139: 显示格式化功能示例详细。
display-format 示例完整，能帮助用户理解如何格式化显示已选数据，尽管代码可进一步优化，但目前已满足说明需求。
230-278: 属性、事件与方法说明详尽。
表格详细罗列了组件所有相关配置项、事件和方法。建议在表格前后添加空行以满足 Markdown 格式要求。docs/en-US/component/number-keyboard.md (1)
200-229: 属性、事件与插槽表格齐全。
详细列出了组件所有可配置项、事件与插槽。建议在表格前后增加空行以遵循 Markdownlint 建议，提升文档排版质量。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
201-201: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
218-218: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
227-227: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
docs/en-US/component/swipe-action.md (1)
5-9: 警告信息建议精简并修正表述
警告块已很好地提醒用户注意滑动触发的问题，但建议将描述中的“manually clicks somewhere outside ofswipeAction”简化为“点击组件外部”，避免冗余。docs/en-US/component/textarea.md (1)
119-161: 属性表格详尽但有小建议
属性说明非常详细，但文中关于auto-focus属性的拼写建议统一（可考虑改为 “autofocus”），以保持与 HTML 标准一致。🧰 Tools
🪛 LanguageTool
[misspelling] ~129-~129: This word is normally spelled as one.
Context: ...1 for no limit | number | - | - | - | | auto-focus | Native attribute, auto focus, brings ...(EN_COMPOUNDS_AUTO_FOCUS)
[misspelling] ~129-~129: This word is normally spelled as one.
Context: ... | - | | auto-focus | Native attribute, auto focus, brings up keyboard | boolean | - | fal...(EN_COMPOUNDS_AUTO_FOCUS)
[uncategorized] ~131-~131: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...| - | | auto-height | Native attribute, auto increase height (style.height doesn't work when ...(AUTO_HYPHEN)
[grammar] ~156-~156: Possible typo detected: Did you mean to write ‘from’ instead of ‘form’?
Context: ...ation) | string | - | - | - | | rules | Form validation rules | FormItemRule[] | - |...(TYPO_FORM_FROM)
docs/en-US/component/badge.md (1)
7-7: 小建议：描述中可考虑添加连字符
在描述 Badge 显示位置时，“upper right”可改为“upper-right”以增强表达准确性。🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Consider adding a hyphen.
Context: ...ute, the badge will be displayed in the upper right corner of the element. ```html <wd-bad...(TOP_LEFT_CORNER)
docs/en-US/guide/custom-theme.md (1)
18-32: 品牌颜色渐变示例需确认角度描述一致性
代码中使用了linear-gradient(315deg, ...)，而说明文字提到了“Gradient angle 45 degrees”。建议确认是否需要调整描述或者代码，确保两者表达一致。docs/en-US/component/img.md (1)
118-124: Slots 参数表建议区分实例如可选
文档中出现两个 “Slots” 小节：一个是示例，一个是参数表。建议可以考虑改进标题或合并，避免重复造成阅读困扰。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
118-118: Multiple headings with the same content
null(MD024, no-duplicate-heading)
docs/en-US/component/button.md (2)
98-109: 自定义样式描述建议微调
关于 “Custom Style” 部分说明文本中，建议在描述 custom-class 用于添加 box-shadow 的部分检查标点符号（例如可能需要添加逗号以提高可读性）。🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: Possible missing comma found.
Context: ...ibutes to customize the button's style. Here we usecustom-classto add a `Materia...(AI_HYDRA_LEO_MISSING_COMMA)
144-146: 部分参数默认值格式建议统一
例如session-message-title的默认值描述“Current title”建议考虑统一格式或增加连字符，使描述风格与其他字段保持一致。🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: Consider adding a hyphen.
Context: ... "May want to send Mini Program" in the bottom right corner when the user enters the custome...(TOP_LEFT_CORNER)
docs/en-US/component/drop-menu.md (1)
123-164: 异步开关示例详尽并附有警告提示
此部分完整描述如何使用 before-toggle 函数实现异步开关操作，并结合 messageBox 弹窗进行状态确认。建议后续考虑将确认弹窗中的提示文本进行国际化配置，以便于文档多语言支持。docs/en-US/component/notice-bar.md (1)
52-59: 多行显示示例描述考虑语言优化
“Multi-line Display” 部分说明了如何通过设置 wrapable 与 scrollable 属性实现多行显示。建议在说明中补充定冠词（例如 “the wrapable property”）以提高英文的严谨性。🧰 Tools
🪛 LanguageTool
[uncategorized] ~54-~54: You might be missing the article “the” here.
Context: ...18px; } ``` ## Multi-line Display Setwrapableproperty to `true` and disable...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/en-US/component/count-to.md (2)
5-17: 基础用法说明详细但语言可更优化
列举了各属性的作用，如 endVal、startVal、duration 等，各句均以 “Set the …” 开头，存在一定重复性。建议适当变换句式以增强语言多样性。🧰 Tools
🪛 LanguageTool
[style] ~8-~8: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...property to specify the starting value. Set thedurationproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~9-~9: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...for number animation from start to end. Set theautoplayproperty to specify whet...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~10-~10: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... specify whether to play automatically. Set thedecimalsproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the number of decimal places to retain. Set thedecimalproperty to specify the d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ty to specify the decimal point symbol. Set theprefixproperty to specify the nu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... property to specify the number prefix. Set thesuffixproperty to specify the nu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... property to specify the number suffix. Set thefontSizeproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...izeproperty to specify the font size. Set thecolor` property to specify the tex...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
5-17: 语言风格改进建议
静态分析工具提示此部分存在连续句式重复问题，建议稍作修改来避免每句均以 “Set the” 开头，从而提升英文表达的多样性。🧰 Tools
🪛 LanguageTool
[style] ~8-~8: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...property to specify the starting value. Set thedurationproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~9-~9: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...for number animation from start to end. Set theautoplayproperty to specify whet...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~10-~10: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... specify whether to play automatically. Set thedecimalsproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the number of decimal places to retain. Set thedecimalproperty to specify the d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ty to specify the decimal point symbol. Set theprefixproperty to specify the nu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... property to specify the number prefix. Set thesuffixproperty to specify the nu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... property to specify the number suffix. Set thefontSizeproperty to specify the ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...izeproperty to specify the font size. Set thecolor` property to specify the tex...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en-US/guide/join-group.md (4)
17-22: 提问示例标点及格式建议
在“不正确示例”部分出现了多处疑问标点的混用，建议统一使用单一形式，确保标点风格一致。🧰 Tools
🪛 LanguageTool
[style] ~21-~21: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...mmon problems but still can't solve it. I've organized my minimal reproduction de...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
27-36: 社群部分及图片展示需注意细节
WeChat 官方账号说明以及图片展示部分清晰，但建议为 <img> 标签添加 alt 属性以提高无障碍支持，并确保图片描述完整。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
34-34: Images should have alternate text (alt text)
null(MD045, no-alt-text)
47-53: 快速定位问题提示部分格式建议
‘Quick Problem Location Tips’ 部分内容简洁明了，但建议调整强调符号（如用下划线替换星号）以符合 markdownlint 的要求，确保格式统一。🧰 Tools
🪛 LanguageTool
[style] ~52-~52: Style-wise, it’s not ideal to insert an adverb (‘quickly’) in the middle of an infinitive construction (‘to ask’). Try moving the adverb to avoid split infinitives.
Context: ....edu.cn/wiki/doc/smart-questions/), how to quickly ask the right questions. 6. The communication groups mainly pro...(SPLIT_INFINITIVE)
🪛 markdownlint-cli2 (0.17.2)
47-47: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
47-47: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
<script setup> 部分代码引入 Element Plus 的组件和 Vue 的 ref，handleClick 函数在未勾选时弹出提示，逻辑严谨。建议未来将提示文本外部化以支持国际化。
57-74: 脚本部分逻辑完整且易读docs/en-US/component/loading.md (1)
`21-28`: **颜色修改说明及警告需要细化：** “Modify Color” 部分中，警告区说明了在小程序中需要使用十六进制颜色值。不过建议针对静态分析提示，将“does not accept abbreviated color values”中的描述改为“不能使用简写形式的颜色值”，以使表述更加严谨。🧰 Tools
🪛 LanguageTool
[style] ~26-~26: Consider replacing this word to strengthen your wording. Context: ...color must be a hexadecimal color value and does not accept abbreviated color value... (AND_THAT)docs/en-US/component/keyboard.md (1)
`220-230`: **语言表述建议优化：** 根据静态分析提示，建议检查事件描述部分（例如“Triggered when delete key is pressed”）是否应改为“Triggered when the delete key is pressed”，以确保语法准确。🧰 Tools
🪛 LanguageTool
[uncategorized] ~222-~222: You might be missing the article “the” here. Context: ...pressed key | | delete | Triggered when delete key is pressed | - | | close | Triggere... (AI_EN_LECTOR_MISSING_DETERMINER_THE)docs/en-US/component/message-box.md (2)
`22-24`: **提示语句需优化：** 文档中 Alert 对话框的描述中连续几句话均以“Alert”开头，建议重构叙述以避免重复，提升可读性。🧰 Tools
--- `192-200`: **自定义操作按钮说明可优化：** “Custom Operation Buttons” 部分提到 “For specific details, refer to [Button Attributes]…”，建议将描述简化，例如直接说明“详情请参见 [Button Attributes]”，避免冗余。🪛 LanguageTool
[style] ~22-~22: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ...ge.alert('Operation successful') } ``` Alert dialog with title. ```html🧰 Tools
🪛 LanguageTool
[style] ~194-~194: This phrase is redundant. Consider writing “details”. Context: ...-props` and `confirm-button-props`. For specific details, refer to [Button Attributes](/componen... (SPECIFIC_DETAILS)docs/en-US/component/sticky.md (2)
`1-4`: **注释：文档标题和简介说明** 文档开头的 “Sticky” 标题和简介较为清晰，能够很好地传达该组件的用途，格式统一，建议保持当前风格。 --- `50-56`: **注释：offset-top 部分说明建议改进符号** “Offset Top” 部分描述了如何利用 `offset-top` 设置组件与顶部的距离，示例计算 “20 - 44 = -24” 表达正确。建议考虑使用 en dash（–）替代简单连字符以提高数值范围表述的准确性。🧰 Tools
🪛 LanguageTool
[typographical] ~54-~54: If you want to indicate numerical ranges or time ranges, consider using an en dash. Context: ...ou want a sticky distance of 20px, then `offset-top = 20 - 44 = -24` ::: ```htmldocs/en-US/component/datetime-picker.md (5)
`5-9`: **注释：基本用法描述建议完善语法** 基本用法部分说明使用 `v-model` 的绑定及默认类型的功能描述已相当清晰。建议在部分句子中适当加入定冠词 “the” 来使英文表达更严谨，虽然对理解无太大影响。--- `37-40`: **注释：日期类型用法描述** 对 `date` 类型只显示年、月、日的说明简单明了，但建议语言上补充定冠词以提高表述完整性。 --- `48-54`: **注释：年月类型说明建议调整语法** “Year-Month Type” 部分说明仅显示年和月，示例描述清楚。建议在描述中适当加入定冠词 “the” 以使语句更完整。🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: You might be missing the article “the” here. Context: ...nding value is of type `timestamp`. For `time` type, the binding value is a strin... (AI_EN_LECTOR_MISSING_DETERMINER_THE)🧰 Tools
--- `59-65`: **注释：年份类型描述简洁** 对 `year` 类型的说明直接明了，但在语言表达上建议补充定冠词以增强句子完整性。🪛 LanguageTool
[uncategorized] ~50-~50: You might be missing the article “the” here. Context: ...h Type `year-month` type only displays year and month. ```html🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: You might be missing the article “the” here. Context: ...## Year Type `year` type only displays year. ```html🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: Did you mean: “By default,”? Context: ... | Background color when switch is off. By default it's white, so there's a gray border. I... (BY_DEFAULT_COMMA)docs/en-US/component/tooltip.md (1)
`21-25`: **警告提示描述建议优化** 在 warning block（行 23-25）中，描述“if there is a scenario where the user manually clicks somewhere outside of `tooltip`…”时，建议简化表述，例如改为：“如果用户点击了 tooltip 外部的元素（例如用于展开 tooltip 的按钮），请为该按钮添加点击事件以阻止事件冒泡，避免意外关闭 tooltip。” 这有助于提高语言表达的简洁度和可读性。🧰 Tools
🪛 LanguageTool
[style] ~24-~24: This phrase is redundant. Consider using “outside”. Context: ...here the user manually clicks somewhere outside of `tooltip` like a button to slide out `t... (OUTSIDE_OF)docs/en-US/component/input-number.md (1)
`1-4`: **组件描述建议微调** 文件标题和开头描述虽简明，但建议在描述中适当添加冠词以符合英语语法习惯（例如，“an InputNumber”），提升文档的语言准确性。🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: You might be missing the article “an” here. Context: # InputNumber Composed of increase button, decrease button and input box, ... (AI_EN_LECTOR_MISSING_DETERMINER_AN) --- [uncategorized] ~3-~3: You might be missing the article “a” here. Context: ...putNumber Composed of increase button, decrease button and input box, used for inputtin... (AI_EN_LECTOR_MISSING_DETERMINER_A) --- [uncategorized] ~3-~3: You might be missing the article “an” here. Context: ...of increase button, decrease button and input box, used for inputting and adjusting n... (AI_EN_LECTOR_MISSING_DETERMINER_AN)🪛 markdownlint-cli2 (0.17.2)
1-1: Headings must start at the beginning of the line null (MD023, heading-start-left)docs/en-US/component/segmented.md (1)
`5-9`: **使用场景描述明确** “When To Use” 部分简洁明了地列出了使用该组件的场景，建议在描述中补充一些实际场景的例子，以便用户更容易理解实际应用。docs/en-US/component/text.md (2)
`72-79`: **建议完善描述中的冠词用法** 当前“Maximum value is 5”缺少定冠词，建议修改为 “The maximum value is 5” 来使表达更准确。🧰 Tools
--- `68-73`: **预览示例图片缺少 alt 属性** “Preview” 部分中多个图片标签未设置 alt 属性，建议为微信、支付宝、H5 及 Android 的预览图分别添加适当的描述文本，如 `alt="微信预览"`、`alt="支付宝预览"`、`alt="H5 预览"`、`alt="Android 预览"`。🪛 LanguageTool
[uncategorized] ~74-~74: A determiner appears to be missing. Consider inserting it. Context: ... the text exceeds this number of lines. Maximum value is 5. ```html🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
31-31: Images should have alternate text (alt text) null (MD045, no-alt-text)--- `90-91`: **优化示例措辞** “Feel free to submit your case” 建议更换为“欢迎提交您的案例”，以使文档语言更为专业。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
69-69: Images should have alternate text (alt text) null (MD045, no-alt-text) --- 70-70: Images should have alternate text (alt text) null (MD045, no-alt-text) --- 71-71: Images should have alternate text (alt text) null (MD045, no-alt-text) --- 72-72: Images should have alternate text (alt text) null (MD045, no-alt-text)--- `92-97`: **贡献指南链接措辞调整** 在 Contributing 部分建议避免频繁使用 “feel free to”，可考虑改为“请阅读”或“欢迎提交”，以提升专业度。🧰 Tools
🪛 LanguageTool
[style] ~90-~90: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. Context: ...ributions of excellent demos and cases. Feel free to submit your case in this [issue](https:... (FEEL_FREE_TO_STYLE_ME)--- `101-104`: **贡献者图片缺少描述** 贡献者展示部分的图片标签缺少 alt 属性，建议为该图片添加诸如 “贡献者头像” 的描述。🧰 Tools
🪛 LanguageTool
[style] ~94-~94: Consider shortening or rephrasing this to strengthen your wording. Context: ...uide](./.github/CONTRIBUTING.md) before making changes to the code. If you encounter any issues,... (MAKE_CHANGES)--- `121-123`: **捐赠二维码图片 alt 属性缺失** 在“Scan to Donate” 部分的二维码图片中未设置 alt 属性，建议分别添加 `alt="微信捐赠二维码"` 与 `alt="支付宝捐赠二维码"`。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
103-103: Images should have alternate text (alt text) null (MD045, no-alt-text)--- `133-133`: **许可协议措辞优化** “Feel free to enjoy and participate in open source” 可优化为“欢迎享受并参与开源项目”，从而显得更加专业。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
121-121: Images should have alternate text (alt text) null (MD045, no-alt-text) --- 122-122: Images should have alternate text (alt text) null (MD045, no-alt-text)🧰 Tools
🪛 LanguageTool
[style] ~133-~133: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. Context: ...s://en.wikipedia.org/wiki/MIT_License). Feel free to enjoy and participate in open source. ... (FEEL_FREE_TO_STYLE_ME)docs/en-US/component/picker-view.md (1)
`66-100`: **多级联动示例** 多级联动部分详细演示了如何根据当前选择动态修改其他列数据，示例代码中对异步操作的处理较为恰当。建议在说明中稍作润色，以使表述更为流畅。🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: You might be missing the article “the” here. Context: ...]) ``` ## Multi-level Linkage Pass in `column-change` property, which is a func... (AI_EN_LECTOR_MISSING_DETERMINER_THE)docs/en-US/component/collapse.md (2)
`1-4`: **Collapse 组件文档** 标题及开篇介绍基本描述了组件功能，建议在描述中增加适当过渡词，使句子更连贯（例如补充主语）。--- `158-186`: **嵌套使用示例** 嵌套使用部分展示了如何在 CollapseItem 内部嵌套另一个 Collapse 组件，并通过自定义样式解决默认内边距问题。建议在文案中补充完整句子，例如在“collapse can be nested”前增加主语。🧰 Tools
🪛 LanguageTool
[uncategorized] ~2-~2: Possible missing preposition found. Context: # Collapse Place a group of content in multiple collapsi... (AI_HYDRA_LEO_MISSING_TO)🧰 Tools
🪛 LanguageTool
[style] ~160-~160: To form a complete sentence, be sure to include a subject. Context: ...lapse> ``` ## Nested Usage `collapse` can be nested, and since the content contai... (MISSING_IT_THERE)docs/en-US/component/floating-panel.md (2)
`1-4`: **文档标题与组件描述** 文档标题“FloatingPanel”及下面的描述基本能传达组件用途，但建议考虑使描述更加连贯，例如适当加入连接词，使语句读起来更顺畅。--- `68-76`: **重复 CSS 样式注意** 此处再次定义的 `.inner-content` 样式与前文重复，建议考虑复用已有样式以避免冗余。🧰 Tools
🪛 LanguageTool
[uncategorized] ~2-~2: Possible missing preposition found. Context: # FloatingPanel A panel floating at the bottom of the pag... (AI_HYDRA_LEO_MISSING_IN)docs/en-US/component/grid.md (3)
`19-32`: **自定义列数说明** 详细说明如何使用 `column` 属性来定制网格列数，同时示例代码展示了设置 3 列的效果。建议可适当补充主语以增强描述完整性。--- `34-37`: **自定义背景颜色说明** 说明了如何使用 `bg-color` 属性定制背景颜色，描述虽简短但准确，建议检查语句完整性。🧰 Tools
🪛 LanguageTool
[style] ~21-~21: To form a complete sentence, be sure to include a subject. Context: ...-grid> ``` ## Custom Columns `column` can be used to customize the number of grid... (MISSING_IT_THERE)--- `130-144`: **自定义样式说明** 文档详细说明了如何利用 `custom-class` 自定义 GridItem 的样式，并列出注意事项。建议注意事项措辞可以更委婉。🧰 Tools
🪛 LanguageTool
[style] ~36-~36: To form a complete sentence, be sure to include a subject. Context: ... ## Custom Background Color `bg-color` can be used to customize the grid backgroun... (MISSING_IT_THERE)🧰 Tools
🪛 LanguageTool
[style] ~140-~140: Consider using a more polite wording. Context: ...dItem` styles are the same. - **If you want to change the height of `GridItem`, don... (IF_YOU_WANT) --- [style] ~142-~142: Consider using a more polite wording. Context: ...fy individual `GridItem`.** - **If you want to change the `icon` size, set the `ico... (IF_YOU_WANT)docs/en-US/component/signature.md (1)
`195-198`: **横屏签名页面说明简洁** 简单描述了如何创建横屏签名页面，信息明确。可考虑在未来提供更详细的示例。.vscode/settings.json (2)
`83-90`: **Locale 相关配置更新正确** “i18n-ally.keysInUse” 与 “i18n-ally.localesPaths” 已调整为项目相应的语言标识与路径，确保能正确读取国际化文件。若有需要，可生成脚本验证文件路径是否存在。 --- `91-112`: **忽略抽取配置建议优化** 配置的 "i18n-ally.extract.ignored" 列表中包含了一系列忽略项，能够防止不需要翻译的文本被抽取。注意部分条目（如 "bottom left"、"bottom right"）存在重复，建议整理合并以提升配置维护性。docs/en-US/component/sidebar.md (1)
`17-32`: **徽标提示部分说明详实** 文档描述通过设置 `is-dot` 属性显示小红点，以及通过 `badge` 属性展示徽标，示例代码正确。注意静态分析工具建议在描述中“upper right”部分添加连字符，请确认文案在国际化后输出正确。🧰 Tools
🪛 LanguageTool
[uncategorized] ~23-~23: Consider adding a hyphen. Context: ... small red dot will be displayed in the upper right corner. Setting the `badge` property wi... (TOP_LEFT_CORNER) --- [uncategorized] ~23-~23: Consider adding a hyphen. Context: ... display the corresponding badge in the upper right corner. ```html🛑 Comments failed to post (4)
docs/en-US/component/overlay.md (1)
16-16: _⚠️ Potential issue_ **文档中存在不一致的组件描述** 这里提到可以通过 `type` 属性修改指示器类型，但在属性表格（第44-50行）中没有列出 `type` 属性。这看起来像是文档错误或与其他组件内容混淆。 建议检查此描述是否属于 Overlay 组件，如不属于，请移除或修正此段落。docs/en-US/guide/typography.md (1)
123-123: _⚠️ Potential issue_ **修正字体名称拼写错误** 在 font-family 代码中，"Roboto" 被错误拼写为 "Rotobo"。这会导致字体无法正确应用。 ```diff -font-family: "San Francisco", Rotobo, arial, "PingFang SC", "Noto SansCJK", "Microsoft Yahei", sans-serif; +font-family: "San Francisco", Roboto, arial, "PingFang SC", "Noto SansCJK", "Microsoft Yahei", sans-serif; ```📝 Committable suggestion
>‼️ **IMPORTANT** > Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements. `````suggestion font-family: "San Francisco", Roboto, arial, "PingFang SC", "Noto SansCJK", "Microsoft Yahei", sans-serif; `````docs/en-US/component/picker.md (1)
13-20: _⚠️ Potential issue_ **TypeScript 基本示例存在变量命名冲突问题** 在示例代码中，`handleConfirm({ value })` 内部使用 `value.value = value` 会造成命名冲突，导致事件参数与外部响应式变量混淆。建议将事件参数重命名，例如： ```diff -function handleConfirm({ value }) { - value.value = value -} +function handleConfirm({ value: selectedValue }) { + value.value = selectedValue +} ```📝 Committable suggestion
>‼️ **IMPORTANT** > Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements. `````suggestion `````docs/en-US/component/collapse.md (1)
61-127: _🛠️ Refactor suggestion_ **异步更新示例** 通过 `beforeExpend` 回调来实现面板展开前的异步操作示例思路清晰，但注意回调中拼写错误：应将 `reslove` 修改为 `resolve`。 建议修改示例如下： ```diff - return new Promise((reslove, reject) => { - toast.loading('Loading') - setTimeout(() => { - toast.close() - reslove(true) - }, 500) - }) + return new Promise((resolve, reject) => { + toast.loading('Loading') + setTimeout(() => { + toast.close() + resolve(true) + }, 500) + }) ```📝 Committable suggestion
>‼️ **IMPORTANT** > Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements. `````suggestion ## Asynchronous Update By passing a `beforeExpend` function to the `wd-collapse-item` component, you can validate and process before opening the panel. Return true to allow opening, return false to prohibit opening. Supports returning Promise for operations such as fetching panel data through API calls. `````
1 participant
🤔 这个 PR 的性质是？(至少选择一个)
🔗 相关 Issue
💡 需求背景和解决方案
引入vue-i18n实现组件库文档和组件库演示项目国际化同步
☑️ 请求合并前的自查清单
Summary by CodeRabbit
文档
新功能
维护更新