1.0.4 • Published 11 months ago

rn-login-screen v1.0.4

Weekly downloads
-
License
ISC
Repository
-
Last release
11 months ago

rn-login-screen A customizable login screen component for React Native projects. Use this open source library in your fresh React Native project for instant startup.

Table of Contents

Installation

To use rn-login-screen in your React Native project, simply install it using npm or yarn:

npm install rn-login-screen
or
yarn add rn-login-screen

Usage

To use the login screen component in your app, import it from the rn-login-screen package and render it as the second component in your app after splash screen. You can customize the appearance and behavior of the login screen by passing in props.

How to use

import LoginScreen from "rn-login-screen";

function App() {
  return (
    <LoginScreen
      placeholderMail={"Email"}
      placeholderPass={"Password"}
      headingText={"Login"}
      LoginSubmitText={"Login"}
      useLogo={true}
      useBg={true}
      LogoPosition={"center"}
      bgSource={require("./src/assets/black1.jpg")}
      source={require("./src/assets/cropped.png")}
      SignUpText={"Sign Up"}
      ForgotPasswordText={"Forgot Password"}
      positionText={"center"}
    />
  );
}

Props

The LoginScreen component accepts the following props:

Prop NameData TypeDescription
placeholderMailanyYour Email
placeholderPassanyYour Password
-----------------------------
placeholderColoranyplaceholder color
-----------------------------
inputStyleanystyle to input
-----------------------------
headingTextanymain heading
-----------------------------
headingTextStylespecified path(req)style to heading
-----------------------------
LoginSubmitTextanyYour Login Button text
-----------------------------
useLogoboolUsing Logo or not
-----------------------------
LogoPositionspecified valuesLogo position
-----------------------------
bgSourcespecified path(req)Your background image
-----------------------------
sourcespecified path(req)Logo source
-----------------------------
imageStyleanyStyle to Logo
-----------------------------
SignUpTextanyYour SignUp Text
-----------------------------
ForgotPasswordTextanyYour Forgot Password Text
-----------------------------
positionTextspecified valuesBox alignment
-----------------------------
loginPressanyonPress for login
-----------------------------
SignUpPressanyonPress for signUp
-----------------------------
onBluranyonBlur
-----------------------------
onFocusanyonFocus
-----------------------------
onKeyPressanyonKeyPress
-----------------------------
keyboardTypeanykeyboardType
-----------------------------
ForgotPasswordPressanyonPress for ForgotPasswordPress

Contributors

We would like to thank the following developers for their contributions to this project:

To all our contributors, thank you for your hard work and dedication!

License

This package is released under the MIT License.

1.0.4

11 months ago

1.0.3

11 months ago

1.0.2

12 months ago

1.0.1

12 months ago

1.0.0

1 year ago