wadetandy/fishtank-vue

Fish Tank Design System - Fish Tank Vue Component Library

Fishtank Vue

Fish Tank VueJS Component Module

Installation

npm install @fishtank/fishtank-vue

Available Components

• Cards
• Modal - Modal Component
• Buttons
  • Primary
  • Secondary
  • Destructive
• Radios
• Switches
• Loaders
• Text Input

Usage

ESM Module

Import the component from the library module

import { Card } from @fishtank/fishtank-vue

extend default {
  components:{
    Card
  }
}

CommonJS Module

Import the component library module, and reference the desired component

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

extend default {
  components:{
    fishtank.Card
  }
}

Component CSS

Fishtank-vue provides styles as:

• dist/fishtank-vue.css: a single CSS file of all component styles
• dist/styles: component specific stylesheets

Import the full library, or per component styles, into your project as necessary.

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