Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.42 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.42 KB

License: MIT npm version primereact Actions CI Discord Chat Stackoverflow Prime Discussions

PrimeReact Hero

PrimeReact

PrimeReact is available at npm.

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

// with yarn
yarn add primereact

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

Styles

Theme is the necessary css file of the components, visit the Themes section for the complete list of available themes to choose from.

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

Each PrimeReact theme has its own font family so it is suggested to apply it to your application for a unified look.

body {
    font-family: var(--font-family);
}

Usage

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.

Module

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

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

Getting Started with NextJS and PrimeReact

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

Getting Started with PrimeReact

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