Skip to content

Commit

Permalink
Update Doc for Unfocused Acrylic and Opacity (#714)
Browse files Browse the repository at this point in the history
Added Enable Unfocused Acrylic Global Setting 

Updated Opacity and Acrylic. 
No more OS limitations!

microsoft/terminal#15974

---------

Co-authored-by: Matt Wojciakowski <[email protected]>
  • Loading branch information
Jaswir and mattwojo authored May 29, 2024
1 parent e0b2300 commit 443f513
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
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 @@ -355,18 +355,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 an unblurred opacity.

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

**Property name:** `opacity`

**Necessity:** Optional

**Accepts:** Number as an 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 @@ -383,7 +385,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 @@ -395,7 +397,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)

:::column-end:::
:::row-end:::
Expand Down Expand Up @@ -515,7 +517,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

0 comments on commit 443f513

Please sign in to comment.