# About

Plugin for Sublime Text 3 - toggle words with support for user defined arrays.

```
 true -> false
  yes -> no
   on -> off
    0 -> 1
 left -> right
  top -> bottom
   up -> down
width -> height
```

and it automatically adapts to words like ->

```
false <-> true
False <-> True
FALSE <-> TRUE
```

# Usage

Set cursor on word or select word and press:

* macOS - <kbd>Cmd</kbd>+<kbd>Alt</kbd>+<kbd>X</kbd>
* Windows - <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>X</kbd>
* Linux - <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>X</kbd>


# Installation

0. Install Package Control
1. Open ST command panel (<kbd>Shift</kbd>+<kbd>Control</kbd>+<kbd>P</kbd>), choose `Package Control — Install Package`, type `Toggle`, find Toggle Words and press <kbd>Enter</kbd>
2. Have fun!

or

1. Open you Sublime Text 3 Packages directory
2. Run `git clone git@github.com:gordio/ToggleWords.git`
3. Have fun!


# Configure

## Keys

You may redefine the key bindings in your sublime-keymap with command `toggle_word`.


## User defined arrays

You can define lists of words, which will be cycled through in order.

Example file `ToggleWords.sublime-settings`:

```
{
    // User defined words
    "toggle_words_dict": [
        ["left", "right"],
        ["up", "down"],
        ["top", "bottom"],
        ["width", "height"],
        ["red","orange","yellow","green","blue","purple"],
        ["true", "false"],
        ["yes", "no"],
        ["on", "off"],
        ["0", "1"]
    ]
}
```

If installed using `Package Control` dictionary file should be located in `<data_path>/Packages`. To get there select `Preferences -> Browse Packages...` in Sublime menu. Create one if it does not exist.