mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00
Code Issues Releases Wiki Activity

Docs tweaks for #2922

Browse Source
This commit is contained in:
Jermolene 2017-06-28 17:58:58 +01:00
parent 1905a3f343
commit bf51acd8d6
2 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
editions/dev/tiddlers/new/Using Notifications.tid Normal file
View File

@ -0,0 +1,31 @@
tags: dev
title: Using Notifications
type: text/vnd.tiddlywiki
!! Overview
The notifier module is part of TiddlyWiki's suite of built-in utilities. It displays the text of a tiddler as a notification that briefly appears at the top right top of the screen. They are automatically dismissed after a few seconds.
Notifications are an easy and visual way to notify the user of key information that is transient -- in other words, it shouldn't matter whether the user misses the notification (modals or alerts that require manual dismissal should be used in these cases).
An example is the `Saved wiki` notification seen each time the "save" button is clicked in the single file configuration of TiddlyWiki.
The notification module makes it easy to display such notifcations, including all the heavy lifting of the notification creation, appending it to the DOM, animating it and finally removing it from the DOM.
!! Parameters
The notifier module only has one method (`display(title,options)`) that accepts two parameters:
* title: The title of an existing tiddler
** If the tiddler does not exist, then no notification will take place
** The content of this tiddler will be transcluded into the notification body
* Options: An object containing a `variables` property that will be applied in the tiddler transclusion
!! Usage
A notifier instance is availably directly on the global `$tw` object:
```js
$tw.notifier.display("$:/language/Notifications/Save/Starting");
```

30
editions/dev/tiddlers/new/notifier_util.tid
View File

@ -1,30 +0,0 @@
tags: dev
title: Notifier utility
type: text/vnd.tiddlywiki
!! Overview
The notifier module is part of tiddlywiki's utils suite. It displays the text contained on one as notification.
Notifications are an easy and visual mechanism to notify the user about key information.
Notifications appear on the right top border of the screen, and are automatically dismissed.
One usage example is the `saved wiki` notification you see each time the save button is clicked.
The notification module makes easier to display such notifcations, making all the heavy lifting of the notifcation creation
,appending it to the `DOM`, animation and `DOM` removal
!! Parameters
The notifier module only has one method (`display(title,options)`) that accepts two parameters
* title: The title of an existing tiddler.
** If the tiddler does not exist, then no notification will take place
** The content of this tiddler will be transcluded into the notification body
* Options: An object conaining a `variables` property that will be used on the tiddler transclusion
!! Usage
A notifier instance is availably directly on the global `$tw` object. You can access it directly on any part of your code that
may need to notify something to the user
```js
$tw.notifier.display("$:/language/Notifications/Save/Starting");
```