https://github.com/mudin/vue-indoor
VueJS wrapper for indoorjs
https://github.com/mudin/vue-indoor
indoor-maps indoorjs vue vue-indoor
Last synced: 6 months ago
JSON representation
VueJS wrapper for indoorjs
- Host: GitHub
- URL: https://github.com/mudin/vue-indoor
- Owner: mudin
- License: mit
- Created: 2019-05-29T02:08:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-13T08:41:11.000Z (almost 5 years ago)
- Last Synced: 2024-11-05T03:37:28.860Z (7 months ago)
- Topics: indoor-maps, indoorjs, vue, vue-indoor
- Language: Vue
- Size: 731 KB
- Stars: 15
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-indoor
[](https://coveralls.io/github/mudin/vue-indoor?branch=master)
vue-indoor is a JavaScript library for the [Vue](https://vuejs.org/) framework that wraps [IndoorJS](http://indoorjsjs.com/) making it easy to create reactive indoor maps.
## How to install
```bash
npm install vue-indoor indoorjs --save
```
### Importing the library in Webpack / Rollup
Now the code of vue-indoor is split component by component (while using a bundler like Webpack/Rollup/Parcel) to do so the following syntax is not working anymore:
```javascript
import vue-indoor from 'vue-indoor' // INVALID
```
And has been replaced by
```javascript
import * as vue-indoor from 'vue-indoor' // VALID
```
Is highly suggested to import only the needed modules by doing so:
```javascript
import * as Indoor from 'indoorjs';
import { IMap, IFloor, IMap } from 'vue-indoor';
```
This will reduce the size of the bundle significantly
## Documentation
Coming soon
## Authors
Mudin Ibrahim
Inspired by many map wrapper (google and leaflet) for many framework (React, Angular and Vue 1.0)
## Contributors
Thanks goes to these [wonderful people](https://github.com/mudin/vue-indoor/contributors)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details