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: improve to not treat as a valid option when the value is null. #564

Merged
merged 4 commits into from
Aug 28, 2024

Conversation

Wxh16144
Copy link
Contributor

@Wxh16144 Wxh16144 commented Aug 27, 2024

maybe fix: ant-design/ant-design#50578 (comment)

Summary by CodeRabbit

  • 新功能

    • 更新了 TreeSelect 组件的逻辑,以确保在处理 null 值时不会发生错误。
  • 测试

    • 增加了测试用例,验证 TreeSelect 组件在 value 属性为 null 时的行为,确保正确处理并显示占位符。

Copy link

vercel bot commented Aug 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tree-select ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 27, 2024 3:19pm

Copy link

coderabbitai bot commented Aug 27, 2024

Walkthrough

此次修改涉及TreeSelect组件的逻辑调整,主要是在处理internalValue时的行为。当internalValuenull时,更新后的逻辑确保传入一个空数组[],而不是直接传递null。这项更改旨在增强组件的健壮性,避免因null引发的潜在错误。

Changes

文件 更改摘要
src/TreeSelect.tsx 修改internalValue处理逻辑,确保传入到toLabeledValues的值为有效输入(数组或空数组)。
tests/Select.multiple.spec.js 添加测试用例,验证TreeSelect组件在value属性为null时的行为,确保正确处理并显示占位符。

Assessment against linked issues

目标 已解决 说明
TreeSelect组件多选模式下value设置为null时显示正常 (#50578)

Poem

在树下静静坐,
兔子欢快跳,
null不再烦恼,
组件更稳妥,
占位符笑盈盈,
变化如春风。 🐇✨


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.

@Wxh16144 Wxh16144 changed the title Wuxh/try fix antd 50578 fix: improve to not treat as a valid option when the value is null. Aug 27, 2024
This reverts commit 0dd12df.
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 23606d8 and e5223d5.

Files selected for processing (2)
  • src/TreeSelect.tsx (1 hunks)
  • tests/Select.multiple.spec.js (1 hunks)
Additional comments not posted (2)
tests/Select.multiple.spec.js (1)

315-349: 新增测试用例验证null值处理

新增的测试用例验证了当value设置为null时的行为,确保没有选中的项目,并且占位符正确显示。

代码更改已批准。

src/TreeSelect.tsx (1)

393-393: 更新internalValue处理逻辑

更新后的逻辑确保当internalValuenull时,传入一个空数组[],避免潜在错误。

代码更改已批准。

@afc163
Copy link
Member

afc163 commented Aug 27, 2024

改完后是一个什么效果?

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (23606d8) to head (e5223d5).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #564   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines          516       516           
  Branches       150       141    -9     
=========================================
  Hits           516       516           

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

@Wxh16144
Copy link
Contributor Author

改完后是一个什么效果?

import React from "react";
import TreeSelect from '../src'; // 'rc-tree-select';

const treeData = [
  {
    label: 'parent',
    value: 'parent',
    children: [
      {
        label: 'child1',
        value: 'child1',
      },
      {
        label: 'child2',
        value: 'child2',
      },
    ],
  },
]

const App = () => {
  const [value, setValue] = React.useState(null);
  return (
    <>
      <TreeSelect
        value={value}
        onChange={setValue}
        multiple
        placeholder="Please select"
        treeData={treeData}
      />
    </>
  );
}

export default App;

before

image

after

image

it('should not omit value when value is null', () => {
const { container } = render(
<TreeSelect
value={null}
Copy link
Member

Choose a reason for hiding this comment

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

value={[null]} value={[null, null]} value={['child1', null]} 的 UI 表现分别是什么样的?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

你说的这3种形式,都属于同一种case,表明已选 value 为 null 的字段。 (这点和 select 的规则一样)

但应该不会出现第二种吧,表示选择了两个 null,

在 options 种允许 value 为 null 的

Copy link
Member

Choose a reason for hiding this comment

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

具体 UI 表现如何呢,本次改动是否有影响?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

具体 UI 表现如何呢,本次改动是否有影响?

我 debug 枚举一下看看,(应该没啥影响)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

before after
image image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TreeSelect组件多选模式下value设置为null时显示异常
2 participants