initial 0.1.0 commit
This commit is contained in:
@@ -1,3 +1,92 @@
|
||||
# tab-park
|
||||
# Tab Park
|
||||
|
||||
A light weight tab unloader
|
||||
Tab Park frees up memory by putting tabs you are not using to sleep. A
|
||||
parked tab stays in the tab strip with its title and icon, but Firefox lets
|
||||
go of the page itself. Click the tab and it comes back, like a refresh.
|
||||
|
||||
That is the whole idea. It is not a tab manager, a session saver, or a
|
||||
workspace. It parks tabs.
|
||||
|
||||
## How to use
|
||||
|
||||
Install it from addons.mozilla.org once it is listed. The toolbar button
|
||||
opens a small panel with everything on it:
|
||||
|
||||
- **Unload this tab** moves you to the next tab that is still awake, then
|
||||
parks the one you were on. If every other tab is already parked, it opens
|
||||
a new tab to move you to instead.
|
||||
- **Unload other tabs in this window** parks every other tab in the window,
|
||||
leaving the one you are on. Pinned tabs are left alone.
|
||||
- **Never park this tab** takes the current tab out of the idle sweep and
|
||||
out of "Unload other tabs". Handy for a chat or a dashboard you keep open
|
||||
for hours.
|
||||
- **Auto-unload** parks a tab after it has been idle for a while. A tab is
|
||||
idle when it has not been the tab you were looking at for the chosen
|
||||
time; looking at a tab resets its clock. It is off by default, and the
|
||||
default idle time is 5 minutes.
|
||||
|
||||
Keyboard shortcuts: `Ctrl+Alt+P` parks the current tab, `Ctrl+Alt+A` parks
|
||||
every other tab in the window, leaving the one you are on. Open the
|
||||
extension's Preferences and click Manage Extension Shortcuts, or use
|
||||
`about:addons` under the gear icon.
|
||||
|
||||
## What it never does
|
||||
|
||||
- It never closes a tab. Nothing is lost; everything stays where it was.
|
||||
- It never parks pinned tabs, the tab you are on, tabs that are still
|
||||
loading, or tabs that would show a "leave this page?" warning.
|
||||
- It never parks a tab that is playing sound, so your music keeps going.
|
||||
You can turn that safeguard off in the toolbar panel.
|
||||
- It never reads your browsing. The extension has no permission to see
|
||||
your tabs or your websites, so it cannot look at addresses, titles, or
|
||||
page content. It can only see the state a tab is in, awake or parked,
|
||||
pinned, playing sound, and how long ago you last looked at it. That is
|
||||
exactly what it needs to decide what to park.
|
||||
- It never talks to the network, shows notifications, or collects anything.
|
||||
Settings stay on your machine. The only permissions are `storage` and
|
||||
`alarms`.
|
||||
|
||||
One consequence of those small permissions: "Never park this tab" is tied to
|
||||
the tab itself and lasts only until that tab is closed or Firefox restarts.
|
||||
|
||||
## How it is different
|
||||
|
||||
Most tab unloaders are tab managers with an unloading feature bolted on.
|
||||
They ask for access to your tabs or to every site you visit, and then offer
|
||||
rules, schedules, whitelists, statistics, and a settings page full of
|
||||
switches.
|
||||
|
||||
Tab Park does one thing: it parks tabs, on demand or once they have been
|
||||
idle long enough. The permission list is the short version of that
|
||||
difference.
|
||||
|
||||
## Settings
|
||||
|
||||
The toolbar panel has the auto-unload switch, the idle time, the skip-sound
|
||||
toggle, and the "Never park this tab" button. The extension's Preferences page
|
||||
only shows the current keyboard shortcuts and a button that opens Firefox's
|
||||
Manage Extension Shortcuts page.
|
||||
|
||||
## A small quirk
|
||||
|
||||
On Firefox 153, a parked tab does not get the faded look that Firefox's own
|
||||
Unload Tab menu item gives, unless you set `browser.tabs.fadeOutUnloadedTabs`
|
||||
to true in `about:config`. Firefox 160 fades them properly (bug 2000401).
|
||||
|
||||
## For developers
|
||||
|
||||
`tools/build.sh` writes `dist/tabpark/` (unpacked) and `dist/tabpark.xpi`
|
||||
(zipped). The xpi is what you upload to AMO. `npx web-ext lint --source-dir
|
||||
dist/tabpark` is clean.
|
||||
|
||||
The test harness drives the real extension in Firefox through Selenium; see
|
||||
`test/harness/README.md`.
|
||||
|
||||
To try it without installing, load it temporarily from
|
||||
`about:debugging#/runtime/this-firefox` (Load Temporary Add-on, pick
|
||||
`manifest.json`).
|
||||
|
||||
## The name
|
||||
|
||||
A park is where something waits without going away. That is what happens to
|
||||
the tab: it stays in the strip, out of memory, until you come back.
|
||||
|
||||
Reference in New Issue
Block a user