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(grid): [grid] fix can not select first option when value is empty #2756

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jan 7, 2025

PR

修复原生select当默认值为空第一项无法选中
当原生select没有指定选中值时,默认会选中第一项,因此再次选择第一项时,不会触发change事件。导致实际的值无法更新
image

修复方案:
当默认值为空值,给原生select标签添加一个隐藏的空选项

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

close #2649

Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request focuses on refactoring the renderOptions function in the Vue grid adapter's renderer. The changes primarily involve transforming variable declarations from let to const, introducing a new hasSelected variable to track option selection, and modifying the option mapping logic. The modifications aim to improve code clarity and ensure more precise handling of option selection during the rendering process, without introducing significant functional changes.

Changes

File Change Summary
packages/vue/src/grid/src/adapter/src/renderer.ts - Converted variable declarations from let to const
- Added hasSelected variable to track option selection
- Updated option mapping logic
- Modified return statement to use optionsList

Suggested reviewers

  • zzcr

Possibly related PRs

Poem

🐰 In the grid of Vue's embrace,
Constants dance with newfound grace
Options selected, clear and bright
Rendering logic takes its flight
A rabbit's code, both swift and neat! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e29e24 and 66af641.

📒 Files selected for processing (1)
  • packages/vue/src/grid/src/adapter/src/renderer.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (5)
packages/vue/src/grid/src/adapter/src/renderer.ts (5)

103-108: LGTM! Good improvement in variable declarations.

Converting mutable declarations to const improves code safety by preventing accidental reassignment.


113-118: LGTM! Efficient selection tracking implementation.

The hasSelected flag efficiently tracks option selection state without requiring additional iterations.


114-124: LGTM! Clean option mapping implementation.

The mapping logic effectively creates option elements while tracking selection state, following Vue's virtual DOM patterns.


125-127: LGTM! Core fix for the empty value selection issue.

Adding a hidden default option when no option is selected ensures proper handling of empty values in the grid component.


103-128: Verify the fix across different scenarios.

While the implementation looks correct, please verify these scenarios:

  1. Initial render with empty value
  2. Clearing a selected value
  3. Selecting the first option after having an empty value
  4. Multiple select components in the same grid
✅ Verification successful

Implementation verified as robust and well-tested

The code handles all specified scenarios correctly:

  • Empty initial state is handled by the fallback empty option
  • Value clearing works through the hasSelected check
  • Selection state is properly tracked per instance
  • Multiple select components are isolated through column/row scoping

The implementation is also covered by existing tests for validation and custom editor scenarios.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for test files covering grid select functionality
fd -e spec.ts -e spec.js -e test.ts -e test.js . | grep -i "grid.*select"

# Search for existing implementations using renderOptions
rg "renderOptions.*select" -A 5

Length of output: 602


Script:

#!/bin/bash
# Check content of select validation and custom editor test files
cat examples/sites/demos/pc/app/grid/validation/select-validation.spec.js
cat examples/sites/demos/pc/app/grid/editor/custom-editor-select.spec.js

# Search for select renderer implementations
ast-grep --pattern 'const optionsList = $$.map((item, index) => {
  $$$
})'

# Look for select component definitions
rg "type.*=.*'select'" -A 5

Length of output: 3661


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

Walkthrough

This PR addresses an issue in the grid component where the first option could not be selected when the value was empty. The changes ensure that a default hidden option is added to handle cases where no option is initially selected.

Changes

File Summary
packages/vue/src/grid/src/adapter/src/renderer.ts Modified the renderOptions function to add a hidden default option if no option is selected. Replaced let with const for variable declarations.

@github-actions github-actions bot added the bug Something isn't working label Jan 7, 2025
key: index
}
return h('option', attrs, item[labelProp])
})
if (options.length && !hasSelected) {
optionsList.unshift(h('option', { style: 'display:none', selected: true }, ''))

Choose a reason for hiding this comment

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

A hidden default option is added to ensure that the first option can be selected when the value is empty. This change prevents the issue where no option is selected by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]: 表格自带的编辑器select组件无法选择第一项
2 participants