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

fix(swiper): correct onChange ts type #2493

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

Alex-huxiyang
Copy link
Collaborator

@Alex-huxiyang Alex-huxiyang commented Jul 29, 2024

  • TypeScript 定义更新

Summary by CodeRabbit

  • 新功能

    • 更新了Swiper组件的onChange回调类型,使其能够提供更详细的事件信息,提升了事件处理能力。
    • 在示例组件中引入新的onChange事件处理函数,增强了组件的交互能力。
  • 文档

    • 修正了Swiper组件文档中的onChange属性说明,以反映新的类型定义,增强了开发者的使用体验。

Copy link

coderabbitai bot commented Jul 29, 2024

Walkthrough

此次修改增强了Swiper组件的onChange属性的类型定义,旨在提供更详细的事件信息。onChange的回调参数类型从简单的数字更新为CommonEventFunction<TaroSwiperProps.onChangeEventDetail>,这使得开发者在切换卡片时可以访问更多的事件细节,从而提升了组件的可用性和开发体验。此外,新增加的示例演示了如何使用该功能,提高了组件的互动性。

Changes

文件路径 修改摘要
src/packages/swiper/doc.taro.md onChange类型改为CommonEventFunction<TaroSwiperProps.onChangeEventDetail>
src/packages/swiper/swiper.taro.tsx onChange类型改为CommonEventFunction<TaroSwiperProps.onChangeEventDetail>
src/packages/swiper/demos/taro/demo1.tsx 新增onChange事件处理函数,并将其与Swiper组件关联,提高交互性

Poem

在草地上跳跃的兔子,
点滴变化总不嫌多,
onChange变得更加明晰,
事件细节触手可及,
开发者欢笑声四起,
代码如春花般绚丽。 🐇✨


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

@Alex-huxiyang Alex-huxiyang linked an issue Jul 29, 2024 that may be closed by this pull request
@Alex-huxiyang Alex-huxiyang changed the title fix(swiper): correct ts type fix(swiper): correct onChange ts type Jul 29, 2024
Copy link

codecov bot commented Jul 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.06%. Comparing base (8488230) to head (3901f3a).

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2493   +/-   ##
=======================================
  Coverage   86.06%   86.06%           
=======================================
  Files         217      217           
  Lines       22859    22859           
  Branches     2549     2549           
=======================================
  Hits        19673    19673           
  Misses       3181     3181           
  Partials        5        5           

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

@oasis-cloud
Copy link
Collaborator

选择某一个 demo ,然后增加 onChange 属性,属性设置为 onChange={onChange},通过 const 声明 onChange 函数

@oasis-cloud oasis-cloud merged commit ac58ca4 into jdf2e:next Jul 29, 2024
5 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 13, 2024
20 tasks
@Alex-huxiyang Alex-huxiyang deleted the 729/swiper/onchange branch November 19, 2024 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swiper 组件 onChange 方法回调参数类型错误
2 participants