React

<p align="center"> <img alt="Primer logo" width="300px" src="https://user-images.githubusercontent.com/4608155/127241386-f11da52d-00d9-4366-b01c-6f4c1ebcf7f2.png"> </p> <h1 align="center">Primer React</h1> <p align="center">A React implementation of GitHub's Primer Design System</p> <p align="center"> <a aria-label="npm package" href="https://www.npmjs.com/package/@primer/react"> <img alt="npm package" src="https://img.shields.io/npm/v/@primer/react.svg"> </a> <a aria-label="contributors graph" href="https://github.com/primer/react/graphs/contributors"> <img alt="contributors graph" src="https://img.shields.io/github/contributors/primer/react.svg"> </a> <a aria-label="last commit" href="https://github.com/primer/react/commits/main"> <img alt="last commit" src= "https://img.shields.io/github/last-commit/primer/react.svg"> </a> <a aria-label="license" href="https://github.com/primer/react/blob/main/LICENSE"> <img alt="license" src="https://img.shields.io/github/license/primer/react.svg" alt=""> </a> </p>

Documentation

Our documentation site lives at primer.style/react. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

Installation

Install @primer/react in your project with your package manager of choice:

npm install @primer/react

yarn add @primer/react

Template

The fastest way make a prototype or try Primer React without setting up a new project is by using our react template.

Contributing

We love collaborating with folks inside and outside of GitHub and welcome contributions!

👉 See the contributing docs for more info on code style, testing, coverage, and troubleshooting.

New Component Proposals

We welcome and encourage new component proposals from internal GitHub teams! Our best work comes from collaborating directly with the teams using Primer React Components in their projects. If you'd like to kick off a new component proposal, please submit an issue using the component proposal issue template and we will get in touch!