Merge pull request #53 from smileart/fix/func-name

doc: change exported function name in READMEs
mvasin · Feb 4, 2021 · f47635d · f47635d · vercel · Feb 4, 2021
2 parents 91c534f + 6b21d0b
commit f47635d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -59,9 +59,9 @@ const MyHalfHeightExampleComponent = ({ children }) => {
 }
 ```
 
-Under the hood `use100vh` uses `getRealHeight` function which is exported as
+Under the hood `use100vh` uses `measureHeight` function which is exported as
 well, so feel free to use it, even without React. Currently it returns
-`document.documentElement?.clientHeight || window.innerHeight`.
+`document.documentElement?.clientHeight || window.innerHeight` or `null`.
 
 ## Testing
 

diff --git a/packages/react-div-100vh/README.md b/packages/react-div-100vh/README.md
@@ -59,9 +59,9 @@ const MyHalfHeightExampleComponent = ({ children }) => {
 }
 ```
 
-Under the hood `use100vh` uses `getRealHeight` function which is exported as
+Under the hood `use100vh` uses `measureHeight` function which is exported as
 well, so feel free to use it, even without React. Currently it returns
-`document.documentElement?.clientHeight || window.innerHeight`.
+`document.documentElement?.clientHeight || window.innerHeight` or `null`.
 
 ## Testing
 

diff --git a/packages/test-app/index.html b/packages/test-app/index.html
@@ -8,7 +8,7 @@
       name="description"
       content="React hook that helps to avoid 100vh issue on mobile"
     />
-    <title>useRealHeight</title>
+    <title>measureHeight</title>
     <style>
       body {
         background: #eee;