Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/infokiller/web-search-navigator

Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari)
https://github.com/infokiller/web-search-navigator

amazon-search chrome-extension chrome-extensions colemak edge-extension firefox-addon firefox-extension github-search google google-scholar google-search keybindings keyboard-navigation keyboard-shortcuts startpage vim youtube youtube-search

Last synced: 14 days ago
JSON representation

Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari)

Host: GitHub
URL: https://github.com/infokiller/web-search-navigator
Owner: infokiller
License: mit
Created: 2017-07-28T20:17:50.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-04-08T03:08:17.000Z (2 months ago)
Last Synced: 2024-04-08T04:24:13.740Z (2 months ago)
Topics: amazon-search, chrome-extension, chrome-extensions, colemak, edge-extension, firefox-addon, firefox-extension, github-search, google, google-scholar, google-search, keybindings, keyboard-navigation, keyboard-shortcuts, startpage, vim, youtube, youtube-search
Language: JavaScript
Homepage:
Size: 12 MB
Stars: 832
Watchers: 14
Forks: 73
Open Issues: 29
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-starred-test - infokiller/web-search-navigator - Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari) (JavaScript)
my-awesome-starred - infokiller/web-search-navigator - Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari) (JavaScript)
osint_stuff_tool_collection - Web Search Navigator
awesome-stars - web-search-navigator
awesome-stars - infokiller/web-search-navigator - Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari) (JavaScript)
my-awesome-stars - infokiller/web-search-navigator - Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari) (JavaScript)
awesome-stars - infokiller/web-search-navigator - Web extension that adds keyboard shortcuts to Google, YouTube, Github, Amazon, and others (Chrome/Firefox/Edge/Safari) (JavaScript)

README

# ![Logo](./src/icon48.png?raw=true) Web Search Navigator

