screen-orientation-react
v1.0.3
Published
React component which displays an animated full-screen message when the mobile device's screen is rotated horizontally.
Downloads
9
Maintainers
asmarenasReadme
screen-orientation-react
React component which displays an animated full-screen message when the mobile device's screen is rotated horizontally.
Some applications or websites may display content properly only in portrait orientation on the mobile devices. To prevent the website's layout from breaking , <ScreenOrientationReact/> informs the user that the app can't be viewed in landscape orientation.
Installation
Install component with npm
$ npm install screen-orientation-reactUsage
You can place <ScreenOrientationReact/> anywhere in your application. Under the hood the component uses screen-orientation-js which renders <div> element containing a message, and appends it to <body>. When the component is active, <div> element's styles will be set to position: fixed; z-index: 9999 , so the message will always remains on the top.
Example
import React from 'react'
import ScreenOrientationReact from 'screen-orientation-react'
const options = {
color: "#7c692d",
bgColor: "#2d7c72",
animation: false,
fontSize: 3
}
class App extends React.Component {
render() {
return(
<div>
<ScreenOrientationReact options={options}/>
</div>
)
}
}Props
You can change the default settings by passing the config object to options prop. The component will use the default setting values for non-passed values.
| Key | Value type| Description | Default value |
|:-------------|:----------|:--------------------------------------------------|:------------------------------------------ |
| message: | string | The custom message to display. | ""Landscape orientation is not support..." |
| color: | string | Text color. | #0000 |
| fontSize: | number | Font size. Recommended values 1-6. | 5 |
| bgColor: | string | Background color. | #ffff |
| animation: | boolean | The rotating phone animation. | true |
| iconColor: | string | Icon color. | #1D1D1D |
| iconSize: | number | Icon size. | 10 |
| minHeight: | number | Min viewport height in landscape mode for the component to be inactive| 500