kjahan-component-library

About

Theme and components

Made with create-react-library

Regarding React 16 / Node 18

Component Library v2+ is meant to be FedRamp Compliant as such we have raised the minimum versions of the following

• React >= 16.x
• Node >= 18.x Anyone who does NOT or cannot use React 16+ / Node 18+ yet in their repository can use the Component Library Version [1.0.4] which is using React ^16.9.0 and Node >=10

Install

CL version < 2.0.1

yarn add @social-solutions/component-library

CL version >= 2.0.1

npm install @social-solutions/component-library

• NOTE: If you run into "Could not find declaration file for module '@social-solutions/component-library' follow these steps
  • Create a new file declarations.d.ts in src/types/@social-solutions/component-library/declarations.d.ts.
  • Add declare module '@social-solutions/component-library';

Deployment

View the live published component library here: Hosted Storybook

Updates that are merged into the master branch are automatically published through Bitbucket pipelines.

Manual deployment is discouraged, but if necessary, the following steps can be used: CL version < 2.0.1

• yarn build-storybook CL version >= 2.0.1
• npm run build-storybook
• aws s3 sync ./storybook-static s3://ssg-component-library

Usage

import React, { Component } from 'react'

import Icons from '@social-solutions/component-library';

const IconContainer = () => (
  <React.Fragment>
    <Icons.Pencil />
    <Icons.TrashCan />
    <Icons.QuestionMark />
  </React.Fragment>
);

Contributing

Get started here