@polar/plugin-fullscreen

1.2.1 • Public • Published

Fullscreen

Scope

The fullscreen plugin allows viewing the map in fullscreen mode. It relies solely on the HTML Fullscreen API, where you can also find more about browser support.

Configuration

fullscreen

fieldName type description
renderType 'iconMenu' | 'independent'? Whether the fullscreen button is being rendered independently or as part of the IconMenu. Defaults to 'independent'.
targetContainerId string Specifies the html element on which the fullscreen mode should be applied. If the parameter is omitted, it falls back to the configured global field containerId.

Store

State

map.subscribe('plugin/fullscreen/isInFullscreen', (isInFullscreen) => {
  /* Your code. */
})

The returned flag indicates whether the MapClient in in fullscreen mode.

Readme

Keywords

none

Package Sidebar

Install

npm i @polar/plugin-fullscreen

Weekly Downloads

5

Version

1.2.1

License

EUPL-1.2

Unpacked Size

24.3 kB

Total Files

10

Last publish

Collaborators

  • dopenguin
  • sende