ResonantGeo is a set of Vue components built on top of Vuetify for quickly prototyping geospatial applications. Each component is self-contained and does not rely on any global state or server infrastructure. Component inputs are props and outputs are events. For props requiring two-way data binding, the .sync modifier is supported following the Vue documentation. To summarize, these props emit update:<prop name> events to request that the parent component update the value rather than doing so directly.

To include a component into an existing application, just install the npm package

npm install resonantgeo

and register the plugin with Vue.

import Resonantgeo from 'resonantgeo';
import Vue from 'vue';

Vue.use(Resonantgeo);

ResonantGeo will then be ready to use in your applications components.

<template>
  <side-panel :expanded.sync="expanded">
  </side-panel>
</template>

<script>
export default {
  data() {
    return {
      expanded: true,
    };
  }
};
</script>

To start a new project from scratch, you can use one of the Vue cli templates to initialize a new application using the same development environment used by the library itself. Two templates exist, jbeezley/resonantgeo-webpack-simple is a basic example of an application with no testing and a simple webpack configuration, while jbeezley/resonantgeo-webpack is a full featured example with unit and end-to-end testing and a webpack configuration suitable for production builds.

To get started, just invoke the vue cli as follows

npm install -g vue-cli
vue init jbeezley/resonantgeo-webpack-simple

There are example applications using ResonantGeo inside the examples directory. Individual examples can be built and served locally by running yarn && yarn dev inside each subdirectory.

Component documentation is in progress...

See CONTRIBUTING.md for instructions on how to develop and contribute to ResonantGeo.