drhayes / TW5-AutoComplete

A TW5 plugin that enables completing Tiddler names in various text inputs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto Complete [TiddlyWiki5 Plugin]

A versatile, customizable and easy to use auto completion plugin for TiddlyWiki.

  • Auto complete anything you want:
    • Tiddler titles
    • Field values
    • Any filter result
  • Define your own triggers
    • Customize the filter which retrieves the suggestions
    • Customize template used for inserting the selected suggestion
    • Customize how the suggestions are displayed in the completion window
    • Control auto-triggering separately for inputs and text areas
  • Clear interface for editing the triggers
  • Manually open auto complete with customizable keyboard shortcut

Plugin compatibility

  • The official CodeMirror plugin -- Auto Complete triggers automatically, manually and is fully interactive
    • Also with its plugin CodeMirror Close Brackets, if your trigger uses one of the characters that gets its mirror auto inserted it will still automatically open Auto Completion on typing
    • Also with its plugin CodeMirror Autocomplete, this plugin's dialog will take priority over the CodeMirror one and will prevent both of them from spawning at the same time
  • Streams by saqimtiaz -- Pressing Enter to Auto Complete won't trigger a new stream insertion
  • SideEditor by Mat von Twaddle -- Auto Completion only appears in the currently focused window

How to use

  • After installing head to the Control Panel and open the tab ''Evidently Cube''
  • Create a new trigger using the button
    • It will be filled with sensible defaults
    • Customize the trigger to your heart's content
  • At any time press Ctrl+Space right in front of a defined trigger to open the completion window manually
    • Or use a different keyboard shortcut you defined

Demo:

See the demo here.

Installation:

Drag this link into your TiddlyWiki 5 page/tab.

Screenshots

Completion in action:

Options:

Editing triggers:

Work in progress, do not use yet

About

A TW5 plugin that enables completing Tiddler names in various text inputs.

License:MIT License


Languages

Language:JavaScript 100.0%