Remove deregisterProvider from SearchProviderRegistry interface #6282
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
|
Thanks for making a pull request to JupyterLab! To try out this branch on binder, follow this link: |
blink1073
approved these changes
May 1, 2019
| @@ -85,6 +80,10 @@ export class SearchProviderRegistry implements ISearchProviderRegistry { | |||
| ); | |||
| } | |||
|
|
|||
| get changed(): ISignal<this, void> { | |||
| * @returns true if removed, false if key did not exist in map. | ||
| */ | ||
| deregisterProvider(key: string): boolean; | ||
| register(key: string, provider: ISearchProviderConstructor): IDisposable; |
There was a problem hiding this comment.
Missing doc for the return value?
|
Thanks, good catches! |
lock
bot
added
the
status:resolved-locked
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
References
Addresses an issue brought up in #6217.
Code changes
This removes the
deregisterProviderfunction onISearchProviderRegistry, renamesregisterProviderto simplyregisterand returns aDisposableDelegate, and adds achangedsignal toISearchProviderRegistrythat emits when a provider has been registered or disposed (and effectively deregistered). The goal here was to allow extensions to only 'deregister' the providers that they provide and no others.Also, with the new signal, we can ensure that the
jp-mod-searchableclass that controls the ctrl + f and other search-related keybindings is added to and removed from active widgets only when they have a registered search provider.User-facing changes
There should be no user-facing changes here, other than a slightly tighter control on when the search keybindings are routed to the browser vs a search provider when providers are registered/deregistered.
Backwards-incompatible changes
This makes three breaking changes to the
ISearchProviderRegistryinterface, as described above:registerProvider->registerand it now returns anIDisposablederegisterProviderchangedsignal