Description

Tooltips are small text like bubbles that appear when the user hovers (focuses on, or touches) an element.

Verint LUX Design System > Tooltips > image2019-7-21_14-3-2.png

For the purpose of this document, tooltips and infotips are the same

Usage & Behaviour

General guidelines

Content

Most tooltips contain plain text which usually describes the control/object they point to
Rich tooltips can contain more than just plain text such as header, icons, dynamic content, tables Etc... .
- For the purpose of this page we'll just use the term tooltips

Examples:

Component
Regular
Regular with heading
Error see Field Validation
Warning see Field Validation
Informative
Help
Additional examples (from different apps)
Regular with dynamic content (Calendar \| statistics)
Regular with heading - 2 lines (Calendar)
Regular with dynamic structured content icon and list (Queue analytics)

Text

When applied to buttons, use user action-oriented copy that communicates the value in a straight forward manner
Keep it short. If you reach more than 150 chars reconsider the tooltip

See examples in table

	Correct	Incorrect
	Generate a schedule for selected employees	Generate schedule
	Search organisation name	search within the listed tree of organisation

Format

Preferred usage for tooltip is to use a small "triangle" at the outline to point mouse cursor.

Triangle position should be dynamic and point the location of the tooltip in relation to the mouse cursor and screen edges/limitations.

See examples:

<<TBD picture of "triangle" options>>.

Placement or Positioning

Position of tooltip should be where mouse cursor last position see <<Interaction below>>
Avoid using the tooltip covering an element the user will interact with.
For example:
<TBD - replace picture with LUX - should be horizontal>>
Avoid using the tooltip on top of another element when items seemed to be arranged as groups
<<TBD - replace picture with LUX - should be horizontal>>

Interaction

The following steps describe how should the tooltip be presented according to user behavior and context

Regular (e.g. truncation of any sort):

Mouse cursor enters target area: display visual feedback of hover within 0.1 seconds..
If cursor remains stationary within target area for 1.5 seconds,
1. Display tooltip on location of the cursor currently within target area (position of tooltip doesn't change while cursor is inside target area)
If cursor had moved to another target area in less than 1 second, show tooltip after 0.1 seconds
Keep displaying the exposed content element until the cursor has left the target area or 12 seconds had passed

Graph micro chart or icon with no label: <<Do we need that distinction>>

Mouse cursor enters target area: display visual feedback of hover within 0.1 seconds..
If cursor remains stationary within target area for 0.2 seconds,
1. Display tooltip on location of the cursor currently within target area (position of tooltip doesn't change while cursor is inside target area)
Keep displaying the exposed content element until the cursor has left the target area or 12 seconds had passed

Tooltips on graphs may sometimes add additional graphical elements to help the user focus on the visual.

See example in Queue Analytics where a vertical line is added with tooltip to help maintain focus of hour:
Verint LUX Design System > Tooltips > image2019-7-28_20-26-31.png

Best practices

Tooltips should not be used as the only way to accomplish a task (should not be vital for the task)
Tooltips with obvious/redundant text are not beneficial to the user
<<TBD update image>>
A formatted structure is easier to read than big chunk (see in additional examples under Content)

Accessibility compliance

<<In general each component should be A11y complied, please follow the 3 guidelines linked below. At the very least we should document that each component is in compliance with each of the 3>>

Focus management

<<How will the component work with keyboard only - without a mouse. Can be reference if written above

We already set a general guidelines described in /wiki/spaces/UX/pages/308969693 >>

Screen reader support

<<Make sure the components support screen reader for content or behaviour where needed - see /wiki/spaces/UX/pages/308248620 >>

Contrast & size compliance

<<Visual designers must comply with the minimal of /wiki/spaces/UX/pages/301498483 for each component>>

Design

Zeplin link	Screen thumbnail
https://app.zeplin.io/project/5970b366bee38cf87b2de932/screen/5a0bfeaed8eb8c025c0045a3
https://app.zeplin.io/project/5970b366bee38cf87b2de932/screen/5b62e50cb935e6dd46261d76

Current appearances in our products

https://www.appcues.com/blog/tooltips

https://docs.microsoft.com/en-us/windows/desktop/uxguide/ctrl-tooltips-and-infotips

https://www.nngroup.com/articles/tooltip-guidelines/

New LUX design

<link rel="stylesheet" href="https://ux.verint.com/fonts/css/verint_lux.css">
<link rel="stylesheet" href="https://ux.verint.com/bootstrap-4.0.0/dist/css/bootstrap.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/js/bootstrap.bundle.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/other/accessibility.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/other/prism.min.js"></script>
<link rel="stylesheet" href="https://ux.verint.com/bootstrap-4.0.0/dist/other/prism-coy.min.css">
<script src="http://ux.verint.com/bootstrap-4.0.0/dist/other/bootstrap-tooltip-custom-class.js"></script>
		

<div class="card">
			<div class="card-header">Tooltips <button id="toggleMarkup" type="button" class="btn btn-sm btn-outline-primary btn btn-fixed-width float-right m-0" onclick="$('pre' ).toggle()">Toggle Markup</button></div>
			<div class="card-body">
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Plain Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-placement="right" title="Aliquam sollicitudin, tincidunt mi volutpat semper" data-html="true" >
						  Plain Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-placement="right" title="Aliquam sollicitudin, tincidunt mi volutpat semper" data-html="true" >
	Plain Tooltip
</button></script></code></pre>
					</div>
				</div>
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Plain Header Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-placement="right" title="<header>Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper sollicitudin, tincidunt</main>" data-html="true" >
						  Header Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-placement="right" title="<header>Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper sollicitudin, tincidunt</main>" data-html="true" >
	Header Tooltip
</button></script></code></pre>
					</div>
				</div>
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Error Header Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-error" data-placement="right" title="<header>Error Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
						  Error Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-error" data-placement="right" title="<header>Error Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
	Error Tooltip
</button></script></code></pre>
					</div>
				</div>
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Warning Header Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-warning" data-placement="right" title="<header>Warning Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
						  Warning Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-warning" data-placement="right" title="<header>Warning Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
	Warning Tooltip
</button></script></code></pre>
					</div>
				</div>
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Info Header Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-info" data-placement="right" title="<header>Informative Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
						  Info Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-info" data-placement="right" title="<header>Informative Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
	Info Tooltip
</button></script></code></pre>
					</div>
				</div>
				<div class="form-group row">
					<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Help Header Example</label>
					<div class="col-lg-4">
						<button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-help" data-placement="right" title="<header>Help Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
						  Help Tooltip
						</button>
					</div>
					<div class="col-lg-6">
						<pre class="language-html"><code><script type="prism-html-markup"><button class="btn btn-sm btn-light btn-fixed-width" type="button" data-toggle="tooltip" data-custom-class="tooltip-help" data-placement="right" title="<header>Help Tooltip Header</header><main>Aliquam sollicitudin, tincidunt volutpat mi semper, tincidunt sollicitudin</main>" data-html="true" >
	Help Tooltip
</button></script></code></pre>
					</div>
				</div>
			</div>
		</div>


<script>
$(function () {
		  $('[data-toggle="tooltip"]').tooltip({delay: { "show": 100, "hide": 0 }});
		  
		  $('.is-invalid').on('shown.bs.tooltip', function () {
			  var x = $(this).offset().left + $(this).width();
			  var y = $(this).offset().top;
			  
			  $('.bs-tooltip-right').css('transform', 'translate3d('+x+'px, '+y+'px, 0px)');
		  });
		})
</script>