mirror of
https://github.com/TiddlyWiki/TiddlyWiki5.git
synced 2026-04-30 21:26:49 +00:00
Lots and lots and lots of docs updates
Now we've got up-to-date skeleton documentation for all the widgets
This commit is contained in:
28
editions/tw5.com/tiddlers/widgets/EditTextWidget.tid
Normal file
28
editions/tw5.com/tiddlers/widgets/EditTextWidget.tid
Normal file
@@ -0,0 +1,28 @@
|
||||
title: EditTextWidget
|
||||
created: 201310241419
|
||||
creator: JeremyRuston
|
||||
modified: 201310300837
|
||||
modifier: JeremyRuston
|
||||
tags: widget
|
||||
|
||||
! Introduction
|
||||
|
||||
The edit text widget provides a user interface in the browser for editing text tiddler fields. The editing element is dynamically bound to the underlying tiddler value: changes to the tiddler are instantly reflected, and any edits are instantly propogated.
|
||||
|
||||
By default, the edit text widget generates a `<textarea>` as the HTML editing element when the `text` field is edited, and a `<input type="text">` element otherwise. This behaviour can be overridden with the `tag` and `type` attributes.
|
||||
|
||||
! Content and Attributes
|
||||
|
||||
The content of the `<$edit-text>` widget is ignored.
|
||||
|
||||
|!Attribute |!Description |
|
||||
|tiddler |The tiddler to edit (defaults to the [[TiddlerVariable: currentTiddler]]) |
|
||||
|field |The field to edit (defaults to `text`). Takes precedence over the `index` attribute |
|
||||
|index |The index to edit |
|
||||
|default |The default text to be provided when the target tiddler doesn't exist |
|
||||
|class |A CSS class to be assigned to the generated HTML editing element |
|
||||
|placeholder |Placeholder text to be displayed when the edit field is empty |
|
||||
|focusPopup |Title of a state tiddler for a popup that is displayed when the editing element has focus |
|
||||
|qualifyTiddlerTitles |If this attribute is present then the state tiddler title specified in the `focusPopup` attributes are qualified as described in HandlingUserInterfaceState |
|
||||
|tag |Overrides the generated HTML editing element tag |
|
||||
|type |Overrides the generated HTML editing element `type` attribute |
|
||||
Reference in New Issue
Block a user