Introducing npm Teams! Private packages + team management tools.Learn more »

seng-panoramarenderer

2.0.0 • Public • Published

Travis Code Climate Coveralls npm npm

seng-panoramarenderer

Provides functionality for displaying simple image (or video) panorama's including basic support for hotspots.

Installation

yarn add seng-panoramarenderer
npm i -S seng-panoramarenderer

Basic usage

Simple Panorama example (make sure the images are preloaded first).

import { PanoramaRenderer } from 'seng-panoramarenderer';
 
const renderer = new PanoramaRenderer(wrapperElement, imageSrc);
renderer.init();

For more examples, please check the examples directory.

Documentation

View the generated documentation.

Building

In order to build seng-event, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/mediamonks/seng-panoramarenderer.git

Change to the seng-panoramarenderer directory:

cd seng-panoramarenderer

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build            # build this project 
yarn dev              # run compilers in watch mode, both for babel and typescript 
yarn test             # run the unit tests incl coverage 
yarn test:dev         # run the unit tests in watch mode 
yarn lint             # run eslint and tslint on this project 
yarn doc              # generate typedoc documentation 

When installing this module, it adds a pre-commit hook, that runs lint and prettier commands before committing, so you can be sure that everything checks out.

Contribute

View CONTRIBUTING.md

Changelog

View CHANGELOG.md

Authors

View AUTHORS.md

LICENSE

MIT © MediaMonks

Install

npm i seng-panoramarenderer

DownloadsWeekly Downloads

9

Version

2.0.0

License

MIT

Unpacked Size

199 kB

Total Files

9

Last publish

Collaborators

  • avatar