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

Non-standard/Deprecated icons are not consistent #5571

Closed
3 of 5 tasks
OnkarRuikar opened this issue Mar 10, 2022 · 9 comments
Closed
3 of 5 tasks

Non-standard/Deprecated icons are not consistent #5571

OnkarRuikar opened this issue Mar 10, 2022 · 9 comments
Assignees
Labels
🐛 bug Something isn't working, or isn't working as expected has PR Issues that already have a PR 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. p2 We want to address this but may have other higher priority items. redesign issues related to the new design

Comments

@OnkarRuikar
Copy link
Contributor

OnkarRuikar commented Mar 10, 2022

Summary

The entire page and compatibility section uses different icons for the same 'Non-standard' badge.
Same is the case with Deprecated badge.
Same icon 👎🏻 has different meanings, in different sections on the same page.

URL

https://developer.mozilla.org/en-US/docs/Web/API/Window#browser_compatibility
https://developer.mozilla.org/en-US/docs/Web/API/Window#methods

Reproduction steps

  1. Open the URL and search mozpaintCount property.
  2. In properties section you'll see assigned badges like this:
    img1
    Note:
    👎🏻 => Non-standard
    🗑 => Deprecated
  3. Now go to browser compatibility section. You'll see:
    img2
    Note:
    👎🏻 => Deprecated
    ⚠ => Non-standard
  4. Now open page https://developer.mozilla.org/en-US/docs/Web/API/Window/mozPaintCount . There you'll see:
    img3
    Note:
    ❌ => Deprecated
    ⚠ => Non-standard
  5. Note, same icon 👎🏻 has different meanings, on the same page. The icons used are different for the same badges.

Expected behavior

Icons should be consistent across the entire site.

  • 1. 🗑 should mean Deprecated everywhere on the website. Compatibility section and notecards need to be corrected.
  • 2. ⚠ should mean Non-Standard everywhere on the website. CSS rule icon-nonstandard needs to be corrected on main page. The icon 👎🏻doesn't fit well here, and has negative tone.

Less severe issues:

  • 3. Same icons should be used everywhere e.g. Experimental icon looks different everywhere: The flask is different for compatibility and main section.
  • 4. Quick links sidebar has colored badges. Looks odd. Can we have same black and white badges there too?
  • 5. Currently badge order is different at 3 places(mentioned in Steps to Reproduce section). For sake of consistency the badges should appear in same order every where e.g. deprecated -> experimental -> non-standard. Or the order can be decided based on the danger of using such APIs, i.e. deprecated are more harmful than experimental, cos they can creep into production easily, and so on.

Actual behavior

  • Icon 👎🏻 represents different badges in main content(non-standard) and in browser compatibility(deprecated).
  • Deprecated badge uses different icons ( 🗑, 👎🏻 , and ❌) at different places: main content, browser compatibility, and notecards.
  • Icons have different flavors at different places. In quicklinks sidebar icons are colored.

Device

Desktop

Browser

Chrome

Browser version

Stable

Operating system

Windows

Screenshot

No response

Anything else?

No response

Validations

@OnkarRuikar OnkarRuikar added the 🐛 bug Something isn't working, or isn't working as expected label Mar 10, 2022
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Mar 10, 2022
@caugner
Copy link
Contributor

caugner commented Mar 10, 2022

Good catch, thanks!

As for the BCD tables, I will check internally if there is any reason not to use the trash symbol there. If there isn't, this would be a good community PR opportunity along these lines:

status.deprecated && {
title: "Deprecated. Not for use in new websites.",
text: "Deprecated",
iconClassName: "icon-thumbs-down",
},

const LEGEND_LABELS = {
yes: "Full support",
partial: "Partial support",
preview: "In development. Supported in a pre-release version.",
no: "No support",
unknown: "Compatibility unknown",
experimental: "Experimental. Expect behavior to change in the future.",
"note-warning": "Non-standard. Check cross-browser support before using.",
"thumbs-down": "Deprecated. Not for use in new websites.",
footnote: "See implementation notes.",
disabled: "User must explicitly enable this feature.",
altname: "Uses a non-standard name.",
prefix: "Requires a vendor prefix or different name for use.",
};

As for the non-standard / deprecated headers, I agree that it would make sense to use the corresponding icons there. Again, I will check this internally and get back.

I would clarify these first before going into issues 4 ("Quick links sidebar has colored badges") and 5 ("Currently badge order is different at 3 places").

@caugner caugner self-assigned this Mar 10, 2022
@caugner caugner added the p2 We want to address this but may have other higher priority items. label Mar 10, 2022
@caugner caugner changed the title Different icons used for same badge in main content and Browser compatibility section Non-standard/Deprecated icons are not consistent Mar 10, 2022
@caugner caugner added redesign issues related to the new design and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Mar 11, 2022
@caugner
Copy link
Contributor

caugner commented Mar 11, 2022

I have checked internally, and we would like to

  • use the trash symbol consistently for deprecated features, and
  • restore the icons for the non-standard / deprecated headers (notecards).

@OnkarRuikar Would you be interested in submitting one or two PRs for this?

@caugner caugner added the accepting PR We invite you to open a PR to resolve this issue. label Mar 11, 2022
@caugner caugner added has PR Issues that already have a PR and removed accepting PR We invite you to open a PR to resolve this issue. labels Mar 13, 2022
@danielhjacobs
Copy link
Contributor

1-3 fixed by #5583

@caugner
Copy link
Contributor

caugner commented Mar 15, 2022

1-3 fixed by #5583

Unless I'm mistaken, 3 is not yet fixed, but will be fixed by #5611.

PS: I have inserted a task list for the 5 problems mentioned in the OP.

@caugner
Copy link
Contributor

caugner commented Apr 7, 2022

FWIW #5644 is resolving point 4.

@danielhjacobs
Copy link
Contributor

@caugner So is there internal consensus for removing the color of those icons? Last I heard it was still being discussed.

@caugner
Copy link
Contributor

caugner commented Apr 7, 2022

@danielhjacobs Sorry for the waiting time. I have added this to the agenda of an internal meeting on Wednesday.

@danielhjacobs
Copy link
Contributor

#5644 is merged. That's fine, but it means I'll need to open a follow-up PR if the result of Wednesday's meeting is that the colors are to be removed.

@github-actions github-actions bot added the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label May 28, 2022
@caugner
Copy link
Contributor

caugner commented Nov 11, 2022

We are consistent now, and we'll keep the colors until further notice.

@caugner caugner closed this as completed Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working, or isn't working as expected has PR Issues that already have a PR 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. p2 We want to address this but may have other higher priority items. redesign issues related to the new design
Projects
Development

No branches or pull requests

3 participants