Add a spec for search, #605 #3299

KaiyuWang16 · 2019-10-23T18:41:14Z

This is the spec for #605

References

PR Checklist

Closes #xxx
CLA signed. If not, go over here and sign the CLA
Tests added/passed
Requires documentation to be updated
I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

carlos-zamora

I'd like this to be a bit more detailed on some user stories. Here's a few that I specifically want more details on:

using search ONLY with the keyboard
is this a part of the TermControl or TermApp?
interaction with terminal when find box is open

doc/specs/#605 - Search/spec.md

carlos-zamora · 2019-10-24T18:19:42Z

doc/specs/#605 - Search/spec.md

+
+In version 1, we want realize a case sensitive/insensitive exact text match. But we may consider the following features in version 2:
+
+1. Add "Find" button in dropdown menu to trigger search. 


As an addition (or replacement) to this point, this may also be a good feature for the command palette #2046 . You and @zadjii-msft should talk about this one 😊

zadjii-msft

I have a lot of questions.

doc/specs/#605 - Search/spec.md

zadjii-msft

Re: the new UI mockup

We should almost certainly have some sort of background to the entire searchbox, to help indicate that all the controls are part of a single UI element.
It seems a little tall - one row for each of the close button, the search box, and the case sensitivity chckbox means that this UI is now obscuring 3 rows of terminal content. Perhaps we could collapse it to a single row more like VsCode?
I would consider calling out these UI as examples of what the UI could look like, but not necessarily what it will definitely look like. Then we're less tied to content of the spec in whatever we end up implementing 😋

doc/specs/#605 - Search/spec.md

zadjii-msft

One of the big concerns I still have with this spec is regarding per-terminal search vs global search.

One of the superior features of iTerm2 is it's content search. The search comes in two variants: search from active tab and search from all tabs

(emph. added)

With the current design of a per-terminal find dialog, how do we transition to a global (search all terminals) model? I know that global search is out of scope for this first iteration, but if the find dialog is inherently tied to the terminal instance it's searching, how do we then re-use this dialog for searching many terminal instances?

There's a bunch of other comments that look like they still need answering in the text of the spec as well.

doc/specs/#605 - Search/spec.md

zadjii-msft

more notes

doc/specs/#605 - Search/spec.md

DHowett-MSFT · 2019-12-03T19:10:58Z

This should 100% not be the expected behavior. Is copyOnSelect triggered by mouse release, or by the terminal extending its selection ranges?

carlos-zamora · 2019-12-03T19:25:06Z

This should 100% not be the expected behavior. Is copyOnSelect triggered by mouse release, or by the terminal extending its selection ranges?

I think on mouse release so we might not have to worry about it. Nonetheless, this should be called out in the concerns section.

doc/specs/#605 - Search/spec.md

cinnamon-msft · 2019-12-03T21:04:27Z

Regarding the UI, I think it needs some polishing. In order to follow the design standards we have in the Terminal, I've created some mockups of how I imagined the UI to look. I'd love to hear what everyone thinks.

Without scrollbar

With scrollbar

Hi Kayla, I wonder if you know the colors used in the Font Icon and search box background in your mock ? @cinnamon-msft

doc/specs/#605 - Search/spec.md

DHowett-MSFT

I only have small nits.

doc/specs/#605 - Search/spec.md

carlos-zamora

Just create the follow up work items and I'll approve it :) Thanks!

doc/specs/#605 - Search/spec.md

zadjii-msft

I suppose I don't really have any more concerns with this - seems good enough for me.

doc/specs/#605 - Search/spec.md

DHowett-MSFT

i'm going to block until the duplicated text is fixed.

This is the PR for feature Search: #605 This PR includes the newly introduced SearchBoxControl in TermControl dir, which is the search bar for the search experience. And the codes that enable Search in Windows Terminal.  The PR that migrates the Conhost search module: #3279 Spec (still actively updating): #3299  ## PR Checklist * [x] Closes #605 * [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Requires documentation to be updated * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx  These functionalities are included in the search experience. 1. Search in Terminal text buffer. 2. Automatic wrap-around. 3. Search up or down switch by clicking different buttons. 4. Search case sensitively/insensitively by clicking a button. S. Move the search box to the top/bottom by clicking a button. 6. Close by clicking 'X'. 7. Open search by ctrl + F. When the searchbox is open, the user could still interact with the terminal by clicking the terminal input area. While I already have the search functionalities, currently there are still some known to-do works and I will keep updating my PR: 1. Optimize the search box UI, this includes: 1) Theme adaptation. The search box background and font color should change according to the theme, 2) Add background. Currently the elements in search box are all transparent. However, we need a background. 3) Move button should be highlighted once clicked. 2. Accessibility: search process should be able to performed without mouse. Once the search box is focused, the user should be able to navigate between all interactive elements on the searchbox using keyboard.  To test: 1. checkout this branch. 2. Build the project. 3. Start Windows Terminal and press Ctrl+F 4. The search box should appear on the top right corner.

This is the PR for feature Search: #605 This PR includes the newly introduced SearchBoxControl in TermControl dir, which is the search bar for the search experience. And the codes that enable Search in Windows Terminal.  The PR that migrates the Conhost search module: microsoft/terminal#3279 Spec (still actively updating): microsoft/terminal#3299  ## PR Checklist * [x] Closes #605 * [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Requires documentation to be updated * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx  These functionalities are included in the search experience. 1. Search in Terminal text buffer. 2. Automatic wrap-around. 3. Search up or down switch by clicking different buttons. 4. Search case sensitively/insensitively by clicking a button. S. Move the search box to the top/bottom by clicking a button. 6. Close by clicking 'X'. 7. Open search by ctrl + F. When the searchbox is open, the user could still interact with the terminal by clicking the terminal input area. While I already have the search functionalities, currently there are still some known to-do works and I will keep updating my PR: 1. Optimize the search box UI, this includes: 1) Theme adaptation. The search box background and font color should change according to the theme, 2) Add background. Currently the elements in search box are all transparent. However, we need a background. 3) Move button should be highlighted once clicked. 2. Accessibility: search process should be able to performed without mouse. Once the search box is focused, the user should be able to navigate between all interactive elements on the searchbox using keyboard.  To test: 1. checkout this branch. 2. Build the project. 3. Start Windows Terminal and press Ctrl+F 4. The search box should appear on the top right corner.

