@abi-software/map-side-bar

This project aims to provide a sidebar for searching capability for SPARC portal.

Usage no npm install needed!

<script type="module">
  import abiSoftwareMapSideBar from 'https://cdn.skypack.dev/@abi-software/map-side-bar';
</script>

README

map-side-bar

npm version

This project aims to provide a sidebar for searching capability for SPARC portal.

Project installation

npm i @abi-software/map-side-bar

Project setup

npm install
npm run serve

Compiles and minifies for production

npm run build-bundle

How to use

Include the package in your script.

import '@abi-software/map-side-bar'
import '@abi-software/map-side-bar/dist/map-side-bar.css'

Template

The code should looks like this

<SideBar :envVars="envVars"
         :visible="sideBarVisibility"
         @actionClick="actionClick">
</SideBar>

envVars contains environment varibables like so:

{
  API_LOCATION: 'http://localhost:5000/',
  ALGOLIA_KEY: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
  ALGOLIA_ID: 'xxxxx',
  ALGOLIA_INDEX: 'k-core_dev_published_time_desc',
}

actionClick event is called when an action button has benn clicked on.