Directory

← Back

ContextHelp

Provides contextual help for Vaadin applications.

Author

Contributors

Rating

ContextHelp is a component allowing you to provide contextual help for your forms and/or fields in an application. ContextHelp shows a bubble containing your specified help text when the user presses F1 (or a configurable hotkey). The bubble opens right next to your field, with a small arrow pointing at the field.

ContextHelp also supports opening the help bubble programmatically and follow focus.

Sample code

ContextHelp contextHelp = new ContextHelp();
layout.addComponent(contextHelp);

TextField foo = new TextField("foo");
TextField bar = new TextField("bar");
layout.addComponent(foo);
layout.addComponent(bar);

contextHelp.addHelpForComponent(bar, "The text field allows you to write many, many, many, many, many things.");
contextHelp.addHelpForComponent(foo, "<b>foo</b> can be <i>formatted</i> using standard <b style='font-size: 20px; color: red;'>HTML</b> and inline <b>CSS</b>.");
ContextHelp contextHelp = new ContextHelp();
contextHelp.extend(UI.getCurrent());    // only needed once for each UI

TextField foo = new TextField("foo");
TextField bar = new TextField("bar");
layout.addComponent(foo);
layout.addComponent(bar);

contextHelp.addHelpForComponent(bar, "The text field allows you to write many, many, many, many, many things.");
contextHelp.addHelpForComponent(foo, "<b>foo</b> can be <i>formatted</i> using standard <b style='font-size: 20px; color: red;'>HTML</b> and inline <b>CSS</b>.");

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Support for Vaadin Framework 8

Released
2017-04-06
Maturity
STABLE
License
Apache License 2.0

Compatibility

Framework
Vaadin 8.0+
Vaadin 7.3+ in 2.0.1
Vaadin 7.0+ in 2.0.0.beta1
Vaadin 6.0+ in 1.3.1
Vaadin 6.2+ in 0.8
Browser
Internet Explorer
Firefox
Safari
Google Chrome
Internet Explorer
Internet Explorer
Internet Explorer

ContextHelp - Vaadin Add-on Directory

Provides contextual help for Vaadin applications. ContextHelp - Vaadin Add-on Directory
ContextHelp is a component allowing you to provide contextual help for your forms and/or fields in an application. ContextHelp shows a bubble containing your specified help text when the user presses F1 (or a configurable hotkey). The bubble opens right next to your field, with a small arrow pointing at the field. ContextHelp also supports opening the help bubble programmatically and follow focus.
Online