Skip to content

Latest commit

 

History

History
151 lines (106 loc) · 4.54 KB

README.md

File metadata and controls

151 lines (106 loc) · 4.54 KB
Raw

Homely

Homely is a custom New Tab page replacement for Google Chrome. It aims to provide a quick, customizable layout of links and menus, as well as simple bookmarks and history components.

Requirements

Keyboard shortcuts

If enabled, the page can be navigated by keyboard. Note that Chrome will, by default, give focus to the onmibox when opening a new tab, so you must first Tab into the page.

Note: shortcuts are disabled whilst input fields (text boxes, selects, buttons) are currently focused.

Global

  • Q L - switch to links
  • W B - switch to bookmarks
  • E A - open apps dropdown
  • R H - open history dropdown
  • T K - open baskets dropdown
  • Y N - open notifcations dropdown
  • U S - open settings dropdown (Shift for modal)
  • Tab Shift+Tab - scroll through dropdown options

Apps

  • Shift+A - open Chrome Apps page
  • Shift+Alt+A - go to Chrome Web Store

Links

  • 1 ... 0 - select nth block (0 for 10th)
  • - = - select previous/next block
  • [ ] - select previous/next button in block
  • Enter - open link
  • Backspace - clear selection

Bookmarks

  • / - focus search field

Baskets

  • Shift+K - refresh baskets
  • Shift+Alt+K - open all non-empty basket pages

Notifications

  • Shift+N - refresh notifications
  • Shift+Alt+N - open all unread notification pages

Settings

  • Tab Shift+Tab - cycle tabs
  • Enter - switch to fields in tab
  • Ctrl+Enter - save and reload
  • Esc - cancel

Misc

  • ? - show keyboard shortcuts modal

Links format

Links can be edited in JSON from the Settings modal. The basic format is as follows:

Block

A block has a title, and holds one or more buttons.

{
    "title": "Search Engines",
    "buttons": [...]
}

Button

A button can either be a simple link, or a dropdown containing many links. Add "external": true to always open a link in a new tab.

{
    "title": "Google",
    "url": "http://www.google.co.uk",
    "external": true,
    "style": "light"
}
{
    "title": "Google",
    "menu": [...],
    "style": "dark"
}

The styles are that of Bootstrap (default, primary, info, success, warning and danger), plus light and dark for shades of grey.

Menu

A menu is a list of links and headings, converted into groups of links (a new group starts at each heading). To start a group without a heading, use the empty string "" as the label.

[
    {
        "title": "Worldwide",
        "url": "http://www.google.com"
    },
    {
        "title": "UK",
        "url": "http://www.google.co.uk"
    },
    "Tools",
    {
        "title": "Images",
        "url": "http://images.google.co.uk"
    },
    {
        "title": "Maps",
        "url": "http://maps.google.co.uk",
        "external": true
    }
]

With the above steps, you should end up with a block and dropdown like this:

Search Engines example

Notifications

Enabling a notification option will prompt for the relevant permission in order to access the given website (and the corresponding block will be highlighted with green text). Disabling it will not immediately remove this, but any unnecessary permissions will be dropped when settings are saved.

In order to read arbitrary websites, the global permissions http://*/ and/or https://*/ must be granted. If not (i.e. adding a permission just for a given site), it will be lost if the browser is restarted, unless explicitly declared in optional_permissions in the manifest (see Chrome issue #158004).

Note: if an option is later re-enabled, Chrome may not re-request the permission, however all currently granted permissions can be seen from Chrome's extension settings page (chrome://extensions).

Gmail

The Gmail notifier can be configured for multiple accounts by specifying the user indexes (as can be found in a Google URL with ?authuser=X or /u/X/). If a user is not signed in, or does not have a Gmail account, an Authentication Required dialog will display from attempting to access the feed unauthorized.

Incognito mode

If Homely is allowed to run in incognito mode, it will also display as the New Tab page of incognito windows. It shares settings with normal windows, however history and notifications are disabled.