UI Components for React
Clone or download
Latest commit 7a41fb9 Jan 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Apr 6, 2018
exports Fixed #671 - Slider.d.ts error Dec 24, 2018
public Fixed #725, Fixed #722 Jan 9, 2019
src Hidden select should always be rendered Jan 10, 2019
.gitignore gitignore update Aug 21, 2018
.npmignore Ignore exports Jul 6, 2018
.nvmrc added .nvmrc file Jan 5, 2017
LICENSE.md Update to latest react-scripts Dec 17, 2018
README.md Readme fix Aug 29, 2018
gulpfile.js Fixed build to include themes Aug 25, 2018
package.json Set version Jan 10, 2019

README.md

Join the chat at https://gitter.im/primefaces/primereact

PrimeReact

PrimeReact is a rich set of open source UI Components for React.

alt text

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.

npm install primereact --save
npm install primeicons --save

Import

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

Dependencies

Majority of PrimeReact components (95%) are native and there are some exceptions having 3rd party dependencies such as Google Maps for GMap.

In addition, components require PrimeIcons for icons, classNames package to manage style classes and react-transition-group for animations.

dependencies: {
    "react": "^16.0.0",
    "react-dom": "^16.0.0",
    "react-transition-group": "^2.2.1",
    "classnames": "^2.2.5",
    "primeicons": "^1.0.0-beta.10"
}

Styles

The css dependencies are as follows, note that you may change the theme with another one of your choice.

primereact/resources/themes/nova-light/theme.css
primereact/resources/primereact.min.css
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/nova-light/theme.css';
import 'primereact/resources/primereact.min.css';
import 'primeicons/primeicons.css';

QuickStart

An example application based on create-react-app is available at github.

TypeScript

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.