Browse Source

Document handleKeyboardEvents

Guy Carmeli 5 years ago
parent
commit
53cad2b289
2 changed files with 8 additions and 2 deletions
  1. 2
    1
      docs/docs/styling.md
  2. 6
    1
      lib/src/interfaces/Options.ts

+ 2
- 1
docs/docs/styling.md View File

142
     }
142
     }
143
   },
143
   },
144
   overlay: {
144
   overlay: {
145
-    interceptTouchOutside: true
145
+    interceptTouchOutside: true,
146
+    handleKeyboardEvents: true
146
   },
147
   },
147
   preview: {
148
   preview: {
148
     reactTag: 0, // result from findNodeHandle(ref)
149
     reactTag: 0, // result from findNodeHandle(ref)

+ 6
- 1
lib/src/interfaces/Options.ts View File

599
   openGestureMode?: 'entireScreen' | 'bezel';
599
   openGestureMode?: 'entireScreen' | 'bezel';
600
 }
600
 }
601
 
601
 
602
-export interface OptionsOverlay {
602
+export interface OverlayOptions {
603
   /**
603
   /**
604
    * Capture touches outside of the Component View
604
    * Capture touches outside of the Component View
605
    */
605
    */
606
   interceptTouchOutside?: boolean;
606
   interceptTouchOutside?: boolean;
607
+  /**
608
+   * Control wether this Overlay should handle Keyboard events.
609
+   * Set this to true if your Overlay contains a TextInput.
610
+   */
611
+  handleKeyboardEvents?: boolean;
607
 }
612
 }
608
 
613
 
609
 export interface OptionsPreviewAction {
614
 export interface OptionsPreviewAction {