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.

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

Jump to bottom

Add docs for "Copy with control sequences" functionality #756

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for "Copy with control sequences" functionality #756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions TerminalDocs/customize-settings/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,6 +985,7 @@ This copies the selected terminal content to your clipboard. If no selection exi
| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `singleLine` | Optional | `true`, `false` | When `true`, the copied content will be copied as a single line. When `false`, newlines persist from the selected text. |
| `withControlSequences` | Optional | `true`, `false` | When `true`, copied content will contain ANSI escape code control sequences representing the styling of the content. When `false`, only the plain text will be copied. |
| `copyFormatting` | Optional | `true`, `false`, `"all"`, `"none"`, `"html"`, `"rtf"` | When `true`, the color and font formatting of the selected text is also copied to your clipboard. When `false`, only plain text is copied to your clipboard. You can also specify which formats you would like to copy. When `null`, the global `"copyFormatting"` behavior is inherited. |

### Paste
Expand Down
2 changes: 2 additions & 0 deletions TerminalDocs/selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ As mentioned above, selected text can be copied with a right-click or the `copy`
- You can copy text without dismissing the text selection by setting the `dismissSelection` parameter in the `copy` action to `false`.
- Copying as a single line
- You can copy text as a single line using the `singleLine` parameter in the `copy` action.
- Copying with control sequences
- You can include [ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code) control sequences in the copied text using the `withControlSequences` parameter in the `copy` action.
- Removing trailing whitespace from block selections
- You can remove the trailing whitespace from a block selection using the `trimBlockSelection` global setting.

Expand Down