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

General: Improve breadcrumb divider design #8423

Conversation

simon-hng
Copy link
Contributor

@simon-hng simon-hng commented Apr 17, 2024

Checklist

General

Client

  • Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
  • I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

I keep misreading the breadcrumb navigation as item1 is less than item2 is less than item3,
leading to poor usability and mental strain

Description

Replaces the divider of the breadcrumb navigation > with a fontawesome icon

Steps for Testing

Prerequisites:

  • None
  1. Try to see if there are any visual bugs with the breadcrumb navigation on various screen sizes and pages

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Screenshots

Before:
Screenshot 2024-04-17 at 20 09 40

After:
Screenshot 2024-04-17 at 20 10 32

Summary by CodeRabbit

  • New Features
    • Enhanced the navigation bar by adding breadcrumb dividers for better visual separation and navigation clarity.
    • Improved styling of breadcrumb item separators with a new CSS class for the divider element.

@simon-hng simon-hng requested a review from a team as a code owner April 17, 2024 18:14
Copy link

coderabbitai bot commented Apr 17, 2024

Walkthrough

The recent updates aim to enhance the user interface of the navigation bar by introducing a dynamic breadcrumb divider. This improvement involves adding a conditional check in the HTML to display icons based on the breadcrumb position, updating the styling in the SCSS file for consistency, and importing the faChevronRight icon in the TypeScript file for use in the NavbarComponent.

Changes

File Path Changes
.../navbar/navbar.component.html Added a conditional check to display a breadcrumb divider icon based on the index value in the loop.
.../navbar/navbar.scss Updated styling by replacing the breadcrumb item separators with a new CSS class for the divider element.
.../navbar/navbar.component.ts Imported and assigned the faChevronRight icon in the NavbarComponent class.

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

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Apr 17, 2024
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: 3

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

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@az108 az108 requested review from az108 and removed request for az108 April 18, 2024 14:14
Copy link
Contributor

@az108 az108 left a comment

Choose a reason for hiding this comment

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

Optical Change is good

@krusche krusche changed the title General: replace breadcrumb divider with font awesome icon General: Improve breadcrumb divider design Apr 25, 2024
@krusche krusche merged commit b0e9763 into ls1intum:develop Apr 25, 2024
17 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

6 participants