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

Clarify docs around usage of help icon for tooltip/popover text #1332

Open
mcoker opened this issue Aug 14, 2024 · 0 comments
Open

Clarify docs around usage of help icon for tooltip/popover text #1332

mcoker opened this issue Aug 14, 2024 · 0 comments

Comments

@mcoker
Copy link
Contributor

mcoker commented Aug 14, 2024

Reported by @christianvogt via slack:

It's a little unclear whether <HelpIcon> or <OutlinedQuestionCircleIcon> is the recommended icon for help text (triggers a tooltip/popover for contextual help). Specifically in the context of a field label in a form.

In all of the places I looked across PF components that support help text triggered via an icon, we're using <HelpIcon>, which is part of our custom icon set. The SVG code is in core (source) and used to create the <HelpIcon> seen on this page which shows all of the icons in @patternfly/react-icons - https://react-staging.patternfly.org/icons. Here's a screenshot, along with <OutlinedQuestionCircleIcon>:

Screenshot 2024-08-13 at 7 40 41 PM Screenshot 2024-08-13 at 7 48 16 PM

However, in the icons table on https://www.patternfly.org/design-foundations/icons#all-icons, only the FA icons are listed and "fa-question-circle (outlined)" says "Indicates the availability of contextual help".

In the form design guidelines, the wording is "In a form, indicate a popover with an unfilled question mark circle that reveals information when clicked."

In the popover design guidelines, the wording is "When using a default popover to define a term or explain a concept, use a gray question-circle icon."

If someone were to ask me which icon to use, I would recommend <HelpIcon> to match the icons used in PF components. However, if someone were to reference the design guidelines on org, I think they would assume <OutlinedQuestionCircleIcon> is the correct icon to use.

I guess the questions are:

  • Is there a preferred/recommended icon to use, or can they be used interchangeably?
  • If our components use <HelpIcon>, should we mention that in these (or other) docs/design guidelines on org?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs triage
Development

No branches or pull requests

1 participant