feat(grid): [grid] support resizable config
PR
PR Checklist
Please check if your PR fulfills the following requirements:
- [x] The commit message follows our Commit Message Guidelines
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] Docs have been added / updated (for bug fixes / features)
PR Type
What kind of change does this PR introduce?
- [ ] Bugfix
- [x] 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: #1602
What is the new behavior?
We can use resizableConfig.limit: ({ field, width }) => number to handle the min-max of each column width limit
Does this PR introduce a breaking change?
- [ ] Yes
- [x] No
Other information
Summary by CodeRabbit
-
New Features
- Introduced resizable columns feature in grid and transfer box components.
- Added multilingual support for resizable column descriptions.
-
Enhancements
- New configuration options to set and limit column width adjustments.
- Improved drag behavior for resizing columns.
-
Testing
- Added test scenarios to validate resizing functionality using Playwright.
-
Documentation
- Updated demos with examples of resizable grid configurations.
Walkthrough
Recent updates introduce the IResizableConfig entity, enabling precise control over column width adjustments in grids, complete with multilingual support. New Vue components, demos, and Playwright tests enhance the grid's functionality, providing a user-friendly experience for resizing columns while maintaining constraints.
Changes
| File Path(s) | Change Summary |
|---|---|
examples/sites/demos/apis/grid.js |
Introduced IResizableConfig for column width drag parameters with multilingual descriptions. |
examples/sites/demos/apis/transfer.js |
Added resizable-config option for columns in the transfer box. |
.../grid-resizable-config-composition-api.vue |
New Vue component for resizable grid columns with limit logic. |
.../grid-resizable-config.spec.ts |
Playwright tests for resizing grid elements. |
.../grid-resizable-config.vue |
New component for displaying data with resizable columns and limit settings. |
.../grid/webdoc/grid-size.js |
New configuration for column width dragging in grid demos. |
packages/vue/src/grid/src/header/src/header.ts |
Modified computeDragLeft and added resizableConfig prop for header drag behavior. |
packages/vue/src/grid/src/table/src/table.ts |
Added resizableConfig to component options. |
Sequence Diagram(s)
Here's a high-level sequence diagram for the resizing feature with resizableConfig:
sequenceDiagram
participant User
participant GridComponent
participant Column
participant ResizableConfig
User->>GridComponent: Resize column
GridComponent->>Column: Adjust width
Column->>ResizableConfig: Validate limits
ResizableConfig-->>Column: Return valid width
Column-->>GridComponent: Update width
GridComponent-->>User: Display resized column
Poem
In the grid where data flows,
Resizing columns where logic grows,
WithResizableConfigto define,
Widths that stay just within the line.
Tests and docs, all align,
A smooth drag, a perfect sign,
Of features crafted, oh so fine! 🐇✨
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto 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.yamlfile 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.
@gweesin 麻烦解决下冲突~