learningequality
Update dropshadows to the latest guidelines
🌱 Are you new to the codebase? Welcome! Please see the contributing guidelines.
Blocks
- https://github.com/learningequality/kolibri-design-system/issues/725
Related
- https://github.com/learningequality/kolibri/issues/12552
Summary
Locate all KDS components that use dropshadows and update their style to follow the updated guidelines in the "Elevation and shadow > Drop shadows" documentation section.
For example, this KModal ’s dropshadow
needs to be changed to %dropshadow-6dp.
Note that some components have dropshadows that are not defined via %dropshadow-... , for example:
These need to be replaced by appropriate %dropshadow-... as well.
Guidance
- See https://github.com/learningequality/kolibri-design-system/blob/9d2a147de7e81c945ca0eab7ffb2c4719fd2bb06/lib/styles/definitions.scss#L4 for all dropshadows to search for. However, use only
%dropshadow-1dp,%dropshadow-2dp, and%dropshadow-6dpfor all updated places. The remaining ones will be removed in accordance with the new guidelines later on. - Updating forked components, such as
Uicomponents (lib/keen/) orPopper.vue, is desired (we don’t upgrade to their upstream latest versions anymore) - Preview components as you work. You can preview many components on their documentation pages when running the development server. If there’s a live example missing, you can use the playground page as described in the "Preview updates in the Kolibri Design System environment"
Acceptance Criteria
- [ ] There are no occurrences of
%dropshadow-…usage other than1dp,2dp, and6dpin the whole KDS codebase, nor are there any dropshadow styles defined in ways different from%dropshadow-.... - [ ] However, the unused
%dropshadow-...s shouldn’t be deleted from definitions.scss yet (they are still being referenced from some non-KDS components in the products).
hi, i see that no one is assigned to this issue can i work on this ?
Yes @lokesh-sagi125, thanks. I will assign you. Please familiarize yourself at first with the development server, the documentation site, and the playground page - all is linked in the contributing guidelines. Try to follow the issue guidance closely and message me if you had any questions. I also provided some additional guidance to a contributor who is currently working on the same issue but in a different repository, so you can read through it https://github.com/learningequality/kolibri/issues/12552.
hi, which drop shadow should i use for hover and focus is it dropshadow-6dp?
@lokesh-sagi125 I don't think focus is explicitly mentioned, so thanks for raising that! Just to be sure you're aware of this guidance for other situations, there are some examples in the linked "Elevation and shadow > Drop shadows". If there's something else missing, you're welcome reach out again here.
hello @MisRob , i have finished replacing all the elements that use box-shadow and repricated dropshadows with appropriate replacements, but some elements like -moz-box-shadow: rgb(58, 58, 58) 0 0 6px 0; seem to be using colors in their shadow what should i do for these?
Thanks @lokesh-sagi125! Ah I see, let me check on this and see if I need to talk our designers. Would you have a moment to post a screenshot of the shadow you're referring to so I can preview?
sorry @MisRob ,but were you asking for the code or the photo of the component?
@MisRob could you please check my draft pr once, i think ive made all the necessary changes requires
i also resolved the issue #725 will PR once the other blocking issue is solved
Hey @lokesh-sagi125, could you add a comment in that issue asking to be assigned? So we can assign this to you and avoid it getting assigned to anyone else.
hey @MisRob i am getting an error "changelog.md is not changes" i am new to contributing, can you tell me what i am supposed to do?
Hi @lokesh-sagi125! This is because we need to create new entries in our Changelog.md file for any changes we do in KDS so we can effectevily communicate this in our next release.
When you opened your PR, you should have seen a template. You should not delete that template, but rather fill in the details there. And one of those sections is precisely "Changelog" which is where the details are written that will later be pasted to the Changelog.md file. For now you can ignore that check, once the code review has passed you can paste the content of this Changelog section into the changelog.md file.
For now to recover the template, you can copy the content of this file and fill in the details :).
Thanks @AlexVelezLl and @lokesh-sagi125 :-)
@lokesh-sagi125 we will follow-up in the PR later on, thanks!
Fixed with https://github.com/learningequality/kolibri-design-system/pull/762
