On selection Change Event


After developing the entire hover panel end connecting it with the webview (via button), the last thing was to make sure that when the cursor changes its position, the hover panel will change accordingly (if necessary).


So, the first thing was to google how "onClickChange"/"onSelectionChange" events work in typescript and the vscode developing environment.


We found this GitHub page:

https://github.com/microsoft/vscode-extension-samples/blob/master/statusbar-sample/src/extension.ts


And under the "statusbar-sample" we found an easy example of how to use vscode "onDidChangeTextEditorSelection" function:



Using that code, we realized we needed to rearrange our code a little bit.


firstly, we moved the new command we made ("newTabCommand") to a new function which is called

at the beginning of the "activate" function:

The next thing was to move the main condition from the "activate" function to the "getImageUrl"

function:

Then we took the local variables from the "activate" function and made them global, so we can access them from outside the "activate" function, when their value will need to be changed.


Also, we moved the Markdown string from inside the "registerHoverProvider" call into the new "hoverStringValue" global variable. before:

after:

Next thing was to change our "activate" function to look a bit more like the one in the example: example code:

our code:


** NOTE: the hoverPanel variable is giving us the ability to change the content in the hover panel without making a new hover. The condition is to make sure not to make a new hover panel for the same URL.
Then we made the "updateHoverPanel" function:



 explanation: 1. get the current selection. 2. if its an image URL and it's not the same as the last URL selected: 2.1. update the global URL variable to the current URL 2.2. update the markdown string according to the current URL 2.3. update the hoverPanel variable according to the current markdown string. Finally, to not make unnecessary hover panels, we made sure there is only one initialization to the "hoverPanel" variable:



And this is the final look:


Comments

Post a Comment

Popular posts from this blog

Turorial- How to add a new feature

Image
In this Post we will explain how to make and integrate a new feature to our extension. ** ALL VARIABLES EXPLANATIONS ARE AT THE BOTTOM Let's say we want to support text files. The first thing we will need to do is to create a new file- we name it "TextObject". We then import the "utils" and "IPreviewObject" files. We create a new (export deafult) class caled "TextObject" which implements IPreviewObject. Now, we need to implement the interface's 3 functions: 1. validatePotentialUrl- we check if the current potential URL has a ".txt" extension. if so- we update the current URL to the potential URL, and the currentPreviewObject to a textObject. 2. GetHtmlContent- returns an empty string because we dont need a webview panel for this feature. 3. makeMrkdownString- this function will need to create a string that will allow to open a text file in a new tab when clicking on a certain button. To do so, w...
Read more

Little Bug Fix

Image
After the big refactoring and redesigning we made, there are a few more things we have left to do: 1. Currently, once the cursor is on a certain URL, the hover panel will change accordingly. So, if we hover over URLs that the cursor is not on them we will still be presented with the last hover panel that was created. That is a bug and we need to fix it. 2. We need to make a unit testing (we dont know how to do that, so we need to learn a bit more) 3. Try and use other VSCODE extensions to support previewing PDFs and HTML (the web page, not the HTML file). To fix (1) we added a new condition to the "push" call (in the activate finction, in extension.ts). We check if the line the cursor is on is the same as the line we hover over. If so, call the "updateHoverPanel" function (which makes a markdown string for the hover panel according to the current URL format). If not, update the hover panel content (the markdown string) to an empty string. W...
Read more

Publishing First Beta & Refactoring The Code

Image
We figured it was time to publish a first beta of our extension to VSCODE marketplace. We made some little adjustments like renaming some variables, for more readable code, and fixed a few major bugs, and then we published it using this tutorial .  You can find our extension on this link . *A big bug we had was that the last hover panel continude to show when hovering on defferent lines that are not a URL. Our problem was fixed by updating the current URL variable to UNDEFINED and the markdown string to an empty string, like so: Now that we published our first working extension, we wanted to focus more on the code and the design. Firstly, we decided it would be smarter to extract the relevant line and check what is it's format rather then what we made so far- which is to send the whole document to each extraction function. We created a new function called "extractCurrentLine" which does the following: 1. The function receives the document text ...
Read more