react-screen-orientation

react-screen-orientation
========================

Installation
------------

npm install react-screen-orientation --save

Usage
-----

Also see the example.

``scss @import "~react-screen-orientation/src/index";`

`javascript import React, {Component} from 'react'

import DeviceOrientation, { Orientation } from 'react-screen-orientation'

class Example extends Component {

render () { return ( {/ Will only be in DOM in landscape /}


            Only visible in landscape


        
        {/ Will stay in DOM, but is only visible in portrait /}
        
          
            Please rotate your device

          

        
      
    )
  }
}


Documentation
-------------
$3

#### children — Orientation

Required. You MUST supply children of type Orientation. Each child will only be visible if it's orientation prop matches the current screen orientation.

#### className — String ('')

Passes CSS classes to the underlying div.

#### lockOrientation — String or Array (undefined)

Try to lock the device using either [The Screen Orientation API][screen-orientation] or [screen.lockOrientation][lockOrientation].

Valid values are: portrait-primary, portrait-secondary, landscape-primary, landscape-secondary, portrait, landscape and default. Multiple values are allowed.

#### onLockOrientation — function (success) (undefined)

Callback which will be called after trying to lock screen orientation using lockOrientation.

#### onOrientationChange — function (orientation, type, angle) (undefined)

Will be called in componentWillMount and when screen orientation changes are detected. Orientation changes are detected using [The Screen Orientation API][screen-orientation] or [window.onorientationchange][orientationchange]

window.screen.orientation.type is split into orientation and type parameters.

Parameters: *orientation — portrait or landscape*type — primary or secondary*angle — 0, 90, 180 or 270

`$3`

#### alwaysRender — boolean (true)

Set this to false to not render the component into the DOM if orientation does not match the current screen orientation. This can be helpful if you need your component to re-render when screen orientation changes.

#### children

Any children will be passed to the DOM.