@nkbt/geovis

geovis

React component-wrapper to swap one element with another and back, useful to show/hide popups, expand/collapse elements, various toggles, etc.

Installation

NPM

npm install --save @nkbt/geovis react redux react-redux three

Don't forget to manually install peer dependencies (react, redux, react-redux, three) if you use npm@3.

Bower:

bower install --save https://unpkg.com/@nkbt/geovis/bower.zip

1998 Script Tag:

<script src="https://unpkg.com/react/dist/react.min.js"></script>
<script src="https://unpkg.com/redux/dist/redux.min.js"></script>
<script src="https://unpkg.com/react-redux/dist/react-redux.min.js"></script>
<script src="https://unpkg.com/three/build/three.min.js"></script>
<script src="https://unpkg.com/@nkbt/geovis/build/geovis.js"></script>
(Module exposed as `GeoVis`)

Demo

http://nkbt.github.io/geovis

Codepen demo

// TODO

Usage

const React = require('react');
const ReactDOM = require('react-dom');
const {createStore, combineReducers} = require('redux');
const {Provider} = require('react-redux');
const {App, attacks, controls} = require('@nkbt/geovis');

const el = React.createElement;

const store = createStore(combineReducers({attacks, controls}));

const appRoot = document.createElement('div');
appRoot.id = 'app';
document.body.appendChild(appRoot);
ReactDOM.render(el(Provider, {store}, el(App)), appRoot);

Options

// TODO

Development and testing

Currently is being developed and tested with the latest stable Node 6 on OSX and Windows.

To run example covering all GeoVis features, use npm start dev, which will compile src/example/Example.js

git clone [e-mail]:nkbt/geovis.git
cd geovis
npm install
npm start dev

# then
open http://localhost:8080

Tests

# to run tests
npm start test

# to generate test coverage (./reports/coverage)
npm start test.cov

# to run end-to-end tests
npm start test.e2e

License

MIT