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

Development: Add multiple cards as user interface components for the new sidebar #8554

Merged
merged 22 commits into from
May 18, 2024

Conversation

egekurt123
Copy link
Contributor

@egekurt123 egekurt123 commented May 7, 2024

Checklist

General

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
  • I strictly followed the client coding and design guidelines.
  • I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
  • I documented the TypeScript code using JSDoc style.

Description

This PR introduces cards of varying sizes "small", "medium", and "large" that are designed to deliver content tailored to the specific needs of different modules, such as lectures, exercises, and conversations. Additionally, a directive has been implemented to facilitate the generation of these cards

Note: This PR only contains the card components. The application of these cards in specific sidebar configurations will be addressed in following PRs. "The reason this PR is separated from its usage is that these cards will be utilized by other developers in the near future."

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
  • Code Review 3
  • Code Review 4

Test Coverage

Class/File Line Coverage
sidebar-card.directive 100%
sidebar-card-large.component 100%
sidebar-card-medium.component 100%
sidebar-card-small.component 86.66%

Screenshots

Small Sidebar Card Example (From a draft branch)

Screenshot 2024-05-18 at 12 46 11

Medium Sidebar Card Example (Currently used, default size)

Screenshot 2024-05-18 at 12 46 17

Large Sidebar Card Example (From a draft branch)

Screenshot 2024-05-18 at 13 00 38

@github-actions github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels May 7, 2024
@egekurt123 egekurt123 marked this pull request as ready for review May 8, 2024 14:39
@egekurt123 egekurt123 requested a review from a team as a code owner May 8, 2024 14:39
Copy link

coderabbitai bot commented May 8, 2024

Walkthrough

The recent updates introduce a new size property to the SidebarCardElement interface, allowing specification of card sizes ('S', 'M', 'L'). This change is reflected across various components and services, ensuring consistent handling of sidebar card elements in different sizes. Enhancements include adding the size property to service methods, updating Angular components to manage different card sizes, and modifying test cases to accommodate these updates.

Changes

Files Change Summary
src/main/webapp/app/types/sidebar.ts Added size property to SidebarCardElement interface.
src/main/webapp/app/overview/course-overview.service.ts Added size: 'M' to objects in mapLectureToSidebarCardElement, mapTutorialGroupToSidebarCardElement, and mapExerciseToSidebarCardElement.
src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.ts Updated SidebarCardLargeComponent to manage large sidebar cards, handle item selection, emit events, and reload the page.
src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.ts Updated SidebarCardMediumComponent to manage medium sidebar cards, handle item selection, emit events, and reload the page. Added emitStoreLastSelectedItem and forceReload methods.
src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.ts Renamed component selector and class, updated @Input decorator for sidebarItem.
src/main/webapp/app/shared/sidebar/sidebar-card.directive.ts Introduced SidebarCardDirective for managing sidebar cards of different sizes dynamically.
src/test/javascript/spec/component/shared/sidebar/sidebar-card-item.component.spec.ts Added size: 'M' to testItem object in the test case.

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.

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

coderabbitai[bot]
coderabbitai bot previously approved these changes May 8, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes May 8, 2024
coderabbitai[bot]

This comment was marked as outdated.

coderabbitai[bot]
coderabbitai bot previously approved these changes May 8, 2024
rabeatwork
rabeatwork previously approved these changes May 16, 2024
Copy link
Contributor

@rabeatwork rabeatwork left a comment

Choose a reason for hiding this comment

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

Maintainer approved

# Conflicts:
#	src/main/webapp/app/overview/course-overview.service.ts
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: 0

Out of diff range and nitpick comments (1)
src/main/webapp/app/overview/course-overview.service.ts (1)

Line range hint 25-25: Add missing import for TranslateService.

+ import { TranslateService } from '@ngx-translate/core';

coderabbitai[bot]
coderabbitai bot previously approved these changes May 17, 2024
Copy link
Contributor

@rabeatwork rabeatwork left a comment

Choose a reason for hiding this comment

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

re-approve

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

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

Reapprove after merge conflicts

Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

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

Reapprove

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.

reapprove

@krusche krusche changed the title Development: Created Multiple Cards and for New Sidebar Development: Add multiple cards as user interface components for the new sidebar May 18, 2024
@krusche krusche added this to the 7.1.0 milestone May 18, 2024
@krusche krusche merged commit b8cb97f into develop May 18, 2024
26 of 27 checks passed
@krusche krusche deleted the chore/add-different-sized-sidebar-cards branch May 18, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore client Pull requests that update TypeScript code. (Added Automatically!) priority:high ready to merge tests
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

None yet

7 participants