Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(keyboard): Using KeyboardStyle in plugin TS declaration #969

Merged
merged 4 commits into from
May 13, 2022
Merged

chore(keyboard): Using KeyboardStyle in plugin TS declaration #969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24254cf
using KeyboardStyle
theproducer May 12, 2022
1dbae51
Merge branch 'capacitor-4' into keyboard-plugin-ts
theproducer May 12, 2022
c5f7c9d
Updating documentation
theproducer May 12, 2022
d82152f
Update keyboard/src/definitions.ts
jcesarmobile May 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions keyboard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ On iOS, the keyboard can be configured with the following options:
| Prop | Type | Description | Default | Since |
| ------------------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ----- |
| **`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 |
| **`style`** | <code>'dark' \| 'light'</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 |
| **`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 |
| **`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 |

### Examples
Expand All @@ -53,7 +53,7 @@ In `capacitor.config.json`:
"plugins": {
"Keyboard": {
"resize": "body",
"style": "dark",
"style": "DARK",
"resizeOnFullScreen": true
}
}
Expand All @@ -71,7 +71,7 @@ const config: CapacitorConfig = {
plugins: {
Keyboard: {
resize: "body",
style: "dark",
style: "DARK",
resizeOnFullScreen: true,
},
},
Expand Down
4 changes: 2 additions & 2 deletions keyboard/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ declare module '@capacitor/cli' {
* Only available on iOS.
*
* @since 1.0.0
* @example "dark"
* @example "DARK"
*/
style?: 'dark' | 'light';
style?: KeyboardStyle;

/**
* There is an Android bug that prevents the keyboard from resizing the WebView
Expand Down