3.0.2 • Published 2 years ago

rn-logscreen v3.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Battle Tested ✅

One Line of Code to Plug & Play | Fully Customizable Beautiful React Native Login Screen

npm version npm Platform - Android and iOS License: MIT

🥳 Version 3

Version 3 with the completely new UI

  • Whole new UI / UX
  • Simplistic Design
  • Better Code Quality
  • Fully Customizable
  • Ready to use SocialButton Component
  • Removed unstable dependencies
  • Only ONE dependency is needed

Installation

Add the dependency:

npm i react-native-login-screen

Peer Dependencies

IMPORTANT! You need install them.
npm i react-native-text-input-interactive
"react-native-text-input-interactive": ">= 0.1.3"

Import

import LoginScreen from "react-native-login-screen";

Usage

<LoginScreen
  logoImageSource={require("./assets/logo-example.png")}
  onLoginPress={() => {}}
  onHaveAccountPress={() => {}}
  onEmailChange={(email: string) => {}}
  onPasswordChange={(password: string) => {}}
/>

Usage with Social Button

Of course you can put any children into the LoginScreen, I recommend you to use SocialButton.

import LoginScreen, { SocialButton } from "react-native-login-screen";

<LoginScreen
  logoImageSource={require("./assets/logo-example.png")}
  onLoginPress={() => {}}
  onHaveAccountPress={() => {}}
  onEmailChange={(email: string) => {}}
  onPasswordChange={(password: string) => {}}
>
  <SocialButton text="Continue with Google" onPress={() => {}} />
  <SocialButton
    text="Continue with Facebook"
    imageSource={require("./assets/social/facebook.png")}
    onPress={() => {}}
  />
  <SocialButton
    text="Continue with Twitter"
    imageSource={require("./assets/social/twitter.png")}
    onPress={() => {}}
  />
</LoginScreen>;

Configuration - Props

Fundamentals

PropertyTypeDefaultDescription
onLoginPressfunctionundefinedset your own function when the login button is pressed
onHaveAccountPressfunctionundefinedset your own function when the have an account button is pressed
onEmailChangefunctionundefinedset your own function when email textinput has a change
onPasswordChangefunctionundefinedset your own function when password textinput has a change
logoImageSourcesourceundefinedset your own logo

Customizations (Optional)

PropertyTypeDefaultDescription
haveAccountTextstring"Already have an account?"change the have account text
disableDividerbooleanfalsedisable the divider if you do not want to use it
disableSocialButtonsbooleanfalsedisable the all social buttons
styleViewStyledefaultset/override the default style for the container
dividerStyleViewStyledefaultset/override the default divider style
logoImageStyleImageStyledefaultset/override the default image style
textInputContainerStyleViewStyledefaultset/override the default text input container style
loginButtonStyleViewStyledefaultset/override the default login button style
loginTextStyleTextStyledefaultset/override the default login text style
haveAccountButtonStyleViewStyledefaultset/override the default have account button style
haveAccountTextStyleTextStyledefaultset/override the default have account text style

Default Social Login Buttons (Optional)

PropertyTypeDefaultDescription
onFacebookPressfunctionundefinedset your own function for the Facebook social button press
onTwitterPressfunctionundefinedset your own function for the Twitter social button press
onApplePressfunctionundefinedset your own function for the Apple social button press
onDiscordPressfunctionundefinedset your own function for the Discord social button press

Version 2 is still available

if you do not like the new design, you can still use the old design :)

npm i react-native-login-screen@2.1.4

Roadmap

  • LICENSE
  • Android Design Bug Fixes
  • Configuration - Props COMING SOON
  • Typescript Challenge!
  • Remove some dependencies
  • Better TextField Library Integration
  • Write an article about the lib on Medium
  • Write an article about the lib on DevTO

Credits

For the awesome photo thanks to jcob nasyr from Unsplash

Author

FreakyCoder, kurayogun@gmail.com

License

React Native Login Screen is available under the MIT license. See the LICENSE file for more info.