Flow

⚠️ This is a legacy version of Flow UI library and is no longer maintained. Please use Flow 2 for future projects.

Flow is a lightweight UI component library based on Vue. It uses StorybookJS as showcase app and sandbox to build components in isolation.

Table of contents

• Prerequisites
• Technologies
• Local Setup
• Usage

Prerequisites

To use the Flow library, you should be familiar with the following:

Node.js

Flow requires node version 16+. For more information on installing Node.js, see nodejs.org. If you are unsure what version of Node.js runs on your system, run node -v in a terminal window.

Vue.js

Vue is a progressive framework for building user interfaces. For more information , see vuejs.org

Technologies

Project is created with:

• Vue: 2.6.+
• Storybook: 6.0.+
• SASS: 1.26.+

Local Setup

To run flow library locally, Go to root folder of flow and run following command:

1. Using yarn

yarn && yarn start

Usage

This guide explains how to setup your Vue project to begin using Flow library.Your Vue.js project must be on version 2.6.*.

1. Install via yarn

yarn add @cldcvr/flow

1. Import Flow CSS in your codebase

import "@cldcvr/flow/dist/style.css";

1. Import Component in your Vue file like below

import { Icon, Button, Pictogram } from "@cldcvr/flow";

Support

We have a Slack channel where you can check for announcements and raise questions.