Skip to content

vr7bd/expo-kiosk

Repository files navigation

expo-kiosk

Module that ensure android apps run in kiosk mode and has functions to exit out of kiosk mode

API documentation

The module only works for android. It is recommended to not exit apps on iOS and will be considered as a crash. If you would like to run your app in kiosk mode for iOS, refer to Guided Access . The module by default makes sure the app runs in fullscreen.

There are 2 functions that can be called from the repo:-

exitApp() - This function does not kill the app. It allows the user to select the Home app.

killApp() - This function kills the app. Make sure there is no logic below this function as the app is getting killed

The above functions can be used in combination.

Help

Running in fullscreen does not work for all android versions. I tried to make it work but couldn't. If you have found a way, kindly submit a PR.

Installation in managed Expo projects

For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release. If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.

Installation in bare React Native projects

For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

Add the package to your npm dependencies

npm install expo-kiosk

Configure for Android

No additional setup necessary.

Contributing

Contributions are very welcome! Please refer to guidelines described in the contributing guide.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published