KaiyuWang16 added 3 commits October 16, 2019 14:50

Spec for Search Experience

5869d4a

Finish Solution design

0773361

Spec for Search

5103f2c

KaiyuWang16 requested review from bitcrazed, cinnamon-msft and DHowett-MSFT October 23, 2019 21:41

carlos-zamora requested changes Oct 24, 2019

View reviewed changes

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Oct 24, 2019

zadjii-msft requested changes Nov 1, 2019

View reviewed changes

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Nov 1, 2019

Add UI design of SearchBoxControl

92d06ec

zadjii-msft reviewed Nov 4, 2019

View reviewed changes

KaiyuWang16 added 2 commits November 4, 2019 11:51

Add new details to spec according to feedbacks

097988d

Minor typos fix

50d65ff

zadjii-msft mentioned this pull request Nov 7, 2019

Addition of an advanced find box #3469

Closed

KaiyuWang16 mentioned this pull request Nov 15, 2019

Search - add search box control and implement search experience #3590

Merged

5 tasks

Spec updates on 11/15

6b7ed3b

zadjii-msft requested changes Nov 25, 2019

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Nov 25, 2019

update button behavior

a462f56

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Nov 25, 2019

KaiyuWang16 added 2 commits November 25, 2019 13:51

Update sepc images

754ced4

Add Esc key binding explnanation

e7c525c

zadjii-msft reviewed Nov 25, 2019

View reviewed changes

PR feedback changes

8fb0d51

zadjii-msft requested changes Nov 26, 2019

View reviewed changes

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Nov 26, 2019

cinnamon-msft reviewed Dec 3, 2019

View reviewed changes

doc/specs/#605 - Search/spec.md Outdated Show resolved Hide resolved

Update for new UI experience

85eca9a

DHowett-MSFT reviewed Dec 10, 2019

View reviewed changes

doc/specs/#605 - Search/spec.md Outdated Show resolved Hide resolved

DHowett-MSFT approved these changes Dec 10, 2019

View reviewed changes

KaiyuWang16 added 2 commits December 10, 2019 16:54

Fix typos and replace images

388d6ca

Replace images and add new future works

c1f17e0

carlos-zamora requested changes Dec 11, 2019

View reviewed changes

doc/specs/#605 - Search/spec.md Outdated Show resolved Hide resolved

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 11, 2019

zadjii-msft approved these changes Dec 11, 2019

View reviewed changes

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 11, 2019

Add issue link for tracking future features

0b785e9

DHowett-MSFT reviewed Dec 11, 2019

View reviewed changes

doc/specs/#605 - Search/spec.md Outdated Show resolved Hide resolved

carlos-zamora approved these changes Dec 11, 2019

View reviewed changes

DHowett-MSFT suggested changes Dec 12, 2019

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 12, 2019

KaiyuWang16 mentioned this pull request Dec 12, 2019

Epic: Search v2 #3920

Open

20 tasks

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 14, 2019

remove duplicate text

a16ba78

DHowett-MSFT approved these changes Dec 14, 2019

View reviewed changes

DHowett-MSFT changed the title ~~Spec for #605 search experience~~ Add a spec for search, #605 Dec 14, 2019

DHowett-MSFT merged commit d95020e into master Dec 14, 2019

DHowett-MSFT deleted the dev/kawa/605-Search-Experice-Spec branch December 14, 2019 00:41

dacapoday mentioned this pull request Jan 21, 2020

windows min/max buttons layout error #4310

Closed

thkrishn mentioned this pull request Feb 3, 2020

Is there way to download the terminal installer? #4442

Closed

zadjii-msft mentioned this pull request Apr 15, 2020

search #5359

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a spec for search, #605 #3299

Add a spec for search, #605 #3299

KaiyuWang16 commented Oct 23, 2019

carlos-zamora left a comment

carlos-zamora Oct 24, 2019

zadjii-msft left a comment

zadjii-msft left a comment

zadjii-msft left a comment

zadjii-msft left a comment

DHowett-MSFT commented Dec 3, 2019

carlos-zamora commented Dec 3, 2019

cinnamon-msft commented Dec 3, 2019 •

edited by KaiyuWang16

DHowett-MSFT left a comment

carlos-zamora left a comment

zadjii-msft left a comment

DHowett-MSFT left a comment


		In version 1, we want realize a case sensitive/insensitive exact text match. But we may consider the following features in version 2:

		1. Add "Find" button in dropdown menu to trigger search.

Add a spec for search, #605 #3299

Add a spec for search, #605 #3299

Conversation

KaiyuWang16 commented Oct 23, 2019

References

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

carlos-zamora left a comment

Choose a reason for hiding this comment

carlos-zamora Oct 24, 2019

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

DHowett-MSFT commented Dec 3, 2019

carlos-zamora commented Dec 3, 2019

cinnamon-msft commented Dec 3, 2019 • edited by KaiyuWang16

DHowett-MSFT left a comment

Choose a reason for hiding this comment

carlos-zamora left a comment

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

DHowett-MSFT left a comment

Choose a reason for hiding this comment

cinnamon-msft commented Dec 3, 2019 •

edited by KaiyuWang16