Closed Bug 1492018 Opened 6 years ago Closed 4 years ago

Use a single class per indicator type

Categories

(developer.mozilla.org Graveyard :: General, enhancement, P5)

enhancement

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: e7358d9c, Assigned: e7358d9c)

References

()

Details

(Keywords: in-triage)

Attachments

(4 files, 1 obsolete file)

(Quoted from `indicators.scss`)
> Indicators
> - in a perfect world each indicator is composed of 2 classes that
>   combine to indicate how it should display.
> - one to indicate whether it is a block or a inline indicator
> - one to indicate what colour and icons it should halve
> - in practice there are multiple classes that indicate these things
>   and a few indicators that only have one class to serve both purposes
> **********************************************************************

Based on that, it seems like the CSS classes `.blockIndicator` and `.inlineIndicator` should be used.

In practice, `.overheadIndicator` is the most commonly used block indicator class, followed by the mishmash of other block indicator classes.

This bug serves to track the work needed in kuma and kumascript to migrate to using `.blockIndicator` (although `.overheadIndicator` might end up being used instead) and `.inlineIndicator` for determining the indicator type.
Attachment #9010696 - Flags: review?(jwhitlock)
Attachment #9010695 - Flags: review?(shobson)
I'm sorry, I'm not on this project anymore and don't have time to do a review.

I am pleased to see this work moving forward though!
Attachment #9010695 - Flags: review?(shobson)
Attachment #9010695 - Flags: review?(lorchard)
Attachment #9010695 - Flags: review?(lcrouch)
Flags: needinfo?(jwhitlock)
Comment on attachment 9010695 [details] [review]
Part 1 - Kuma: Prefer `.blockIndicator` for styling block indicators

I've also been a long time away from this project and won't be much help for a review.
Attachment #9010695 - Flags: review?(lorchard)
Keywords: in-triage
Priority: -- → P5
Comment on attachment 9010697 [details] [review]
Part 2 - KumaScript: Prefer `.blockIndicator` for styling block indicators

Can we get this merged before the “macro massacre” project¹ will require me to rebase this yet again?

¹ https://discourse.mozilla.org/t/next-steps-for-kumascript/32227
Attachment #9010697 - Flags: review?(wbamberg)
:Exe Boss, I'm not familiar enough with the Kuma front-end code to review this change. I suggest you ask Schalk Neethling (:espressive).
Attachment #9010697 - Flags: review?(wbamberg)
(In reply to John Whitlock from https://github.com/mozilla/kuma/pull/4962#issuecomment-426333569)
> I think I'm the wrong person to review this. I can review style changes
> if you are trying to fix something that I can see on a particular page
> on MDN, because I can load the page in my browser before and after the
> change and see what the effect is. I'm not aware of any pages that this
> change would make a visual difference on.
> 
> This appears to be a refactoring of classes for some quality goal in
> the CSS source, which isn't clear to me. I think @schalkneethling
> or @hobinjk are better suited to review.
Flags: needinfo?(jwhitlock)
Attachment #9010697 - Flags: review?(schalk.neethling.bugs)
Attachment #9010696 - Flags: review?(schalk.neethling.bugs)
Attachment #9010696 - Flags: review?(jwhitlock)
Attachment #9010696 - Flags: review?(hobinjk)
Comment on attachment 9010695 [details] [review]
Part 1 - Kuma: Prefer `.blockIndicator` for styling block indicators

We don't review PRs on Bugzilla
Attachment #9010695 - Flags: review?(lcrouch)
Attachment #9010695 - Flags: review?(jwhitlock)
Attachment #9010696 - Flags: review?(schalk.neethling.bugs)
Attachment #9010696 - Flags: review?(hobinjk)
Attachment #9010697 - Flags: review?(schalk.neethling.bugs)
Attachment #9010697 - Flags: review?(jwhitlock)
Attachment #9010696 - Attachment is obsolete: true
Attachment #9010697 - Attachment description: Part 3 - KumaScript: Prefer `.blockIndicator` for styling block indicators → Part 2 - KumaScript: Prefer `.blockIndicator` for styling block indicators
See Also: → 1104069
Commit pushed to master at https://github.com/mdn/kumascript

https://github.com/mdn/kumascript/commit/938e4de3b249fcf9f71528438850eef7d7eed941
Bug 1492018: Prefer `.blockIndicator` for styling block indicators (#830)

* Bug 1492018: Prefer `.blockIndicator` for styling block indicators

* Bug 1492018: Avoid using `style` attributes for styling indicators

* Bug 1492018: Use `.experimental` and `.indicator-warning` for {{ES7}}
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/ff3272518ad16c05b09489454390c8ba33cc15ba
Bug 1492018: Prefer `.blockIndicator` for styling block indicators (#4979)

See [bug 1492018](https://bugzil.la/1492018) for details.

## TODO
- [x] Add the `.properties` class to the `:matches(…)` selector (see [`ime-mode`](https://developer.mozilla.org/docs/Web/CSS/ime-mode) for a case where this is necessary)
- [x] Push remaining commits (3/3)

## Changes:
- Add support for snugging `.blockIndicator`.
- Add indicator colour override classes (obsoletes https://github.com/mozilla/kuma/issues/4962):
  - `.indicator-info` - grey
  - `.indicator-version` - blue
  - `.indicator-warning` - yellow
  - `.indicator-danger` - red
- Use classes instead of `style` attributes for ES7/Harmony and JSOverrides.
- Fix `<pre>` block and `.properties` table snugging.

---

review?(@schalkneethling)
Blocks: 1493499
See Also: → 1493499
No longer blocks: 1493499
MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: