https://github.com/gil--/magento2-keyboard-shortcuts

:keyboard: :peace_symbol: Improve accessibility by adding customer-facing keyboard shortcuts for quickly navigating around a Magento 2 website.
https://github.com/gil--/magento2-keyboard-shortcuts

accessibility magento magento-accessibility magento2 magento2-module

Last synced: 26 days ago
JSON representation

:keyboard: :peace_symbol: Improve accessibility by adding customer-facing keyboard shortcuts for quickly navigating around a Magento 2 website.

• Host: GitHub
• URL: https://github.com/gil--/magento2-keyboard-shortcuts
• Owner: gil--
• Created: 2018-06-13T16:09:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-17T03:29:24.000Z (over 6 years ago)
• Last Synced: 2024-05-01T14:32:16.346Z (8 months ago)
• Topics: accessibility, magento, magento-accessibility, magento2, magento2-module
• Language: HTML
• Homepage:
• Size: 13.7 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Total Downloads](https://poser.pugx.org/gilg/keyboardshortcuts/downloads)](https://packagist.org/packages/gilg/keyboardshortcuts)

[![Latest Stable Version](https://poser.pugx.org/gilg/keyboardshortcuts/v/stable)](https://packagist.org/packages/gilg/keyboardshortcuts)

# Magento 2 Storefront Keyboard Hotkeys

This module enables hotkeys for a store's main functionality.

## Install

`composer require gilg/keyboardshortcuts`

## Purpose

The purpose of these hotkeys is to **increase accessibility** to those with limited mobility and to **speed up developer workflow** by allowing for quick keyboard navigation.

## Hotkeys

The namespace (the first key of a keyboard shortcut) is configurable with the default option being `m`. If left blank in admin configuration, no namespace will be used. It's recommended to use a namespace to avoid conflicting with native browser & assistive technology hotkeys.

| Hotkey | Purpose |

| :------------------- | :----------------- |

| ? | Show keyboard hotkey information modal

| m+e | Go to Account Dashboard

| m+c | Go to Checkout

| m+i | Open minicart

| m+s | Focus in Search box

> Every hotkey is configurable and be disabled.

## Support

This module is provided as is. However, feel free to file a github issue or create a PR and I will try to respond when I can.

## Preview

### Frontend Modal

![Frontend Modal Preview Screenshot](https://user-images.githubusercontent.com/3484527/41502655-28b0c866-718d-11e8-9b41-118c7a7d552d.png)

### Admin Options

![Admin Options Preview Screenshot](https://user-images.githubusercontent.com/3484527/41502671-66f0b744-718d-11e8-9d17-dfa4b4779956.png)