Skip to content

Commit 919f70b

Browse files
committed
Updated documentation related to Keymap and minor fix to return basekeymap
1 parent 62bbab4 commit 919f70b

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

docs/plugins/app.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# App
2+
3+
SDK provides various methods that can be used within the application.
4+
5+
6+
## Available Methods
7+
8+
###overRideKeyMap
9+
10+
Over-rides the default keymap with the new keymap.
11+
12+
This can be done using the below snippet :
13+
14+
```js
15+
this.application.overRideKeyMap(customKeyMap, keepDefaults)
16+
```
17+
18+
- `customKeyMap` : Keymap to be overidden
19+
- `keepDefaults`: Flag to overide the the default keymap or not.
20+
- By default `keepDefaults` will be false.
21+
- If set to `false`, it will override the existing keymap.
22+
- If set to `true`, it will be merged with the base keymap along with the exsiting keymap, where it has all the keys which has same values.

docs/plugins/keymap.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

src/Application/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ export default function(App, appData, platformSettings) {
142142
keymapping[key] = customKeymap[key]
143143
return keymapping
144144
}, baseKeymap)
145+
return baseKeymap
145146
}
146147

147148
_setup() {

0 commit comments

Comments
 (0)