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

Add new home page sidebar [WiP] #82

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

umonkey
Copy link
Owner

@umonkey umonkey commented May 26, 2024

The new sidebar should provide better search function for desktop and mobile users.

Summary by CodeRabbit

  • New Features

    • Introduced a SpeciesSearchBar component for tree searches.
    • Added HomeSideBar component with integrated SpeciesSearchBar.
  • Enhancements

    • Updated TreeSidePane component with improved status line formatting.
    • Enhanced input styling with new custom properties for better visual appearance.
  • Bug Fixes

    • Corrected the title of TreeSidePane in Storybook for better organization.
  • Documentation

    • Added Storybook configurations for SpeciesSearchBar and HomeSideBar components.
  • Data Updates

    • Expanded SAMPLE_TREE object with new properties for better data representation.

@umonkey umonkey marked this pull request as draft May 26, 2024 18:32
Copy link

coderabbitai bot commented May 26, 2024

Important

Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a SpeciesSearchBar component with associated storybook configurations, styling, and hooks for managing search functionality. Additionally, a HomeSideBar component is created, incorporating the SpeciesSearchBar and utilizing custom hooks for search handling. Updates also include modifications to the TreeSidePane component, new input styling properties in the global stylesheet, and enhancements to the SAMPLE_TREE object in the sample data.

Changes

File(s) Change Summary
frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.stories.tsx Introduces storybook configurations for the SpeciesSearchBar component.
frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.tsx Adds a simple text input component for searching trees with handlers for input changes, key presses, and search button clicks.
frontend/src/components/elements/SpeciesSearchBar/hooks.ts Introduces the useSpeciesSearchBar hook for managing search functionality.
frontend/src/components/elements/SpeciesSearchBar/index.ts Exports the SpeciesSearchBar component.
frontend/src/components/elements/SpeciesSearchBar/styles.scss Adds styling rules for the SpeciesSearchBar component.
frontend/src/components/elements/SpeciesSearchBar/types.ts Defines the IProps interface for the SpeciesSearchBar component.
frontend/src/components/index.ts Exports SpeciesSearchBar from the elements directory.
frontend/src/components/sidebar/HomeSideBar/HomeSideBar.stories.tsx Introduces a story for the HomeSideBar component.
frontend/src/components/sidebar/HomeSideBar/HomeSideBar.tsx Adds the HomeSideBar component that includes the SpeciesSearchBar and uses custom hooks for search functionality.
frontend/src/components/sidebar/HomeSideBar/hooks.ts Introduces the useHomeSideBar hook for managing search functionality and navigation.
frontend/src/components/sidebar/TreeSidePane/TreeSidePane.stories.tsx Updates the storybook title for TreeSidePane from 'Dialogs/TreeSidePane' to 'Sidebar/TreeSidePane'.
frontend/src/components/sidebar/TreeSidePane/hooks.ts Adds a call to setStatus with formatStatusLine in the useTreeSidePane function.
frontend/src/index.css Introduces new custom properties for input styling.
frontend/src/sample-data.ts Updates the SAMPLE_TREE object with additional properties: state, created_at, updated_at, and thumbnail_id.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant SpeciesSearchBar
    participant HomeSideBar
    participant useHomeSideBar
    participant useSpeciesSearchBar

    User->>SpeciesSearchBar: Input search query
    SpeciesSearchBar->>useSpeciesSearchBar: Handle input change
    SpeciesSearchBar->>useSpeciesSearchBar: Handle key press
    SpeciesSearchBar->>useSpeciesSearchBar: Handle search button click
    useSpeciesSearchBar->>HomeSideBar: Trigger search action
    HomeSideBar->>useHomeSideBar: Update search query
    useHomeSideBar->>navigate: Navigate to search results
