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

feat(SearchTabPanel): Replace ToggleButtonGroup with Stack for query option icon buttons #191

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Henry8192
Copy link
Collaborator

@Henry8192 Henry8192 commented Feb 24, 2025

Description

ToggleButtonGroup is causing inconvenience whenever isCaseSensitive or isRegex updates. It is only used because the button pressed status needs to be shown visually. The current implementation achieves the same goal without using ToggleButtonGroup, and are easier for query options to update.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Search Scheduling without any query options, search results are found and shown;
Enable case sensitive, no search results are found.

example.zip

Copy link

coderabbitai bot commented Feb 24, 2025

Walkthrough

This update modifies both the styling and state management within the SearchTabPanel component. In the CSS file, explicit dimensions are applied to the query option button using !important. In the TypeScript file, the previous enum-based approach and its utility functions have been removed, and two new state variables along with dedicated toggle handlers have been introduced to manage the case sensitivity and regex options. Additionally, the UI layout has been adjusted to replace the ToggleButtonGroup with a Stack containing IconButton elements.

Changes

Files Summary of Changes
src/…/SearchTabPanel/index.css Updated .query-option-button class with explicit width (1.5rem), height (1.5rem), min-width (0), and min-height (0), all marked as !important to enforce strict sizing.
src/…/SearchTabPanel/index.tsx Removed the QUERY_OPTION enum and associated utility functions; added state variables (isCaseSensitive, isRegex) and new toggle handler functions (handleCaseButtonPressed, handleRegexButtonPressed); replaced the ToggleButtonGroup with a Stack of IconButtons and updated query submission logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SearchTabPanel
    participant QueryService

    User ->> SearchTabPanel: Click "Case Sensitivity" or "Regex" button
    SearchTabPanel ->> SearchTabPanel: Toggle isCaseSensitive/isRegex state
    SearchTabPanel ->> SearchTabPanel: Update IconButton state (aria-pressed)
    SearchTabPanel ->> QueryService: Call handleQuerySubmit with updated options
    QueryService -->> SearchTabPanel: Return query results
    SearchTabPanel -->> User: Render updated search results
Loading

Possibly related PRs

Suggested reviewers

  • junhaoliao
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@Henry8192 Henry8192 changed the title feat(SearchTabPanel): Toggle button group removal feat(SearchTabPanel): Replace ToggleButtonGroup with Stack for query option icon buttons Feb 24, 2025
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

🧹 Nitpick comments (1)
src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.tsx (1)

68-82: Consider optimizing the button handlers.

The handlers follow a consistent pattern but could be optimized to avoid redundant state updates.

Consider this optimization:

-    const handleCaseButtonPressed = () => {
-        handleQuerySubmit({
-            isCaseSensitive: !isCaseSensitive,
-            isRegex: isRegex,
-        });
-        setIsCaseSensitive(!isCaseSensitive);
-    };
+    const handleCaseButtonPressed = () => {
+        const newIsCaseSensitive = !isCaseSensitive;
+        setIsCaseSensitive(newIsCaseSensitive);
+        handleQuerySubmit({
+            isCaseSensitive: newIsCaseSensitive,
+            isRegex: isRegex,
+        });
+    };

-    const handleRegexButtonPressed = () => {
-        handleQuerySubmit({
-            isCaseSensitive: isCaseSensitive,
-            isRegex: !isRegex,
-        });
-        setIsRegex(!isRegex);
-    };
+    const handleRegexButtonPressed = () => {
+        const newIsRegex = !isRegex;
+        setIsRegex(newIsRegex);
+        handleQuerySubmit({
+            isCaseSensitive: isCaseSensitive,
+            isRegex: newIsRegex,
+        });
+    };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ec35a06 and 0fb58ff.

📒 Files selected for processing (2)
  • src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.css (1 hunks)
  • src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.tsx (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ...

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.tsx
🧠 Learnings (1)
src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.css (1)
Learnt from: junhaoliao
PR: y-scope/yscope-log-viewer#107
File: src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.css:14-18
Timestamp: 2024-11-14T04:35:00.986Z
Learning: In `src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.css`, the use of `!important` flags is necessary for overriding styles in the `.query-input-box` class.
🔇 Additional comments (5)
src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.css (1)

20-24: LGTM! The button dimensions are appropriate.

The explicit dimensions with !important flags are necessary and appropriate for icon buttons. Setting both fixed and minimum dimensions ensures consistent button sizing.

src/components/CentralContainer/Sidebar/SidebarTabs/SearchTabPanel/index.tsx (4)

11-11: LGTM! The Stack import is appropriate.

The Stack component is a suitable replacement for ToggleButtonGroup to manage button layout.


47-48: LGTM! The state management is simplified.

Using boolean flags for case sensitivity and regex options is more straightforward than the previous enum-based approach.


56-58: LGTM! The query submission is simplified.

Direct use of boolean flags makes the code more readable and maintainable by removing the need for utility functions.


111-148: LGTM! The UI changes are well-implemented.

The Stack component with IconButtons provides a clean and accessible replacement for the toggle button group. The buttons are properly configured with tooltips, aria attributes, and consistent styling.

@Henry8192 Henry8192 requested a review from junhaoliao February 24, 2025 21:24
Copy link
Member

@junhaoliao junhaoliao left a comment

Choose a reason for hiding this comment

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

can we create a custom component in src/components for the toggle buttons? e.g.,

interface ToggleIconButton extends IconButton {
    isActive: boolean;
}

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.

2 participants