Steemit-Sidebar - Version 0.6.1

Repository

https://github.com/MWFIAE/Steemit-Sidebar

Pull-Request (Aug. 7. 2018)

https://github.com/MWFIAE/Steemit-Sidebar/pull/31

New Features

Short version:

[+] Change side of the sidebar
[+] reload settings from other tabs
[+] multiple language support
[+] more information about Steempower
[+] preset user name from logged in user
[*] better code commenting

Long version

1. Sidebar-Side

_{Github Commit}
Users can now change the side of the sidebar to their liking:

Left-Side	Right-Side

This is done via the settings menu:

As you can see this setting requires a site-refresh to take effect, so keep that in mind.

How was that implemented?

	First a little CSS to move the sidebar to the right side if the class mw-right is set.
Of course we have to set the class, this is done via a variable in my template. This would also allow a class mw-left to be set, but this class isn't used as of now.
	Now we need a way to set the change the side we want to use, so I made an extra row in the settings menu. Also the table in the settings menu got messy a bit so I spaced out the code a little more, to make it more readable.
I added the default value for the side to the MWSidebar object, nothing fancy
	I made a little function to update the settings if another option is selected. This will also be useful latter once I remove the need for the refresh
Instead of always using the right arrow "⟩" if the sidebar is collapsed. We now use "⟩" or "⟨" depending on the setting
	The same in reverse if the sidebar is not collapsed
Finally the saving and loading for this setting was implemented

Additional Screenshots

The Sidebar on the left side.	And if it is collapsed
The Sidebar on the right side	And if it is collapsed
Click on the little cog to open the settings menu

	There you will find the option for the Sidebar-Side

---

2. Reload Settings from another tab

_{Github Commit}

Often times users will have more than 1 tab open with Steemit. This causes a problem with the settings made in the Steemit-Sidebar. To solve that and improve user experience I implemented automatic reloading of the settings in other tabs.

How was that implemented?

	Added a new variable to the settings. This will hold the last time the settings were saved. We need this information to detect if new settings were saved in another tab.
Naturally this variable needs to be filled while loading the settings
	While saving the settings we first set the value to the current UTC timestamp. Then it will be saved with the other setting
Now the interesting stuff. We check every second what the currently saved last timestamp is. If it's above the timestamp of the current tab then this is a clear evidence that the settings were saved in another tab. If this happens we just reload the settings.
	Finally just call the function once so that it can reschedule itself.

---

3. Multiple language support

_{Github Commit - Language Setting
Github Commit - Text replace}

I implemented support for multiple languages besides English. The language can then be selected inside the settings menu.

How was that implemented?

	Added option to settings menu. Also minor rearrangement.
Setting the initial value and bind the event listener for the change event.
	The function that is called if the language is changed. It updates the settings and then re renders parts of the sidebar.
Of course the language needs to be saved and loaded.
	The texts are now not hard coded in the view templates, but instead saved in an language map.
Just a little example how these are then used in the template.
	Finally we need to pass the I18N constant into my template processing function.

Additional Screenshots

As there aren't any other languages beside English right now, there isn't much to show...
Feel free to leave a pull-request to add your own language! :)

---

4. More information about the Steempower

_{Github Commit}

It was requested by several users that they see more information about the Steempower a user possesses. How much was received from another user? How much does the user itself own? And how much did he delegate to other user?
It can now be seen in the sidebar if you hover over the Steempower of an user.

How was that implemented?

	Extended the user template with an additional tooltip. The CSS classes etc. already exists because of the tooltip for the voting power.
Now we just need to calculate the values to be displayed.

The values are calculated using these formulas:

ownSP=totalVestingFund * ( vesting_shares / totalVestingShares)
receivedSP= totalVestingFund * (received_vesting_shares / totalVestingShares)
delegatedSP= totalVestingFund * (delegated_vesting_shares / totalVestingShares)

---

5. Preset user name for new users

_{Github Commit}

It is often difficult for new users to get started with the sidebar. Therefore to make it easier I implemented some logic to get the logged in user. This user is then automatically entered into the search box to make it more obvious for new users.

How was that implemented?

	We can just use the user name that is saved by Steemit in the local storage.
To read the saved value we need to convert it from hex to ASCII.
	As you may have noticed we also read the private posting key for this user. Don't worry though! The sidebar will never upvote or post in your name without your consent. To be honest the key isn't even used yet. But I plan to implement a feature to upvote posts from the sidebar.

---

6. Better comments!

_{Github Commit}

It is time for a little code cleanup! Most likely a lack of comments made it difficult to understand the code for the sidebar. Therefore I took the time to comment every function, parameter and "global" variable!

How was that implemented?

Lets take the "LerpColor" function for example:

While the method name was already very descriptive, it's a lot better with the added comment and descriptive parameter names!

Let's look at a few more functions:

That's how it should look ;)
Btw. this commenting style was chosen so that I can use the jsdoc npm package to generate some online documentation. Haven't found the time to do so, though.

GitHub Account

https://github.com/MWFIAE

I hope you enjoyed the long read!

Greetings,
Martin