react-mapexplorer

react-mapexplorer

A react component used to display a Map Explorer from chainscript.

Demo & Examples

Live demo: stratumn.github.io/react-mapexplorer

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use react-mapexplorer is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-mapexplorer.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-mapexplorer --save

Usage

Simply include the MapExplorer component in your React application:

var MapExplorer = require('react-mapexplorer').MapExplorer;

// OR with ES6 import
import { MapExplorer } from 'react-mapexplorer';

<MapExplorer mapId={mapId} applicationUrl={applicationUrl} />

Properties

• mapId: The ID of the map that should be displayed

• applicationUrl: The remote URL listened by the agent.

• chainscript: A JSON chainscript.

• evidenceComponent: An optional component used to rendered the evidence associated with a segment (uses the BitcoinEvidence component by default)

Notes

Either (mapId and applicationUrl) OR chainscript must be set. If you'd like to develop your own evidence component, you can have a look at src/DummyEvidence.js for instance.

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

Copyright 2017 Stratumn SAS. All rights reserved.

Unless otherwise noted, the source files are distributed under the Apache License 2.0 found in the LICENSE file.