Skip to content

Commit

Permalink
documentation for minimzeToTray (#352)
Browse files Browse the repository at this point in the history
  • Loading branch information
leonMSFT committed Jul 9, 2021
1 parent 766b41a commit efeb23c
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
17 changes: 17 additions & 0 deletions TerminalDocs/customize-settings/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -688,6 +688,23 @@ _This command is not currently bound in the default settings_.
> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview).
### Minimize To Tray ([Preview](https://aka.ms/terminal-preview))

This will hide the currently focused window from the Taskbar and instead will be accessible from the system tray icon. This action will only be useable when the tray icon is visible through one of the two global settings `minimizeToTray` or `alwaysShowTrayIcon`.

**Command name:** `minimizeToTray`

**Default binding:**

_This command is not currently bound in the default settings_.

```json
{"command": "minimizeToTray" },
```

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

___
Expand Down
38 changes: 38 additions & 0 deletions TerminalDocs/customize-settings/interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,44 @@ When this is set to `true`, the window will snap to the nearest character bounda

___

## Minimize To Tray ([Preview](https://aka.ms/terminal-preview))

When this is set to `true`, minimizing a window will hide it from the taskbar, making it inaccessible from that area. It will instead be accessible from Terminal's system tray icon. If either this global setting or the `minimizeToTray` global setting is set to true, Terminal will place an icon in the system tray. The user will also be able to utilize the `minimizeToTray` _action_.

**Property name:** `minimizeToTray`

**Necessity:** Optional

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

**Default value:** `false`

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

___

## Always Show Tray Icon ([Preview](https://aka.ms/terminal-preview))

When this is set to `true`, the Terminal will place its icon in the system tray. If either this global setting or the `minimizeToTray` global setting is set to true, Terminal will place an icon in the system tray. The user will also be able to utilize the `minimizeToTray` _action_.

**Property name:** `alwaysShowTrayIcon`

**Necessity:** Optional

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

**Default value:** `false`

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

___

## Tab settings

### Tab switcher interface style
Expand Down

0 comments on commit efeb23c

Please sign in to comment.