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(drag): add the ability to support onDrag, onDragStart, onDragEnd callbacks #2418

Merged
merged 2 commits into from
Jul 5, 2024

Conversation

Alex-huxiyang
Copy link
Collaborator

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

新增支持onDrag,onDragStart,onDragEnd回调函数的能力

  • 新特性提交
  • 站点、文档改进
  • 演示代码改进

Summary by CodeRabbit

  • 新功能
    • Drag 组件添加了拖拽事件处理功能,包括 onDragStartonDragonDragEnd
    • 更新了相关文档,详细说明了新的事件处理程序的用法和用例。

Copy link

coderabbitai bot commented Jul 5, 2024

Walkthrough

在此次更改中,主要为拖拽组件新增了事件处理程序:onDragStartonDragonDragEnd。这些事件处理程序记录了拖拽元素的相关状态,同时更新了相应的文档以反映这些新增功能,从而提升组件的交互能力。

Changes

文件 变更摘要
src/.../h5/demo1.tsx 新增了拖拽开始、拖拽进行和拖拽结束的事件处理程序,并记录状态。
src/.../taro/demo1.tsx 同步新增事件处理程序以及拖拽组件的样式更新。
src/packages/drag/doc.*.md 更新文档以包含新添加的事件处理程序及其签名。
src/packages/drag/drag.taro.tsx DragProps接口添加了onDragStartonDragEndonDrag事件处理程序。
src/packages/drag/drag.tsx 引入新的DragState接口并更新DragProps以处理新事件。

Poem

在代码的森林里,
兔子跳跃不停息。
拖拽功能添新技,
开始结束都有序。
轻轻拖拽记录起,
组件交互更华丽。 🌟


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c93a5db and 262b479.

Files selected for processing (2)
  • src/packages/drag/drag.taro.tsx (6 hunks)
  • src/packages/drag/drag.tsx (4 hunks)
Files skipped from review as they are similar to previous changes (2)
  • src/packages/drag/drag.taro.tsx
  • src/packages/drag/drag.tsx

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 Configration 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 5, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jul 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.01%. Comparing base (958d83d) to head (262b479).
Report is 2 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2418      +/-   ##
==========================================
+ Coverage   85.98%   86.01%   +0.02%     
==========================================
  Files         217      217              
  Lines       22833    22855      +22     
  Branches     2542     2545       +3     
==========================================
+ Hits        19633    19658      +25     
+ Misses       3195     3192       -3     
  Partials        5        5              

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

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: 4

Comment on lines 89 to 91
onDragStart && first && onDragStart()
onDrag && onDrag({ offset: [x, y] })
onDragEnd && last && onDragEnd({ offset: [x, y] })
Copy link

Choose a reason for hiding this comment

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

优化可选链使用

在调用 onDragStart, onDrag, 和 onDragEnd 时,建议使用可选链操作符以确保安全调用。

- onDragStart && first && onDragStart()
- onDrag && onDrag({ offset: [x, y] })
- onDragEnd && last && onDragEnd({ offset: [x, y] })
+ first && onDragStart?.()
+ onDrag?.({ offset: [x, y] })
+ last && onDragEnd?.({ offset: [x, y] })
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
onDragStart && first && onDragStart()
onDrag && onDrag({ offset: [x, y] })
onDragEnd && last && onDragEnd({ offset: [x, y] })
first && onDragStart?.()
onDrag?.({ offset: [x, y] })
last && onDragEnd?.({ offset: [x, y] })
Tools
Biome

[error] 90-90: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Comment on lines 89 to 91
onDragStart && onDragStart()
const touches = e.touches[0]
axisCache.current = { x: touches.clientX, y: touches.clientY }
Copy link

Choose a reason for hiding this comment

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

优化可选链使用

在调用 onDragStart, onDrag, 和 onDragEnd 时,建议使用可选链操作符以确保安全调用。

- onDragStart && onDragStart()
+ onDragStart?.()
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
onDragStart && onDragStart()
const touches = e.touches[0]
axisCache.current = { x: touches.clientX, y: touches.clientY }
onDragStart?.()
const touches = e.touches[0]
axisCache.current = { x: touches.clientX, y: touches.clientY }
Tools
Biome

[error] 89-89: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Comment on lines 102 to 105
onDrag &&
onDrag({
offset: [translateX.current, translateY.current],
})
Copy link

Choose a reason for hiding this comment

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

优化可选链使用

在调用 onDrag 时,建议使用可选链操作符以确保安全调用。

- onDrag &&
-   onDrag({
-     offset: [translateX.current, translateY.current],
-   })
+ onDrag?.({
+   offset: [translateX.current, translateY.current],
+ })
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
onDrag &&
onDrag({
offset: [translateX.current, translateY.current],
})
onDrag?.({
offset: [translateX.current, translateY.current],
})
Tools
Biome

[error] 102-105: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Comment on lines 127 to 131
onDragEnd &&
onDragEnd({
offset: [translateX.current, translateY.current],
})
if (direction !== 'y' && attract && dragRef.current) {
Copy link

Choose a reason for hiding this comment

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

优化可选链使用

在调用 onDragEnd 时,建议使用可选链操作符以确保安全调用。

- onDragEnd &&
-   onDragEnd({
-     offset: [translateX.current, translateY.current],
-   })
+ onDragEnd?.({
+   offset: [translateX.current, translateY.current],
+ })
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
onDragEnd &&
onDragEnd({
offset: [translateX.current, translateY.current],
})
if (direction !== 'y' && attract && dragRef.current) {
onDragEnd?.({
offset: [translateX.current, translateY.current],
})
if (direction !== 'y' && attract && dragRef.current) {
Tools
Biome

[error] 127-131: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

@xiaoyatong xiaoyatong merged commit 9337a24 into jdf2e:next Jul 5, 2024
5 checks passed
@Alex-huxiyang Alex-huxiyang deleted the hxy/0705/drag 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.

[FR]: 希望Drag组件能添加位置变化的回调
2 participants