Naboo's Podracing Misadventure

    @procore/core-react
    TypeScript icon, indicating that this package has built-in type declarations

    11.0.2 • Public • Published

    CORE React npm npm

    A set of React components implementing the design system spec.

    Requirements

    Node 14+ NPM or Yarn

    Usage

    Install

    Install @procore/core-react from NPM.

    yarn add @procore/core-react

    or

    npm install @procore/core-react

    Install the peer dependencies.

    yarn add formik styled-components react react-dom

    Imports

    Named imports support tree shaking and types.

    import { Button, ButtonProps } from '@procore/core-react'
    import { Cog } from '@procore/core-icons'
    
    export function ButtonCustom(props: ButtonProps) {
      return <Button {...props} icon={<Cog />} />
    }

    Developing

    To get started, type the following from the project root directory:

    yarn

    All commands below will be ran in the package directory:

    cd packages/core-react

    We use Storybook to develop. Stories are broken into two categories, Demos for interactions and Coverage for displaying variants.

    yarn storybook

    Testing

    Testing currently consists of Jest snapshots, Enzyme tests, and React Testing Library tests.

    yarn test

    Visual Regression Testing is ran in CI, pixel snapshots of Coverage stories.

    Building

    yarn build
    

    Contributing and Styleguide

    Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

    In lieu of a formal styleguide, we use husky to create a precommit hook, which executes lint-staged to automatically format any git staged files using prettier.

    License

    The package is available under the Procore Developers License

    About Procore

    Procore Logo

    Procore - building the software that builds the world.

    Learn more about the #1 most widely used construction management software at procore.com

    Install

    npm i @procore/core-react

    DownloadsWeekly Downloads

    4,740

    Version

    11.0.2

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    5.1 MB

    Total Files

    1409

    Last publish

    Collaborators

    • ryanfuentesprocore
    • stajics
    • brocktillotsonprocore
    • kyle.williams
    • greg.spies
    • dtorres-procore
    • noor.ali
    • ari-procore
    • alanprocore
    • jl4ever
    • james.lawson
    • ajaykumar-procore
    • dennis.heckman
    • tara.chambers
    • lalovar-procore
    • james.cleary
    • chadryder
    • devin.cunningham.procore
    • abhijit.patwardhan
    • maxscott_pc
    • lydiahara
    • sherylnapigkit
    • changprocore
    • apcarroll_procore
    • andy.mayer
    • bob.laskowski
    • vinaya-procore
    • r-pulling
    • kahliholmes
    • amanzhula-zoolatech
    • andrew.wheeler
    • leandro-proc
    • yadhu.prakash
    • jason-kaye
    • initbar-procore
    • jesse.olsen
    • jsoncummings
    • patrick.lardin
    • brad.urani
    • ian.nguyen
    • allenanle.procore
    • ismail.hassan
    • brookyboy009
    • uddhavjoglekar
    • dancingshell
    • justinmwatts
    • rysmithprocore
    • bostonaholic
    • robbiegprocore
    • jadamsss
    • jeremy.bouzigard
    • dallashall-procore
    • bates550
    • timdoherty
    • b.bookout
    • jalyng
    • chrisarevir
    • htael
    • espi
    • truthysystems
    • dev-account-admin
    • sseanwang
    • bhargavrnd
    • dannyphillips
    • farismmk
    • dannyporrello
    • mcclayton
    • gregburger
    • danny.ou
    • messanjah
    • eyvettesou
    • jgee67
    • chriszhang
    • arthurzhuk
    • cagmz
    • mariah_delaney
    • lukenispel
    • kimhin267
    • hyogman
    • juliana.hernandez
    • evan.freymiller
    • manuphatak
    • judy-lu-pc
    • procore-it-support
    • wilfredr
    • andrewburke-pc
    • jkleintech
    • rachel.arkebauer
    • aaronme
    • procore-npm-bot
    • lincolnp
    • james.dabbs-procore
    • laurenbrandsteinprocore
    • kimtodd
    • scottbieser-procore
    • fkennedy
    • zach.mckenzie.procore
    • natalie.walia
    • kapoorlakshya-procore
    • shayonj_procore
    • heplayskeys
    • mike.south
    • thomasoboyle
    • dischorde
    • derek-carter-procore
    • dlgasser
    • moises.narvaez-procore
    • cfprocore
    • rory.forster
    • lgm_procore
    • evan.waits
    • todd-andrew-procore
    • jeremy-marcus
    • israel-pereira
    • jmejia-fsl
    • kedar.procore
    • ersgonzalo
    • stephan-procore
    • aleclarsenprocore
    • himansudesai
    • yihai.zweifel
    • jay-rajan
    • jacky-lei
    • bpross22
    • peter.jin