@loky-js/loky NPM

LoKy

Love Keys - A simple javascript library to enable keyboard compatibility to internal and external websites.

People with mobility or vision disabilities, keyboard shortcuts are indispensable. Some of our internal platform like Github Enterprise, Concourse supports smart keyboard shortcuts for such accessibility reasons. So the idea is to enable fundamental keyboard shortcuts for our internal and external websites.

The added benefits enabling keyboard shortcut for websites in addition to the mouse controls enables us to work faster, more efficiently and with increased precision, thereby saving you time and improving your productivity.

╭╮           ╭┈┈╮
┆┆    .┈┈┈┈┈.┆  ├┈┈..┈┈.┈┈.
┆┆___╮┆  □  ┆┆    <┘┆  ┆  ┆
╰┈┈┈┈╯╰┈┈┈┈┈╯╰┈┈┴┈┈╯╰┈┈┈  ┆
                    ╰┈┈┈┈┈╯

Usage:-

You will need Node.js installed on your system.

To install loky:-

$ npm i @loky-js/loky

After install to work with`loky`

For react.js

import loky from '@loky-js/loky/src/loky';

loky('T',"highlight_text","#name", function(event, handler){
    event.preventDefault() 
    // function can be used here eg- document.getElementById("name").focus();
});

For HTML

<script  src="../node_modules/@loky-js/loky/src/loky.js"></script>
<script type="text/javascript" >
loky('T',"highlight_text","#name", function(event, handler){
    event.preventDefault() 
    // function can be used here eg- document.getElementById("name").focus();
}); 
</script>
</script>

Or manually download and link loky.js in your HTML, It can also be downloaded via git.

To display the list of shortcuts, download the `css` manually and link in your `HTML` :

<div id= shortcuts> </div>
<script  src="../node_modules/@loky-js/loky/src/loky.js"></script>
<script type="text/javascript" >
loky('shift+/',"shortcut_page","
(? - Shortcut)
(T - Text Box click)
(B - Button Click)
", function(event, handler){
    event.preventDefault()
    $("#shortcuts").modal("show");
    });
</script>