React Pakistan

React Pakistan is an OpenSource & Free Software (FOSS) platform, creating React software solutions for the global community.

React Commons Collection

A generic, Commons library for React web apps, following modern approach by building your project's UI in isolation using state of the art Storybook along with React.

Install

Add React Commons Collection to your project.

yarn add @react-pakistan/react-commons-collection or npm install @react-pakistan/react-commons-collection

Add React Commons Collection base theme to your project.

yarn add @react-pakistan/util-functions or npm install @react-pakistan/util-functions

Styles

Styled Components are employed to maintain and update theme for this project. Please consider adding Styled Component Provider wrapper to the entry point of your application, following is the sample code. You could either use the default theme as shown below or wire your custom theme object instead. See Typography & Colors being used in the theme object.

  import { ThemeProvider } from 'styled-components';
  import { theme } from '@react-pakistan/util-functions';

  <ThemeProvider theme={theme}>
    <App />
  </ThemeProvider>

Use

Refer to React Pakistan Docs for detail usage docs.