Intro

c1-frontend-components is precisely as it sounds: a library of reuseable frontend components for Correlation One projects. The goal of the library is to minimize code reuse and maintain consistency across those projects.

Install Library

npm install c1-frontend-components

Simple Usage

import React from 'react';
import {Button} from 'c1-frontend-components';

const SimpleComponent = () => {
    return <Button
            text='Click Me'
            background=#000000
            onClick={() => console.log('Hello World)}
            />
};

export default SimpleComponent;

Complex Usage

To see the full list of components available, and their related props, please see our Style Guide.

For a comprehensive understanding of what each component can do, please check out the bottom panel on the guide for each component. In particular, look at:

• "Knobs": to dynamically play around with components live
• "Readme": to see what props exists for each component and usage examples

Running Storybook Locally

git clone [email protected]:correlation-one/frontend-components.git
npm install
npm run storybook

Bundle library for npm publish

npm run npm-build

Currently Published Components

• Buttons
• Toggles
• Checkboxes
• Notifications
• Radio Buttons
• Error Page
• Lists
• Submit Button
• Text Input
• Text Area
• Checkboxes
• Dropdown

Other Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.