Package Exports
- react-native-smart-scroll-view
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-native-smart-scroll-view) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-native-smart-scroll-view
A pure JS React Native Component for IOS.
A wrapper around react-native ScrollView to handle keyboard events and auto adjust input fields to be visible above keyboard on focus.
Takes in your components and recursively searches for any component (i.e. TextInput) that is given smartScrollOptions as a prop. Further props are added to these components to ensure they are always visible above the keyboard and within the ScrollView when focused.
There is also the option to autofocus the next component with smartScrollOptions on text input submission and the ability to autofocus any smart component by specifying the index.
Great for use with forms which have multiple TextInput fields!
Getting Started
Installation
$ npm i react-native-smart-scroll-view --saveProperties
In wrapping around the ScrollView and using the TextInput to control keyboard we have used their native properties to create our functionality. You can still add most props to TextInputs and we will allow you to pass some props to the ScrollView but do so with care.
SmartScrollView Props
| Prop | Default | Type | Description |
|---|---|---|---|
| forceFocusField | undefined |
number or string |
Force scroll the view to the TextInput field at the specified index (smart children indexed in order from 0) or scrollRef you have given to your smart child (see smartScrollOptions below) |
| scrollContainerStyle | {flex: 1} |
number |
Style options for the View that wraps the ScrollView, the ScrollView will take up all available space. |
| scrollPadding | 5 |
number |
Padding between the top of the keyboard/ScrollView and the focused TextInput field |
| contentContainerStyle | {flex: 1} |
number |
Set to the ScrollView contentContainerStyle prop |
| zoomScale | 1 |
number |
Set to the ScrollView zoomScale prop |
| showsVerticalScrollIndicator | true |
bool |
Set to the ScrollView showsVerticalScrollIndicator prop |
| contentInset | {top: 0, left: 0, bottom: 0, right: 0} |
object |
Set to the ScrollView contentInset prop |
| onScroll | () => {} |
func |
Set to the ScrollView onScroll function. It will be called alongside our own |
| onRefFocus | ()=>{} |
func |
Gives back the scrollRef of the node whenever a smart component is focused |
TextInput Props
For each native TextInput component that you would like to use please provide the prop smartScrollOptions alongside the normal props. Beware some props modified, see below.
smartScrollOptions - An object with the following keys:
| Key | Type | Description |
|---|---|---|
| type | enum (text,custom) |
'text' option will have below option, 'custom' will just locate the next one, further scrolling must be done by forcing the index |
| moveToNext | bool |
If true, the next TextInput field will be focused when the submit button on the keyboard is pressed. Should be set to false or omitted for the last input field on the page. Warning this will not work if keyboardType for the TextInput is set to 'number-pad', 'decimal-pad', 'phone-pad' or 'numeric' as they do not have a return key |
| onSubmitEditing(next) | func |
Optional function that takes a callback. When invoked, the callback will focus the next TextInput field. If no function is specified the next TextInput field is focused. Example: (next) => { if (condition) { next() } } |
| scrollRef | string |
Way to reference a particular component to use the forceFocusField to have control of where the focus is |
How We Modify TextInput Props
We attach our own onFocus function and will call yours alongside.
If moveToNext in smartScrollOptions is true and type = 'text':
- We replace
onSubmitEditingwith our own. See above. blurOnSubmitis set to false
Example Usage
Code for the above gif is found here
Here is another example of the smart-scroll-view in action.
To run the code yourself and play around open and run the Xcode project.
open SuperScrollingFormExample/ios/SuperScrollingFormExample.xcodeprojTODO
- Allow for more types other than text input to have smart scroll functionality.
- i.e. a customisable picker component that can be used to replace keyboard to allow the user to select a value from a picker.
- Any image, button, slider....
- Allow for header/banner above keyboard.
- Better animations....
- Your issues/suggestions!