Skip to content

Commit

Permalink
Remove docs about editing a field of the containing tiddler
Browse files Browse the repository at this point in the history
Doesn't apply post v5.2.0
  • Loading branch information
Jermolene committed Oct 21, 2021
1 parent f30a455 commit 8654066
Showing 1 changed file with 1 addition and 23 deletions.
24 changes: 1 addition & 23 deletions editions/tw5.com/tiddlers/widgets/EditTextWidget.tid
@@ -1,6 +1,6 @@
caption: edit-text
created: 20131024141900000
modified: 20210519154352055
modified: 20211021091910134
tags: Widgets
title: EditTextWidget
type: text/vnd.tiddlywiki
Expand Down Expand Up @@ -37,25 +37,3 @@ The content of the `<$edit-text>` widget is ignored.
|refreshTitle |<<.from-version 5.1.23>> An optional tiddler title that makes the input field update whenever the specified tiddler changes |
|disabled|<<.from-version "5.1.23">> Optional, disables the text input if set to "yes". Defaults to "no"|
|fileDrop|<<.from-version "5.2.0">> Optional. When set to "yes" allows dropping or pasting images into the editor to import them. Defaults to "no"|

! Notes

One trap to be aware of is that the edit text widget //cannot be used// to edit a field of the tiddler that contains it. Each keypress results in the tiddler being re-rendered, which loses the cursor position within the text field.

Instead, place the edit text widget in a [[template|TemplateTiddlers]] that references the tiddler you want to modify.

For example, if you wanted the tiddler GettingStarted to edit the value of the "myconfig" field of the tiddler "AppSettings", you might do so by creating a separate tiddler "ChangeAppSettings" that contains the following:

```
<$edit-text tiddler="AppSettings" field="myconfig"/>
```

And reference the template in any other tiddler (e.g. GettingStarted) with `{{ChangeAppSettings}}`.

This works when your use of the tiddler //is not// the AppSettings itself which would cause a recursion problem. In this latter case you have to save the fields to a temporary (or alternative) tiddler (sort of the reverse of above) like so:

```
<$edit-text tiddler="StoreAppSettings" field="myconfig"/>
```

In short the EditTextWidget //can not// change properties of the tiddler it is embedded in or part of. It can only change fields of //other// tiddlers. One could use ShadowTiddlers to accomplish the field storage if needed.

0 comments on commit 8654066

Please sign in to comment.