Functional React Native component that notifies when the user stops interacting with the mobile screen for a given amount of time.
As of version 1.1.0, react-native-user-inactivity resets the timer also when the keyboard appears or disappears.
If you want to avoid this behaviour, you can set the skipKeyboard property to true.
As of version 1.0.0, react-native-user-inactivity has been rebuilt as a functional component that uses the new React Hook API.
Thanks to usetimeout-react-hook, react-native-user-inactivity supports timers different
than the standard one (setTimeout). This has solved some of the most recurrent issues, such as #12, #16, #17.
This fork adds a small API to the original. It allows you to programatically inform UserInactivity that it must reset the inactivity timer because user activity has occured. And to programatically change the duration of the inactivity timeout.
The differences from the orginal are:
- src/BackgroundTimer.ts modified (API added);
- package-lock.json removed;
- package.json editited;
- tsconfig.json editited;
- And README.md modified.
npm install https://github.com/baydroid/react-native-user-inactivity.gitIf you are running a version of react < 17 you'll need to include the --legacy-peer-deps flag.
npm install --legacy-peer-deps https://github.com/baydroid/react-native-user-inactivity.git- 🥇 supports generic timers (you're no longer constrained to
setTimeout) ⚠️ optional reset capability of the timer- ✨ super elastic behaviour thanks to the Hooks API
- 💪 written in TypeScript
- ✔️ the core logic of this component is delegated to
usetimeout-react-hook, which has 100% code coverage
This package primarily exposes a single functional component, UserInactivity. The signatures of UserInactivity's React props and API are as follows:
/**
* UserInactivityAPI is the type of an object providing the API supported by UserInactivity.
* Such an object can be obtained via UserInactivity's optional getAPI property.
*/
type UserInactivityAPI = {
/**
* Calling resetTimerDueToActivity() informs UserInactivity that some user activiity has occured.
* This causes the inactivity timeout to be reset.
*/
resetTimerDueToActivity: () => void;
/**
* Calling changeTimeForInactivity(newTimeForInactivity : number) sets how much time must pass without activity before onAction(active: boolean)'s called.
* The single parameter is the new inactivity timeout in milliseconds.
* After the timeout's been set this way UserInactivity ignores its timeForInactivity property.
* Note that the inactivity timer's reset after changeTimeForInactivity()'s called.
*/
changeTimeForInactivity: (newTimeForInactivity : number) => void;
}interface UserInactivityProps<T = unknown> {
/**
* Number of milliseconds after which the view is considered inactive.
* If it changed, the timer restarts and the view is considered active until
* the new timer expires.
* It defaults to 1000.
*/
timeForInactivity?: number;
/**
* If it's explicitly set to `true` after the component has already been initialized,
* the timer restarts and the view is considered active until the new timer expires.
* It defaults to true.
*/
isActive?: boolean;
/**
* Generic usetimeout-react-hook's TimeoutHandler implementation.
* It defaults to the standard setTimeout/clearTimeout implementation.
* See https://github.com/jkomyno/usetimeout-react-hook/#-how-to-use.
*/
timeoutHandler?: TimeoutHandler<T>;
/**
* Children components to embed inside UserInactivity's View.
* If any children component is pressed, `onAction` is called after
* `timeForInactivity` milliseconds.
*/
children: React.ReactNode;
/**
* If set to true, the timer is not reset when the keyboard appears
* or disappears.
*/
skipKeyboard?: boolean;
/**
* Optional custom style for UserInactivity's View.
* It defaults to { flex: 1 }.
*/
style?: StyleProp<ViewStyle>;
/**
* Callback triggered anytime UserInactivity's View isn't touched for more than
* `timeForInactivity` seconds.
* It's `active` argument is true if and only if the View wasn't touched for more
* than `timeForInactivity` milliseconds.
*/
onAction: (active: boolean) => void;
/**
* Optional callback which, if present, is automatically called whenever its UserInactivity component is used.
* The callback is passed a single parameter of type UserInactivityAPI.
* The properties of this object are the API methods provided by UserInactivity.
*/
getAPI?: (api: UserInactivityAPI) => any;
}When a native timer is needed (in order to avoid issues such as #12, #16, #17) an implementation of
usetimeout-react-hook's TimeoutHandler should be
passed to the timeoutHandler prop.
A default one (BackgroundTimer) is optionally provided: in order to use it you must:
- manually run:
npm i -S react-native-background-timer - manually link the native library:
react-native link react-native-background-timer
In case of doubts, please refer to the official react-native-background-timer repository.
The default BackgroundTimer can be used like this:
import UserInactivity from 'react-native-user-inactivity';
import BackgroundTimer from 'react-native-user-inactivity/lib/BackgroundTimer';
export default () => {
return (
<UserInactivity
timeForInactivity={2000}
timeoutHandler={BackgroundTimer}
onAction={isActive => { console.log(isActive); }}
style={{ flex: 1, paddingTop: '10%' }}
>
);
}Warning: it seems that react-native-background-timer doesn't work properly with Android 10+ (#41). I'm currently unable to reproduce the problem, but help from the open-source community on this matter is certainly appreciated.
Since the component itself is written in TypeScript, your editor's intellisense system should automagically detect
the typings file (even if you're using plain JS!), thus providing a better developer experience.
In fact, autocomplete capabilities and warning should come for free as you're typing the props to pass to the UserInactivity component.
import React, { useState } from 'react';
import { View, Text, TextInput, Button } from 'react-native';
import UserInactivity from 'react-native-user-inactivity';
export default () => {
const [active, setActive] = useState(true);
const [timer, setTimer] = useState(2000);
return (
<View style={{ flex: 1 }}>
<UserInactivity
isActive={active}
timeForInactivity={timer}
onAction={isActive => { setActive(isActive); }}
style={{ flex: 1, paddingTop: '10%' }}
>
<Button id="btn-1" title="1 Press this to simulate activity" />
<Button id="btn-2" title="2 Press this to simulate activity" />
<Text id="text-1" style={{ textAlign: 'center' }}>Type below to simulate activity</Text>
<TextInput
id="text-input-1"
style={{height: 40, borderColor: 'gray', borderWidth: 1}}
onChange={() => { setActive(true); }}
textContentType="creditCardNumber"
value={timer.toString(10)}
onChangeText={text => setTimer(Number.parseInt(text || 0, 10))}
/>
</UserInactivity>
<View style={{ flex: 3, backgroundColor: '#fcfcaa', }}>
<Text style={{ textAlign: 'center' }}>{active ? 'ACTIVE' : 'NOT ACTIVE'}</Text>
<Button title="Manually set to Active" onPress={() => { setActive(true); }} />
</View>
</View>
);
}Also, please checkout the example on Snack/Expo.
This package is built using TypeScript, so the source needs to be converted in JavaScript before being usable by the users. This can be achieved using TypeScript directly:
npm run buildAlberto Schiabel
- Github: @jkomyno
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
The code is short, throughly commented and well tested, so you should feel quite comfortable working on it.
If you have any doubt or suggestion, please open an issue.
Chances are the problem you have bumped into have already been discussed and solved in the past. Please take a look at the issues (both the closed ones and the comments to the open ones) before opening a new issue. Unfortunately, at the moment I'm not able to offer fast support, because I am a student worker and React Native is no longer part of my main tech stack.
Give a ⭐️ if this project helped or inspired you! In the future, I might consider offering premium support to Github Sponsors.
Built with ❤️ by Alberto Schiabel.
This project is MIT licensed.