intellij-sdk-code-samples/tooltip.md at 2adf322f35e0ecde6f5ad0a44b178558afd696ad

mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 02:07:50 +08:00

Karol Lewandowski d8e83b57ea

* Add UI Guidelines to  SDK docs

* Add UI Guidelines to  SDK docs

* Fixing build errors

* optimize PNGs

* add UI guidelines landing page placeholder

* IJ SDK Docs <-> UI guidelines crosslinks updated

* split_button.md: remove reference to removed setting

* use <ui-path>

* use MD instead of <note>

* use %gh-ic% links

* drop_down.md: fix <control>

* code samples: fix most obvious issues

* remove obsolete `_defaults.md`

* ijs.tree: UI cleanup

* Delete "under construction" pages

* Fix headers

* Add link-summary

* Remove invalid links

* Delete unused files

* Remove ''@2x' from image file names

* Use Markdown syntax for some images and tables

* Rename non-unique files to unique

* Remove alpha in images where content is unreadable

* align quotation marks

* Controls: cleanup/fixes, add code links, edit

* tooltip.md: fix HTML

* misc fixes

* typography.md: fix table contents

* typography.md: fix table header

* UI guidelines landing page + TOC fixes

* remove unused icons_list.md

* Normalize image paths

* validation_errors.md: Fix broken tab

* "correct"/"incorrect" labels styling

* Resize images to 50%

* button.topic: fixes

* grammar, spelling, minor edits

* remove '&nbsp;'

* fix 99px

* cleanup

* UI_kit.md: minor

* Fix "MRK058: Large image in paragraph rendered as a block element by default."

* button.topic: Add img[alt]

* mnemonics.md: Update "Contact Us" link to the IJSDK YouTrack

* split_button.md: Use ui-path

* UI landing: add feedback snippet

* Improve code snippets formatting and naming

* Fix code samples

* Fix code samples

* Add Kotlin variants for code samples

* Add icons_list.md

* crosslinks

* Change external link to https://intellij-icons.jetbrains.design/

* icons list -> https://intellij-icons.jetbrains.design

* Hide info about reducing split button to simple action button (now it is available through the registry only)

* reformat

* icons_style.md: Images in new line

---------

Co-authored-by: marianna.kononenko <marianna.kononenko@jetbrains.com>
Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>

2024-05-16 13:51:56 +02:00

8.8 KiB

Raw Blame History

UI guidelines on using tooltips.

Implementation: HelpTooltip

A tooltip shows an action name or provides useful information about an action or a setting.

{width=174}

When to use

There are three types of tooltips:

Action Shows an action name or label for icons and unlabeled controls, and a shortcut if available.
Action help Shows help text for icons and unlabeled controls in addition to an action name or label.
Help Shows help text for all other controls.

All icons and unlabeled controls should have an Action or an Action help tooltip.

Use Action help and Help tooltips according to the Context help rules.

How to use

Required and optional information

Always show the required information in a tooltip:

Tooltip	Required info	Optional
Action	Action name	Shortcut
Action help	Action name Help text	Shortcut Link
Help	Help text No action name or label because it is already shown in the UI.	Shortcut Link

Show a shortcut if an action or a setting has one. Do not show a single shortcut in a tooltip.

{width=230}

Provide a link to a source that can further explain the action or the setting. A link can navigate to a place in the IDE or to an external help article.

Local link	External link
{width="300"}	{width="300"}

Do not show just an action name and a link to a help article. Provide help text so that the user does not need to switch to a web browser.

{width=516}

Text length and formatting

The text width in an action tooltip is not limited. The text width in a help tooltip is limited by 250px.

Show no more than 10 lines of help text. If the text does not fit, leave only the essential information and add a link to a help article.

Incorrect

{width=601}

Correct

{width=601}

Text style formatting:

Avoid using style formatting in the help text. Usually, the text is short and no bold or italics are needed.

Incorrect

{width=461}

Correct

{width=461}
Use formatting for code, console commands or parameters. Use HTML tags. Enclosing the text in <html></html> tags is not needed.

{width=407 style=block} Editor breadcrumbs
Action name, shortcut and link do not allow HTML tagging.

If the help text is longer than 5 lines, separate the text into paragraphs with the <p> tag. The <p> tag adds vertical space between paragraphs to visually separate them. Do not use the <br/> tag as it does not add space.

{width=300}

val LONG_TEXT = """A new overloading method will be created with
    the new parameter added to this method definition.<p>
    The method with the old signature will be kept and the call
    to the new method will be added to it. The necessary value
    or expression will be passed to the new method call."""
HelpTooltip().setDescription(LONG_TEXT).installOn(component)

String LONG_TEXT = "A new overloading method will be created with " +
    "the new parameter added to this method definition.<p>" +
    "The method with the old signature will be kept and the call " +
    "to the new method will be added to it. The necessary value " +
    "or expression will be passed to the new method call.";
new HelpTooltip().setDescription(LONG_TEXT).installOn(component);

Writing guidelines

Make the help text short and descriptive.

In a help tooltip, do not repeat an action or a setting name in the text.

{width=394}

Question mark icon for help tooltips

Always use the help tooltip with the question mark icon. Without the icon, it is unclear which component has help information.

Always place the question mark icon to the right of the corresponding UI component.

Examples with different controls:

Checkbox

{width=543}

Tree item

{width=390}

Combo box

{width=467}

Group header

{width=409}

Settings breadcrumbs

{width=458}

Stand-alone button not at the bottom of a dialog

{width=476}

Exception: do not use the help tooltip with buttons at a dialog’s bottom. Put the information into the help article that is opened with the question mark button in the bottom left corner.

Incorrect

{width=372}

Style

{width=723}

Built-in behavior

All tooltips appear on hover (not on click), including the help tooltip with the question mark icon.

All tooltips are hidden when the mouse cursor leaves the area that triggers the tooltip.

If the mouse cursor stays in the tooltip trigger area, tooltips are also hidden after a timeout specified in the table below.

Tooltip	Appears after	Hides after If cursor is in the tooltip trigger area
Action	300 milliseconds ide.tooltip.initialReshowDelay registry key	10 seconds ide.helptooltip.regular.dismissDelay
Action help		30 seconds ide.helptooltip.full.dismissDelay
Help		Never hides

If a tooltip has a link, it is possible to move the mouse cursor over the tooltip. The tooltip does not close automatically when the cursor is over it.

Tooltips are positioned automatically depending on the mouse cursor location.

8.8 KiB Raw Blame History Unescape Escape

Tooltip