1.0.1 • Published 5 years ago

pxg-rocket-react v1.0.1

Weekly downloads
2
License
ISC
Repository
github
Last release
5 years ago

PXG Rocket React

Rocket is a vehicle leading to the moon. How to use this library? Just plug and play, as simple as that.

Structure

Component/Container

- ComponentName
  - ComponentName.tsx
  - ComponentName.stories.tsx
  - ComponentName.test.tsx

- ContainerName
  - ContainerName.tsx
  - ContainerName.stories.tsx
  - ContainerName.test.tsx

Available Components

  • Button
  • CompetitionA
  • Input
  • InputChat
  • Modal
  • Navigation
  • Text
  • DetailPageNavigation
  • MainNavigation
  • SearchNavigation

Tools

  • React
  • Typescript
  • Styled Components
  • Jest
  • Storybook

How to install

npm install pxg-rocket-react

How to use

import { Button } from 'pxg-rocket-react'
import { ThemeProvider } from 'pxg-rocket-react/libs/styled-components'

// Wrap app with ThemeProvider
<ThemeProvider theme={theme}>
  <App />
</ThemeProvider>

// Use in JSX
<Button variant="primary" size="md">Click Me!</Button>

How to run docs using Storybook

yarn
yarn storybook

How to test

yarn
yarn test