Skip to content
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.

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

Update Doc for Unfocused Acrylic and Opacity #714

Merged
merged 10 commits into from
May 29, 2024
26 changes: 25 additions & 1 deletion TerminalDocs/customize-settings/interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,38 @@ title: Windows Terminal Interaction Settings
description: Learn how to customize interaction settings within Windows Terminal.
author: cinnamon-msft
ms.author: cinnamon
ms.date: 03/10/2023
ms.date: 05/29/2024
ms.topic: how-to
---

# Interaction settings in Windows Terminal

The properties listed below affect the entire terminal window, regardless of the profile settings. These should be placed at the root of your [settings.json file](../install.md#settings-json-file).

## Enable unfocused acrylic

Controls if unfocused acrylic is possible. When this is set to `true`, unfocused windows can have acrylic instead of opaque.
When set to `false` unfocused windows cannot have acrylic, when the focused window has acrylic the unfocused window will be Solid.

**Property name:** `compatibility.enableUnfocusedAcrylic`

**Necessity:** Optional

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

**Default value:** `false`

:::column-end:::
:::column span="":::
![enable_unfocused_docs](./../images/opacity.gif)

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

<br />

___

## Automatically copy selection to clipboard

When this is set to `true`, a selection is immediately copied to your clipboard upon creation. The right-click on your mouse will always paste in this case. When it's set to `false`, the selection persists and awaits further action. Using your mouse to right-click will copy the selection.
Expand Down
14 changes: 8 additions & 6 deletions TerminalDocs/customize-settings/profile-appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,18 +359,20 @@ This sets the transparency of the window for the profile. This accepts an intege

When `useAcrylic` is set to `true`, the window will use the acrylic material to create a blurred background for the terminal. When `useAcrylic` is set to false, the terminal will use a unblurred opacity.

Users can choose different opacity values for focused and unfocused windows allowing for customization.

**Property name:** `opacity`

**Necessity:** Optional

**Accepts:** Number as a integer value from 0-100

**Default value:** `100` when `useAcrylic` is false, `50` when `useAcrylic` is true.
**Default value:** `100`

:::column-end:::
:::column span="":::
![Windows Terminal acrylic opacity](./../images/acrylic-opacity.gif)

![opacity_permutations_1_doc](https://github.com/Jaswir/terminal-docs/assets/15957528/8efc1447-f50c-44f2-a36d-f8ea9a83cf09)
![jolsen](https://github.com/Jaswir/terminal-docs/assets/15957528/066ecc66-5172-47c5-abc1-fc9ee425fe45)
:::column-end:::
:::row-end:::

Expand All @@ -387,7 +389,7 @@ When `useAcrylic` is set to `true`, the window will use the acrylic material to

:::row:::
:::column span="":::
When this is set to `true`, the window will have an acrylic background. When it's set to `false`, the window will have a plain, untextured background. The transparency only applies to focused windows due to OS limitations.
When this is set to `true`, the window will have an acrylic background. When it's set to `false`, the window will have a plain, untextured background. Depending on the `Enable Unfocused Acrylic` global setting the transparency applies to unfocused windows aswell as focused windows when set to `true` or only applies to focused windows when set to `false`.

**Property name:** `useAcrylic`

Expand All @@ -399,7 +401,7 @@ When this is set to `true`, the window will have an acrylic background. When it'

:::column-end:::
:::column span="":::
![Windows Terminal acrylic](./../images/acrylic.gif)
![updated_acrylic_toggle_doc](https://github.com/Jaswir/terminal-docs/assets/15957528/f27e8213-1311-4c3f-b91d-f66a0b4c1d3c)
mattwojo marked this conversation as resolved.
Show resolved Hide resolved

:::column-end:::
:::row-end:::
Expand Down Expand Up @@ -519,7 +521,7 @@ An object you can add to a profile that applies settings to the profile when it

**Necessity:** Optional

**Accepts:** `backgroundImage`, `backgroundImageAlignment`, `backgroundImageOpacity`, `backgroundImageStretchMode`, `cursorHeight`, `cursorShape`, `cursorColor`, `colorScheme`, `foreground`, `background`, `selectionBackground`, `experimental.retroTerminalEffect`, `experimental.pixelShaderPath`
**Accepts:** `backgroundImage`, `backgroundImageAlignment`, `backgroundImageOpacity`, `backgroundImageStretchMode`, `cursorHeight`, `cursorShape`, `cursorColor`, `colorScheme`, `foreground`, `background`, `opacity`, `selectionBackground`, `useAcrylic`, `experimental.retroTerminalEffect`, `experimental.pixelShaderPath`

**Example:**
```json
Expand Down