Skip to content

Commit 30fc895

Browse files
kuraydevkuraydev
committed
docs: README is updated
1 parent de0c552 commit 30fc895

1 file changed

Lines changed: 55 additions & 32 deletions

File tree

‎README.md‎

Lines changed: 55 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,14 @@
1818
Version 5 with the completely new UI
1919

2020
- Whole new UI / UX Design 😍
21-
- Simplistic Design
21+
- Built-in Email Validation 📧
22+
- Built-in Password Validation 🔒
23+
- Built-in Email Tooltip 📧
24+
- Built-in Password Tooltip 🔒
25+
- Built-in Show/Hide Password Feature 👀
26+
- Fully Customizable 🎨
2227
- Better Code Quality 🚀
23-
- Fully Customizable
2428
- Ready to use `SocialButton` Component
25-
- Built-in Show/Hide Password Feature 👀
2629
- `Only ONE dependency` is needed
2730

2831
## Installation
@@ -108,38 +111,53 @@ You can put any `children` into the LoginScreen, I recommend you to use `SocialB
108111

109112
### Customizations (Optional)
110113

111-
| Property | Type | Default | Description |
112-
|-------------------------|:-----------------------------------------------------------------------------------------------------------------------:|:-------------------:|---------------------------------------------------------|
113-
| onEyePress | function | undefined | set your own function when `eye icon` button is pressed |
114-
| signupText | string | "Create an account" | change the sign up text |
115-
| disableSignup | boolean | false | disable the signup if you do not want to use it |
116-
| disableDivider | boolean | false | disable the divider if you do not want to use it |
117-
| disableSocialButtons | boolean | false | disable the all social buttons |
118-
| disablePasswordInput | boolean | false | disable the password text input |
119-
| emailPlaceholder | string | "Email" | change email placeholder text |
120-
| passwordPlaceholder | string | "Password" | change password placeholder text |
121-
| loginButtonText | string | "Login" | change login button's text |
122-
| style | ViewStyle | default | set/override the default style for the container |
123-
| dividerStyle | ViewStyle | default | set/override the default divider style |
124-
| logoImageStyle | ImageStyle | default | set/override the default image style |
125-
| textInputContainerStyle | ViewStyle | default | set/override the default text input container style |
126-
| loginButtonStyle | ViewStyle | default | set/override the default login button style |
127-
| loginTextStyle | TextStyle | default | set/override the default login text style |
128-
| signupStyle | ViewStyle | default | set/override the default signup button style |
129-
| signupTextStyle | TextStyle | default | set/override the default signup text style |
130-
| textInputProps | [IInteractiveTextInputProps](https://github.com/WrathChaos/react-native-text-input-interactive#customization-optionals) | default | set/override the default textinput props |
131-
114+
| Property | Type | Default | Description |
115+
|-------------------------|:----------:|:-------------------:|---------------------------------------------------------|
116+
| onEyePress | function | undefined | set your own function when `eye icon` button is pressed |
117+
| signupText | string | "Create an account" | change the sign up text |
118+
| disableSignup | boolean | false | disable the signup if you do not want to use it |
119+
| disableDivider | boolean | false | disable the divider if you do not want to use it |
120+
| disableSocialButtons | boolean | false | disable the all social buttons |
121+
| disablePasswordInput | boolean | false | disable the password text input |
122+
| disableEmailValidation | boolean | false | disable built-in email validation |
123+
| disableEmailTooltip | boolean | false | enable built-in password validation |
124+
| disablePasswordTooltip | boolean | false | disable built-in email tooltip |
125+
| disableEmailTooltip | boolean | false | disable built-in password tooltip |
126+
| emailPlaceholder | string | "Email" | change email placeholder text |
127+
| passwordPlaceholder | string | "Password" | change password placeholder text |
128+
| loginButtonText | string | "Login" | change login button's text |
129+
| style | ViewStyle | default | set/override the default style for the container |
130+
| dividerStyle | ViewStyle | default | set/override the default divider style |
131+
| logoImageStyle | ImageStyle | default | set/override the default image style |
132+
| textInputContainerStyle | ViewStyle | default | set/override the default text input container style |
133+
| loginButtonStyle | ViewStyle | default | set/override the default login button style |
134+
| loginTextStyle | TextStyle | default | set/override the default login text style |
135+
| signupStyle | ViewStyle | default | set/override the default signup button style |
136+
| signupTextStyle | TextStyle | default | set/override the default signup text style |
137+
| signupTextStyle | TextStyle | default | set/override the default signup text style |
138+
| passwordContentTooltip | Component | default | set on your own **tooltip content** for password |
139+
| emailContentTooltip | Component | default | set on your own **tooltip content** for email |
132140

133141
### Advanced Customizations (Optional)
134142

135-
| Property | Type | Default | Description |
136-
|--------------------|:---------:|:-------:|-------------------------------------------------------------|
137-
| customTextInputs | Component | default | set your own custom text inputs instead of built-in ones |
138-
| textInputChildren | Component | default | set your own EXTRA custom text inputs with the current ones |
139-
| customLogo | Component | default | set your own logo |
140-
| customLoginButton | Component | default | set your login button |
141-
| customSignupButton | Component | default | set your sign up button |
142-
| customDivider | Component | default | set your divider |
143+
| Property | Type | Default | Description |
144+
|--------------------------|:-----------------------------------------------------------------------------------------------------------------------:|:----------------:|------------------------------------------------------------------------|
145+
| customTextInputs | Component | default | set your own custom text inputs instead of built-in ones |
146+
| textInputChildren | Component | default | set your own EXTRA custom text inputs with the current ones |
147+
| customLogo | Component | default | set your own logo |
148+
| customLoginButton | Component | default | set your login button |
149+
| customSignupButton | Component | default | set your sign up button |
150+
| customDivider | Component | default | set your divider |
151+
| customLoginButton | Component | default | set on your own components instead of default **login button** |
152+
| customSignupButton | Component | default | set on your own components instead of default **signup button** |
153+
| TouchableComponent | Pressable | TouchableOpacity | set on your own Touchable Component |
154+
| customTextInputs | Component | default | set on your own **textinputs** instead of default ones |
155+
| customSocialLoginButtons | Component | default | set on your own components instead of default **social login buttons** |
156+
| emailTextInputProps | [IInteractiveTextInputProps](https://github.com/WrathChaos/react-native-text-input-interactive#customization-optionals) | default | set/override the email text input props |
157+
| passwordTextInputProps | [IInteractiveTextInputProps](https://github.com/WrathChaos/react-native-text-input-interactive#customization-optionals) | default | set/override the password text input props |
158+
159+
160+
143161

144162
### Default Social Login Buttons (Optional)
145163

@@ -172,6 +190,11 @@ npm i react-native-login-screen@2.1.4
172190
- [x] ~~Better TextField Library Integration~~
173191
- [x] ~~Password show/hide~~
174192
- [x] ~~Customizable Components~~
193+
- [x] ~~Customizable Styles~~
194+
- [x] ~~Built-in Email Validation~~
195+
- [x] ~~Built-in Password Validation~~
196+
- [x] ~~Built-in Email Tooltip~~
197+
- [x] ~~Built-in Password Tooltip~~
175198
- [ ] Write an article about the lib on Medium
176199
- [ ] Write an article about the lib on DevTO
177200

0 commit comments

Comments
 (0)