Skip to main content
Version: 5.0.x

Form recipe

To handle fullscreen form, check the example form component

This is the basic case, where all form elements are placed inside scrollable container. When the keyboard is visible, the only tasks are to push the input (if needed) above the keyboard and make the submit button visible, when scrolling to the bottom.

packages/app/src/screens/FormExample.tsx
import { useFocusEffect } from '@react-navigation/native';
import * as React from 'react';
import { Image, ScrollView, StyleSheet, View } from 'react-native';
import { AvoidSoftInput, useSoftInputAppliedOffsetChanged } from 'react-native-avoid-softinput';
import { SafeAreaView } from 'react-native-safe-area-context';

import Button from '../components/Button';
import MultilineInput from '../components/MultilineInput';
import SingleInput from '../components/SingleInput';
import { styles as commonStyles } from '../consts/styles';

const icon = require('../../assets/AppIconTransparent.png');

const NOOP = () => {};

export const FormExample: React.FC = () => {
const onFocusEffect = React.useCallback(() => {
AvoidSoftInput.setShouldMimicIOSBehavior(true);
AvoidSoftInput.setEnabled(true);
return () => {
AvoidSoftInput.setEnabled(false);
AvoidSoftInput.setShouldMimicIOSBehavior(false);
};
}, []);

useFocusEffect(onFocusEffect);

useSoftInputAppliedOffsetChanged(({ appliedOffset }) => {
console.log({ appliedOffset });
});

return <SafeAreaView edges={[ 'bottom', 'left', 'right' ]} style={commonStyles.screenContainer}>
<ScrollView
bounces={false}
contentContainerStyle={commonStyles.scrollContainer}
contentInsetAdjustmentBehavior="always"
overScrollMode="always"
showsVerticalScrollIndicator={true}
style={commonStyles.stretch}>
<View style={styles.logoContainer}>
<Image
resizeMode="contain"
source={icon}
style={styles.logo}
/>
</View>
<View style={styles.formContainer}>
<SingleInput placeholder="Single line input" />
<MultilineInput placeholder="Multiline input" style={styles.secondInput} />
<MultilineInput placeholder="Large multiline input" />
</View>
<View style={styles.submitButtonContainer}>
<Button
onPress={NOOP}
title="Submit"
/>
</View>
</ScrollView>
</SafeAreaView>;
};

const styles = StyleSheet.create({
formContainer: {
alignItems: 'center',
alignSelf: 'stretch',
justifyContent: 'center',
paddingHorizontal: 10,
},
logo: {
height: 200,
width: 200,
},
logoContainer: {
alignItems: 'center',
alignSelf: 'stretch',
flex: 1,
justifyContent: 'center',
paddingVertical: 100,
},
secondInput: {
height: 200,
},
submitButtonContainer: {
alignItems: 'center',
alignSelf: 'stretch',
justifyContent: 'center',
marginTop: 100,
},
});