Merge pull request #364 from rdkcentral/over-ride-keymap

Over ride keymap

Author: uguraslan

docs/_sidebar.md

@@ -2,6 +2,7 @@
 
 - Plugins
   - [Accessibility](/plugins/accessibility.md)
+  - [App](/plugins/app.md)
   - [Utils](/plugins/utils.md)
   - [Storage](/plugins/storage.md)
   - [Settings](/plugins/settings.md)

docs/plugins/app.md

@@ -0,0 +1,33 @@
+# App
+
+SDK provides various methods that can be used within the application.
+
+## Available Methods
+
+### overRideKeyMap
+
+This method can be used to merge and override the existing keymap (coming from `settings.json`) by using a custom keymap in runtime. The method will merge all key mappings by overriding the existing key mappings with the new ones when a key is defined in both keymaps.
+
+`keepDuplicates` flag is set to `false` by default, which means duplicated values (like two different keys trigger the `Back` action) will be removed from the final keymap. If `keepDuplicates` is set to `true`, duplicated **values** will be kept in the final keymap.
+
+#### Usage
+
+```js
+const customKeyMap = {
+    13: "Enter",
+    83: "Search"
+}
+
+this.application.overRideKeyMap(customKeyMap) // keepDuplicates = false
+```
+
+or
+
+```js
+this.application.overRideKeyMap(customKeyMap, true) // keepDuplicates = true
+```
+
+#### Parameters
+
+- `customKeyMap` : keymap object
+- `keepDuplicates`: flag to keep duplicated values in the final keymap or not. The default value is `false`.

src/Application/index.js

@@ -119,6 +119,32 @@ export default function(App, appData, platformSettings) {
       Accessibility.colorshift(this, type, config)
     }
 
+    get keymapping() {
+      return this.stage.application.config.keys
+    }
+
+    /**
+     * This function overides the default keymap with the latest keymap.
+     * @param customKeymap
+     * @param keepDuplicates
+     */
+    overRideKeyMap(customKeymap, keepDuplicates = false) {
+      const baseKeymap = this.stage.application.config.keys
+      Object.keys(customKeymap).reduce((keymapping, key) => {
+        // prevent duplicate values to exist in final keymapping (i.e. 2 keys triggering 'Back')
+        if (!keepDuplicates) {
+          Object.keys(baseKeymap).forEach(baseKey => {
+            if (baseKey != key && baseKeymap[baseKey] == customKeymap[key]) {
+              delete keymapping[baseKey]
+            }
+          })
+        }
+        keymapping[key] = customKeymap[key]
+        return keymapping
+      }, baseKeymap)
+      return baseKeymap
+    }
+
     _setup() {
       Promise.all([
         this.loadFonts((App.config && App.config.fonts) || (App.getFonts && App.getFonts()) || []),