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

Update the kolibri logo. #561

Merged
merged 10 commits into from
Mar 20, 2024

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Feb 29, 2024

Description

  • Updates the Kolibri logo.
  • Removes use of KImg in KLogo in order to render the SVG inline for animation, color changes etc.
  • Moves prop validation helper function in KImg into utils file so that it can be referenced in KLogo.
  • Adds the option to show the blob background for the Kolibri logo
  • Adds the option to animate the Kolibri logo as a loader
  • Adds the different permissible color schemes for the logo
  • Updates KLogo documentation to showcase variants

Before/after screenshots

All options are documented and demonstrated in the updated documentation.

Changelog

Updated in PR.

Testing checklist

  • Contributor has fully tested the PR manually
  • The change is described in the changelog

Reviewer guidance

Review the updated KLogo documentation page for this.
Did the minor refactor of KImg put the function in the right place?

After review

  • The changelog item has been pasted to the CHANGELOG.md

Comments

@rtibbles
Copy link
Member Author

One possibility that occurs is we should include both the logo with a background and without a background here, I'll make the update accordingly.

@rtibbles rtibbles changed the base branch from develop to release-v4 March 7, 2024 19:48
@rtibbles rtibbles force-pushed the new_logo_new_you branch 2 times, most recently from da78764 to d24dd5a Compare March 8, 2024 03:42
@MisRob MisRob self-requested a review March 8, 2024 12:12
@MisRob MisRob self-assigned this Mar 8, 2024
Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

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

That's all very nice :) Nothing jumped out from the code and the documentation page is very helpful, thank you.

Very minor note is that it may be nice to reformulate a bit this section since it doesn't have much to do with KImg anymore. Perhaps we could just instead mention that KImg is for non-logo images.

Screenshot from 2024-03-12 15-29-39

@rtibbles
Copy link
Member Author

Sure, that had also occurred to me at one point, and then I'd forgotten about it. I'll update the docs.

@rtibbles rtibbles force-pushed the new_logo_new_you branch 2 times, most recently from 528068c to 9a29533 Compare March 19, 2024 15:19
</DocsPageTemplate>

</template>


<script>

export default {};
// Note for developers, to utilize the saveSVG method, select all of:
Copy link
Member

Choose a reason for hiding this comment

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

Handy

Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

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

Overall it's looking good, thanks for all this work @rtibbles.

Not blocking, just a few doc tweaks that would be nice before merging:

(1) I think we could remove maxSize from examples code
Screenshot from 2024-03-20 10-33-31

since it's not a 'meaningful' representation of how the component will be used (with defined size in px, maxSize won't have any further effect). If we wanted to demonstrate how to use size together with maxSize, something like this would make more sense
Screenshot from 2024-03-20 10-35-46

but I think it'd be okay to keep examples simple and have just size.

(2) Relatedly, as we're now using size language, I think that related props documentation
Screenshot from 2024-03-20 10-36-50
could benefit from more specificity as to what values are expected.

I wrote some guidance for this in KImg if it helps (and this reminds me I'd better include it in KImg props docs as well):

Values may be either numbers or strings consisting of a numeral and a valid unit. The following units are supported: %, cm, em, ex, ch, in, lh, mm, px, rem, rlh, vh, vw. If you don't provide a unit, px will be used by default.

@rtibbles
Copy link
Member Author

Will update, thanks @MisRob!

@rtibbles rtibbles merged commit d1362b2 into learningequality:release-v4 Mar 20, 2024
8 checks passed
@rtibbles rtibbles deleted the new_logo_new_you branch March 20, 2024 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants