feat: dismiss keyboard

[kirillzyusko]

📜 Description

Added KeyboardController.dismiss method.

💡 Motivation and Context

Actually there is quite a lot of motivation behind such functionality. Let's go one-by one

1️⃣ Community request

In Algolia I constantly see that people are looking for dismiss method.

One week ago	Two weeks ago	One month ago

2️⃣ react-native flaws implementation

react-native implementation is based on the next code:

class Keyboard {
  // ...
  dismiss(): void {
    dismissKeyboard();
  }
  // ...
}

function dismissKeyboard() {
  TextInputState.blurTextInput(TextInputState.currentlyFocusedInput());
}

Where currentlyFocusedInput is set in:

function focusInput(textField: ?ComponentRef): void {
  if (currentlyFocusedInputRef !== textField && textField != null) {
    currentlyFocusedInputRef = textField;
  }
}

And the usage of this function:

const _onFocus = (event: FocusEvent) => {
  TextInputState.focusInput(inputRef.current);
  if (props.onFocus) {
    props.onFocus(event);
  }
};

So theoretically if you use TextInput component that is not based on the implementation from react-native core (i. e. you decided to write your own component), then Keyboard.dismiss most likely will not work 😓

3️⃣ Standalone module

I'm going to continue the development of this library and in the future I may need to rely on the presence/implementation of my own methods.

For example I'm thinking about Toolbar component implementation (the component above the keyboard with prev/next/done buttons). In my opinion it'll be strange when this component will fully depend on the methods from this package AND on a single function from react-native Keyboard module 🤔

So I think it's better to have own equivalent.

📢 Changelog

Docs

• re-write docs about existing setInputMode/setDefaultMode;
• added documentation about dismiss method;

JS

• added dismiss in specs, types;
• added mock and unit-test;

iOS

• used with resignFirstResponder selector to dismiss a keyboard (source);
• added dismiss method to KeyboardController;

Android

• used hideSoftInputFromWindow to close a keyboard (source);
• added dismiss method to KeyboardController;

🤔 How Has This Been Tested?

Tested manually on:

• Pixel 3a (Android 13, emulator);
• iPhone 15 Pro (iOS 17.2 simulator);

📸 Screenshots (if appropriate):

Android	iOS
Screen.Recording.2023-12-23.at.00.33.43.mov	Simulator.Screen.Recording.-.iPhone.15.Pro.-.2023-12-23.at.00.32.22.mp4

📝 Checklist

• CI successfully passed

[github-actions]

📊 Package size report

Current size	Target Size	Difference
99758 bytes	99386 bytes	372 bytes 📈

[github-actions]

PR Preview Action v1.4.6
🚀 Deployed preview to https://kirillzyusko.github.io/react-native-keyboard-controller/pr-preview/pr-306/
on branch gh-pages at 2023-12-23 13:29 UTC

[argos-ci]

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	✅ No change detected	-	Dec 23, 2023, 1:30 PM