Summary

Add a foundation model for typeahead search of UIs.

Review Request #13627 — Created March 11, 2024 and submitted March 18, 2024, 10:55 p.m.

Information

Owner

chipx86

Repository

Ink

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

This introduces TypeaheadBuffer, which tracks key presses made within
a short period of time (default is 3 seconds) for the purposes of
navigating a UI (such as a menu or sidebar). It takes care of
maintaining its buffer based on key presses and assisting in performing
matches based on the keys pressed.

Components can instantiate this, send key presses, listen to buffer
changes, and use those and helper methods to help find the relevant
element in the UI to select.

This does not provide any visuals showing what's been typed (though that
may come later, based on work done in another codebase).

Testing Done

Unit tests pass.

Commits

Summary	ID
Add a foundation model for typeahead search of UIs. This introduces `typeaheadBuffer`, which tracks key presses made within a short period of time (default is 3 seconds) for the purposes of navigating a UI (such as a menu or sidebar). It takes care of maintaining its buffer based on key presses and assisting in performing matches based on the keys pressed. Components can instantiate this, send key presses, listen to buffer changes, and use those and helper methods to help find the relevant element in the UI to select. This does not provide any visuals showing what's been typed (though that may come later, based on work done in another codebase).	a4cd3e23d244990a4582cb28aed8a923735b4d24

Summary

Add a foundation model for typeahead search of UIs.

This introduces `typeaheadBuffer`, which tracks key presses made within a short period of time (default is 3 seconds) for the purposes of navigating a UI (such as a menu or sidebar). It takes care of maintaining its buffer based on key presses and assisting in performing matches based on the keys pressed. Components can instantiate this, send key presses, listen to buffer changes, and use those and helper methods to help find the relevant element in the UI to select. This does not provide any visuals showing what's been typed (though that may come later, based on work done in another codebase).

a4cd3e23d244990a4582cb28aed8a923735b4d24

Issues

Description	From	Last Updated
Typo in summary: fondation	david	March 17, 2024, 12:57 a.m.
Add a module level comment here.	david	March 17, 2024, 12:58 a.m.
TItem?	david	March 17, 2024, 12:58 a.m.
This syntax isn't quite right. This defines a function that takes an argument named ItemT with no type, and returns …	david	March 17, 2024, 12:59 a.m.
Same here.	david	March 17, 2024, 12:59 a.m.
Add type for this?	david	March 17, 2024, 12:59 a.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues
```
Typo in summary: fondation
```
src/ink/js/foundation/models/tests/typeaheadBufferTests.ts (Diff revision 1)
The issue has been resolved. Show all issues
```
Add a module level comment here.
```
src/ink/js/foundation/models/typeaheadBuffer.ts (Diff revision 1)
The issue has been resolved. Show all issues
```
TItem?
```

src/ink/js/foundation/models/typeaheadBuffer.ts (Diff revision 1)

The issue has been resolved. Show all issues

This syntax isn't quite right. This defines a function that takes an argument named ItemT with no type, and returns a string. It needs to be ((item: ItemT) => string)

src/ink/js/foundation/models/typeaheadBuffer.ts (Diff revision 1)
The issue has been resolved. Show all issues
```
Same here.
```
src/ink/js/foundation/models/typeaheadBuffer.ts (Diff revision 1)
The issue has been resolved. Show all issues
```
Add type for this?
```

Change Summary:


Buffer text is now normalized when set, fixing comparison issues.
Fixed some type-related issues and type name consistency.
Added a missing file-level comment.

Summary:

-	Add a fondation model for typeahead search of UIs.
+	Add a foundation model for typeahead search of UIs.

Commits:

	Summary	ID
	Add a fondation model for typeahead search of UIs. This introduces `typeaheadBuffer`, which tracks key presses made within a short period of time (default is 3 seconds) for the purposes of navigating a UI (such as a menu or sidebar). It takes care of maintaining its buffer based on key presses and assisting in performing matches based on the keys pressed. Components can instantiate this, send key presses, listen to buffer changes, and use those and helper methods to help find the relevant element in the UI to select. This does not provide any visuals showing what's been typed (though that may come later, based on work done in another codebase).	87d4cc75aeffed139323a96c16a525878700f656
	Add a foundation model for typeahead search of UIs. This introduces `typeaheadBuffer`, which tracks key presses made within a short period of time (default is 3 seconds) for the purposes of navigating a UI (such as a menu or sidebar). It takes care of maintaining its buffer based on key presses and assisting in performing matches based on the keys pressed. Components can instantiate this, send key presses, listen to buffer changes, and use those and helper methods to help find the relevant element in the UI to select. This does not provide any visuals showing what's been typed (though that may come later, based on work done in another codebase).	a4cd3e23d244990a4582cb28aed8a923735b4d24

Diff:

Revision 2 (+958)

Show changes

	src/ink/js/foundation/models/index.ts
	src/ink/js/foundation/models/typeaheadBuffer.ts
	src/ink/js/foundation/models/tests/typeaheadBufferTests.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Description:

~		This introduces `typeaheadBuffer`, which tracks key presses made within
	~	This introduces `TypeaheadBuffer`, which tracks key presses made within
		a short period of time (default is 3 seconds) for the purposes of
		navigating a UI (such as a menu or sidebar). It takes care of
		maintaining its buffer based on key presses and assisting in performing
		matches based on the keys pressed.

		Components can instantiate this, send key presses, listen to buffer
		changes, and use those and helper methods to help find the relevant
		element in the UI to select.

		This does not provide any visuals showing what's been typed (though that
		may come later, based on work done in another codebase).

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (fee49e6)