README.md

PrimeReact

PrimeReact is a rich set of open source UI Components for React. See PrimeReact homepage for live showcase and documentation.

Download

PrimeReact is available at npm.

# Using npm
npm install primereact

# Using yarn
yarn add primereact

# Using pnpm
pnpm add primereact

Import

Each component can be imported individually so that you only bundle what you use. Import path is available in the documentation of the corresponding component.

//import { ComponentName } from 'primereact/{componentname}';
import { Button } from 'primereact/button';

export default function MyComponent() {
  return (
    <Button label="PrimeReact" />
  )
}

Theming

PrimeReact has two theming modes; styled or unstyled.

Styled Mode

Styled mode is based on pre-skinned components with opinionated themes like Material, Bootstrap or PrimeOne themes. Theme is the required css file to be imported, visit the Themes section for the complete list of available themes to choose from.

// theme
import 'primereact/resources/themes/lara-light-cyan/theme.css';

Unstyled Mode

Unstyled mode is disabled by default for all components. Using the PrimeReact context, set unstyled as true to enable it globally. Visit the Unstyled mode documentation for more information and examples.

Contributors