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: add left and right scroll buttons to Tabs bar #4161 #4162

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

P2K0
Copy link
Contributor

@P2K0 P2K0 commented Aug 15, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Added scroll functionality to the tab bar, enhancing user interaction with horizontal scrolling.
    • Integrated new icons for left and right scrolling actions within the tab bar.
    • Introduced a new library for Vue.js icon support to improve UI design.
  • Improvements

    • Added an id attribute to the scrollbar components for better accessibility and targeting in styling.

Copy link

changeset-bot bot commented Aug 15, 2024

⚠️ No Changeset found

Latest commit: 2799ad6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Walkthrough

The recent changes enhance the tab components in the UI kit, focusing on accessibility and usability. Key updates include the addition of an id attribute to scrollbar components for improved targeting and the introduction of horizontal scrolling functionality in the tab bar. New icons have also been integrated, enriching user interaction and overall experience when navigating through tabs.

Changes

Files Change Summary
.../tabs-ui/src/components/tabs-chrome/tabs.vue Added id="tabs-scrollbar" to <VbenScrollbar> for improved accessibility.
.../tabs-ui/src/components/tabs/tabs.vue Added id="tabs-scrollbar" to <VbenScrollbar> to enhance accessibility and targeting.
.../effects/layouts/package.json Added dependency @radix-icons/vue with version ^1.0.0 for Vue.js icon support.
.../effects/layouts/src/basic/tabbar/tabbar.vue Introduced useTabViewScroll for scroll functionality; added ChevronLeftIcon and ChevronRightIcon for navigation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TabBar
    participant ScrollBar

    User->>TabBar: Scroll left/right
    TabBar->>ScrollBar: Trigger scroll action
    ScrollBar-->>TabBar: Update view
    TabBar->>User: Display updated tabs
Loading

Poem

🐇
In the land of tabs, oh what a sight,
Scroll left, scroll right, with joy and delight!
A new ID added for all to see,
Icons to cheer, as happy as can be.
Hopping along with features so grand,
Our tabbed adventures are simply well-planned!
🌟


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
Contributor

@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 e2d9d08 and d19ed3e.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (4)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue (1 hunks)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue (1 hunks)
  • packages/effects/layouts/package.json (1 hunks)
  • packages/effects/layouts/src/basic/tabbar/tabbar.vue (4 hunks)
Files skipped from review due to trivial changes (2)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue
  • packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue
Additional comments not posted (4)
packages/effects/layouts/package.json (1)

23-23: Dependency Addition: @radix-icons/vue.

The addition of the @radix-icons/vue package is appropriate given the new icon usage in the tabbar.vue component. Ensure that the package is correctly installed and used across the project.

packages/effects/layouts/src/basic/tabbar/tabbar.vue (3)

Line range hint 2-17:
New Imports for Scrolling and Icons.

The imports for onMounted, ChevronLeftIcon, ChevronRightIcon, and useTabViewScroll are appropriate for the new scrolling functionality and icon usage in the tab bar. Ensure these are correctly integrated and utilized throughout the component.


59-68: Scroll Elements Initialization.

The onMounted hook correctly initializes the scroll elements by querying the DOM and setting them with setScrollBarEl and setScrollViewEl. Ensure that the element selectors are accurate and that the elements exist in the DOM when this code runs.


Line range hint 72-94:
Template Enhancements for Scrolling.

The addition of ChevronLeftIcon and ChevronRightIcon in the template provides intuitive controls for scrolling through tabs. The @click events are appropriately set to call scrollDirection with the correct parameters. Ensure that the scrollDirection method is implemented correctly to handle these actions.

@P2K0 P2K0 changed the title feat: Tabs栏 增加左右滚动按钮 (#4161) feat: add left and right scroll buttons to Tabs bar #4161 Aug 15, 2024
Copy link
Contributor

@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 d19ed3e and 2799ad6.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (5)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue (1 hunks)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue (1 hunks)
  • packages/effects/layouts/package.json (1 hunks)
  • packages/effects/layouts/src/basic/tabbar/tabbar.vue (4 hunks)
  • packages/effects/layouts/src/basic/tabbar/use-tab-view-scroll.ts (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue
  • packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue
  • packages/effects/layouts/package.json
  • packages/effects/layouts/src/basic/tabbar/tabbar.vue
Additional comments not posted (4)
packages/effects/layouts/src/basic/tabbar/use-tab-view-scroll.ts (4)

9-11: LGTM!

The setScrollBarEl function is straightforward and correctly assigns the element to the reactive reference.


13-15: LGTM!

The setScrollViewEl function is straightforward and correctly assigns the element to the reactive reference.


17-27: LGTM!

The getScrollClientWidth function correctly calculates and returns the client widths of the scrollbar and viewport elements, handling null cases appropriately.


29-43: LGTM!

The scrollDirection function correctly handles scrolling logic with smooth behavior, ensuring checks for element existence and appropriate conditions for scrolling.

@anncwb anncwb added the feature label Aug 15, 2024
@anncwb anncwb self-requested a review August 15, 2024 13:51
@anncwb anncwb merged commit eb280ff into vbenjs:main Aug 15, 2024
16 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants