feat(tree-menu): [tree-menu] adapt to tree-menu smb themes
PR
PR Checklist
Please check if your PR fulfills the following requirements:
- [ ] The commit message follows our Commit Message Guidelines
- [x] 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
- [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?
- [ ] Yes
- [x] No
Other information
Summary by CodeRabbit
-
New Features
- Introduced a
highlight-queryoption to control the highlighting of search keywords in the tree menu. - Enhanced components to dynamically reflect user selection for highlighting through a radio group.
- Introduced a
-
Styling Enhancements
- Updated styles for the tree menu, including hover effects and color customizations for improved visual feedback and usability.
-
Documentation
- Updated documentation to reflect the new
highlight-queryfeature in both English and Chinese.
- Updated documentation to reflect the new
[!CAUTION]
Review failed
The pull request is closed.
Walkthrough
The changes enhance the tree menu component by introducing a new configuration option, highlight-query, which allows users to control the highlighting of search keywords in matched nodes. This includes updates to the UI with radio groups for user selection, styling improvements, and new CSS variables to improve the visual consistency of the component.
Changes
| Files | Change Summary |
|---|---|
examples/sites/demos/apis/tree-menu.js |
Added highlight-query property to control keyword highlighting in matched nodes. |
examples/sites/demos/pc/app/tree-menu/show-filter-composition-api.vue, .../show-filter.vue |
Introduced radio group for selecting keyword highlighting; updated to pass highlight-query prop conditionally. |
packages/theme/src/tree-menu/index.less |
Enhanced styling with new color properties and hover effects for tree nodes. |
packages/theme/src/tree-menu/smb-theme.js, packages/vue/src/tree-menu/src/index.ts |
Updated theme properties and added highlightQuery to tree menu props. |
packages/vue/src/tree-menu/src/pc.vue |
Added highlightQuery prop to enhance component functionality for keyword highlighting. |
packages/theme/src/tree-menu/vars.less |
Introduced new CSS variable --ti-tree-menu-node-number-color for consistent styling of node numbers. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant RadioGroup
participant TinyTreeMenu
User->>RadioGroup: Select highlight option
RadioGroup->>TinyTreeMenu: Update highlight-query prop
TinyTreeMenu->>TinyTreeMenu: Highlight matched nodes
Poem
๐ In the woods where the tree nodes sway,
A highlight feature now comes to play!
With colors bright and options clear,
Searching brings joy, and no more fear!
So hop along, let's find our way,
In the tree menu, we dance and play! ๐
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.