@pga/pga-component-library

    1.4.47 • Public • Published

    pga-component-library

    Travis npm package Coveralls

    React Component Library for internal component sharing.

    How to use

    • View available components at PGA Labs
      • Make sure you read Notes tab on the bottom pane for specific component instructions
    • run npm install --save @pga/pga-component-library in project directory
    • import components into your project, for example: import { Header } from '@pga/pga-component-library'

    How To Contribute

    • Understand the structure of the repo.
      • This is really 2 repo's in one. The component-library, which utilizes NWB and the Storybook
      • When making a reusable component, please review the Storybook Documentation and NWB.
    • Create component and be sure to:
      • Add it to Storybook stories under /stories/components/<your-story> with propTypes and good instructions.
      • export it at src/index.js
      • Make sure it's well tested in src/__tests__
    • Make a PR! CircleCI should automatically deploy to NPM and publish new changes to our component library website on merge with master.
      • IMPORTANT Before making a PR: run npm run bump-version to change the version number in package.json

    Happy hacking!

    Install

    npm i @pga/pga-component-library

    Homepage

    pga.org

    DownloadsWeekly Downloads

    473

    Version

    1.4.47

    License

    MIT

    Unpacked Size

    13.8 MB

    Total Files

    605

    Last publish

    Collaborators

    • silvait
    • bsubedi26
    • van100j
    • jasonwalkow
    • georgeismike
    • kevinjscott
    • pgamachineuser