[![Chrome Web Store](https://img.shields.io/chrome-web-store/rating/cohamjploocgoejdfanacfgkhjkhdkek?label=Chrome)](https://chrome.google.com/webstore/detail/web-search-navigator/cohamjploocgoejdfanacfgkhjkhdkek)
[![Mozilla Add-on](https://img.shields.io/amo/rating/web-search-navigator?label=Firefox)](https://addons.mozilla.org/en-US/firefox/addon/web-search-navigator/)
[![CodeFactor](https://www.codefactor.io/repository/github/infokiller/web-search-navigator/badge)](https://www.codefactor.io/repository/github/infokiller/web-search-navigator)
[![CodeQL](https://github.com/infokiller/web-search-navigator/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/infokiller/web-search-navigator/actions/workflows/codeql-analysis.yml)
[![Linters](https://github.com/infokiller/web-search-navigator/actions/workflows/lint.yml/badge.svg)](https://github.com/infokiller/web-search-navigator/actions/workflows/lint.yml)

Browser extension that adds configurable keyboard shortcuts to Google search,
YouTube, Startpage, Brave Search, Google Scholar, Github, Gitlab, and Amazon.

![Demo flow](./assets/demo.gif?raw=true)

## Table of contents

- [Table of contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Chrome](#chrome)
- [Installing from a release](#installing-from-a-release)
- [Firefox](#firefox)
- [Edge](#edge)
- [Safari (experimental)](#safari-experimental)
- [Keybindings](#keybindings)
- [Development](#development)
- [Coding style](#coding-style)
- [Commit messages](#commit-messages)
- [Building for development](#building-for-development)
- [Building a release](#building-a-release)
- [Adding a new search engine](#adding-a-new-search-engine)
- [Troubleshooting](#troubleshooting)
- [Privacy policy](#privacy-policy)
- [Trademarks notice](#trademarks-notice)

## Features

- Lightweight
- Supports Chrome, Firefox, and Edge
- Extensive Google keyboard shortcuts including:
- Selecting results
- Opening results in the background or foreground
- Navigating to other sections (maps/news/videos/etc)
- Navigating to the next/previous result page
- Changing time restrictions
- Support for navigating cards such as Top Stories, Twitter, and videos
- All keyboard shortcuts can be changed
- Settings are synched between devices with the same browser profile
- Supports both key combos and key sequences
- Custom CSS rules to control the look of highlighted results
- Experimental and optional support for YouTube, Startpage, Brave Search, Google
Scholar, Github, Gitlab, and Amazon (needs to be enabled in the options). Note
that the extension does not have permissions for these optional websites
unless you explicitly enable them.

## Installation

### Chrome

Install from the
[Chrome Web Store](https://chrome.google.com/webstore/detail/enhanced-keyboard-navigat/cohamjploocgoejdfanacfgkhjkhdkek).

See below for downloading a release and installing it manually (not recommended
since you won't get updates automatically).

#### Installing from a release

1. Download the latest release from

1. Extract the zip file to any directory you'd like, though you need to make
sure the directory is not deleted while you want to use the extension
1. Go to extensions page in Chrome (URL: `chrome://extensions`)
1. Enable developer mode if needed
1. Disable other existing instances of Web Search Navigator (from the store or
from loading another unpacked version)
1. Click "Load Unpacked" and select the directory you extracted the release zip
into

### Firefox

Install from the
[Add-ons for Firefox](https://addons.mozilla.org/firefox/addon/web-search-navigator/).

### Edge

Install from
[Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/inkjbmhmeghalgpacijccmbmbclkjgop).

### Safari (experimental)

> NOTE: Safari is supported on a best-effort basis and isn't packaged yet.

Follow
[these steps](https://github.com/infokiller/web-search-navigator/issues/64#issuecomment-1166552333).

## Keybindings

> NOTE:
>
> - Shortcuts for navigation to tabs (images, news, etc.) only work when the tab
> is visible.
> - All shortcuts can be customized to your liking via options

| Shortcuts | Action |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| ↓/j | Select next search result |
| ↑/k | Select previous search result |
| //Escape | Focus on input search box |
| Enter/Space | Navigate to selected result |
| Ctrl + Enter/⌘ + Enter/Ctrl + Space | Open selected result in background tab |
| Ctrl + Shift + Enter/⌘ + Shift + Enter/Ctrl + Shift + Space | Open selected result in new window/tab |
| ←/h | Navigate to previous search result page |
| →/l | Navigate to next search result page |
| a/s | Navigate to All tab (= default search tab) |
| i | Navigate to images tab |
| v | Navigate to videos tab |
| m | Navigate to maps tab |
| n | Navigate to news tab |
| Alt + s | Navigate to shopping tab |
| b | Navigate to books tab | | Alt + l | Navigate to flights tab | | f | Navigate to financial tab | | z + h | Filter results by past hour | | z + d | Filter results by past 24 hours (day) | | z + w | Filter results by past week | | z + m | Filter results by past month | | z + y | Filter results by past year | | z + z | Turn off filter (show all results) | | z + s | Toggle sort by date/relevance (only when filtering) |

## Development

### Coding style

To check the code for linting and formatting errors, run `yarn run check`. We
use a Javascript coding style based on
[Google's](https://google.github.io/styleguide/jsguide.html). We use the
following tools to lint the code enforce a consistent style:

- Javascript: [eslint](https://eslint.org/) for both linting and formatting
- CSS: [Stylelint](https://stylelint.io/) for linting and
[Prettier](https://prettier.io/) for formatting
- Markdown: [Markdownlint](https://github.com/igorshubovych/markdownlint-cli)
for linting and [Prettier](https://prettier.io/) for formatting
- Bash: [Shellcheck](https://github.com/koalaman/shellcheck) for linting and
[shfmt](https://github.com/mvdan/sh) for formatting. shfmt doesn't run in
`yarn run check` because it can't be installed using `yarn install`.

Please try to write your code in a similar style, and run `yarn run check`
before sending a pull request.

### Commit messages

Starting from 2020-07-19, this project uses
[Conventional Commits](https://www.conventionalcommits.org/). Please write all
you commit messages in this style.

### Building for development

We use [yarn](https://yarnpkg.com/) package manager for dependency management
and [gulp](https://gulpjs.com/) for building. To build the extension for
development run:

```sh
yarn install && yarn build
```

The extension will be deployed directly to the `src` directory.

The easiest way to run the built extension is to use `web-ext` which will run a
separate it in a separate browser profile and reload it automatically on changes
to the source files. From the project root directory:

```sh
# Replace '--target chromium' with "--target firefox-desktop" for Firefox.
yarn run web-ext run --source-dir src --target chromium \
--start-url 'https://www.google.com/search?q=whatever'
```

Alternatively, you can load this directory as an unpacked extensions to your
browser.

_It would be better to deploy for example to `build/deploy` and add `gulp-watch`
to update the deployed files automatically. However when done so the Chrome's
auto-reload extension gets broken and one has to reload the extension manually
on every change. Hence the `src` directory is used for the convenience._

### Building a release

To build a bundle consumable by the browser with minified dependencies:

```sh
# Replace make-chrome.sh with make-firefox.sh for Firefox
yarn install && yarn build --env production && ./tools/make-chrome.sh
```

Then, upload the bundle to the browser store from
`./build/chrome/package.zip`/`./build/firefox/package.zip`.

### Adding a new search engine

See a
[reference commit with minimal changes for amazon.com](https://github.com/infokiller/web-search-navigator/commit/f57a7e4aedf66d8395995671ef4f18f3e93333b0).
Specific steps:

- Add the required URLs to the `optional_permissions` key in
[`src/manifest.json`](./src/manifest.json)
- Add a checkbox for enabling it to
[`src/options_page.html`](./src/options_page.html) (copy an existing one and
modify it)
- Add code to [`src/options_page.js`](./src/options_page.js) for handling the
permission request
- Add a new class to [`src/search_engines.js`](./src/search_engines.js) with the
required properties. See the documentation at the top of the file and use the
other search engines classes in that file as a reference.
- Add a class instance to
[`searchEngines`](https://github.com/infokiller/web-search-navigator/blob/60d64947b07381e0be61df657c4de4a85ccfc2a7/src/search_engines.js#L542).

## Troubleshooting

Before reporting a bug, please check and answer the following:

- Does it happen when you disable other extensions?
- Does it happen only in Chrome, only in Firefox, or both?

In addition, please try to reproduce the bug in a clean browser profile with no
other extensions. The easiest way to do it is to clone the repo and use
`web-ext`:

```sh
git clone https://github.com/infokiller/web-search-navigator
cd web-search-navigator
yarn install && yarn build
# Replace chromium with firefox-desktop for firefox
yarn run web-ext run --source-dir src --target chromium
```

This will open a clean browser instance with no other extensions. Note that this
browser instance will have the default extension options (including permissions
for alternative search engines), so you may need to modify the option.

## Privacy policy

See [PRIVACY_POLICY.md](./docs/PRIVACY_POLICY.md).

## Trademarks notice

This project is not affiliated with Google LLC.