Viewport

viewport is a utility JavaScript library to control viewport.

Introduction

Installation

Yarn

yarn add @pluginjs/viewport

NPM

npm i @pluginjs/viewport

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/viewport/dist/viewport.js"></script>

Production:

<script src="https://unpkg.com/@pluginjs/viewport/dist/viewport.min.js"></script>

API

on

Parameters

| Name | Type | Description | |||-| | eventName | String | | | func | Function | handler | | instance | Object | instance |

off

Parameters

| Name | Type | Description | |||-| | eventName | String | | | func | Function | handler |

eventMapper

Parameters

| Name | Type | Description | |||-| | eventName | String | | | func | Function | handler |

isVisible

Returns

| Name | Type | Description | |||-| | isIntersecting | Boolean | |

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/viewport is Licensed under the GPL-v3 license.

If you want to use @pluginjs/viewport project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.