Nanobot: Polygonal Mascot

    primereact

    8.3.0 • Public • Published

    License: MIT npm version Actions CI Discord Chat Stackoverflow

    PrimeReact Hero

    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.

    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>

    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 and react-transition-group for animations. The react-transition-group is available as dependencies in the npm package of PrimeReact.

    dependencies: {
        "react": "^17.0.0 || ^18.0.0",
        "react-dom": "^17.0.0 || ^18.0.0",
        "primeicons": "^5.0.0"
    }

    Optional

    Here is the list of components with 3rd party dependencies.

    Component Dependency
    Charts Charts.js 3.x
    GMap Google Maps
    Editor Quill.js
    FullCalendar* FullCalendar 4.0 Alpha.2+
    DataView PrimeFlex

    *Deprecated since v6.4.0

    Styles

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

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

    QuickStart

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

    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

    Install

    npm i primereact

    DownloadsWeekly Downloads

    49,392

    Version

    8.3.0

    License

    MIT

    Unpacked Size

    27.5 MB

    Total Files

    1027

    Last publish

    Collaborators

    • cagatay.civici
    • mert.sincan