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

feat: add component Details sidebar [FC-0062] #1303

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Sep 19, 2024

Description

This PR adds the Details tab in the Component Sidebar.

image

More information

Part of:

Depends on:

Testing Instructions


Private ref: FAL-3803

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 19, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 19, 2024

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@rpenido rpenido changed the title feat: add ComponentDetails component feat: add ComponentDetails component [FC-0062] Sep 19, 2024
@rpenido rpenido force-pushed the rpenido/fal-3803-component-sidebar-details-tab branch 5 times, most recently from a6a7b73 to c106f87 Compare September 19, 2024 18:19
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.73%. Comparing base (9d3a05f) to head (a9a7b21).
Report is 13 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1303      +/-   ##
==========================================
+ Coverage   92.47%   92.73%   +0.25%     
==========================================
  Files        1025     1035      +10     
  Lines       18978    19261     +283     
  Branches     4048     4079      +31     
==========================================
+ Hits        17550    17861     +311     
+ Misses       1360     1335      -25     
+ Partials       68       65       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rpenido rpenido force-pushed the rpenido/fal-3803-component-sidebar-details-tab branch 4 times, most recently from 1a4df25 to cbed007 Compare September 20, 2024 20:15
@@ -9,7 +9,7 @@ import { mockLibraryBlockMetadata } from '../data/api.mocks';
import ComponentManagement from './ComponentManagement';

/*
* FIXME: Summarize the reason here
* This function is used to get the inner text of an element.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Missed comment from the ComponentManagent tab test

@rpenido rpenido force-pushed the rpenido/fal-3803-component-sidebar-details-tab branch from cbed007 to 1788a4c Compare September 20, 2024 20:40
@rpenido rpenido changed the title feat: add ComponentDetails component [FC-0062] feat: add component Details sidebar [FC-0062] Sep 20, 2024
@rpenido rpenido marked this pull request as ready for review September 20, 2024 21:03
@rpenido rpenido requested a review from a team as a code owner September 20, 2024 21:03
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 23, 2024
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

One nit, but 👍 when that's fixed :)

  • I tested this using the PR test instructions
  • I read through the code
  • I checked for accessibility issues by using my keyboard to navigate
  • Includes documentation N/A
  • User-facing strings are extracted for translation

src/library-authoring/component-info/messages.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

@rpenido Looks good 👍 One small nit, but not a blocker.


// istanbul ignore if: this should never happen
if (!componentMetadata) {
return null;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can throw an error instead of null. (ex.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @ChrisChV!
I added a better error handling here (a9a7b21), adding a loading and error state, as this could have an error from api.

@rpenido rpenido force-pushed the rpenido/fal-3803-component-sidebar-details-tab branch from 596b87a to ab22ed8 Compare September 25, 2024 11:57
@rpenido rpenido force-pushed the rpenido/fal-3803-component-sidebar-details-tab branch from ab22ed8 to a9a7b21 Compare September 25, 2024 12:07
@ChrisChV ChrisChV merged commit ff67c9a into openedx:master Sep 25, 2024
7 checks passed
@ChrisChV ChrisChV deleted the rpenido/fal-3803-component-sidebar-details-tab branch September 25, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants