Skvsharedcomponents NPM

SV Shared Components

NPM Package Publishing from Github Workflow - POC

Prerequisites

This project requires NodeJS (version 14 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
8.12.1
v14.17.6

Project Name

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

To install and set up the library, run:

$ npm install -S skvsharedcomponents

Or if you prefer using Yarn:

$ yarn add --dev skvsharedcomponents

Usage

Serving the app

$ npm start

Running the tests

$ npm test

Building a distribution version

$ npm run build

This task will create a distribution version of the project inside your local dist/ folder

Components

Available Components

import {BasicButton, OutlineButton, Card } from 'skvsharedcomponents';

Supported options and result fields for the Available Components are listed below.

Options

Basic Button

<BasicButton  buttonSize = "btn--wide" buttonColor = "red">Hello, User</BasicButton>

Outline Button

<OutlineButton  buttonSize = "btn--wide" buttonBorderColor = "red-border">Hello, User</OutlineButton>

Type	Default value
buttonSize	'btn--wide', 'btn--large', 'btn--medium', 'btn--small'
buttonColor	'primary', 'black', 'red'

Cards

Props:

 const card = {
    cardHeader:{
      image:"imge-url", 
      title:"title" // Eg.NEWS,Blog
    },
    cardBody:{
      date:"Date", // Eg.SEPT 23, 2022
      title:"title", // Eg.This is Title
      content:"content",
      button:"button text"
    }
  }

Usgae: