Added icon override documentation to appearance.md #808
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds documentation about the new icon override feature for profile and action entries (PR: microsoft/terminal#18116)
4 tasks
|
Learn Build status updates of commit 62f71aa: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
carlos-zamora
pushed a commit
to microsoft/terminal
that referenced
this pull request
Oct 29, 2024
## Summary of the Pull Request This PR is to allow users to set a custom icon for entries in the new tab menu for "action" and "profile" type entries. ## References and Relevant Issues This PR is in response to #18103 ## Detailed Description of the Pull Request / Additional comments It is now possible to specify an optional "icon" setting for any "action" or "profile" type entry in the "newTabMenu" JSON settings. When specified, this icon will be used as the menu icon for that action/profile in the new tab menu. If not specified, the action/profile definition's default icon will be used instead (if present). The Cascadia settings schema ("doc/cascadia/profiles.schema.json") has been updated to reflect this. ## Validation Steps Performed Manually tested with multiple combinations of icon settings: - ActionEntry: - valid path in action definition and new tab entry (renders new tab entry icon) - valid path in action definition but no path in new tab entry (renders action definition icon) - no path in action definition, valid path in new tab entry (renders new tab entry icon) - invalid path in action definition, valid path in new tab entry (renders new tab entry icon) - valid path in action definition, invalid path in new tab entry (renders no icon) - invalid path in both (renders no icon) - no path in both (renders no icon) - ProfileEntry: - valid path in new tab entry (renders new tab entry icon) - no path in new tab entry (renders profile's default icon) - invalid path in new tab entry (renders no icon) ## PR Checklist - [x] Closes #18103 - [x] Tests added/passed - [x] Documentation updated - If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: [#808](MicrosoftDocs/terminal#808) - [x] Schema updated (if necessary)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation about the new icon override feature for profile and action entries to be introduced by PR: microsoft/terminal#18116
Also added a section on "action" entries as it was previously missing.