TiddlyWiki5/editions/tw5.com/tiddlers/mechanisms/PopupMechanism.tid

created: 20131212175656755
modified: 20151223222712715
tags: Mechanisms
title: PopupMechanism
type: text/vnd.tiddlywiki

The popup mechanism allows blocks of content to be selectively displayed and positioned with respect to an anchor. It has several parts:

* [[StateTiddlers|StateMechanism]] to record whether a popup is currently displayed or not
* The RevealWidget to selectively display the popup content
** <<.from-version "5.2.4">> For positioning the popups relative or absolute coordinates can be used. See [[Coordinate Systems]] for more information about usage and format.
** For "sticky" popups — those that don't close when clicking inside one — set the ''class'' attribute to `tc-popup-keep`
* The ButtonWidget to trigger the display of the popup by setting the state tiddler appropriately
Docs update Fixes #247 @giffmex - I appreciate that I haven’t fixed everything you mentioned 2013-12-12 18:16:16 +00:00			`created: 20131212175656755`
documentation for "tc-popup-keep" 2015-12-23 22:28:47 +00:00			`modified: 20151223222712715`
Add mechanisms to the reference docs 2014-09-11 19:12:25 +00:00			`tags: Mechanisms`
Docs update Fixes #247 @giffmex - I appreciate that I haven’t fixed everything you mentioned 2013-12-12 18:16:16 +00:00			`title: PopupMechanism`
			`type: text/vnd.tiddlywiki`

			`The popup mechanism allows blocks of content to be selectively displayed and positioned with respect to an anchor. It has several parts:`

documentation for "tc-popup-keep" 2015-12-23 22:28:47 +00:00			`* [[StateTiddlers\|StateMechanism]] to record whether a popup is currently displayed or not`
Docs update Fixes #247 @giffmex - I appreciate that I haven’t fixed everything you mentioned 2013-12-12 18:16:16 +00:00			`* The RevealWidget to selectively display the popup content`
Fixed PR to fix popup position if popup is triggered from within an offsetParent element (#7013) * Fix popup location for tables This commit introduces the `popupAbsCoords` option to the $button widget and implements an absolut coordinate format. Coordinates for popups are stored in the format `(x,y,w,h)`. These coordinates are relative to the offset parent of the element that defines the popup. This commits adds a second format `@(x,y,w,h)`. Coordinates specified in this format a relative to the pages root element. The `popupAbsCoords` option of the $button widget enables the use of this coordinates. * Unify the declaration of the RegEx for parsing the popup-position The regular expression was declared in three locations with the same content. This commit supplies a new function `parseCoordinates` in `popup.js`. This function returns the parsed coordinates and understands the classic/absolute coordinates. This function is used in `reveal.js` and `action-popup.js` to parse the coordinates. * Add documentation for coordinate systems * Consolidate creating coordinate strings The Popup object now contains a `buildCoordinates` method that can be used to build coordinate strings. It takes an "enum" for the coordinate- system to use. This makes everything easily extensible and prevents the use of magic values. * Add tests for `parseCoordinates` and `buildCoordinates` * Add `tv-popup-abs-coords` to `collectDOMVariables` This will make the absolute coordinates available for the `DraggableWidget` and the `EventCatcherWidget`. * Add documentation for the `tv-popup-abs-coords` ... to the `DraggableWidget` and the `EventCatcherWidget`. * Fix crash when generating a static version of the TW The Popup class is not initialized in `startup.js` if `$tw.browser` is not true. After having consolidated the facilities for parsing coordinate strings into `popup.js` this breaks because the static build needs to parse coordinate stings even if no Popup module is initialized. This commit solves this problem by making `readPopupState`, `parseCoordinates` and `buildCoordinates` static methods of `popup.js`. It also adds a comment to these functions to show that these can be called safely even if the Popup-Class is not initialized. 2022-12-01 21:16:44 +00:00			`** <<.from-version "5.2.4">> For positioning the popups relative or absolute coordinates can be used. See [[Coordinate Systems]] for more information about usage and format.`
documentation for "tc-popup-keep" 2015-12-23 22:28:47 +00:00			** For "sticky" popups — those that don't close when clicking inside one — set the ''class'' attribute to `tc-popup-keep`
Docs update Fixes #247 @giffmex - I appreciate that I haven’t fixed everything you mentioned 2013-12-12 18:16:16 +00:00			`* The ButtonWidget to trigger the display of the popup by setting the state tiddler appropriately`