Class DeviceInformation

Hierarchy

DeviceInformation

Index

Constructors

constructor

new DeviceInformation(props): DeviceInformation
Parameters
- props: Props
Returns DeviceInformation
- Defined in utils/deviceInfo/deviceInfo.ts:45

Properties

`Private` `Optional` `Readonly` _browser

_browser?: Browser

`Private` _detailedDeviceInfo

_detailedDeviceInfo: DetailedDeviceInformationProvider

`Private` `Readonly` _deviceType

_deviceType: DeviceType

Represents an abstracted device type: desktop, tablet or mobile.

`Private` _dimensions

_dimensions: ScreenDimensions

Represents the viewport (layout and visual) and (full)screen dimensions. WebKit browsers prior to 15 will only support layout dimensions.

`Private` _orientation

_orientation: ScreenOrientation

Represents the current viewport orientation. If the viewport is square, it will default to portrait.

`Private` `Readonly` _userInput

_userInput: UserInput

Represents the current input source. Note: On a touchscreen device which has a mouse plugged in, it will return the mouse.

`Protected` orientationIsLandscapeQuery

orientationIsLandscapeQuery: MediaQueryList

Accessors

browser

get browser(): undefined | Browser
Returns undefined | Browser
- Defined in utils/deviceInfo/deviceInfo.ts:138

deviceType

get deviceType(): DeviceType
Returns DeviceType
- Defined in utils/deviceInfo/deviceInfo.ts:126

orientation

get orientation(): ScreenOrientation
Returns ScreenOrientation
- Defined in utils/deviceInfo/deviceInfo.ts:122

platform

get platform(): SupportedPlatforms | "Platform not found"
Returns SupportedPlatforms | "Platform not found"
- Defined in utils/deviceInfo/deviceInfo.ts:117

screenDimensions

get screenDimensions(): ScreenDimensions
Returns ScreenDimensions
- Defined in utils/deviceInfo/deviceInfo.ts:134

userInput

get userInput(): UserInput
Returns UserInput
- Defined in utils/deviceInfo/deviceInfo.ts:130

Methods

`Private` getBrowser

getBrowser(): undefined | Browser
Returns undefined | Browser
- Defined in utils/deviceInfo/deviceInfo.ts:86

getDeviceDetails

getDeviceDetails(): DetailedDeviceInformation
Returns DetailedDeviceInformation
- Defined in utils/deviceInfo/deviceInfo.ts:113

getDeviceSummary

getDeviceSummary(): IDeviceSummary
Returns IDeviceSummary
- Defined in utils/deviceInfo/deviceInfo.ts:142

`Private` getDeviceType

getDeviceType(): DeviceType
Returns the current viewing medium.

Returns DeviceType
- Defined in utils/deviceInfo/deviceInfo.ts:104

`Private` getOrientation

getOrientation(): ScreenOrientation
Returns ScreenOrientation
- Defined in utils/deviceInfo/deviceInfo.ts:108

`Private` getUpdatedScreenDimensions

getUpdatedScreenDimensions(): ScreenDimensions
Returns ScreenDimensions
- Defined in utils/deviceInfo/deviceInfo.ts:59

`Private` getUserInput

getUserInput(): "touch" | "mouse"
Returns "touch" | "mouse"
- Defined in utils/deviceInfo/deviceInfo.ts:98

Class DeviceInformation

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: Props

Returns DeviceInformation

Properties

Private Optional Readonly _browser

Private _detailedDeviceInfo

Private Readonly _deviceType

Private _dimensions

Private _orientation

Private Readonly _userInput

Protected orientationIsLandscapeQuery

Accessors

browser

Returns undefined | Browser

deviceType

Returns DeviceType

orientation

Returns ScreenOrientation

platform

Returns SupportedPlatforms | "Platform not found"

screenDimensions

Returns ScreenDimensions

userInput

Returns UserInput

Methods

Private getBrowser

Returns undefined | Browser

getDeviceDetails

Returns DetailedDeviceInformation

getDeviceSummary

Returns IDeviceSummary

Private getDeviceType

Returns DeviceType

Private getOrientation

Returns ScreenOrientation

Private getUpdatedScreenDimensions

Returns ScreenDimensions

Private getUserInput

Returns "touch" | "mouse"

Settings

Member Visibility

Theme

On This Page

`Private` `Optional` `Readonly` _browser

`Private` _detailedDeviceInfo

`Private` `Readonly` _deviceType

`Private` _dimensions

`Private` _orientation

`Private` `Readonly` _userInput

`Protected` orientationIsLandscapeQuery

`Private` getBrowser

`Private` getDeviceType

`Private` getOrientation

`Private` getUpdatedScreenDimensions

`Private` getUserInput