Get started using Primer React components in your React application.

Getting started

  1. Install @primer/react and its peer dependencies:

    npm install @primer/react react react-dom styled-components
  2. Wrap the root of your application with ThemeProvider and BaseStyles:

    import {ThemeProvider, BaseStyles} from '@primer/react'
    function App() {
    return (
  3. Import components from @primer/react and use them in your application:

    import {Button} from '@primer/react'
    function MyComponent() {
    return <Button>Click me</Button>

More information

See the primer/react repository for more information about how to use and contribute to Primer React. For component-specific documentation, check out the React section of component guidelines (example: ActionList).