https://github.com/primer/react

An implementation of GitHub's Primer Design System using React
https://github.com/primer/react

component-library design-system primer react

Last synced: 3 days ago
JSON representation

An implementation of GitHub's Primer Design System using React

• Host: GitHub
• URL: https://github.com/primer/react
• Owner: primer
• License: mit
• Created: 2018-02-17T00:09:05.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T13:26:05.000Z (about 1 month ago)
• Last Synced: 2024-10-29T14:51:47.820Z (about 1 month ago)
• Topics: component-library, design-system, primer, react
• Language: TypeScript
• Homepage: https://primer.style/guides/react
• Size: 356 MB
• Stars: 3,139
• Watchers: 33
• Forks: 535
• Open Issues: 105
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-github-repos - primer/react - An implementation of GitHub's Primer Design System using React (TypeScript)
• react-cheatsheet - Primer
• best-of-react - GitHub - 11% open · ⏱️ 06.06.2024): (UI Frameworks & Libraries)

README

        


  



Primer React


A React implementation of GitHub's Primer Design System




  

    

  

  

    

  

  

    

  

  

    

  



## Documentation

Our documentation site lives at [primer.style/react](https://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:

```console

npm install @primer/react

```

```console

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](https://github.com/primer/react-template).

## Roadmap

You can track our roadmap progress in the [Roadmap Project Board](https://github.com/primer/react/projects/3), see more detail in the [quarterly planning Discussions](https://github.com/primer/react/discussions?discussions_q=%5BRoadmap%5D), and find a [list of all the current epic tracking issues](https://github.com/primer/react/discussions/997).

## Contributing

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

> 👉 See [the contributing docs](contributor-docs/CONTRIBUTING.md) 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](https://github.com/primer/react/issues/new?template=new-component-proposal.md) and we will get in touch!