Skip to content

docs(hint): Updates design guidelines for accuracy. #4610

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.

Sign up for GitHub

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

Merged
andrew-ronaldson merged 2 commits into from
May 15, 2025
Merged

docs(hint): Updates design guidelines for accuracy. #4610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a7ecc5
docs(hint): Updates design guidelines for accuracy.
edonehoo May 9, 2025
34fb7a8
Merge branch 'main' into iss4593
andrew-ronaldson May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions ...entation-site/patternfly-docs/content/design-guidelines/components/hint/hint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@ section: components
---
import '../components.css';

For information on other forms of on-screen help, see [Tooltip](/components/tooltip/design-guidelines) and [Popover](/components/popover/design-guidelines).
## Elements

<div class="ws-docs-content-img">
![hint at the top of a UI screen](./img/hint-element.svg)
</div>

1. **Content:** A description of the hint, containing a title (optional), body, and link.
1. **Options menu toggle**
1. **Options menu:** User options for the hint. Can be customized to allows users to dismiss the hint, learn more at another resource, or anything else relevant to your scenario.

## Usage

Use hints to share information about an interaction or prerequisite step that might not be immediately obvious to the user.

<div class="ws-docs-content-img">
![hint at the top of a UI screen](./img/hint-element.svg)
</div>
For information on other forms of on-screen help, see [tooltip](/components/tooltip/design-guidelines) and [popover](/components/popover/design-guidelines).

## Content considerations
Use full sentences with punctuation.
Include relevant links to documentation when necessary.
- Use full sentences with punctuation.
- Include relevant links to documentation when necessary.
Loading