mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-25 23:03:15 +00:00
Code Issues Releases Wiki Activity

Doc updates for Modals (#5057)

Browse Source
This commit is contained in:
saqimtiaz 2020-11-17 15:43:46 +01:00 committed by GitHub
parent d6e055368d
commit 2b60ab1fdc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
editions/tw5.com/tiddlers/features/Modals.tid
View File

@ -1,5 +1,5 @@
created: 20160107225427489 created: 20160107225427489
modified: 20200312172056083 modified: 20201117081054556
tags: Features tags: Features
title: Modals title: Modals
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -10,9 +10,11 @@ The tiddler to be displayed can contain the following optional fields that are u
|!Field |!Description | |!Field |!Description |
|footer|The footer text for the modal| |footer|The footer text for the modal|
|subtitle|The subtitle text for a modal| |subtitle|The subtitle text for a modal, displayed in a `h3` html tag|
|class|An additional class to apply to the modal wrapper| |class|An additional class to apply to the modal wrapper|
Note that the footer and subtitle fields are not limited to plain text, and wiki text features such as widgets and transclusions can be used as well.
Modals are displayed with the [[WidgetMessage: tm-modal]]. Modals are displayed with the [[WidgetMessage: tm-modal]].
<$button message="tm-modal" param="SampleWizard">Open demo modal</$button> <$button message="tm-modal" param="SampleWizard">Open demo modal</$button>

13
editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid
View File

@ -1,22 +1,25 @@
caption: tm-modal
created: 20140811112133701 created: 20140811112133701
modified: 20141107142803042 modified: 20201117081247738
tags: Messages tags: Messages
title: WidgetMessage: tm-modal title: WidgetMessage: tm-modal
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
caption: tm-modal
|!Name |!Description | |!Name |!Description |
|param |Title of the tiddler to be displayed | |param |Title of the tiddler to be displayed |
|paramObject |Hashmap of variables to be provided to the modal | |paramObject |Hashmap of variables to be provided to the modal, contains all extra parameters passed to the widget sending the message. |
|rootwindow |<<.from-version 5.1.18>> ''yes'' or ''true'' will always display a modal in the wiki-root-window | |rootwindow |<<.from-version 5.1.18>> ''yes'' or ''true'' will always display a modal in the wiki-root-window |
The "currentTiddler" variable is set to the title of the modal tiddler, but can be overridden by specifying a different value in `paramObject`. The "currentTiddler" variable is set to the title of the modal tiddler, but can be overridden by specifying a different value in `paramObject`.
The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core. The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.
[[Fields within the tiddler|Modals]] being displayed in the modal can be used to customize its appearance.
! Example ! Example
Here is an example of displaying a modal and passing parameters to it: Here is an example of displaying a modal and passing parameters to it:
(Note how all parameters to `action-sendmessage` other than `$param` and `$message` are available as variables within the modal.)
<$macrocall $name='wikitext-example-without-html' <$macrocall $name='wikitext-example-without-html'
src='Your name: <$edit-text tiddler="$:/temp/yourName" tag="input" default="Your name"/> src='Your name: <$edit-text tiddler="$:/temp/yourName" tag="input" default="Your name"/>
@ -29,5 +32,9 @@ Your message:
Click me! Click me!
</$button>'/> </$button>'/>
<<.tip """<$macrocall $name=".from-version" version="5.1.18"/> if triggered from within a ''new window'', the above examples will be displayed within that window. The <$macrocall $name=".attr" _="rootwindow"/> attribute can be set to ''yes'' or ''true'' to inherit this behavior and to display the Modal within the ''root'' window""">> <<.tip """<$macrocall $name=".from-version" version="5.1.18"/> if triggered from within a ''new window'', the above examples will be displayed within that window. The <$macrocall $name=".attr" _="rootwindow"/> attribute can be set to ''yes'' or ''true'' to inherit this behavior and to display the Modal within the ''root'' window""">>
<<.tip """<$macrocall $name=".from-version" version="5.1.23"/> Links to tiddlers within a modal will open in the same story as the widget that sent the `tm-modal` message. You can override this by specifying values for the variables `tv-story-list` and `tv-history-list` when sending the `tm-modal` message.
""">>