1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00

Update documentation for Modals (#4495)

Update documentation for modals to include the custom class introduced in #4485, as well as the footer and subtitle fields that don't appear to be documented.
This commit is contained in:
saqimtiaz 2020-04-02 20:49:41 +02:00 committed by GitHub
parent bbdebb27ce
commit bd449a177b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,11 +1,18 @@
created: 20160107225427489 created: 20160107225427489
modified: 20160107225651558 modified: 20200312172056083
tags: Features tags: Features
title: Modals title: Modals
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
Modals (or "wizards") fade the main TiddlyWiki window to display an isolated tiddler that must be explicitly dismissed by the user. Modals (or "wizards") fade the main TiddlyWiki window to display an isolated tiddler that must be explicitly dismissed by the user.
The tiddler to be displayed can contain the following optional fields that are used to customize the modal:
|!Field |!Description |
|footer|The footer text for the modal|
|subtitle|The subtitle text for a modal|
|class|An additional class to apply to the modal wrapper|
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>