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

Fixes #303. Replaced dynamic styling with class-based CSS approach. #323

Closed
wants to merge 4 commits into from

Conversation

poojatalele
Copy link

@poojatalele poojatalele commented Aug 4, 2024

Fixes

Description

This PR addresses the issue where dynamic styling was being used to control the visibility of resource cards in the _assets/js/listing.js file. To enhance maintainability and consistency, the following updates were made:

Introduced new CSS utility classes (.hidden and .visible) to handle the visibility of resource elements without relying on dynamically injected styles.
Refactored the updateVisibility function to utilize these new classes, ensuring that elements are shown or hidden based on the user's filter selections (topic, medium, language).
Adjusted the resource navigation filters to dynamically apply the appropriate visibility classes, providing a cleaner and more efficient way to control the display of filters.
These changes align with the suggestion to replace dynamic styling with a class-based approach, making the codebase more consistent and easier to maintain.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@poojatalele poojatalele requested a review from a team as a code owner August 4, 2024 05:31
@poojatalele poojatalele requested review from TimidRobot and annatuma and removed request for a team August 4, 2024 05:31
@possumbilities possumbilities requested review from possumbilities and removed request for TimidRobot and annatuma August 5, 2024 20:53
@Murdock9803
Copy link
Member

@poojatalele you should make more descriptive Pull Requests. The fields are almost all empty. You can remove them if not necessary.

@@ -270,6 +270,7 @@ GEM
PLATFORMS
aarch64-linux
arm64-darwin-23
x86_64-linux
Copy link
Member

Choose a reason for hiding this comment

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

This is an additional change which should be reverted. The Gemfile.lock file is not the target here i believe.

@poojatalele
Copy link
Author

poojatalele commented Aug 11, 2024

@poojatalele you should make more descriptive Pull Requests. The fields are almost all empty. You can remove them if not necessary.

Updated all the changes, kindly review. @Murdock9803

@possumbilities
Copy link
Contributor

@poojatalele thank you for this contribution!

After looking through there are some improvements that could be made to streamline it a bit further. Since the default state is visible, we don't need a visible class, and could instead only have a hidden class and utilize the classList.toggle method rather than the classList.add and classList.remove methods.

For a somewhat similar example of approach see the vocabulary.js file.

@poojatalele
Copy link
Author

@poojatalele thank you for this contribution!

After looking through there are some improvements that could be made to streamline it a bit further. Since the default state is visible, we don't need a visible class, and could instead only have a hidden class and utilize the classList.toggle method rather than the classList.add and classList.remove methods.

For a somewhat similar example of approach see the vocabulary.js file.

Okay, got it! I'll update the changes.

@possumbilities
Copy link
Contributor

@poojatalele Thank you! 👍

@poojatalele
Copy link
Author

@Murdock9803 @possumbilities Replaced classList.add and classList.remove with classList.toggle.
Kindly review :)

@possumbilities
Copy link
Contributor

The changes here break the function of the filters after recent UX work. Closing, and would suggest it be revisitied with current work merged in.

@possumbilities possumbilities self-assigned this Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Feature] Replace the dynamic styling in listing.js with class-based CSS approach
3 participants