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

Organise and fix bugs in color definitions #4969

Merged
merged 4 commits into from
Sep 20, 2024
Merged

Organise and fix bugs in color definitions #4969

merged 4 commits into from
Sep 20, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Sep 20, 2024

Description

This PR organises colors into groups in the tailwind.css and tailwind.config.ts files for clarity.

Color changes

This PR removes redundant and/or unused colors and also adds missing colors.

Action tailwind.css tailwind.config.ts
Removed color-gray colors.gray.DEFAULT
Removed color-gray-13-0 colors.gray-opacity.13.0
Removed color-white-0 colors.white.0
Removed --color-bg-zero backgroundColor.zero
Removed colors.gray.light-gray
Removed colors.gray.dark-gray
Added --color-bg-blur

Functions in Tailwind config

This PR also uses functions to generate color shade and opacity scales in tailwind.config.ts. Typing out 13 shades for each color is understandably more readable but also error-prone. There is an existing case of such error where a value was missed.

5: "var(--color-yellow-5)",
7: "var(--color-yellow-7)",

Still, to preserve most of the past readability, programmatic definition is kept to a minimum and is confined to two of the most repetitive usages.

Testing Instructions

This PR should result in no change to the user-interface.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • 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.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

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.

@dhruvkb dhruvkb added 🟩 priority: low Low priority and doesn't need to be rushed 📄 aspect: text Concerns the textual material in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: frontend Related to the Nuxt frontend labels Sep 20, 2024
@openverse-bot openverse-bot added the 🧱 stack: documentation Related to Sphinx documentation label Sep 20, 2024
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/4969

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@dhruvkb dhruvkb marked this pull request as ready for review September 20, 2024 09:21
@dhruvkb dhruvkb requested a review from a team as a code owner September 20, 2024 09:21
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

I like the cleanup but I'm a little wary of removing the list of all values from tailwind.config because we lose the ability to use search during development. Maybe we could move the generation to a separate script, and generate the tailwind file using it?

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

I like this approach; LGTM.

To @obulat's point I think if I was searching for a CSS var, like "--color-info-1", for example, the result returned from frontend/src/styles/tailwind.css would be much more useful than the now-unavaliable tailwind.config.ts value, anyway.

@dhruvkb
Copy link
Member Author

dhruvkb commented Sep 20, 2024

Adding onto Zack's point, searching in tailwind.config.ts was already not very good because it's nested so a value like --color-yellow-7 would not match the file because the definition is

colors: {
  yellow: {
    7: 'var(--color-yellow-7)',
  },
}

@dhruvkb dhruvkb merged commit bd3e47f into main Sep 20, 2024
90 checks passed
@dhruvkb dhruvkb deleted the darker_homepage branch September 20, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants