- 📦 Installation
- ℹ️ Usage
- 🎣 Responsive Hooks
- 💡 Examples
- ✨ Why Responsive Dimensions?

Installation

``sh
#npm
npm install --save react-native-responsive-dimensions

#yarn
yarn add react-native-responsive-dimensions
`

Usage

While working with mobile devices, there are two kinds of dimensions you will have to focus on

- Window Dimensions ﹣ which is the size of the window / view port on which your app is being displayed
- Screen Dimensions ﹣ this is the total screen dimensions of your device (your app may occupy the entire screen or only a portion of the screen)

$3

`js
import { StyleSheet } from "react-native";
import {
responsiveHeight,
responsiveWidth,
responsiveFontSize
} from "react-native-responsive-dimensions";

const styles = StyleSheet.create({
container: {
justifyContent: "center",
height: responsiveHeight(50), // 50% of window height
width: responsiveWidth(50), // 50% of window width
alignItems: "center"
},
sampleText: {
fontSize: responsiveFontSize(2) // 2% of total window size
}
});
`

$3

`js
import { StyleSheet } from "react-native";
import {
responsiveScreenHeight,
responsiveScreenWidth,
responsiveScreenFontSize
} from "react-native-responsive-dimensions";

const styles = StyleSheet.create({
container: {
justifyContent: "center",
height: responsiveScreenHeight(50), // 50% of Screen height
width: responsiveScreenWidth(50), // 50% of Screen width
alignItems: "center"
},
sampleText: {
fontSize: responsiveScreenFontSize(2) // 2% of total screen size
}
});
`

Responsive hooks

The above responsive dimension methods do not auto update once the value is set. They are suitable for using within StyleSheet.create method as the values don't change once set. However, you might want your views to respond to dimension changes such as screen rotation, device folding (in foldable devices) & browser window resizing (react-native-web).

The values set by these hooks auto respond to changes. The following hooks are available for use ﹣

- useResponsiveHeight
- useResponsiveWidth
- useResponsiveFontSize
- useResponsiveScreenHeight
- useResponsiveScreenWidth
- useResponsiveScreenFontSize
- useDimensionsChange

$3

`jsx
import React from "react";
import { View } from "react-native";
import {
useResponsiveHeight,
useResponsiveWidth
} from "react-native-responsive-dimensions";

const App = () => {
const height = useResponsiveHeight(25);
const width = useResponsiveWidth(25);

return ;
};
`

$3

useDimensionsChange basically calls a function whenever the dimensions update with new window & screen dimensions as arguments. This is a good place to include your layout animations if your UI layout reacts to dimension updates and you want to make the transitions smooth.

`jsx
import React, { useCallback } from "react";
import { View, LayoutAnimation } from "react-native";
import {
useResponsiveHeight,
useResponsiveWidth,
useDimensionsChange
} from "react-native-responsive-dimensions";

const App = () => {
const height = useResponsiveHeight(25);
const width = useResponsiveWidth(25);

useDimensionsChange(
useCallback(({ window, screen }) => {
LayoutAnimation.configureNext(LayoutAnimation.Presets.easeInEaseOut);
}, [])
);

return ;
};
``

Examples

- [Using Responsive Height & Width (snack)][responsive-example]
- [Using the Responsive Hooks (react-native-web)][responsive-hooks-example]

Why Responsive Dimensions

I built responsive dimensions as a personal tool to tackle some of my problems I face during my everyday app development. You might want to use it if your usecase comes under one of the following scenarios.

- While working with React Native UI (especially animations) there are lots of scenarios that require calculating a certain percentage of the display area.

- If your app supports tablets then you might want to scale some of your fonts & UI Components based on the display size.

- If you are using react-native-web or targetting foldable devices your UI needs to react to the changes in the window dimensions.

[build]: https://github.com/DaniAkash/react-native-responsive-dimensions/actions
[build-badge]: https://github.com/daniakash/react-native-responsive-dimensions/workflows/build/badge.svg
[coverage-badge]: https://api.codeclimate.com/v1/badges/0cf535fb8d3da2aa4a91/test_coverage
[coverage-url]: https://codeclimate.com/github/DaniAkash/react-native-responsive-dimensions/test_coverage
[maintainability-badge]: https://api.codeclimate.com/v1/badges/0cf535fb8d3da2aa4a91/maintainability
[maintainability-url]: https://codeclimate.com/github/DaniAkash/react-native-responsive-dimensions/maintainability
[bundle-phobia-badge]: https://badgen.net/bundlephobia/minzip/react-native-responsive-dimensions
[bundle-phobia]: https://bundlephobia.com/result?p=react-native-responsive-dimensions
[downloads-badge]: https://img.shields.io/npm/dm/react-native-responsive-dimensions.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/react-native-responsive-dimensions
[package]: https://www.npmjs.com/package/react-native-responsive-dimensions
[version-badge]: https://img.shields.io/npm/v/react-native-responsive-dimensions.svg?style=flat-square
[twitter]: https://twitter.com/dani_akash_
[twitter-badge]: https://img.shields.io/twitter/follow/dani_akash_?style=social
[github-watch-badge]: https://img.shields.io/github/watchers/DaniAkash/react-native-responsive-dimensions.svg?style=social
[github-watch]: https://github.com/DaniAkash/react-native-responsive-dimensions/watchers
[github-star-badge]: https://img.shields.io/github/stars/DaniAkash/react-native-responsive-dimensions.svg?style=social
[github-star]: https://github.com/DaniAkash/react-native-responsive-dimensions/stargazers
[responsive-example]: https://snack.expo.io/@daniakash/responsive-dimensions
[responsive-hooks-example]: https://codesandbox.io/s/react-native-responsive-dimensions-hooks-2cqm8