ronnykind/primereact

The Most Complete React UI Component Library

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, if you have an existing application run the following command to download it to your project.

// with npm
npm install primereact primeicons

// with yarn
yarn add primereact primeicons

Please note that react >= 17.0.0 and react-dom >= 17.0.0 are peer dependencies and some components have optional dependencies.

Styles

Theme, core and icons are the necessary css files of the components, visit the Themes section for the complete list of available themes to choose from. In upcoming version 10, a css-in-js approach will be implemented along with migration to SVG icons to remove the requirement to install css files.

//theme
import "primereact/resources/themes/lara-light-indigo/theme.css";     
    
//core
import "primereact/resources/primereact.min.css";

//icons
import "primeicons/primeicons.css";

If you are using a bundler such as webpack with a css loader you may also import them to your main application component, an example from create-react-app would be.

import 'primereact/resources/themes/lara-light-indigo/theme.css';
import 'primereact/resources/primereact.min.css';
import 'primeicons/primeicons.css';

Import

Module

//import { ComponentName } from 'primereact/{componentname}';
import { Dialog } from 'primereact/dialog';
import { Accordion, AccordionTab } from 'primereact/accordion';

CDN

<script src="https://unpkg.com/primereact/core/core.min.js"></script>
<script src="https://unpkg.com/primereact/accordion/accordion.min.js"></script>
//<script src="https://unpkg.com/primereact/{componentname}/{componentname}.min.js"></script>

const { Dialog } = primereact.dialog;
const { Accordion, AccordionTab } = primereact.accordion;

Import all components and structures

<script src="https://unpkg.com/primereact/primereact.all.min.js"></script>

QuickStart

Example applications based on create-react-app and Next.js are available at github.

Next.js PrimeReact has first class support for SSR and Next.JS, in fact this website is also built with Next.js

CRA Create-React-App is the official scaffolding project by Facebook

TypeScript

Typescript is fully supported as type definition files are provided in the npm package of PrimeReact. A sample typescript-primereact application is available as well at github.

Contributors