make RFValue to get standardScreenHeight as param

heyman333 · Oct 24, 2019 · 519020d · 519020d
1 parent 2812e77
commit 519020d
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-## react-native-responsive-fontsize
+<img src="images/main.png" alt="main image">
+
+# react-native-responsive-fontsize
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](https://github.com/heyman333/react-native-responsive-fontSize/pulls)
 [![Platform](https://img.shields.io/badge/platform-react--native-lightgrey.svg)](http://facebook.github.io/react-native/)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/heyman333/react-native-responsive-fontSize/blob/master/LICENSE)
 
 <strong>Use this library if you have a small problem with the font size 🎉</strong>
 
-<img src="images/main.png" alt="main image">
-
 <hr />
 
 #### How to install
@@ -24,14 +24,21 @@ npm install react-native-responsive-fontsize --save
 | :------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: |
 | <img src="https://raw.githubusercontent.com/heyman333/react-native-responsive-fontSize/master/images/SE.png" width="320" height="568"> | <img src="https://raw.githubusercontent.com/heyman333/react-native-responsive-fontSize/master/images/X.png" width="385" height="812"> |
 
+#### Methods
+
+|              |                  arguments                   |                                Description                                 |
+| :----------: | :------------------------------------------: | :------------------------------------------------------------------------: |
+| RFPercentage |               percent: number                |  The font size is calculated as a percentage of the height of the device.  |
+|   RFValue    | value: number, standardScreenHeight?: number | The font size is determined based on standardScreenHeight and passed value |
+
 #### Usage
 
 ```js
 import { RFPercentage, RFValue } from "react-native-responsive-fontsize";
 
 const styles = StyleSheet.create({
   welcome: {
-    fontSize: RFValue(24),
+    fontSize: RFValue(24, 580) // second argument is standardScreenHeight(optional),
     textAlign: "center",
     margin: 10,
   },
@@ -44,6 +51,10 @@ const styles = StyleSheet.create({
 });
 ```
 
+#### Changelog
+
+[releases](https://github.com/heyman333/react-native-responsive-fontSize/releases)
+
 #### Load map (I'm waiting for your help)
 
 - [ ] support landscape mode

diff --git a/index.d.ts b/index.d.ts
@@ -1,4 +1,4 @@
 declare function RFPercentage(percent: number): number;
-declare function RFValue(value: number): number;
+declare function RFValue(value: number, standardScreenHeight: number): number;
 
 export { RFPercentage, RFValue };
diff --git a/index.js b/index.js
@@ -14,9 +14,8 @@ export function RFPercentage(percent) {
   return Math.round(heightPercent);
 }
 
-export function RFValue(fontSize) {
-  // guideline height for standard 5" device screen
-  const standardScreenHeight = 680;
+// guideline height for standard 5" device screen is 680
+export function RFValue(fontSize, standardScreenHeight = 680) {
   const heightPercent = (fontSize * deviceHeight) / standardScreenHeight;
   return Math.round(heightPercent);
 }