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

Add renameTab to docs #76

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions TerminalDocs/customize-settings/key-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,27 @@ 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). |

### Rename the Tab
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may need to be badged with the Preview tag for Preview 1.2 (when it comes out). Not sure how we should track 1.2 things when 1.1 is actively in preview. @cinnamon-msft?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah. We should make a release-1.2 branch and have this PR point to there instead of master. Then, the Preview tag can be added and it will all go live once we merge the release-1.2 branch into the master and live branches.
My apologies for not creating this branch sooner!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, just made the release-1.2 branch 😄

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay made the PR point to the new branch! Not sure what badging with the preview tag means though, is that something I'd have to do?


This changes the name of the current tab to the provided name, or can be used to reset the name to the default.

**Command name:** `renameTab`

**Example bindings:**

```json
{ "command": { "action": "renameTab", "title": "name" }, "keys": "alt+r" },
{ "command": { "action": "renameTab" }, "keys": "ctrl+alt+r" },
{ "command": "renameTab", "keys": "alt+shift+r" }
```

#### Actions

| Name | Necessity | Accepts | Description |
| ---- | --------- | ------- | ----------- |
| `title` | Optional | String | If provided, will set the tab's name to the given string. If omitted, it will reset the tab's name to default |


<br />

___
Expand Down