Interface: HandleHTMLDimensionsOptions

Options for HandleHTMLDimensionsFeature.

Hierarchy

  • HandleHTMLDimensionsOptions

Properties

deltaMin

• Optional deltaMin: number

The minimum difference between two updates' dimensions to trigger a change event.

defaultvalue 0


forceImplementation

• Optional forceImplementation: HTMLDimensionsImplementation | false

Force a specific implementation, if the underlying API is available.

warning: forcing to 'polling' might increase battery consumption.

remarks

This option is useful in development to force one implementation to mock older browsers.

defaultvalue false


listenToWindowResizeEvent

• Optional listenToWindowResizeEvent: boolean

Allow or disallow using window.addEventListener('resize', handler) to complement dimensions extraction.

remarks This option only affects 'polling' and 'resize' implementations.

defaultvalue true


pollingInterval

• Optional pollingInterval: number

In polling mode, at which interval should the dimensions be retrieved?

remarks A value of 0 will disable polling.

defaultvalue 200