From cfc31eb6516e5f1e10a87fe62a494ee480419c14 Mon Sep 17 00:00:00 2001 From: Matthias Lindinger Date: Fri, 14 Apr 2023 13:30:21 +0200 Subject: [PATCH] Rename package --- README.md | 20 ++++++++++---------- demo/src/index.js | 6 +++--- nwb.config.js | 2 +- package-lock.json | 4 ++-- package.json | 4 ++-- src/index.js | 4 ++-- src/state/selectors.js | 2 +- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 5283cdb..d916bbd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# mirador-keyboardnavigation +# mirador-keyboardshortcuts [![npm package][npm-badge]][npm] [![required Mirador version][mirador-badge]][mirador] @@ -17,28 +17,28 @@ A Mirador 3 plugin which adds keyboard shortcuts for the following events: Currently the plugin can only be used if you build your own Mirador JavaScript bundle. To include the plugin in your Mirador installation, you need to install it -from npm with `npm install mirador-keyboardnavigation`, import it into your project +from npm with `npm install mirador-keyboardshortcuts`, import it into your project and pass it to Mirador when you instantiate the viewer: ```javascript import Mirador from 'mirador/dist/es/src/index'; -import keyboardNavigationPlugin from 'mirador-keyboardnavigation/es'; +import keyboardShortcutsPlugin from 'mirador-keyboardshortcuts/es'; const miradorConfig = { // Your Mirador configuration } -Mirador.viewer(config, [...keyboardNavigationPlugin]); +Mirador.viewer(config, [...keyboardShortcutsPlugin]); ``` ## Configuration -You can configure the plugin globally by adding the `keyboardNavigation` entry to +You can configure the plugin globally by adding the `keyboardShortcuts` entry to the top-level configuration: ```javascript const miradorConfig = { // ... - keyboardNavigation: { + keyboardShortcuts: { // Global config, see available settings below shortcutMapping: { "navigate-to-first-canvas": "home", @@ -73,10 +73,10 @@ starting the work, so we can discuss if it's a fit. **Note**: The package requires Node.js `16` and npm in major version `8`. -[demo-cfg]: https://github.com/dbmdz/mirador-keyboardnavigation/blob/main/demo/src/index.js#L5-L40 -[event-types]: https://github.com/dbmdz/mirador-keyboardnavigation/blob/main/src/state/events.js#L5-L9 +[demo-cfg]: https://github.com/dbmdz/mirador-keyboardshortcuts/blob/main/demo/src/index.js#L5-L40 +[event-types]: https://github.com/dbmdz/mirador-keyboardshortcuts/blob/main/src/state/events.js#L5-L9 [hotkeys-js]: https://wangchujiang.com/hotkeys/#defining-shortcuts [mirador]: https://github.com/ProjectMirador/mirador/releases/tag/v3.3.0 [mirador-badge]: https://img.shields.io/badge/Mirador-%E2%89%A53.3.0-blueviolet -[npm]: https://www.npmjs.org/package/mirador-keyboardnavigation -[npm-badge]: https://img.shields.io/npm/v/mirador-keyboardnavigation.png?style=flat-square +[npm]: https://www.npmjs.org/package/mirador-keyboardshortcuts +[npm-badge]: https://img.shields.io/npm/v/mirador-keyboardshortcuts.png?style=flat-square diff --git a/demo/src/index.js b/demo/src/index.js index 8c76423..dd8181b 100644 --- a/demo/src/index.js +++ b/demo/src/index.js @@ -1,6 +1,6 @@ import Mirador from "mirador/dist/es/src/index"; -import keyboardNavigationPlugin from "../../src"; +import keyboardShortcutsPlugin from "../../src"; const config = { catalog: [ @@ -32,11 +32,11 @@ const config = { view: "single", }, ], - keyboardNavigation: { + keyboardShortcuts: { shortcutMapping: { "toggle-fullscreen": "f", }, }, }; -Mirador.viewer(config, [...keyboardNavigationPlugin]); +Mirador.viewer(config, [...keyboardShortcutsPlugin]); diff --git a/nwb.config.js b/nwb.config.js index 826b6fb..a5cbabf 100644 --- a/nwb.config.js +++ b/nwb.config.js @@ -3,7 +3,7 @@ module.exports = { npm: { esModules: true, umd: { - global: 'MiradorKeyboardNavigation', + global: 'MiradorKeyboardShortcuts', externals: { react: 'React' } diff --git a/package-lock.json b/package-lock.json index 17a443f..a557f9f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "mirador-keyboardnavigation", + "name": "mirador-keyboardshortcuts", "version": "0.1.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "mirador-keyboardnavigation", + "name": "mirador-keyboardshortcuts", "version": "0.1.0", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 2dd1d82..891dd4b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "mirador-keyboardnavigation", + "name": "mirador-keyboardshortcuts", "version": "0.1.0", "description": "Mirador 3 plugin to add keyboard shortcuts", "keywords": [ @@ -10,7 +10,7 @@ "react-component" ], "homepage": "", - "repository": "https://github.com/dbmdz/mirador-keyboardnavigation", + "repository": "https://github.com/dbmdz/mirador-keyboardshortcuts", "license": "MIT", "author": "Matthias Lindinger ", "main": "lib/index.js", diff --git a/src/index.js b/src/index.js index 38a9033..96fffaa 100644 --- a/src/index.js +++ b/src/index.js @@ -1,9 +1,9 @@ import { KeyboardEventTypes } from "./state/events"; -import keyboardNavigationSaga from "./state/sagas"; +import keyboardShortcutsSaga from "./state/sagas"; export default [ { - saga: keyboardNavigationSaga, + saga: keyboardShortcutsSaga, }, ]; diff --git a/src/state/selectors.js b/src/state/selectors.js index ec5cce9..269700d 100644 --- a/src/state/selectors.js +++ b/src/state/selectors.js @@ -11,7 +11,7 @@ const getFocusedWindowId = createSelector( /** Selector to get the plugin config for a given window */ const getPluginConfig = createSelector( [getConfig], - ({ keyboardNavigation = {} }) => keyboardNavigation + ({ keyboardShortcuts = {} }) => keyboardShortcuts ); export { getFocusedWindowId, getPluginConfig };