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

Upgrade to Bootstrap 5 & realign themes #3506

Open
wants to merge 108 commits into
base: main
Choose a base branch
from

Conversation

Wout-atmire
Copy link

References

Description

This PR aims to change the Bootstrap version of DSpace from Bootstrap version 4 to Bootstrap version 5 because version 4 is out of date. This version upgrade includes the required visual changes to maintain the same look as the DSpace version with Bootstrap 4.

Instructions for Reviewers

List of changes in this PR:

  • Updated packages @ng-bootstrap/ng-bootstrap to version ^12.0.0 and bootstrap to version ^5.3
  • We updated the SCSS to align with the migration-conditions of changing to Bootstrap 5. So that it remains compatible
    • Mainly updating old Bootstrap 4 classes to the renamed Bootstrap 5 classes (eg text-right to text-end, ml-4 to ms-4, ...)
  • Updated the styling ot perserve the look of DSpace
    • Added / Removed / Changed HTML element's Bootstrap classes
    • Changed which HTML elements uses which Angular directive
    • Removing certain HTML elements or changing them from type
    • Added new SASS variables
    • Added new CSS mappings

To test this you can start a local Angular instance in combination with the REST of host: demo.dspace.org. You can then compare it in another browser tab with DSpace that still uses Bootstrap 4 https://demo.dspace.org.
Note that we deliberately left in some style changes:

  • The width of the containers

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
    Reason: This is an upgrade for a major dependency and thus it affects a lot of code.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

LotteHofstede and others added 30 commits August 28, 2024 13:26
@tdonohue tdonohue self-requested a review February 20, 2025 15:11
@atarix83 atarix83 requested review from FrancescoMolinaro and removed request for FrancescoMolinaro February 26, 2025 07:51
Copy link
Contributor

@FrancescoMolinaro FrancescoMolinaro left a comment

Choose a reason for hiding this comment

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

Hi @Wout-atmire , many thanks for these changes!

I had a look to the PR and it looks good, anyway I found some issues, you can find them as comments on the code diff.
In addition I found out a couple of problems more that I couldn't spot in the code.

In specific in the submission page I can see that the arrows of ds-number-picker changed color and are now greenish:

current

image

before

image

Furthermore I believe we lost some of the classes from ngDynamicForms, for instance the is-invalid class. This is reproduceable for instance on the license checkbox, where the text is not red anymore:

current

image

before

image

@@ -5,6 +5,8 @@

.dropdown-menu {
overflow: hidden;
min-width: 100%;
top: 100%;
@include media-breakpoint-down(sm) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @Wout-atmire I think that we should change also this media-breakpoint-down as you did for all the others.

@@ -2,6 +2,9 @@

@import './_theme_sass_variable_overrides.scss';
@import '../../../styles/_variables.scss';

$theme-colors: map-merge($theme-colors, $theme-custom-semantic-colors);
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @Wout-atmire would be possible to move this sass variable inot the sass override file?

@@ -6,820 +6,58 @@
// Variables should follow the `$component-state-property-size` formula for
// consistent naming. Ex: $nav-link-disabled-color and $modal-content-box-shadow-xs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @Wout-atmire is there a reason to delete all the existing variable mappings?

Copy link
Author

Choose a reason for hiding this comment

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

Hi @FrancescoMolinaro, thank you for the feedback. The removed mappings were dependent on variables that are no longer present in Bootstrap 5. Let me know if you need any further clarification.

Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

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

@Wout-atmire : Thanks for this PR! I gave this a code review & testing today. Overall, it's looking good, but I've run into a few things as well. (I also noticed a lot of the things that @FrancescoMolinaro mentioned above, so I've excluded those from my feedback.)

First, besides what is mentioned above, I've found a few pages which need some minor CSS cleanup as they no longer look as good.

  1. The collection harvesting options now have a radio button (circled below). That should not be visible. Part of this form is also slightly misaligned (see for example how this page looks on sandbox.dspace.org)

collection-harvest

  1. The Administrative Reporting feature (disabled by default) is showing no space between checkboxes and the text next to them.
    admin-reports

Other than that, I didn't notice anything that stood out. I did notice a few other minor oddities though in my code review...see inline below.

I'm basically a +1 to this work once this minor feedback is addressed along with the feedback of @FrancescoMolinaro above. Thanks again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file high priority new feature themes
Projects
Status: 👀 Under Review
Development

Successfully merging this pull request may close these issues.

Upgrade Bootstrap to v5
5 participants