Skip to content

Commit f2402fa

Browse files
committed
Fix some docs
1 parent ded2e11 commit f2402fa

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

lib/components/Keyboard/KeyboardInput/KeyboardRegistry.js

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -99,30 +99,27 @@ export default class KeyboardRegistry {
9999

100100
/**
101101
* Default event to be used for when an item on the keyboard has been pressed.
102-
* globalID (string) - ID that includes the componentID and the event name
103-
* (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
102+
* componentID (string) - the ID of the keyboard.
104103
* args (object) - data to be sent to the listener.
105104
*/
106-
static onItemSelected = (globalID, args) => {
107-
KeyboardRegistry.notifyListeners(`${globalID}.onItemSelected`, args);
105+
static onItemSelected = (componentID, args) => {
106+
KeyboardRegistry.notifyListeners(`${componentID}.onItemSelected`, args);
108107
};
109108

110109
/**
111110
* Request to show the keyboard
112-
* globalID (string) - ID that includes the componentID and the event name
113-
* (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
111+
* componentID (string) - the ID of the keyboard.
114112
*/
115-
static requestShowKeyboard = globalID => {
116-
KeyboardRegistry.notifyListeners('onRequestShowKeyboard', {keyboardId: globalID});
113+
static requestShowKeyboard = componentID => {
114+
KeyboardRegistry.notifyListeners('onRequestShowKeyboard', {keyboardId: componentID});
117115
};
118116

119117
/**
120-
* iOS only
121-
* Call to make the keyboard full screen (experimental)
122-
* globalID (string) - ID that includes the componentID and the event name
123-
* (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
118+
* iOS only (experimental)
119+
* Call to make the keyboard full screen
120+
* componentID (string) - the ID of the keyboard.
124121
*/
125-
static toggleExpandedKeyboard = globalID => {
126-
KeyboardRegistry.notifyListeners('onToggleExpandedKeyboard', {keyboardId: globalID});
122+
static toggleExpandedKeyboard = componentID => {
123+
KeyboardRegistry.notifyListeners('onToggleExpandedKeyboard', {keyboardId: componentID});
127124
};
128125
}

0 commit comments

Comments
 (0)