keyboard-interactions
Wrapper around keyboard inputs

Project Overview

This library contains a simple wrapper for different input methods. By introducing an ‘action’ to bind multiple input combos plus their handlers with it a better customisation by the user may be achieved.

See for yourself with a running Demo

For example:

Hotkeys.register("unique-action-name", "space", {
  //target:window, // the default target that watches events
  category: "default",
  description:
    "if user presses this combination all listeners will be triggered",
});

// add listeners somewhere
Hotkeys(/*target*/) // change the target to another dom element to restrict targets
  .on("unique-action-name", (evt) => {
    console.log("action was triggerd", evt);
  });

For the time being this is not meant to be a stand alone library
But rather as a backend for a compatible GUI.
For the reference implementation dowload npm “@nk/core-components” and check out the “nk-hotkey-dialog” example

Features

• Better Usability by customizing Keyboard Inputs

credits, references, acknowledgements

• Mousetrap.js - ccampbell/mousetrap
• Keypress.js - dmauro/Keypress

technical goals

• function as a no-gui backend for UI components that implement a keymap dialog

possible extensions

• interface for other HID
  • gyro+ accelerometer - https://github.com/dorukeker/gyronorm.js/
  • mouse and touch - http://hammerjs.github.io/recognizer-pinch/
• though the library is primarily targeted to solve they keymap via actions, we should expose the same functionality without the actions
  • (this is useful where no configuration will be necessary ike with the gyro maybe)

TODO

• currently rebinding keys will not work via gui

+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Psst — looking for a more complete solution? Check out SvelteKit, the official framework for building web applications of all sizes, with a beautiful development experience and flexible filesystem-based routing.

Looking for a shareable component template instead? You can use SvelteKit for that as well or the older sveltejs/component-template

---

svelte app

This is a project template for Svelte apps. It lives at https://github.com/sveltejs/template.

To create a new project based on this template using degit:

npx degit sveltejs/template svelte-app
cd svelte-app

Note that you will need to have Node.js installed.

Get started

Install the dependencies…

cd svelte-app
npm install

…then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you’re using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json’s dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in public. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you’re building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv public --single"

Using TypeScript

This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:

node scripts/setupTypeScript.js

Or remove the script via:

rm scripts/setupTypeScript.js

If you want to use baseUrl or path aliases within your tsconfig, you need to set up @rollup/plugin-alias to tell Rollup to resolve the aliases. For more info, see this StackOverflow question.

Deploying to the web

With Vercel

Install vercel if you haven’t already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven’t already:

npm install -g surge

Then, from within your project folder:

npm run build
surge public my-project.surge.sh