Skip to content
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.

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

feat: ✨ count-to组件添加type属性 #556

Merged

Conversation

wyl086
Copy link
Contributor

@wyl086 wyl086 commented Aug 24, 2024

🤔 这个 PR 的性质是?(至少选择一个)

  • 日常 bug 修复
  • 新特性提交
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • CI/CD 改进
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 代码重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

💡 需求背景和解决方案

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充

Summary by CodeRabbit

  • 新功能

    • 更新了 wd-count-to 组件文档,新增 type 参数,以支持多种文本主题(primaryerrorsuccesswarningdefault)。
    • 在示例中添加了“设置主题”的演示,展示不同类型的 wd-count-to 组件用法。
  • 文档

    • 组件文档结构更为清晰,改善了可读性,确保所有部分格式一致。

Copy link

netlify bot commented Aug 24, 2024

Deploy Preview for wot-design-uni ready!

Name Link
🔨 Latest commit 2a26381
🔍 Latest deploy log https://app.netlify.com/sites/wot-design-uni/deploys/66c997ba1161220007a1080e
😎 Deploy Preview https://deploy-preview-556--wot-design-uni.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

vercel bot commented Aug 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wot-design-uni ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 24, 2024 8:21am

Copy link

coderabbitai bot commented Aug 24, 2024

Walkthrough

本次更改对wd-count-to组件及相关文档进行了显著增强。新增type参数,允许用户设置文本主题,并更新了属性表以包含该参数。同时,演示和组件逻辑进行了修改,以支持新的主题样式。所有相关文档结构和格式也得到了优化。

Changes

文件路径 更改摘要
docs/component/count-to.md 添加type参数说明及例子,更新属性表,调整文档结构和格式。
src/pages/countTo/Index.vue 新增“设置主题”演示,展示不同type属性配置的wd-count-to组件实例。
src/uni_modules/wot-design-uni/components/wd-count-to/types.ts 新增type属性到countToProps对象,设置默认值为'default'
src/uni_modules/wot-design-uni/components/wd-count-to/wd-count-to.vue 在三个插槽中为<wd-text>组件添加:type属性。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant wd-count-to
    participant wd-text

    User->>wd-count-to: 设置组件属性(type)
    wd-count-to->>wd-text: 传递文本和类型
    wd-text->>User: 渲染带有主题样式的文本
Loading

兔子蹦蹦跳跳,欢声嬉戏,
新功能加入,乐趣无比。
主题多样,效果奇妙,
数字也能,轻松展现。
咕噜咕噜,跳跃不息,
代码更新,兔子欢喜! 🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between febe730 and 437eddc.

Files selected for processing (7)
  • docs/component/count-to.md (2 hunks)
  • docs/component/text.md (1 hunks)
  • src/pages/countTo/Index.vue (1 hunks)
  • src/uni_modules/wot-design-uni/components/wd-count-to/types.ts (2 hunks)
  • src/uni_modules/wot-design-uni/components/wd-count-to/wd-count-to.vue (1 hunks)
  • src/uni_modules/wot-design-uni/components/wd-text/types.ts (2 hunks)
  • src/uni_modules/wot-design-uni/components/wd-text/wd-text.vue (1 hunks)
Additional comments not posted (7)
src/uni_modules/wot-design-uni/components/wd-count-to/types.ts (1)

13-19: 新增 type 属性的更改已批准。

type 属性的添加增强了组件的可配置性,并与预定义的文本类型保持一致。

src/pages/countTo/Index.vue (1)

10-16: 新增的演示块已批准。

新的演示块有效地展示了 wd-count-to 组件的 type 属性,为用户提供了视觉示例。

src/uni_modules/wot-design-uni/components/wd-text/wd-text.vue (1)

127-127: 更改已批准:确保文本类型一致性

text 转换为字符串以确保类型一致性是一个很好的做法,可以防止潜在的类型错误。

src/uni_modules/wot-design-uni/components/wd-count-to/wd-count-to.vue (1)

5-13: 更改已批准:增强的灵活性

通过在 <wd-text> 组件中添加 :type 属性,增强了组件的灵活性,使其能够根据指定类型调整渲染。

docs/component/text.md (1)

152-152: 更改已批准:增强的参数灵活性

text 参数类型从 string 更改为 string / number 提高了灵活性,允许接受数字值。

docs/component/count-to.md (2)

78-92: 属性表更新良好

type参数的添加清晰且一致,默认值和可选值已正确指定。


Line range hint 1-122: 文档结构和格式改进良好

整体结构和格式的改进提高了可读性,并在各个部分保持了一致性。

Comment on lines 17 to 20
* 类型:string | string
* 默认值:'空字符串'
*/
text: makeStringProp(''),
text: makeNumericProp(''),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正文档注释中的类型说明。

注释中提到的类型为 string | string,这似乎是一个错误。考虑到 makeNumericProp 的使用,类型应该是 string | number

请应用以下更改来修正注释:

 /**
  * 文字
- * 类型:string | string
+ * 类型:string | number
  * 默认值:'空字符串'
 */
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.

Suggested change
* 类型:string | string
* 默认值:'空字符串'
*/
text: makeStringProp(''),
text: makeNumericProp(''),
/**
* 文字
* 类型:string | number
* 默认值:'空字符串'
*/
text: makeNumericProp(''),

Comment on lines +25 to +35
## 设置主题

通过<code>type</code>参数设置文本主题,我们提供了五类属性:<code>primary</code> <code>error</code> <code>success</code> <code>warning</code> <code>default-默认</code>。

```html
<wd-count-to type="primary" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="error" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="success" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="warning" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="info" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
```
Copy link

@coderabbitai coderabbitai bot Aug 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正示例中的info类型

在设置主题部分,info类型不在提供的五种属性中。请确认是否需要添加或删除该示例。

如果info类型是有效的,请更新文档以包含该选项;否则,请移除示例中的info类型。

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wyl086 此处确实如rabbit所说,info类型不在提供的五种属性中。

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

@wyl086 wyl086 force-pushed the feature/count-to/add-type-prop branch from 437eddc to 2a26381 Compare August 24, 2024 08:20
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 437eddc and 2a26381.

Files selected for processing (4)
  • docs/component/count-to.md (2 hunks)
  • src/pages/countTo/Index.vue (1 hunks)
  • src/uni_modules/wot-design-uni/components/wd-count-to/types.ts (2 hunks)
  • src/uni_modules/wot-design-uni/components/wd-count-to/wd-count-to.vue (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • docs/component/count-to.md
  • src/pages/countTo/Index.vue
  • src/uni_modules/wot-design-uni/components/wd-count-to/types.ts
  • src/uni_modules/wot-design-uni/components/wd-count-to/wd-count-to.vue

Comment on lines +25 to +35
## 设置主题

通过<code>type</code>参数设置文本主题,我们提供了五类属性:<code>primary</code> <code>error</code> <code>success</code> <code>warning</code> <code>default-默认</code>。

```html
<wd-count-to type="primary" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="error" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="success" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="warning" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
<wd-count-to type="info" prefix="¥" :startVal="0" :endVal="888888" suffix="%"></wd-count-to>
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wyl086 此处确实如rabbit所说,info类型不在提供的五种属性中。

@Moonofweisheng Moonofweisheng merged commit 60c92f2 into Moonofweisheng:master Sep 12, 2024
6 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 16, 2024
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants