fix: apply search after loading new batch of referenda

[Nick-1979]

closes #1220

Summary by CodeRabbit

• New Features

  • Introduced a search functionality in the SearchBox component, allowing users to input and manage search keywords.
  • Enhanced filtering options with updated status handling based on user selections.

• Improvements

  • Updated placeholder text in the InputFilter component for better user experience.

[coderabbitai]

Walkthrough

The changes involve modifications to the SearchBox component in SearchBox.tsx. A new state variable, searchKeyword, is introduced to manage the search input. The onSearch function is updated to set this state, and a useEffect hook ensures the search keyword is reapplied when the referenda data updates. Functions related to filtering and status changes are also altered for direct mutation of the filter object. Additionally, the placeholder text in the InputFilter component is updated to utilize a translation function.

Changes

File Path	Change Summary
packages/extension-polkagate/src/fullscreen/governance/SearchBox.tsx	Introduced searchKeyword state, updated onSearch, added useEffect for keyword reapplication, modified onFilter, onMyVotes, and onChangeStatus functions, and updated placeholder text in InputFilter.

Assessment against linked issues

Objective	Addressed	Explanation
Apply search in referenda list after loading a new batch of them (#1220)	✅

Poem

In the search box, a keyword will bloom,
As referenda dance, dispelling the gloom.
With filters in hand, we navigate the night,
Finding our votes, making all things right.
A hop and a skip, through data we weave,
In this governance garden, we truly believe! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

packages/extension-polkagate/src/fullscreen/governance/SearchBox.tsx (3)

141-147: LGTM with a suggestion: New effect for reapplying search.

This new useEffect hook successfully addresses the PR's main objective by reapplying the search when new referenda are loaded. Great job!

However, consider optimizing the onSearch function with useCallback to prevent unnecessary re-renders of this effect.

You could wrap the onSearch function with useCallback like this:

const onSearch = useCallback((keyword: string) => {
  // ... existing onSearch logic ...
}, [filter, referenda, setFilteredReferenda]);

This will ensure that onSearch is only recreated when its dependencies change, potentially reducing unnecessary effect triggers.

---

165-165: LGTM with a suggestion: Updated placeholder text with translation.

The use of the translation function for the placeholder text improves internationalization. Good job!

Consider specifying the type argument for the t function to ensure proper type inference:

placeholder={t<string>('🔍 Search in all referenda ')}

This will help maintain type safety and improve code clarity.

---

166-168: Consider removing or implementing the commented-out code.

There's a commented-out line that suggests the InputFilter component's value is not being controlled. This might lead to inconsistencies between the displayed value and the stored state.

Consider either:

1. Removing the commented-out line if it's not needed, or
2. Implementing it to make the InputFilter a controlled component:

value={searchKeyword ?? ''}

This will ensure that the input value always reflects the current state.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a94a2b1 and 30fff35.

📒 Files selected for processing (1)

• packages/extension-polkagate/src/fullscreen/governance/SearchBox.tsx (4 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/extension-polkagate/src/fullscreen/governance/SearchBox.tsx (2)

51-54: LGTM: New state variable for search keyword.

The addition of the searchKeyword state variable is well-placed and correctly typed. This change aligns with the PR objective of improving search functionality for referenda.

---

92-93: LGTM: Updating search keyword state.

The addition of setSearchKeyword(keyword) in the onSearch function ensures that the search term is properly stored in the component's state. This change supports the PR's objective of maintaining search functionality across referenda updates.