Loading

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

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 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 full the 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 help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c49cf2f and dd0589f.
Files selected for processing (14)
  • frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.stories.tsx (1 hunks)
  • frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.tsx (1 hunks)
  • frontend/src/components/elements/SpeciesSearchBar/hooks.ts (1 hunks)
  • frontend/src/components/elements/SpeciesSearchBar/index.ts (1 hunks)
  • frontend/src/components/elements/SpeciesSearchBar/styles.scss (1 hunks)
  • frontend/src/components/elements/SpeciesSearchBar/types.ts (1 hunks)
  • frontend/src/components/index.ts (1 hunks)
  • frontend/src/components/sidebar/HomeSideBar/HomeSideBar.stories.tsx (1 hunks)
  • frontend/src/components/sidebar/HomeSideBar/HomeSideBar.tsx (1 hunks)
  • frontend/src/components/sidebar/HomeSideBar/hooks.ts (1 hunks)
  • frontend/src/components/sidebar/TreeSidePane/TreeSidePane.stories.tsx (1 hunks)
  • frontend/src/components/sidebar/TreeSidePane/hooks.ts (1 hunks)
  • frontend/src/index.css (1 hunks)
  • frontend/src/sample-data.ts (1 hunks)
Files not reviewed due to errors (3)
  • frontend/src/components/sidebar/TreeSidePane/hooks.ts (no review received)
  • frontend/src/components/sidebar/TreeSidePane/TreeSidePane.stories.tsx (no review received)
  • frontend/src/sample-data.ts (no review received)
Files skipped from review due to trivial changes (8)
  • frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.stories.tsx
  • frontend/src/components/elements/SpeciesSearchBar/index.ts
  • frontend/src/components/elements/SpeciesSearchBar/styles.scss
  • frontend/src/components/elements/SpeciesSearchBar/types.ts
  • frontend/src/components/index.ts
  • frontend/src/components/sidebar/HomeSideBar/HomeSideBar.stories.tsx
  • frontend/src/components/sidebar/HomeSideBar/HomeSideBar.tsx
  • frontend/src/index.css
Additional Context Used
Biome (25)
frontend/src/components/elements/SpeciesSearchBar/SpeciesSearchBar.tsx (2)

9-10: All these imports are only used as types.


30-30: Provide an explicit type prop for the button element.

frontend/src/components/elements/SpeciesSearchBar/hooks.ts (1)

4-5: All these imports are only used as types.

frontend/src/components/sidebar/TreeSidePane/TreeSidePane.stories.tsx (1)

5-6: All these imports are only used as types.

frontend/src/components/sidebar/TreeSidePane/hooks.ts (1)

5-6: All these imports are only used as types.

frontend/src/sample-data.ts (20)

11-11: The computed expression can be simplified without the use of a string literal.


12-12: The computed expression can be simplified without the use of a string literal.


13-13: The computed expression can be simplified without the use of a string literal.


14-14: The computed expression can be simplified without the use of a string literal.


15-15: The computed expression can be simplified without the use of a string literal.


16-16: The computed expression can be simplified without the use of a string literal.


17-17: The computed expression can be simplified without the use of a string literal.


18-18: The computed expression can be simplified without the use of a string literal.


19-19: The computed expression can be simplified without the use of a string literal.


20-20: The computed expression can be simplified without the use of a string literal.


21-21: The computed expression can be simplified without the use of a string literal.


22-22: The computed expression can be simplified without the use of a string literal.


25-25: The computed expression can be simplified without the use of a string literal.


26-26: The computed expression can be simplified without the use of a string literal.


27-27: The computed expression can be simplified without the use of a string literal.


28-28: The computed expression can be simplified without the use of a string literal.


29-29: The computed expression can be simplified without the use of a string literal.


30-30: The computed expression can be simplified without the use of a string literal.


31-31: The computed expression can be simplified without the use of a string literal.


32-32: The computed expression can be simplified without the use of a string literal.

Comment on lines 9 to 28
export const useHomeSideBar = () => {
// Remember search query across sessions.
const { searchQuery, setSearchQuery } = useSearchQuery();

const navigate = useNavigate();

const handleSearch = (query: string) => {
console.debug(`Searching for: ${query}`);
mainBus.emit("before_search");
mainBus.emit("search", query);

setSearchQuery(query);
navigate(routes.search(query));
};

return {
handleSearch,
searchQuery,
};
}
Copy link

Choose a reason for hiding this comment

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

Consider adding error handling and user feedback mechanisms for the search operation.

import { useEffect, useState } from "react";

// Local imports.
import { IProps } from "./types.ts";
Copy link

Choose a reason for hiding this comment

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

Use TypeScript's import type syntax for type-only imports to prevent potential side effects.

- import { IProps } from "./types.ts";
+ import type { IProps } from "./types.ts";

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
import { IProps } from "./types.ts";
import type { IProps } from "./types.ts";

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.

1 participant