react-native-viewport
v0.0.2
Published
Viewport dimensions for react-native
Downloads
3
Maintainers
Readme
react-native-viewport
Utility to get current size of the viewport.
Add it to your project
- Run
npm install react-native-viewport --save
- Open your project in XCode, right click on
Libraries
and clickAdd Files to "Your Project Name"
. - Navigate to
node_modules/react-native-viewport
- Select
Viewport.xcodeproj
- Add
libViewport.a
toBuild Phases -> Link Binary With Libraries
. - Click on
Viewport.xcodeproj
inLibraries
and go theBuild Phases
tab. Double click the text to the right ofHeader Search Paths
and verify that it has$(SRCROOT)../react-native/React
- if it isn't, then add it. This is so XCode is able to find the headers that theViewport
source files are referring to by pointing to the header files installed within thereact-native
node_modules
directory. - Whenever you want to use it within React code now you can:
var Viewport = require('react-native-viewport');
Methods
Note that any time you receive dimensions you will be given an object formatted like so:
{
width: 120,
height: 120
}
addEventListener(eventName, callback)
Adds an event listener to the backing viewport manager. Will call the provided callback whenever the event is fired.
Currently the only supported event is
dimensionsDidChange
. As a convenience, you can reference this event viaViewport.events.DEVICE_DIMENSIONS_EVENT
. This event fires whenever the dimensions of the screen change (e.g. a screen rotation).
removeEventListener(eventName, callback)
Removes an event listener from the backing viewport manager. Will only remove listeners with the exact name and callback specified.
getDimensions(callback)
Gets the current dimensions and passes them to the specified callback. This is useful if you ever want to get dimensions in an adhoc way, such as when the app first boots up and before you have the chance to attach a listener.