Skip to content

Commit cb4af94

Browse files
fix(docs): autoBackdropColor reference
1 parent c7ec14f commit cb4af94

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ The keyboard can be configured with the following options:
4040
| **`resize`** | <code><a href="#keyboardresize">KeyboardResize</a></code> | Configure the way the app is resized when the Keyboard appears. Only available on iOS. | <code>native</code> | 1.0.0 |
4141
| **`style`** | <code><a href="#keyboardstyle">KeyboardStyle</a></code> | Override the keyboard style if your app doesn't support dark/light theme changes. If not set, the keyboard style will depend on the device appearance. Only available on iOS. | | 1.0.0 |
4242
| **`resizeOnFullScreen`** | <code>boolean</code> | There is an Android bug that prevents the keyboard from resizing the WebView when the app is in full screen (i.e. if StatusBar plugin is used to overlay the status bar). This setting, if set to true, add a workaround that resizes the WebView even when the app is in full screen. Only available for Android | | 1.1.0 |
43+
| **`autoBackdropColor`** | <code>'off' \| 'auto' \| 'dom'</code> | Controls how the keyboard backdrop color (the area visible behind the keyboard) is set every time the keyboard is about to show. `'off'` — Do not tint the backdrop. `'auto'` — Use the `backgroundColor` set in the Capacitor config; otherwise derive the color from the web app's DOM body background. `'dom'` — Always derive the color from the web app's DOM body background, ignoring the `backgroundColor` config. If the DOM has no resolvable background, the backdrop is left untouched. Only available on iOS. | <code>"off"</code> | 8.0.4 |
4344

4445
### Examples
4546

@@ -51,7 +52,8 @@ In `capacitor.config.json`:
5152
"Keyboard": {
5253
"resize": "body",
5354
"style": "DARK",
54-
"resizeOnFullScreen": true
55+
"resizeOnFullScreen": true,
56+
"autoBackdropColor": "auto"
5557
}
5658
}
5759
}
@@ -71,6 +73,7 @@ const config: CapacitorConfig = {
7173
resize: KeyboardResize.Body,
7274
style: KeyboardStyle.Dark,
7375
resizeOnFullScreen: true,
76+
autoBackdropColor: 'auto'
7477
},
7578
},
7679
};

src/definitions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ declare module '@capacitor/cli' {
5555
*
5656
* Only available on iOS.
5757
*
58-
* @since 8.1.0
58+
* @since 8.0.4
5959
* @default "off"
6060
* @example "auto"
6161
*/

0 commit comments

Comments
 (0)