1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00

Added docs for th-closing-tiddler hook (#5820)

This commit is contained in:
Saq Imtiaz 2021-06-23 10:51:46 +02:00 committed by GitHub
parent 83ee363cb4
commit 076a04fbfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,20 @@
created: 20210623075733310
modified: 20210623081959571
tags: HookMechanism
title: Hook: th-closing-tiddler
type: text/vnd.tiddlywiki
This hook allows plugins to monitor the closing of a tiddler from the story.
Hook function parameters:
* ''event'': Widget message object with the following properties:
** ''event'': DOM event object that triggered the widget message
** ''tiddlerTitle'': the title of the tiddler being closed
** ''widget'': reference to the widget that sent the message.
Return value:
* ''event'': Widget message object
The original event widget message object can be returned unmodified by the hook.