bloombergindustry / fishtank-vue

Fish Tank Design and Component System - VueJS Component Library

Fishtank Vue

Fish Tank VueJS Component Module

Installation

npm install @fishtank/fishtank-vue

Usage

Please reference https://fishtank.bna.com for detailed documentation

ESM Module

Import the component from the library module

import { FishTankCard } from @fishtank/fishtank-vue

extend default {
  components:{
    FishTankCard
  }
}

CommonJS Module

Import the component library module, and reference the desired component

const fishtank = require(“@fishtank-vue”)

extend default {
  components:{
    fishtank.FishTankCard
  }
}

OR

const card = require(“@fishtank-vue”).FishTankCard

extend default {
  components:{
    card
  }
}

Component CSS

Fishtank-vue provides styles are compiled and self-contained within the component itself. There are no additional CSS imports.

Contributing

Contributing Documentation

Dev Environment Setup

# install dependencies
npm install

# or
yarn

# serve with hot reload at localhost:8080
npm run serve 

#or
yarn serve