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

refactor(base-select): [base-select] remove tree/grid code from base-select #2522

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

kagol
Copy link
Member

@kagol kagol commented Nov 14, 2024

PR

主要更新:

  • 从 base-select 中移除 tree/grid 下拉树和下拉表格相关变量和方法

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Introduced new computed properties for dynamic icon and tag type handling.
    • Added methods for improved user input management, including clearing search text and updating selected data.
  • Bug Fixes

    • Enhanced error handling across various functions to prevent runtime exceptions.
  • Refactor

    • Removed outdated functions related to grid data handling, streamlining component logic and improving maintainability.
    • Adjusted expected height for the mini size variant in the select component tests.
  • Tests

    • Updated test assertions for the mini size variant of the select component to reflect new height expectations.

@kagol kagol added the refactoring Refactoring label Nov 14, 2024
Copy link

coderabbitai bot commented Nov 14, 2024

Walkthrough

The changes in this pull request involve modifications to the base-select component and its associated test suite. The test suite for size variations now includes updated height assertions for the 'mini' size variant and improved error handling. In the component's implementation, several functions related to grid handling have been removed or altered, streamlining data management and enhancing state handling. New computed properties have been added, and the overall structure has been refined to improve maintainability and performance.

Changes

File Path Change Summary
examples/sites/demos/pc/app/base-select/size.spec.ts Updated height assertion for 'mini' size variant, added error handling for page loads, and verified CSS class presence for size variants.
packages/renderless/src/base-select/index.ts Removed gridOnQueryChange and getcheckedData functions, modified initQuery, and enhanced error handling in handleQueryChange. Introduced computeOptimizeOpts.
packages/renderless/src/base-select/vue.ts Removed getcheckedData and gridOnQueryChange, added computedGetIcon and computedGetTagType, and simplified state management by removing several properties.

Possibly related PRs

Suggested reviewers

  • zzcr

🐰 "In the meadow, changes bloom,
The select component sheds old gloom.
With height adjusted, tests now sing,
A simpler flow, a lighter spring.
New icons and tags, oh what a delight,
In the world of code, everything feels right!" 🌼


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

@kagol kagol changed the title refactor(base-select): remove tree/grid code from base-select refactor(base-select): [base-select] remove tree/grid code from base-select Nov 14, 2024
Copy link

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 554e778 and aac37e5.

📒 Files selected for processing (3)
  • examples/sites/demos/pc/app/base-select/size.spec.ts (1 hunks)
  • packages/renderless/src/base-select/index.ts (0 hunks)
  • packages/renderless/src/base-select/vue.ts (0 hunks)
💤 Files with no reviewable changes (2)
  • packages/renderless/src/base-select/index.ts
  • packages/renderless/src/base-select/vue.ts

@@ -54,5 +54,5 @@ test('mini 尺寸', async ({ page }) => {

await expect(input).toHaveClass(/tiny-input-mini/)
await expect(tag.nth(0)).toHaveClass(/tiny-tag--mini tiny-tag--light/)
expect(height).toBeCloseTo(27, 1)
expect(height).toBeCloseTo(28, 1)
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Based on the shell script results, I can now make a definitive assessment. The results show that across different components:

  1. Mini size consistently has 24px height:

    • Input: await expect(mini).toHaveCSS('height', '24px')
    • Time Select: await expect(miniBox).toHaveCSS('height', '24px')
    • Autocomplete: await expect(miniSize).toHaveCSS('height', '24px')
    • Cascader: await expect(page.locator('.tiny-cascader.tiny-cascader--mini input')).toHaveCSS('height', '24px')
  2. Small size consistently has 28px height:

    • Input: await expect(small).toHaveCSS('height', '28px')
    • Time Select: await expect(smallBox).toHaveCSS('height', '28px')
    • Autocomplete: await expect(smallSize).toHaveCSS('height', '28px')
    • Cascader: await expect(page.locator('.tiny-cascader.tiny-cascader--small input')).toHaveCSS('height', '28px')

Height assertion for mini size should be 24px, not 28px

The mini size height assertion of 28px in base-select is inconsistent with the established pattern across other components where mini size is consistently 24px. This appears to be an error in the test case rather than an intentional design change.

  • examples/sites/demos/pc/app/base-select/size.spec.ts: Change the mini size height assertion from 28px to 24px to maintain consistency with other components
🔗 Analysis chain

Verify if mini and small sizes should have the same height

The height assertion for mini size (28px) is now identical to the small size variant. This could indicate:

  1. A bug fix to align with correct specifications
  2. An intentional design change to make mini same height as small
  3. A potential issue if mini and small sizes shouldn't be identical

If this is an intentional change, please ensure it's documented in the component's specifications.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for size-related specifications or documentation

# Check if there's any documentation about component sizes
fd -e md -e vue . | xargs rg -l "(?i)(size|mini|small).*(height|dimension)"

# Look for size-related constants or theme variables
fd -e ts -e js . | xargs rg "(mini|small).*height"

# Search for other test files that might contain size assertions
fd spec.ts$ . | xargs rg "toBeCloseTo.*28"

Length of output: 3756

@zzcr zzcr merged commit d8a2eac into dev Nov 15, 2024
13 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants