view_components icon indicating copy to clipboard operation
view_components copied to clipboard

System arguments `color` valid values differ from LabelComponent's `scheme` valid values

Open cheshire137 opened this issue 3 years ago • 1 comments

👋🏻 Something I noticed when trying to coordinate an Octicon's color with a LabelComponent's scheme was that the valid values for each aren't the same. Compare:

color:

Text color. One of :accent, :attention, :closed, :danger, :default, :done, :inherit, :muted, :on_emphasis, :open, :severe, :sponsors, :subtle, or :success.

-- https://primer.style/view-components/system-arguments#color

scheme:

One of :accent, :attention, :danger, :default, :done, :info, :orange, :primary, :purple, :secondary, :severe, :sponsors, :success, or :warning.

-- https://primer.style/view-components/components/label

Common values:

  • :accent
  • :attention
  • :danger
  • :default
  • :done
  • :severe
  • :sponsors
  • :success

Differences:

  • :subtle is a valid color but is not a valid scheme
  • :closed is a valid color but is not a valid scheme
  • :inherit is a valid color but is not a valid scheme
  • :muted is a valid color but is not a valid scheme
  • :on_emphasis is a valid color but is not a valid scheme
  • :open is a valid color but is not a valid scheme
  • :subtle is a valid color but is not a valid scheme
  • :info is a valid scheme but is not a valid color
  • :warning is a valid scheme but is not a valid color
  • :secondary is a valid scheme but is not a valid color
  • :purple is a valid scheme but is not a valid color
  • :primary is a valid scheme but is not a valid color
  • :orange is a valid scheme but is not a valid color

I wanted to bring this up because I think some/all of the different values could actually probably work for both components, just based on my understanding that all these colors are coming from Primer variables like in https://primer.style/css/utilities/colors.

cheshire137 avatar Aug 08 '22 20:08 cheshire137

Hi @cheshire137, thanks for reporting this! It definitely seems like something that should get addressed. We're going to move this into our backlog to explore improving it in the future.

Internal note: this will require breaking changes.

lesliecdubs avatar Aug 15 '22 23:08 lesliecdubs

Hi! This issue has been marked as stale because it has been open with no activity for 180 days. You can comment on the issue or remove the stale label to keep it open. If you do nothing, this issue will be closed in 7 days.

github-actions[bot] avatar Feb 12 '23 00:02 github-actions[bot]

Not stale

lesliecdubs avatar Feb 13 '23 23:02 lesliecdubs

Hi! This issue has been marked as stale because it has been open with no activity for 180 days. You can comment on the issue or remove the stale label to keep it open. If you do nothing, this issue will be closed in 7 days.

github-actions[bot] avatar Aug 13 '23 01:08 github-actions[bot]

Are we still not stale, @lesliecdubs? The bot is insistent. 😅 I didn't want to reopen if y'all wanted it closed because it's not a priority right now, though.

cheshire137 avatar Aug 21 '23 14:08 cheshire137

@cheshire137 I think this is still a valid issue, though it's unlikely we will have resources within Primer Engineering to address it in the near future. Please feel free to reopen in the "Unprioritized backlog" if you'd like to keep this on the radar for future improvement.

lesliecdubs avatar Aug 21 '23 21:08 lesliecdubs

Please feel free to reopen in the "Unprioritized backlog" if you'd like

Thanks! Sorry, is that a milestone/project/repo/label?

cheshire137 avatar Aug 23 '23 14:08 cheshire137

Sorry for the obtuse instruction 🤦🏻‍♀️ I will go ahead and reopen this issue and move it to the "Unprioritized backlog" on our team project board.

lesliecdubs avatar Aug 24 '23 23:08 lesliecdubs

Hi! This issue has been marked as stale because it has been open with no activity for 180 days. You can comment on the issue or remove the stale label to keep it open. If you do nothing, this issue will be closed in 7 days.

github-actions[bot] avatar Feb 21 '24 00:02 github-actions[bot]