-
Notifications
You must be signed in to change notification settings - Fork 7.1k
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: some element-plus components doesn't has props 'options' #5082
Conversation
…andling
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
apps/web-ele/src/adapter/component/index.tsOops! Something went wrong! :( ESLint: 9.15.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs WalkthroughThe changes in this pull request primarily involve updates to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
apps/web-ele/src/adapter/component/index.ts (3)
42-46
: Consider strengthening the TKV type definitionThe current type allows any additional properties which could lead to type safety issues. Consider making it more strict by explicitly defining all allowed properties.
type TKV = { - [key: string]: any; label: string; value: any; + disabled?: boolean; };
88-90
: Add type safety to DefaultButton componentThe implementation would benefit from proper type definitions for props and attrs.
- DefaultButton: (props, { attrs, slots }) => { + DefaultButton: (props: Record<string, any>, { attrs, slots }: Omit<SetupContext, 'expose'>) => { return h(ElButton, { ...props, ...attrs, type: 'info' }, slots); },
Line range hint
1-7
: Enhance documentation for component adaptationsWhile the existing comment explains the purpose, it would be helpful to add:
- Documentation for the new TKV type
- Examples of using options vs slots for CheckboxGroup and RadioGroup
- Notes about the ElSelectV2 migration
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
apps/web-ele/src/adapter/component/index.ts
(4 hunks)
🔇 Additional comments (1)
apps/web-ele/src/adapter/component/index.ts (1)
113-113
: Verify ElSelectV2 compatibility with existing usage
The change from ElSelect to ElSelectV2 could be a breaking change. ElSelectV2 might have different props or behavior.
Consider:
- Adding a migration guide for users
- Documenting any behavioral differences
- Potentially making this a major version bump if there are breaking changes
此PR有冲突,相关改动已在main分支中存在 |
…r better type safety
|
There was a problem hiding this 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
🧹 Outside diff range and nitpick comments (1)
apps/web-ele/src/adapter/component/index.ts (1)
81-83
: Add type safety to button propsConsider adding proper typing for the button props to ensure type safety.
- DefaultButton: (props, { attrs, slots }) => { + DefaultButton: (props: Partial<typeof ElButton.__defaults>, { attrs, slots }: Omit<SetupContext, 'expose'>) => { return h(ElButton, { ...props, attrs, type: 'info' }, slots); },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
apps/web-ele/src/adapter/component/index.ts
(3 hunks)
🔇 Additional comments (4)
apps/web-ele/src/adapter/component/index.ts (4)
68-79
: Add type safety and fix attrs spreading
The CheckboxGroup implementation has several potential improvements needed:
- Props type safety is missing
- The attrs spreading syntax is incorrect
- No validation for option values
91-102
: Refactor RadioGroup to reduce code duplication and add type safety
The RadioGroup implementation is nearly identical to CheckboxGroup, suggesting an opportunity for code reuse. It also needs the same type safety improvements.
15-15
: Verify type definitions for CheckboxProps and RadioProps
The types are imported from element-plus but their structure should be documented for maintainability.
Also applies to: 31-31
103-103
: Verify ElSelectV2 compatibility and performance
The switch from ElSelect to ElSelectV2 might introduce breaking changes. Please ensure:
- All existing select functionality works as expected
- Performance is not negatively impacted
- All existing props and events are compatible
✅ Verification successful
Let's analyze the Select component usage patterns and any potential breaking changes by searching with broader patterns and context.
Based on the search results, I can now generate a final response:
ElSelectV2 change appears safe with minimal usage impact
The codebase shows that:
- The Select component is wrapped with
withDefaultPlaceholder
HOC, maintaining consistent placeholder behavior - Only one instance of Select usage found in
login.vue
using 'VbenSelect', which is an abstraction layer - The component is registered globally through
globalShareState.setComponents
The change to ElSelectV2 appears safe because:
- The component is properly abstracted behind an adapter layer
- Usage is minimal and through higher-level components
- Basic props (v-model, options) remain compatible as per Element Plus documentation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for existing Select component usage
rg -A 3 "Select.*options"
# Search for any Select-specific props or events
ast-grep --pattern ':options="$_"'
Length of output: 64
Script:
#!/bin/bash
# Search for Select component usage patterns with broader context
rg -A 5 -B 5 "Select" apps/web-ele/src/
# Look for Select component props and usage
ast-grep --pattern 'Select $$$'
# Search for v-model usage with Select
rg -A 3 "v-model.*Select"
# Search for ElSelect usage patterns
rg -A 3 "ElSelect"
Length of output: 4800
#5071 closed because of duplicate pr |
Description
Type of change
Please delete options that are not relevant.
pnpm-lock.yaml
unless you introduce a new test example.Checklist
pnpm run docs:dev
command.pnpm test
.feat:
,fix:
,perf:
,docs:
, orchore:
.Summary by CodeRabbit
New Features
ElSelectV2
component, enhancing the selection functionality.CheckboxGroup
andRadioGroup
as functional components for improved flexibility and dynamic rendering.Bug Fixes
DefaultButton
method.Type Additions
CheckboxProps
andRadioProps
to define the structure of options for the checkbox and radio groups.