Skip to content

Add keybinding docs for tabSwitcher #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 20, 2020
Merged

Add keybinding docs for tabSwitcher #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c86e5a
add the blurb for ats
Aug 10, 2020
b7b4ae6
update docs to reflect new world order
leonMSFT Aug 19, 2020
c0062cb
oops this is true by default
leonMSFT Aug 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions TerminalDocs/customize-settings/global-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,30 @@ When this is set to `true`, closing a window with multiple tabs open _will_ requ
:::column-end:::
:::row-end:::

### Use Tab Switcher Experience

:::row:::
:::column span="":::
When this is set to `true`, the `nextTab` and `prevTab` commands will use the Tab Switcher UI. The UI will show all the currently open tabs in a vertical list, navigable with the keyboard or mouse.
The tab switcher will open on the initial press of the keybindings for `nextTab` and `prevTab`, and will stay open as long as a modifier key is held down. When all modifier keys are released, the switcher will close and the highlighted tab will be focused. <kbd>Tab</kbd>/<kbd>Shift+Tab</kbd>, the Up and Down arrow keys, and the `nextTab`/`prevTab` keybindings can be used to cycle through the switcher UI.

**Property name:** `useTabSwitcher`

**Necessity:** Optional

**Accepts:** `true`, `false`

**Default value:** `true`

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).

:::column-end:::
:::column span="":::

:::column-end:::
:::row-end:::

<br />

___
Expand Down
18 changes: 18 additions & 0 deletions TerminalDocs/customize-settings/key-bindings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,24 @@ This opens a specific tab depending on the index.
| ---- | --------- | ------- | ----------- |
| `index` | Required | Integer | Tab that will open based on its position in the tab bar (starting at 0). |


### Tab Search ([Preview](https://aka.ms/terminal-preview/))

This opens the tab search box.

**Command name:** `tabSearch`

**Default binding:**

_This command is not currently bound in the default settings_.

```json
{"command": "tabSearch", "keys": "ctrl+shift+t"}
```

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/).

### Rename tab ([Preview](https://aka.ms/terminal-preview/))

This command can be used to rename a tab to a specific string.
Expand Down