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

Studio: Audit and fix theme token updates against KDS #4459

Merged
merged 18 commits into from
Apr 17, 2024

Conversation

akolson
Copy link
Member

@akolson akolson commented Feb 28, 2024

Summary

Description of the change(s) you made

Updates Studio with KDS theming updates introduced in learningequality/kolibri-design-system#551.

Manual verification steps performed

  • Browse through Studio while observe the branding changes.

Screenshots (if applicable)

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

Development

QA

  • Can you see some glitches in regards to colors?
  • Are contrast ratios good?
  • Please test states that are often not obviously visible - errors, warning, and similar
  • Mobile device

References

Closes #4439
KDS PR: learningequality/kolibri-design-system#551
Designs: https://www.figma.com/file/p7aOP2MBv0SED1uhaPwqEd/Product-rebrand?type=design&node-id=426-7545&mode=design

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

MisRob and others added 6 commits February 23, 2024 08:30
Fixes "Error: Can't resolve 'kolibri-design-system/lib/utils/i18n'"
caused by removal of this file in KDS v2.0.0 by copying the removed
file content directly to Studio.
Remove deprecated `value` prop in favor of the new
`buttonValue` prop that's supposed to replace it
in `KRadioButton`.
@akolson akolson changed the title [WIP] Studio: Audit and fix theme token updates against KDS Studio: Audit and fix theme token updates against KDS Feb 29, 2024
@marcellamaki marcellamaki requested a review from bjester February 29, 2024 15:11
color: {
type: String,
default: 'secondary',
},
Copy link
Member Author

Choose a reason for hiding this comment

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

I added a color prop here as there are instances where the MainNavigationDrawer top needs to match with the AppBar color since its not always yellow. We actually do have a white app bar too and this prop provides the much needed flexibility.

@akolson akolson marked this pull request as ready for review February 29, 2024 15:19
Copy link
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

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

Hi @akolson - this looks like good work! One thing that needs updating, which wasn't fully outlined, is the "immersive" app bars, or full screen modal app bars, should all be black, rather than blue. I just double checked with Jessica. Some of this might be token swapping, and perhaps some of it is hex codes - I'm not sure.

Other than that, I don't see any critical blockers right now.

I did notice one KDS update needed for the loaders, but I'll follow up with @LianaHarris360 about that in KDS :)

@akolson
Copy link
Member Author

akolson commented Mar 18, 2024

Thanks @marcellamaki. I think we should be good now;
image

@akolson akolson requested review from bjester and marcellamaki March 18, 2024 15:26
@marcellamaki
Copy link
Member

marcellamaki commented Mar 18, 2024

I did notice one KDS update needed for the loaders, but I'll follow up with @LianaHarris360 about that in KDS :)

Oops, it's a vuetify thing, not a KDS thing!

So, there are several places where VProgressCircular is used with colors secondary, greenSuccess, progressBarColor. Since we are updating KCircularLoader and KLinearLoader in KDS to use black, I think we should update them here too. Most critically is not using secondary which is yellow, and doesn't provide sufficient contrast, but I think all of them should be updated, unless @jtamiace thinks we should keep other colors (i.e. green) for studio-specific use case.

(Sorry I thought I was going to make this edit in time before you pushed changes but I didn't quite make it )

@akolson
Copy link
Member Author

akolson commented Mar 18, 2024

@marcellamaki I think the figma designs spec mentions using black if I recall correctly
image

<img
:height="`${height}px`"
width="auto"
:src="require('shared/images/kolibri-logo.svg')"
Copy link
Member

Choose a reason for hiding this comment

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

Any other usages of this file? Is it safe to delete?

@bjester
Copy link
Member

bjester commented Apr 16, 2024

image

@akolson The icon indicating resources are coach content seemingly isn't using the correct color.

image

The color comes from CSS vars, so it seems to possibly be set through some explicit CSS.

@@ -73,7 +76,11 @@
</VListTile>
</VList>
<VContainer>
<KolibriLogo :height="75" />
<KLogo
altText="Kolibri logo"
Copy link
Member

Choose a reason for hiding this comment

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

Seems like this alt text should be translated. Although for the rebranding release, I think we're trying to avoid translating things. It also sucks I don't think we can have KLogo just have this internally.

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

Approved! Merging so we can create the release PR

Things for followup:

  • KLogo alt text
  • channelHighlightDefault color
  • whether there are other usages of shared/images/kolibri-logo.svg that need replaced, and if not can we delete the file

@bjester bjester merged commit f0fa1f6 into learningequality:hotfixes Apr 17, 2024
9 checks passed
@akolson akolson mentioned this pull request Apr 17, 2024
@akolson akolson deleted the studio_rebranding branch October 31, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants