close the side nav when you select an item to navigate to

[burnettk]

previously this had been happening by accident because we were doing a full page reload when selecting an item

addresses #1253 and #1252

Summary by CodeRabbit

• New Features
  • Enhanced navigation experience by automatically closing the side navigation menu when certain elements, including the header logo, are clicked.
  • Improved error message handling based on the current location path.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates introduce a new functionality to enhance user interaction with the side navigation menu. Functions within the NavigationBar.tsx component have been modified to include an optional parameter for closing the side navigation menu when certain UI elements are interacted with. This improvement focuses on providing a smoother navigation experience by allowing the side menu to automatically close upon actions such as clicking the header logo. Additionally, changes in ContainerForExtensions.tsx introduce new logic for handling error messages based on the current location path.

Changes

File Path	Change Summary
.../NavigationBar.tsx	Added closeSideNavMenuIfExpanded as an optional parameter to configurationElement and headerMenuItems functions; HeaderName component updated with an onClick handler to close the side navigation menu.
.../ContainerForExtensions.tsx	Introduced useLocation hook from react-router-dom and useAPIError hook; added logic for handling error messages based on the current location path.

Related issues

• UI tweaks (Part 2) #863: The changes in the NavigationBar.tsx component address objectives related to standardizing button text capitalization, implementing responsive behavior for buttons, and enhancing visual appeal by adjusting color and spacing of UI elements.
• Assist Marius with Vendor Onboarding process #790: The modifications in ContainerForExtensions.tsx align with the objective of enhancing the onboarding workflow to improve efficiency and user experience by handling error messages effectively based on the current location path.

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>.
  • Generate unit-tests 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 tests 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 tests.
  • @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 a review. This is useful when automatic reviews are disabled for the repository.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 6131fc9 and 22c56d3.

Files selected for processing (1)

• spiffworkflow-frontend/src/components/NavigationBar.tsx (9 hunks)

Additional comments: 3

spiffworkflow-frontend/src/components/NavigationBar.tsx (3)

• 174-180: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [177-200]

The addition of the closeSideNavMenuIfExpanded parameter to the configurationElement function aligns with the PR objectives and is implemented correctly. Ensure to verify the integration and potential side effects of this change in the broader application context.

• 244-250: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [237-300]

The implementation of the closeSideNavMenuIfExpanded parameter within the headerMenuItems function is consistent and correct. It's applied to multiple navigation items, enhancing the user experience as intended. Ensure to verify the integration and potential side effects of this change in the broader application context.

• 340-363: The implementation of the onClick handler in the HeaderName component to call closeSideNavMenuIfExpanded is correct and aligns with the PR objectives. This change is crucial for improving the user experience. Ensure to verify the integration and potential side effects of this change in the broader application context.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 22c56d3 and d74e6eb.

Files selected for processing (1)

• spiffworkflow-frontend/src/ContainerForExtensions.tsx (3 hunks)

Additional comments: 3

spiffworkflow-frontend/src/ContainerForExtensions.tsx (3)

• 2-2: The addition of useLocation from react-router-dom is appropriate for accessing the current location object, which is used later in the file to clear error messages when navigating to a different path. This is a good use of React Router's capabilities.
• 22-22: The introduction of the useAPIError custom hook is a good practice for managing API errors in a centralized manner. It's important to ensure that this hook is well-documented and tested, given its critical role in error handling.
• 42-53: The logic to clear error messages when navigating to a different path is sound. However, the comment on line 51 about not including removeError in the dependency array of useEffect to avoid an infinite loop raises a concern. While it's true that including functions in the dependency array can lead to infinite loops if those functions are re-created on each render, the proper solution is to ensure that removeError is memoized (using useCallback) in its definition within useAPIError. This ensures that removeError does not change across renders unless its own dependencies change, which should be none in this case.

Consider memoizing the removeError function within the useAPIError hook using useCallback to safely include it in the dependency array of useEffect and adhere to React's best practices for hooks.