mobile-height-fix
v1.0.1
Published
A npm module that helps fix the height of the screen for mobile phones by setting a custom property (--vh) on the HTML root element.
Downloads
8
Readme
Index
A simple module for fixing the height issue in mobile browsers where the address bar is visible, and the content does not fill the full height of the screen.
Is intended to solve this issue automagically 🪄
- https://css-tricks.com/css-fix-for-100vh-in-mobile-webkit/
- https://css-tricks.com/the-trick-to-viewport-units-on-mobile/
From the latter of these pages I took most of the cue to create this module, so kudos to Louis Hoebregts (@Mamboleoo)
Installation
npm install mobile-height-fixUsage
After importing the module
The body will be set to have a minimum height of 100% of the height of the screen
A new custom property will be available,
--vhthat represents the 1% of the height of the screen You can use this css variable in this way>
height: calc(var(--vh, 1vh) * 100)Importing in HTML (recommended)
Add the following script tag in the <head> section of your HTML file to ensure that the script is executed as soon as possible:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Your Website Title</title>
<script type="module" src="node_modules/mobile-height-fix/MobileHeightFix.js"></script>
</head>
<body>
<!-- Your content here -->
</body>
</html>Importing in JavaScript
If you are using a bundler or a more complex JavaScript setup, you can import the module in your JavaScript file:
// Import the MobileHeightFix class
import MobileHeightFix from 'mobile-height-fix';
// Create an instance and initialize the fix
const heightFix = new MobileHeightFix();Explanation
The MobileHeightFix class provides a solution to the issue on mobile browsers where the address bar is visible, and the content does not fill the full height of the screen. It sets a custom property (--vh) on the HTML root element to reflect the actual height of the viewport.
The script automatically sets the full height when it is initialized and adds a resize event listener to handle changes in viewport size.
API
MobileHeightFix()
Constructor that initializes the MobileHeightFix instance.
setFullHeight()
Sets the full height of the window by updating the --vh custom property on the HTML root element.
init()
Initializes the fix by calling setFullHeight() and adding a resize event listener.
Example
// Import the MobileHeightFix class
import MobileHeightFix from 'mobile-height-fix';
// Create an instance and initialize the fix
const heightFix = new MobileHeightFix();
// Will update the --vh value
heightFix.setFullHeight();Explanation
Script (No Import/Export)
The Index script provides a solution to the issue on mobile browsers where the address bar is visible, and the content does not fill the full height of the screen. It automatically sets a custom property (--vh) on the HTML root element to reflect the actual height of the viewport. The script is designed to work without explicit import/export and automatically sets the full height when it is loaded. It also adds a resize event listener to handle changes in viewport size.
Module (Import/Export)
The Index module can be imported in more complex JavaScript setups. It provides the same functionality as the script but allows you to use modern JavaScript features like import/export. To use this option, import the module and create an instance to initialize the fix.
License
This project is licensed under the ISC License - see the LICENSE file for details.