mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 13:29:56 +00:00
Code Issues Releases Wiki Activity

Merge pull request #2151 from tobibeer/sticky-popup-docs

Browse Source 
documentation for "tc-popup-keep"
This commit is contained in:
Jeremy Ruston 2015-12-24 11:01:32 +00:00
commit 08fed4840f
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
editions/tw5.com/tiddlers/mechanisms/PopupMechanism.tid
View File

@ -1,13 +1,14 @@
created: 20131212175656755 created: 20131212175656755
modified: 20131212180213909 modified: 20151223222712715
tags: Mechanisms tags: Mechanisms
title: PopupMechanism title: PopupMechanism
type: text/vnd.tiddlywiki 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: The popup mechanism allows blocks of content to be selectively displayed and positioned with respect to an anchor. It has several parts:
* StateTiddlers to record whether a popup is currently displayed or not * [[StateTiddlers|StateMechanism]] to record whether a popup is currently displayed or not
* The RevealWidget to selectively display the popup content * The RevealWidget to selectively display the popup content
** 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 * The ButtonWidget to trigger the display of the popup by setting the state tiddler appropriately

6
editions/tw5.com/tiddlers/widgets/RevealWidget.tid
View File

@ -1,9 +1,9 @@
caption: reveal
created: 20131024141900000 created: 20131024141900000
modified: 20150518163239603 modified: 20151223222838652
tags: Widgets tags: Widgets
title: RevealWidget title: RevealWidget
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
caption: reveal
! Introduction ! Introduction
@ -22,7 +22,7 @@ The content of the `<$reveal>` widget is displayed according to the rules given
|tag |Overrides the default HTML element tag (`<div>` in block mode or `<span>` in inline mode) | |tag |Overrides the default HTML element tag (`<div>` in block mode or `<span>` in inline mode) |
|type |The type of matching performed: ''match'', ''nomatch'' or ''popup'' | |type |The type of matching performed: ''match'', ''nomatch'' or ''popup'' |
|text |The text to match when the type is ''match'' and ''nomatch'' | |text |The text to match when the type is ''match'' and ''nomatch'' |
|class |An optional CSS class name to be assigned to the HTML element| |class |An optional CSS class name to be assigned to the HTML element<br/>&raquo; Set to `tc-popup-keep` to make a popup "sticky", so it won't close when you click inside of it|
|style |An optional CSS style attribute to be assigned to the HTML element | |style |An optional CSS style attribute to be assigned to the HTML element |
|position |The position used for the popup when the type is ''popup''. Can be ''left'', ''above'', ''aboveright'', ''right'', ''belowleft'' or ''below'' | |position |The position used for the popup when the type is ''popup''. Can be ''left'', ''above'', ''aboveright'', ''right'', ''belowleft'' or ''below'' |
|default |Default value to use when the state tiddler is missing | |default |Default value to use when the state tiddler is missing |