search

umonkey / treemap

A web app for crowd-mapping urban trees.
0 stars 1 forks source link

Add new home page sidebar [WiP] #82

Open umonkey opened 5 months ago

umonkey commented 5 months ago

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

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!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

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.