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: ✨ Search新增customInputClass,placeholderClass等属性 #845

Merged
merged 1 commit into from
Jan 18, 2025

Conversation

de1ck
Copy link
Contributor

@de1ck de1ck commented Jan 16, 2025

Closes: #299

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

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

🔗 相关 Issue

💡 需求背景和解决方案

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

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

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

Summary by CodeRabbit

  • 新功能

    • 为搜索组件添加了占位符样式自定义选项
    • 允许通过 placeholderStyleplaceholderClass 属性定制占位符外观
  • 弃用

    • 标记 use-suffix-slot 属性为已弃用,将在未来版本移除
  • 改进

    • 增加了输入框样式的自定义灵活性
    • 支持更精细的样式控制

Copy link

vercel bot commented Jan 16, 2025

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 Jan 16, 2025 6:16am

Copy link

coderabbitai bot commented Jan 16, 2025

总览

演练

此次更改为 wd-search 组件引入了两个新属性:placeholderStyleplaceholderClass,用于增强占位符文本的样式定制能力。同时,use-suffix-slot 属性被标记为已弃用。修改涉及文档更新、类型定义和组件实现,主要目的是提供更灵活的输入框样式自定义选项。

变更

文件 变更摘要
docs/component/search.md 更新文档,添加新属性说明,标记 use-suffix-slot 为已弃用
src/uni_modules/wot-design-uni/components/wd-search/types.ts 新增 customInputClassplaceholderStyleplaceholderClass 属性
src/uni_modules/wot-design-uni/components/wd-search/wd-search.vue 动态绑定 placeholder-styleplaceholder-classclass 属性

对链接问题的评估

目标 是否已解决 说明
为 Search 组件添加自定义输入类 [#299]

可能相关的 PR

诗歌

🐰 搜索组件,样式自由

占位符轻舞,类名飞扬

定制之风,悄然绽放

兔子微笑,代码如歌!

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, 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.

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. (Beta)
  • @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.

Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for wot-design-uni ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 10a826c
🔍 Latest deploy log https://app.netlify.com/sites/wot-design-uni/deploys/6788a3d6acf04b0008381dac
😎 Deploy Preview https://deploy-preview-845--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

@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: 1

🧹 Nitpick comments (2)
src/uni_modules/wot-design-uni/components/wd-search/types.ts (1)

14-14: 需要为 customInputClass 属性添加文档注释

为了保持代码一致性和可维护性,建议添加与其他属性相同格式的文档注释。

建议添加如下注释:

+  /**
+   * 输入框自定义样式类
+   * 类型: string
+   * 默认值: ''
+   */
   customInputClass: makeStringProp(''),
docs/component/search.md (1)

158-159: 需要更新版本占位符

文档中的 $LOWEST_VERSION$ 占位符需要替换为实际的最低支持版本号。

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1c29703 and 10a826c.

📒 Files selected for processing (3)
  • docs/component/search.md (2 hunks)
  • src/uni_modules/wot-design-uni/components/wd-search/types.ts (2 hunks)
  • src/uni_modules/wot-design-uni/components/wd-search/wd-search.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - wot-design-uni
  • GitHub Check: Header rules - wot-design-uni
  • GitHub Check: Pages changed - wot-design-uni
🔇 Additional comments (2)
src/uni_modules/wot-design-uni/components/wd-search/types.ts (1)

93-101: 属性定义和注释看起来不错!

placeholderStyle 和 placeholderClass 的属性定义清晰,注释说明充分。

docs/component/search.md (1)

184-184: 外部样式类文档完善

新增的 custom-input-class 样式类文档说明清晰。但同样需要更新版本占位符。

Comment on lines +14 to +15
:placeholder-class="`wd-search__placeholder-txt', ${placeholderClass}`"
:placeholder-style="placeholderStyle"
Copy link

@coderabbitai coderabbitai bot Jan 16, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

需要修复模板字符串语法并优化类名绑定

当前实现存在以下问题:

  1. placeholder-class 的模板字符串语法不正确
  2. 类名绑定可以更简洁

建议按如下方式修改:

-  :placeholder-class="`wd-search__placeholder-txt', ${placeholderClass}`"
+  :placeholder-class="['wd-search__placeholder-txt', placeholderClass]"

input 元素的其他属性绑定看起来正确。

Also applies to: 18-18

Copy link
Contributor Author

Choose a reason for hiding this comment

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

input placeholder-class ts类型仅支持string,所以无法按照数组传递参数

Copy link

Choose a reason for hiding this comment

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

@de1ck 感谢指出这个类型限制。我明白了 uni-app input 组件的 placeholder-class 只接受 string 类型。


✏️ Learnings added
Learnt from: de1ck
PR: Moonofweisheng/wot-design-uni#845
File: src/uni_modules/wot-design-uni/components/wd-search/wd-search.vue:14-15
Timestamp: 2025-01-16T07:45:18.744Z
Learning: In uni-app's input component, the placeholder-class attribute only accepts string type in TypeScript, not array. Therefore, class names must be concatenated as strings rather than bound as arrays.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@Moonofweisheng Moonofweisheng merged commit 03623f4 into Moonofweisheng:master Jan 18, 2025
6 checks passed
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.

[新功能需求] Search 新增 custom-input-class
2 participants