Feature: Add use-scroll hook

[matiaspompilio]

What's this PR do?

This PR adds the use-scroll hook which, given a reference to an element, can scroll the element when it is in overflow.

@ulises-jeremias @rpmolina

Summary by CodeRabbit

• New Features
  • Introduced a useScroll hook for smooth scrolling functionality in React components.
  • Added a new Example component showcasing the use of the useScroll hook with interactive elements.

[coderabbitai]

Walkthrough

The codebase has been updated to include a new useScroll hook within the @nanlabs/react-hooks library. This hook, aimed at enhancing scrolling capabilities, is now available for use in React components. An Example component demonstrates the hook's functionality by enabling horizontal scrolling for a series of boxes in a container, with buttons to scroll left and right.

Changes

File Path	Change Summary
.../useScroll.stories.tsx	Added Example component using useScroll for scrollable boxes with left/right buttons.
.../react-hooks/index.ts .../use-scroll/index.ts	Exported new use-scroll hook and created file to export the useScroll hook.
.../use-scroll/useScroll.ts	Introduced useScroll hook with elementRef parameter and scroll function for smooth scrolling.

Poem

🐇
In the code, there's a playful hop,
A useScroll hook lands with a gentle plop.
Boxes glide left and right at a command,
Crafted by paws in a digital land. 🌟
🐇

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between be2d849 and c637563.

Files selected for processing (4)

• apps/playground/src/stories/hooks/useScroll.stories.tsx (1 hunks)
• packages/react-hooks/index.ts (1 hunks)
• packages/react-hooks/use-scroll/index.ts (1 hunks)
• packages/react-hooks/use-scroll/useScroll.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• packages/react-hooks/use-scroll/index.ts

Additional comments: 6

packages/react-hooks/index.ts (1)

• 17-17: The export statement for use-scroll is correctly added and follows the existing pattern of export statements in the file.

packages/react-hooks/use-scroll/useScroll.ts (3)

• 3-5: The UseScrollParams type is correctly defined with an elementRef of type React.RefObject<HTMLElement>.
• 7-12: The ScrollDirections enum is correctly defined with appropriate direction values.
• 14-42: The useScroll function is well-implemented, using useCallback for performance optimization and handling the scrolling logic as expected.

apps/playground/src/stories/hooks/useScroll.stories.tsx (2)

• 11-33: The Box component is correctly implemented using forwardRef to pass a ref to the div element.
• 35-71: The Example component effectively demonstrates the usage of the useScroll hook with a well-structured example and appropriate event handlers.

[ulises-jeremias]

just one comment, the rest looks great! thanks for this PR!

[ulises-jeremias]

could you change this type to use sum types instead of enums? Enums are less recommended in TS

[matiaspompilio]

Sounds good!

[matiaspompilio]

New changes were added. Please review 🙌

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c637563 and 308ba5f.

Files selected for processing (1)

• packages/react-hooks/use-scroll/useScroll.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• packages/react-hooks/use-scroll/useScroll.ts