Skip to content

Commit 499d2c6

Browse files
authored
README for v1.4 (#90)
1 parent 2dadb1e commit 499d2c6

File tree

1 file changed

+22
-96
lines changed

1 file changed

+22
-96
lines changed

README.md

Lines changed: 22 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,37 @@
11
# Second Sidebar for Firefox
22

3-
A Firefox userChrome.js script for adding a second sidebar with web panels like in Vivaldi/Floorp/Zen but better.
3+
A Firefox userChrome.js script for adding a second sidebar with web panels like in Vivaldi/Edge/Floorp/Zen but better.
44

5-
![promo_rounded](https://github.com/user-attachments/assets/d3cd7163-6b9c-4005-a422-2995490c1be0)
5+
![promo-rounded](https://github.com/user-attachments/assets/2eb261b0-0942-4c74-a8c9-087d7455bfbd)
66

77
## Motivation
88

9-
There are many forks of Firefox, but I prefer to continue using the original browser. However, I have also tried other browsers such as Vivaldi, Floorp and Zen. I also miss the feature of having a decent sidebar with web panels, which is why I decided to create my own version, with blackjack and hookers.
9+
I've tried various browsers, such as Vivaldi, Edge, Floorp, and Zen, and they all have one thing in common that I can't imagine using a browser without — the sidebar. Unfortunately, Firefox, which I feel most closely aligns with my needs in terms of spirit and functionality, has a rather unsatisfactory sidebar. Therefore, I decided to create another one myself, with blackjack and hookers!
1010

1111
## Demo
1212

13-
https://github.com/user-attachments/assets/a92fb9b5-84d5-42a1-99f3-ad718767383f
13+
https://github.com/user-attachments/assets/e4a2c01a-0d32-463d-84da-ffa6b090508c
1414

1515
## Features
1616

17-
<details>
18-
<summary>⚠️ Warning: data-intensive GIFs under spoiler ⚠️</summary>
19-
<table>
20-
<tr>
21-
<td>
22-
<h3>Adding new web panel</h3>
23-
<ol>
24-
<li>Left-click on the Plus button.</li>
25-
<li>Enter the web address. The current address will be automatically inserted into the field.</li>
26-
<li>Choose Multi-Account Container if you want.</li>
27-
<li>Press Enter or click on the "Create" button.</li>
28-
<li>A new web panel will be created with default settings.</li>
29-
</ol>
30-
</td>
31-
<td><img src="https://github.com/user-attachments/assets/5b7c3802-3de7-4ac3-8c3d-93ea07c91f09" width="400px" /></td>
32-
</tr>
33-
<tr>
34-
<td>
35-
<h3>Pinning and unpinning the web panel</h3>
36-
Depending on your needs, you can pin the web panel to the side of the web page or make it appear on top of the content.
37-
</td>
38-
<td><img src="https://github.com/user-attachments/assets/048fd1e2-d50e-4ffc-beba-dc33d06e7251" width="400px" /></td>
39-
</tr>
40-
<tr>
41-
<td>
42-
<h3>Mobile view and zooming</h3>
43-
There is an option to open the website using the mobile user agent. There are also buttons to zoom in and out of the content.
44-
</td>
45-
<td><img src="https://github.com/user-attachments/assets/fad1d08e-f906-47d1-990d-9e6568e1512b" width="400px" /></td>
46-
</tr>
47-
<tr>
48-
<td>
49-
<h3>Unloading the web panel from memory</h3>
50-
To save memory, you can manually unload the web panel using two methods: the toolbar button or the context menu.
51-
</td>
52-
<td><img src="https://github.com/user-attachments/assets/520b38dd-5515-47dc-89c9-407ad9dc7155" width="400px" /></td>
53-
</tr>
54-
<tr>
55-
<td>
56-
<h3>Web panel settings</h3>
57-
Here you can change the following:
58-
<ol>
59-
<li>Page address. After changing the relevant field, please wait one second for the changes to be temporarily applied. They will be saved or canceled depending on your next action.
60-
</li>
61-
<li>Multi-Account Container.</li>
62-
<li>Favicon address. The same as for the page address.</li>
63-
<li>Web panel type: floating or pinned.</li>
64-
<li>Mobile View.</li>
65-
<li>Load into memory at startup: automatic loading of the web panel. </li>
66-
<li>Unload from memory after closing.</li>
67-
<li>Hide toolbar: "headless" web panel.</li>
68-
<li>Zoom.</li>
69-
<li>Position of the web panel button.</li>
70-
</ol>
71-
All changes are applied instantly, but can be rolled back by clicking the "Cancel" button or by losing focus. They are saved only after clicking the "Save" button.
72-
</td>
73-
<td><img src="https://github.com/user-attachments/assets/a19976d6-b4f8-4baa-a99b-c22bce6ab864" width="400px" /></td>
74-
</tr>
75-
<tr>
76-
<td>
77-
<h3>Deleting the web panel</h3>
78-
There is confirmation of the deletion, so you don't need to worry about accidentally deleting the web panel.
79-
</td>
80-
<td><img src="https://github.com/user-attachments/assets/5a870ce7-76d3-4297-a8e4-5603cb1dff3a" width="400px" /></td>
81-
</tr>
82-
<tr>
83-
<td>
84-
<h3>Sidebar settings</h3>
85-
Here you can change the following:
86-
<ol>
87-
<li>Sidebar position: left or right.</li>
88-
<li>Sidebar width (padding).</li>
89-
<li>Floating web panel offset: distance between sidebar and floating web panel.</li>
90-
<li>New web panel position: before or after "Plus" button.</li>
91-
<li>Container indicator position: which side of web panel button to color.</li>
92-
<li>Hide sidebar in popup windows.</li>
93-
<li>Auto-hide of back and forward buttons from toolbar.</li>
94-
</ol>
95-
All changes are applied instantly, but can be rolled back by clicking the "Cancel" button or by losing focus. They are saved only after clicking the "Save" button.
96-
</td>
97-
<td><img src="https://github.com/user-attachments/assets/b0cea2a7-99bc-4098-b417-08d2416c0c65" width="400px" /></td>
98-
</tr>
99-
<tr>
100-
<td>
101-
<h3>Customization</h3>
102-
You can customize the Second Sidebar like any other toolbar in Firefox: https://support.mozilla.org/en-US/kb/customize-firefox-controls-buttons-and-toolbars.
103-
Moreover, you can also move your web panel buttons to other toolbars!
104-
</td>
105-
<td><img src="https://github.com/user-attachments/assets/51403ab6-c9e8-4317-bf40-2b68691308d6" width="400px" /></td>
106-
</tr>
107-
</table>
108-
</details>
17+
### Sidebar
18+
19+
- Actions: `Show``Hide`
20+
- Customize via [Customize Toolbar...](https://support.mozilla.org/en-US/kb/customize-firefox-controls-buttons-and-toolbars)
21+
- Settings: `Position (left / right)``Auto-hide``Animate hiding / showing``Width``Floating web panel offset``Position of the new web panel button (Before plus button / After plus button)``Container indicator position (Left / Right / Top / Bottom / Around)``Hide sidebar in popup windows``Auto hide back button``Auto hide forward button`
22+
23+
### Web panels
24+
25+
- Actions: `Create``Delete``Edit``Change width``Unload``Mute``Unmute``Pin``Unpin``Change zoom``Go back``Go forward``Reload``Go home`
26+
- Extensions support
27+
- Sound icon
28+
- Notification badge
29+
- Periodic reload
30+
- Settings: `Web address``Multi-Account Container``Favicon web address``Type of web panel (pinned / floating)``Mobile View``Loading into memory at startup``Unloading from memory after closing``Hide toolbar``Hide sound icon``Hide notification badge``Periodic reload``Zoom`
31+
32+
### Widgets
33+
34+
- `Second Sidebar` to show / hide sidebar
10935

11036
## Install (fx-autoconfig)
11137

0 commit comments

Comments
 (0)