JSPM – react-native-windows-hello@0.8.0

Package Exports

react-native-windows-hello

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-windows-hello) 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 Windows library providing developers with all Windows Hello features.

The following library allows you to use all features of Windows Hello functionality. This includes the signing-in options and passport. This library is a set of native methods providing easy API to fetch the device availability, sign in using your biometrics.

Installation & Usage

To install this module cd to your project directory and enter the following command:

yarn add react-native-windows-hello

npm install react-native-windows-hello --save

After having it installed you can call all the Windows Hello methods through the NativeModules, so the usage would be:

NativeModules.SignIn.requestScanPromise()
  .then(result => {
    Alert.alert("SUCCESS", `${result}`);
  })
  .catch(error => {
    Alert.alert("ERROR:", `${error}`);
  });

Check out the example project for more examples.

API

The following library provides you with the native modules exposing the following methods:

Method	Description	Returns
`SignIn` `.checkAvailabilityPromise`	Gets the status of biometric device on a user's machine and returns a promise with the result	`Promise` with `String`
`SignIn` `.requestScanPromise`	Displays the biometric scan prompt as a popup and returns a promise after user's actions	`Promise` with `String`
`SignIn` `.checkAvailabilityCallback`	Gets the status of biometric device on a user's machine and launches a callback with the result as a callback's parameter	Callback(`String`)
`SignIn` `.requestScanCallback`	Displays the biometric scan prompt as a popup and returns a result through a callback	Callback(`String`)
`SignIn` `.checkAvailabilityAsync`	Gets the status of biometric device on a user's machine and returns an empty callback, which acts as a notification about launching the request. The result of that action should be then manually fetched by running `getLastAvailabilityCheckResult`	Callback()
`SignIn` `.requestScanAsync`	Displays the biometric scan prompt as a popup and returns an empty callback after user's actions, which acts as a notification about launching the request. The result of that action should be then manually fetched by running `getLastScanResult`	Callback()
`SignIn` `.getLastScanResult`	Returns a promise with last result of a biometric device status	`Promise` with `String`
`SignIn` `.getLastAvailabilityCheckResult`	Returns a promise with last result of a biometric signing in result	`Promise` with `String`

Contributing

If you would like to contribute to the react-native-windows-hello project, you are more than welcome! You can do this by:

Create an Issue and let the author handle it
Each issue created in the Issues section gives a chance of improving the project and make it even more useful.
Create the Pull Request with the desired changes
When creating the pull request please remember to describe changes you made and how to test them. A short demo of any kind is very appreciated.

Setting up the project

To start developing you need to fork this project, and clone your fork.
After that you can:

yarn install
Implement changes (mostly in windows/ReactNativeWindowsHello/Source directory)
After implementation you can check the build by running:
msbuild -p:Configuration=Debug -p:Platform=x64 .\windows\ReactNativeWindowsHello.sln
Or launch the build through the Visual Studio.

Made with ❤️ at Callstack

react-native-windows-hello is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. Callstack is a group of React and React Native geeks, contact us at hello@callstack.com if you need any help with these or just want to say hi!

Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