and-component-library/README.md

Distribution of AND Web Components

# And Component Library 

This is shared UI component library project that can be used across AND digital web projects.

Currently all the components are exported as a standard Web Components, hence, it can be used in any front-end projects irrespective of the tech stack that you choose for your project.

The documentation and an interactive Storybook of the available components can be found here: https://and-component-library.netlify.app/

*Note that you will need to have [Node.js](https://nodejs.org) installed.*


## Install

Install this package: npm install and-component-library --save

## How to configure

Once after you install this package in your project, import the specific components that you need from And Component Library's javascript by adding import statement to your app’s entry point (usually index.js or app.js):

  import 'and-component-library/<component-name>'

  Example: To import button compoent from this library, you may have to include the following line in your app:

  import 'and-component-library/Button'

*Note This project generates web components as Shadow-Dom, so refer to the component's documentation to alter the attributes, as the styles may not be overridden with css override and to apply the "Poppins" font to the components, use @import url(https://fonts.googleapis.com/css2?family=Poppins) in the root CSS file of your project e.g. index.css *

## Documentation

This is the storybook-documentation link for the components library:

https://and-component-library.netlify.app