keyboardVerticalOffset documentation issue

[slavko-lukic]

Hello.

Both this library and KeyboardAvoidingView from react-native have very vague description for keyboardVerticalOffset prop.

Distance between the top of the user screen and the React Native view. This may be non-zero in some cases. Defaults to 0.

What is this "React Native view" in question? Is it the main app view? Is it the KeyboardAvoidingView being used?
I suggest rewriting this to be more clear so that people stop tuning this randomly though trial and error until they get it right.

[kirillzyusko]

Hey @slavko-lukic

What is this "React Native view" in question? Is it the main app view? Is it the KeyboardAvoidingView being used?

This is a distance between top of the screen and your KeyboardAvoidingView

Assume if you have layout like

• App
  • Header
  • KeyboardAvoidingView

In this case you would need to specify headerHeight as a keyboardVerticalOffset. How documentation can be improved? Do you think that a visual example should be there to show a particular layout and which keyboardVerticalOffset should be used?

Really curious to hear your thoughts 👀

[slavko-lukic]

Hey @kirillzyusko

I'd maybe just paraphrase prop annotation so that it's clear that offset should be distance from top of the screen to the KeyboardAvoidingView in question. And when you hover over prop you can easily see it.

That example you gave or visual example could be added to your website for additional clarity.

[kirillzyusko]

@slavko-lukic I'm trying to draw an example using GPT-solutions, but they fail to do that 🙈

I think I'll draw a diagram and add it to website soon + change description 🙂

[slavko-lukic]

@kirillzyusko That's great 🙌
You wouldn't believe the number of times i've seen this prop used incorrectly over the years.

By the way, keep up the good work. This library is solving one of the most annoying problems in react native. 👍

[kirillzyusko]

Published new version of documentation - should be clearer now 😊