• Stars
    star
    114
  • Rank 297,963 (Top 7 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created about 6 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

React Native: Lock Screen

PRs Welcome

ReactNative: Lock Screen (Android/iOS)

If this project has helped you out, please support us with a star 🌟

An easy-to-use, customizable and Material Design ready Pattern/Pin Lock view for Android & iOS.

Pin
Pattern
With Background

📖 Getting started

$ yarn add react-native-lock-screen --save

RN60 >= RNLS V1 >

RN60 above please use react-native-lock-screen V1 and above

$ yarn add react-native-lock-screen

$ yarn add react-native-svg

$ yarn add react-native-vector-icons

  • iOS

iOS Prerequisite: Please make sure CocoaPods is installed on your system

- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:
  use_native_modules!

  pod 'RNLockScreen', :path => '../node_modules/react-native-lock-screen/ios'
  • Android

RN60 < RNLS V1 <

RN60 below please use react-native-lock-screen V.0.*

$ react-native link react-native-lock-screen

$ react-native link react-native-svg

$ react-native link react-native-vector-icons

  • Android
    • Please add below snippet into your app build.gradle
buildscript {
    repositories {
      jcenter()
      maven { url "https://maven.google.com" }
		...
    }
	...
}


allprojects {
    repositories {
      maven { url 'https://jitpack.io' }
		  maven { url "https://maven.google.com" }
		...
    }
}

Note: This library is support on Android 27 > above

  • iOS

  • After react-native link react-native-lock-screen, please verify node_modules/react-native-lock-screen/ios/ contains Pods folder. If does not exist please execute pod install command on node_modules/react-native-lock-screen/ios/, if any error => try pod repo update then pod install

💻 Usage

import { RNLockScreen } from 'react-native-lock-screen';

<RNLockScreen type={RNLockScreen.Type.Pin} mode={RNLockScreen.Mode.Capture} onCapture={lock => {
  }} onVerified={() => {

  }}
  lock={'123'}
/>

💡 Props

Prop Type Default Note
type number Pin - 0 Specify type of lock (Pin/Pattern)
mode number Capture - 0 Specify mode of lock (Capture/Verify)
lock string Specify lock then the mode is Verify
lockLimit number 4 Specify lock limit of lock
clearLockOnError bool true Specify clear flag on error, it will automatically reset pin visualize state to it's default
onCapture func Specify onCapture event function, this is invoked once passcode is captured
onVerified func Specify onVerified event function, this is invoked when the passcode is verified
backgroundImage number : optional Specify lock screen background image
renderHeaderFragment func : optional Specify func to customize header fragment
renderSeparator func : optional Specify func to customize separator
renderLockFragment func : optional Specify func to customize lock fragment
patternProps object : optional Specify obj to pass pattern props
pinProps object : optional Specify obj to pass pin props
headerFragmentProps object : optional Specify obj to pass header fragment props
lockFragmentProps object : optional Specify obj to pass lock fragment props
defaultState object : optional Specify obj to pass DEFAULT state props
reenterState object : optional Specify obj to pass REENTER state props
successState object : optional Specify obj to pass SUCCESS state props
errorState object : optional Specify obj to pass error state props
confirmPin object : optional Specify obj to pass confirm pin state props
deletePin object : optional Specify obj to pass delete pin state props
  • Default State Props: defaultState
Prop Type Default Note
title string Enter a passcode Specify the header fragment title
titleStyle string { fontSize: 24, color: "#FFF" } Specify title style
icon string lock icon Specify the header circle icon
dotProps string style: { backgroundColor: "#FFF" } Specify the Dot component props
  • Reenter State Props: reenterState
Prop Type Default Note
title string Enter a passcode Specify the header fragment title
titleStyle string { fontSize: 24, color: "#FFF" } Specify title style
icon string lock icon Specify the header circle icon
dotProps string style: { backgroundColor: "#FFF" } Specify the Dot component props
  • Success State Props: successState
Prop Type Default Note
title string Enter a passcode Specify the header fragment title
titleStyle string { fontSize: 24, color: "#FFF" } Specify title style
icon string lock icon Specify the header circle icon
dotProps string style: { backgroundColor: "#037d50" } Specify the Dot component props
  • Error State Props: errorState
Prop Type Default Note
title string Enter a passcode Specify the header fragment title
titleStyle string { fontSize: 24, color: "#FFF" } Specify title style
icon string lock icon Specify the header circle icon
dotProps string style: { backgroundColor: "#be0000" } Specify the Dot component props
  • Pin Props
Prop Type Default Note
confirmPin string Specify text/icon/style of confirm pin
deletePin string Specify text/icon/style of delete pin
rippleProps string Specify props of ripple. Please refer react-native-material-ripple
containerStyle string Specify style of root container
textStyle string Specify style of text displayed
suggestionStyle string Specify style of suggestion displayed
alphabetPinSuggestion bool true Enable/Disable alphabet suggestion
  • Confirm/Delete Pin Props
Prop Type Default Note
title string Specify text of confirm pin
icon string Confirm Icon/Delete Icon Specify icon of confirm pin
style string Specify style of title/icon

Credits

🤔 How to contribute

Have an idea? Found a bug? Please raise to ISSUES. Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list below.

📜 License

This library is provided under the Apache License.

RNLockScreen @ prscX

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • If you're feeling especially charitable, please follow prscX on GitHub.

    Buy Me A Coffee

    Thanks! ❤️
    prscX.github.io
    </ Pranav >

More Repositories

1

react-native-photo-editor

React Native: Native Photo Editor
Java
1,102
star
2

react-native-bottom-action-sheet

React Native: Native Bottom Action Sheet
JavaScript
634
star
3

react-native-app-tour

React Native: Native App Tour Library
Objective-C
621
star
4

react-native-spruce

React Native Bridge for Native Spruce Animation Library
JavaScript
532
star
5

react-native-popover-menu

React Native: Native Popover Menu
JavaScript
479
star
6

awesome-react-native-native-modules

A curated list of Awesome ReactNative: Native Modules Guidelines/Components/News/Tools/Learning Materials
437
star
7

react-native-shine-button

React Native: Native Shine Button - Effects like shining
Java
357
star
8

react-native-file-selector

React Native: Native File Selector
Java
306
star
9

react-native-tooltips

React Native: Native Tooltip View
JavaScript
267
star
10

react-native-iconic

React Native - Native Animated Icons with different states
Java
223
star
11

react-native-fluidic-slider

React Native: Native Fluidic Slider
Objective-C
196
star
12

react-native-styled-dialogs

React Native: Native Styled Dialogs
Objective-C
174
star
13

react-native-morphing-text

React Native: Native Morphing Text
Swift
160
star
14

react-native-toasty

React Native: Native Toast
JavaScript
156
star
15

react-native-siri-wave-view

React Native: Native Siri Wave View
Objective-C
145
star
16

react-native-download-button

React Native: Native Download Button: with pretty cool animation
Java
123
star
17

react-native-selection-menu

React Native: Native Selection Menu
Java
110
star
18

react-native-voice-recorder

React Native: Native Audio Recorder View
Java
93
star
19

react-native-notification-banner

React Native: Native Notification Banner
JavaScript
90
star
20

react-native-material-shadows

React Native: Native Material Shadows
Java
86
star
21

PXSiriWave9

iOS: Siri Waveform effect similar to 9
Objective-C
64
star
22

react-native-chip-view

React Native: Material Chip View
JavaScript
43
star
23

react-native-number-selector

ReactNative: Native Number Picker
Java
39
star
24

react-native-number-stepper

ReactNative: Number Stepper
JavaScript
35
star
25

react-native-richtext

React Native: Native Rich Text Editor
Swift
31
star
26

prettier-pack

Prettier + ESLint + Husky + Lint + Flow + React + React Native
JavaScript
31
star
27

react-native-about-libraries

React Native: It offers information about install packages
JavaScript
31
star
28

react-native-easy-permissions

React Native: Native Easy Permissions
Objective-C
31
star
29

react-native-file-type

React Native: Detect the file type of a Buffer/Uint8Array by reading from Local Storage
Java
27
star
30

react-native-text-switch

ReactNative: Native Text Switch
Objective-C
26
star
31

vs-essential-plugins

Essential Prepackaged VSCode Plugins for ReactNative
JavaScript
25
star
32

react-native-bottom-sheet-text-view

React Native: Native Bottom Sheet - Text View
Objective-C
22
star
33

react-native-add-shortcuts

React Native: Native Add Shortcuts
Java
21
star
34

PXMultiSelector.iOS

iOS: Multi Selector List
20
star
35

react-native-local-authenticate

React Native: Local Authentication
Java
15
star
36

react-native-image-helper

React Native: Native Image Helper
Java
9
star
37

pod-installer

POD Installer
JavaScript
6
star
38

react-native-whats-new

React Native: Native Whats New Kit
Java
6
star
39

simplified-promise

Enhance Simplicity of JS Promise
JavaScript
4
star
40

BottomSheetTextView.iOS

Android - BottomSheet TextView
Objective-C
2
star
41

BottomSheetTextView.Android

Android - BottomSheet TextView
Java
1
star
42

prscX.github.io

prscX Profile Page
CSS
1
star