WarningThis tutorial is a work in progress.
The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
InformationThis is a Javascript widget bundled by default with the XWiki platform.

Usage

The Modal Popup is a widget used as a base class for different modal widgets in XWiki, like the Confirmation Box or the Jump To Page widget. It will not display a dialog box since it should not be used by itself.

Constructor fields for the ModalPopup Javascript class

content

Object that defines the content of the modal dialog.

shortcuts

Object that defines the shortcuts that will pop up the dialog.

options

Object that defines the options for the modal dialog: title, displayCloseButton, screenColor, borderColor, titleColor, backgroundColor, screenOpacity, verticalPosition and horizontalPosition.

Examples

Widgets bundled by default with XWiki build on top of the Model Popup class:

• Confirmation Box widget
• Jump to page widget (for tag xwiki-web-2.0): http://svn.xwiki.org/svnroot/xwiki/platform/web/tags/xwiki-web-2.0/standard/src/main/webapp/resources/js/xwiki/widgets/jumpToPage.js

Tips

Check out the Javascript code:

• for your wiki instance: http://localhost:8080/xwiki/bin/skin/resources/js/xwiki/widgets/modalPopup.js
• from svn (for tag xwiki-web-2.0): http://svn.xwiki.org/svnroot/xwiki/platform/web/tags/xwiki-web-2.0/standard/src/main/webapp/resources/js/xwiki/widgets/modalPopup.js.

Check out the CSS code:

• for your wiki instance: http://localhost:8080/xwiki/bin/skin/resources/js/xwiki/widgets/modalPopup.css 
• from svn (for tag xwiki-web-2.0): http://svn.xwiki.org/svnroot/xwiki/platform/web/tags/xwiki-web-2.0/standard/src/main/webapp/resources/js/xwiki/widgets/modalPopup.css.