+
+
+
+ Standard
+
+
+
+ Popup
+A standard popup
+ + +Variations
+ +
+
+
+ Size
+A popup can be large or small
+ + +
+
+
+
+ Inverted
+A popup can have its colors inverted
+ +Usage
+ +Initializing an popup
+
+ $('.ui.popup')
+ .popup()
+ ;
+
+
+ Including metadata
+Frequently used metadata like, title, content, html, or arrowOffset or variation, can be included in html metadata
+
+
+
+
+ Examples
+ +
+
+
+ Positioning
+A popup can be positioned to any side of an element. If space is not available, it will automatically search for a similar alternative position to use.
+ + + + + + + + +
+
+
+ Title
+A popup can be formatted with a title
+ +
+
+
+
+ HTML
+A popup can be formatted with html
+ +Settings
+| Content | + + +||
|---|---|---|
| content | ++ | Content to display | +
| title | ++ | Title to display alongside content | +
| html | ++ | HTML content to display instead of preformatted title and content | +
| Popup Settings | + + +||
|---|---|---|
| inline | +true | +If a popup is inline it will be created next to current element, allowing for local css rules to apply. Otherwise popups will appended to body and removed after being hidden. | +
| delay | +0 | +Delay in milliseconds before showing a popup when using hover events. | +
| variation | ++ | Popup variation to use, can use multiple variations with a space delimiter | +
| on | +hover | +Event used to invoke popup | +
| clickToClose | +hover | +Whether clicking anywhere outside a popup should close it. | +
| position | +top center | +Position that the popup should appear | +
| distanceAway | +0 | +Distance away from element for the popup to appear. | +
| arrowOffset | +0 | +Offset to apply to arrow positioning of element | +
| maxSearchDepth | +10 | +Number of iterations before giving up search for popup position when a popup cannot fit on screen | +
| Animation | + + +||
|---|---|---|
| animation | +Pop | +Animation to use, can be set to either pop or fade. | +
| duration | +250 | +Callback after a popup html is generated. | +
| easing | +easeOutQuint | +Callback after a popup section is shown. | +
| Callbacks | + + +||
|---|---|---|
| onInit | +None | +Callback after a popup html is generated. | +
| onShow | +None | +Callback after a popup section is shown. | +
| onHide | +None | +Callback after a popup section is hidden. | +
| UI Module Settings | + + +||
|---|---|---|
| moduleName | +Popup | +Name used in debug logs | +
| debug | +True | +Provides standard debug output to console | +
| performance | +False | +Provides standard debug output to console | +
| verbose | +False | +Provides ancillary debug output to console | +
| namespace | +popup | +Event namespace. Makes sure module teardown does not effect other events attached to an element. | +
| errors | +
+
+ errors : {
+ method : 'The method you called is not defined.'
+ }
+
+ |
+ |