Contents

Displays

Access to currently connected displays.

Properties

primary

readonly primary: Display | null;

The current primary display.

Usually non-null, but may be null in headless environments or when the platform cannot report display information.

all

readonly all: readonly Display[];

All currently connected displays.

Events

‘displayConnected’

on(event: 'displayConnected', listener: (display: Display) => void): void;
off(event: 'displayConnected', listener: (display: Display) => void): void;

Emitted when a new display becomes available.

Example

import { displays } from '@mobrowser/api';

displays.on('displayConnected', (display) => {
  console.log('Display connected:', display.name || display.id)
})

‘displayDisconnected’

on(event: 'displayDisconnected', listener: (display: Display) => void): void;
off(event: 'displayDisconnected', listener: (display: Display) => void): void;

Emitted when a display is no longer available.

Example

import { displays } from '@mobrowser/api';

displays.on('displayDisconnected', (display) => {
  console.log('Display disconnected:', display.name || display.id)
})

‘displayChanged’

on(event: 'displayChanged', listener: (display: Display) => void): void;
off(event: 'displayChanged', listener: (display: Display) => void): void;

Emitted when a display’s bounds, work area, resolution, scale factor, primary state, or other reported display information changes.

Example

import { displays } from '@mobrowser/api';

displays.on('displayChanged', (display) => {
  console.log('Display changed:', display.id)
})