mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Update EventCatcherWidget.tid (#5335)

Browse Source 
* Update EventCatcherWidget.tid

Changed "JavaScript events" to "DOM-initiated Javascript events". 
Removed the quotes from `"event"`. 
Tightened up some of the language.

* Update EventCatcherWidget.tid

Edited/reworded as per discussion(s).
This commit is contained in:
CodaCoder 2021-01-04 02:40:35 -06:00 committed by GitHub
parent 58010e089f
commit d5175e4fdc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
editions/tw5.com/tiddlers/widgets/EventCatcherWidget.tid
View File

@ -7,27 +7,29 @@ type: text/vnd.tiddlywiki
! Introduction ! Introduction
<<.from-version "5.1.23">> <<.from-version "5.1.23">>
The event catcher widget traps JavaScript events dispatched within its child content, and allows invoking a series of ActionWidgets in response to the events.
//This is an advanced widget intended for use by those familiar with HTML, CSS and JavaScript handling of DOM events.//
The event catcher widget traps DOM-initiated Javascript events dispatched within its child content, and allows invoking a series of ActionWidgets in response to those events.
In order for the events to be trapped they must: In order for the events to be trapped they must:
* be of one of the types specified as a parameter to the event catcher widget. * be of one of the events specified in the event catcher widget's `events` attribute.
* arise within a DOM node matching the selector specified as a parameter to the widget. * arise within a DOM node specified by the widget's `selector` attribute.
* support event bubbling.
Use of the event catcher widget is beneficial when using large numbers of other trigger widgets such as the ButtonWidget is causing performance problems. The workflow it enables is akin to what is referred to as "event delegation" in JavaScript parlance. Use of the event catcher widget is beneficial when using large numbers of other trigger widgets such as the ButtonWidget is causing performance problems. The workflow it enables is akin to what is referred to as "event delegation" in JavaScript parlance.
//This is an advanced widget intended to be used by those familiar with HTML, CSS and JavaScript.//
! Content and Attributes ! Content and Attributes
The content of the `<$eventcatcher>` widget is displayed normally. The content of the `<$eventcatcher>` widget is displayed normally.
|!Attribute |!Description | |!Attribute |!Description |
|events |Space separated list of JavaScript events to be trapped, for example "click" or "click dblclick" | |events |Space separated list of JavaScript events to be trapped, for example "click" or "click dblclick". |
|selector |A CSS selector. Only events originating inside a DOM node with this selector will be trapped. | |selector |A CSS selector. Only events originating inside a DOM node with this selector will be trapped. |
|actions-* |Action strings to be invoked when a matching event is trapped. Each event is mapped to an action attribute name of the form `actions-"event"` where `event` represents the type of the event. For example: `actions-click` or `actions-dblclick` | |actions-* |Action strings to be invoked when a matching event is trapped. Each event is mapped to an action attribute name of the form <code>actions-<em>event</em></code> where <code><em>event</em></code> represents the type of the event. For example: `actions-click` or `actions-dblclick` |
|class |An optional CSS class name to be assigned to the HTML element | |tag |Optional. The HTML element the widget creates to capture the events, defaults to:<br>» `span` when parsed in inline-mode<br>» `div` when parsed in block-mode |
|tag |Optional. The html element the widget creates to capture the events, defaults to:<br>» `span` when parsed in inline-mode<br>» `div` when parsed in block-mode | |class |Optional. A CSS class name (or names) to be assigned to the widget HTML element. |
! Variables ! Variables