Skip to content

Commit

Permalink
moved elevated state to future considerations, no longer experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
@PankajBhojwani
PankajBhojwani committed Dec 9, 2020
1 parent df039d2 commit 95ab38c
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions doc/specs/Configuration object for profiles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ issue id: <#8345>

This spec outlines how we can support 'configuration objects' in our profiles, which
will allow us to render differently depending on the state of the control. For example, a
control can be rendered differently if it's focused as compared to when it's unfocused. Another
example is that an elevated state control can be rendered differently as compared to a
non-elevated one.
control can be rendered differently if it's focused as compared to when it's unfocused.

## Inspiration

Expand All @@ -22,13 +20,6 @@ Reference: [#3062](https://github.com/microsoft/terminal/issues/3062)
Users want there to be a more visible indicator than the one we have currently for which
pane is focused and which panes are unfocused. This change would grant us that feature.

## Note: this is going to be an experimental change

Upon discussion we realized that this feature might cause scaling problems in the future. Thus, we
have decided to make this an experimental change for now - meaning that we are not (at this point) committed
to supporting this feature in the long term. We will decide on the longevity of this feature after obtaining
user feedback from the initial experimental phase.

## Solution Design

We will add new interfaces in the `TerminalControl` namespace, called `IControlAppearance` and `ICoreAppearance`,
Expand Down Expand Up @@ -79,21 +70,12 @@ for that profile (similarly, they could define just 1 or 2 parameters if they wi
and unfocused states for that profile). If they do not define any `unfocusedState` for the profile, then
the global/default one will be used.

### Multiple states

At the time of writing this, we have noted two possible 'appearance states' that we should allow: unfocused and elevated.
The question then is, in the case of an unfocused and elevated control, which appearance should we use?

For now, we will solve this problem by allowing a third state "unfocused elevated". This solution style of combining states
is of course not going to be feasible if we add more states in the future - hence why this feature is going to remain
experimental for now.

## UI/UX Design

Users will be able to add a new setting to their profiles that will look like this:

```
"experimental.state.unfocused":
"unfocusedConfig":
{
"colorScheme": "Campbell",
"cursorColor": "#888",
Expand Down Expand Up @@ -134,6 +116,9 @@ does not cause the window to flash/show a jarring indicator that the rendering v

We will need to decide how this will look in the settings UI.

We may wish to add more states in the future (like 'elevated'). When that happens, we will need to deal with how
these appearance objects can scale/layer over each other.

## Resources


1 comment on commit 95ab38c

@github-actions
Copy link

Choose a reason for hiding this comment

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

New misspellings found, please review:

  • IAppearance
To accept these changes, run the following commands 
perl -e '
my @expect_files=qw('".github/actions/spell-check/expect/5757ec679b03a4240130c3c53766c91bbc5cd6a7.txt
.github/actions/spell-check/expect/655f007265b351e140d20b3976792523ad689241.txt
.github/actions/spell-check/expect/alphabet.txt
.github/actions/spell-check/expect/expect.txt
.github/actions/spell-check/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"AAAAA Bopomofo CParams CSV GENERATEPROJECTPRIFILE hhhh Inlines MAKEINTRESOURCEA renamer
 Reserialize rgus SGRXY UDK UDKs Unfocus xe xlang "');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
  if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
  next if /^($re)(?:$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spell-check/expect/95ab38cacbc7baaabfbbc4ba7c10fa96702a511d.txt";
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"csv IAppearance inlines Renamer reserialize udk unfocus "');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a) cmp lc($b)} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;'
git add .github/actions/spell-check/expect || echo '... you want to ensure .github/actions/spell-check/expect/95ab38cacbc7baaabfbbc4ba7c10fa96702a511d.txt is added to your repository...'
✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spell-check/dictionary/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spell-check/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spell-check/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The :check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

Please sign in to comment.