feat(crop): [crop] update crop for smb design
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
- [x] 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?
- [x] Yes
- [ ] No
Other information
根据最新规范, 修改图片裁剪组件。 移除了预览的功能 调整了裁剪区域的样式 调整了裁剪工具条的样式 调整了裁剪工具条的提示文字 增加 esc 关闭裁剪 同步调整文档
Summary by CodeRabbit
-
New Features
- Enhanced user interaction during cropping with new localized strings for actions like choosing images, zooming, and rotating.
- Introduced a quick exit option for the crop interface by handling the Escape key.
-
Bug Fixes
- Improved rendering performance by switching from
v-iftov-showfor the crop preview display.
- Improved rendering performance by switching from
-
Refactor
- Removed the 'preview' functionality from the cropping configuration and components, simplifying the cropping tool's interface.
- Streamlined cropping state management and rendering logic for better performance.
-
Style
- Significant CSS refactoring to improve clarity and responsiveness by commenting out unused styles and adjusting existing ones.
Walkthrough
The recent changes enhance the cropping tool by streamlining functionality and improving user interaction. Key updates include the removal of the image preview feature, refactoring rendering logic, and adjustments to localization strings. These modifications aim to simplify the interface, boost performance, and enrich the user experience with clearer options for image manipulation.
Changes
| Files | Change Summary |
|---|---|
examples/sites/demos/apis/crop.js, examples/sites/demos/pc/app/crop/aspect-ratio-composition-api.vue, examples/sites/demos/pc/app/crop/aspect-ratio.vue |
Removed 'preview' functionality and related properties, simplifying the API and component interactions. |
examples/sites/demos/pc/app/crop/get-image-data-composition-api.vue |
Changed access method for the getCanvasData function to improve clarity and reactivity. |
packages/renderless/src/crop/index.ts, packages/renderless/src/crop/vue.ts |
Commented out unused functions and properties, updated keyCode checks for strict equality, and made adjustments to image state management and rendering logic. |
packages/theme/src/crop/index.less |
Commented out various CSS rules, adjusted styles for cropper elements, and removed unused styles for a cleaner codebase. |
packages/vue-locale/src/lang/en.ts, packages/vue-locale/src/lang/zh-CN.ts |
Updated localization strings to enhance user interaction, replacing old entries with new commands and commenting out previous ones. |
packages/vue/src/crop/src/pc.vue |
Altered rendering logic, removed crop preview section, commented out unused code, and streamlined constants related to cropping functionality. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant CropTool as Crop Tool
participant ImageProcessor as Image Processor
User->>CropTool: Initiate Crop
CropTool->>ImageProcessor: Load Image
ImageProcessor-->>CropTool: Image Loaded
CropTool->>User: Display Crop Interface
User->>CropTool: Adjust Crop Area
CropTool->>ImageProcessor: Process Crop
ImageProcessor-->>CropTool: Cropped Image Data
CropTool->>User: Display Cropped Image
User->>CropTool: Confirm Crop
CropTool-->>User: Crop Complete
Poem
🐇 In fields of pixels, so bright and clear,
A tool for cropping, we hold dear.
With features pruned, and clarity found,
Our joyous edits will abound!
So hop along, let’s crop with cheer,
For every image brings us near! 🌸
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.
[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