mirror of
https://github.com/SoPat712/Speeder.git
synced 2026-08-19 11:52:31 -04:00
docs: correct extension behavior guidance
This commit is contained in:
@@ -24,7 +24,7 @@ Constraints: local commits only; no push; no browser testing; one commit per fea
|
||||
## Extension lifecycle and copy
|
||||
|
||||
- [x] Initialize and synchronize the disabled toolbar icon from background state.
|
||||
- [ ] Correct shortcut, subtitle-nudge, live-update, and obsolete troubleshooting copy.
|
||||
- [x] Correct shortcut, subtitle-nudge, live-update, and obsolete troubleshooting copy.
|
||||
- [ ] Run automated tests in the release workflow before packaging.
|
||||
|
||||
## Verification
|
||||
|
||||
@@ -56,16 +56,14 @@ settings page, as well as add additional shortcut keys to match your
|
||||
preferences. For example, you can assign multiple different "preferred speed"
|
||||
shortcuts with different values, which will allow you to quickly toggle between
|
||||
your most commonly used speeds. To add a new shortcut, open extension settings
|
||||
and click "Add New".
|
||||
and choose an action from "Add shortcut…".
|
||||
|
||||
<img width="1760" height="1330" alt="image" src="https://github.com/user-attachments/assets/32e814dd-93ea-4943-8ec9-3eca735447ac" />
|
||||
|
||||
Some sites may assign other functionality to one of the assigned shortcut keys —
|
||||
these collisions are inevitable, unfortunately. As a workaround, the extension
|
||||
listens both for lower and upper case values (i.e. you can use
|
||||
`Shift-<shortcut>`) if there is other functionality assigned to the lowercase
|
||||
key. This is not a perfect solution, as some sites may listen to both, but works
|
||||
most of the time.
|
||||
Some sites may assign other functionality to one of the assigned shortcut keys.
|
||||
You can record `Shift+<shortcut>` as a separate, exact binding, or use a site
|
||||
rule to block the site from capturing a particular Speeder shortcut. Shift is
|
||||
not applied automatically to an unshifted binding.
|
||||
|
||||
## Development
|
||||
|
||||
@@ -81,12 +79,10 @@ npx --yes web-ext lint --source-dir extension
|
||||
|
||||
### The video controls are not showing up?
|
||||
|
||||
This extension is only compatible
|
||||
with HTML5 video. If you don't see the controls showing up, chances are you are
|
||||
viewing a Flash video. If you want to confirm, try right-clicking on the video
|
||||
and inspect the menu: if it mentions flash, then that's the issue. That said,
|
||||
most sites will fallback to HTML5 if they detect that Flash is not available.
|
||||
You can try manually disabling Flash from the browser.
|
||||
Speeder works with HTML5 video and, when enabled in settings, HTML5 audio. Check
|
||||
that Speeder is enabled for the current site, then use the popup's "Rescan page
|
||||
for videos" action after a player loads dynamically. Browser-internal pages and
|
||||
players that do not expose HTML5 media to extensions cannot be controlled.
|
||||
|
||||
### What is this fork all about?
|
||||
|
||||
|
||||
@@ -998,8 +998,8 @@
|
||||
<label class="site-override-lead">
|
||||
<span
|
||||
>Override shortcuts for this site<br /><em
|
||||
>Add shortcuts from the menu; none by default. Leave off
|
||||
to use global Shortcuts.</em
|
||||
>A site shortcut replaces global bindings for the same
|
||||
action; other global shortcuts remain active.</em
|
||||
></span
|
||||
>
|
||||
<input type="checkbox" class="override-shortcuts" />
|
||||
@@ -1037,11 +1037,11 @@
|
||||
<section id="faq" class="settings-card info-card">
|
||||
<h4>Extension controls not appearing?</h4>
|
||||
<p>
|
||||
This extension only works with HTML5 audio and video. If the
|
||||
controls never appear, you may be looking at Flash content instead.
|
||||
Right-click the player to check: if the menu mentions Flash, that
|
||||
is the issue. Most sites will fall back to HTML5 when Flash is not
|
||||
available, so disabling Flash in the browser can help.
|
||||
Speeder works with HTML5 video and, when enabled above, HTML5 audio.
|
||||
Check that the current site is enabled, then use the popup’s
|
||||
“Rescan page for videos” action after a player loads
|
||||
dynamically. Browser-internal pages and players that do not expose
|
||||
HTML5 media to extensions cannot be controlled.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
|
||||
@@ -1159,15 +1159,7 @@ function addSiteRuleShortcut(rowsEl, action, binding, value, force) {
|
||||
|
||||
var actionLabel = document.createElement("div");
|
||||
actionLabel.className = "shortcut-label";
|
||||
var actionLabelText = actionLabels[action] || action;
|
||||
if (action === "toggleSubtitleNudge") {
|
||||
var ruleEl = rowsEl.closest(".site-rule");
|
||||
var pattern = ruleEl ? ruleEl.querySelector(".site-pattern").value : "";
|
||||
if (!pattern.toLowerCase().includes("youtube.com")) {
|
||||
actionLabelText += " (only for YouTube embeds)";
|
||||
}
|
||||
}
|
||||
actionLabel.textContent = actionLabelText;
|
||||
actionLabel.textContent = actionLabels[action] || action;
|
||||
|
||||
var keyInput = document.createElement("input");
|
||||
keyInput.className = "customKey";
|
||||
@@ -1834,7 +1826,7 @@ function initLucideButtonIconsUI() {
|
||||
slug +
|
||||
" for " +
|
||||
action +
|
||||
". Reload pages for the hover bar."
|
||||
". Open pages update automatically."
|
||||
);
|
||||
});
|
||||
})
|
||||
|
||||
@@ -527,7 +527,7 @@ document.addEventListener("DOMContentLoaded", function () {
|
||||
|
||||
function settingsSavedReloadMessage(enabled) {
|
||||
setStatusMessage(
|
||||
`${enabled ? "Enabled" : "Disabled"}. Reload page to see changes`
|
||||
`${enabled ? "Enabled" : "Disabled"}. Open pages update automatically.`
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -90,6 +90,9 @@ describe("popup UI", () => {
|
||||
expect(document.getElementById("enable").classList.contains("hide")).toBe(
|
||||
false
|
||||
);
|
||||
expect(document.getElementById("status").textContent).toBe(
|
||||
"Disabled. Open pages update automatically."
|
||||
);
|
||||
expect(chrome.browserAction.setIcon).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user