|
1 | | -[](https://opensource.org/licenses/MIT) |
2 | | -[](https://badge.fury.io/js/primereact) |
3 | | - |
4 | | -[](https://github.com/primefaces/primereact/actions/workflows/node.js.yml) |
5 | | -[](https://discord.gg/gzKFYnpmCY) |
6 | | -[](https://stackoverflow.com/questions/tagged/primereact) |
7 | | -[](https://github.com/orgs/primefaces/discussions) |
8 | | - |
9 | | -[](https://www.primereact.org) |
10 | | - |
11 | 1 | # PrimeReact |
12 | 2 |
|
13 | | -PrimeReact is a rich set of open source UI Components for React. See [PrimeReact homepage](https://primereact.org/) for live showcase and documentation. |
14 | | - |
15 | | -## Download |
16 | | - |
17 | | -PrimeReact is available at [npm](https://www.npmjs.com/package/primereact). |
18 | | - |
19 | | -``` |
20 | | -# Using npm |
21 | | -npm install primereact |
22 | | -
|
23 | | -# Using yarn |
24 | | -yarn add primereact |
25 | | -
|
26 | | -# Using pnpm |
27 | | -pnpm add primereact |
28 | | -``` |
29 | | - |
30 | | -## Import |
31 | | - |
32 | | -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. |
| 3 | +### The next chapter has begun. |
33 | 4 |
|
34 | | -```javascript |
35 | | -//import { ComponentName } from 'primereact/{componentname}'; |
36 | | -import { Button } from 'primereact/button'; |
| 5 | +After years as an open source library, PrimeReact enters its next chapter as part of **PrimeUI**, a sustainable foundation for the libraries you rely on. |
37 | 6 |
|
38 | | -export default function MyComponent() { |
39 | | - return ( |
40 | | - <Button label="PrimeReact" /> |
41 | | - ) |
42 | | -} |
43 | | -``` |
| 7 | +This repository is now **archived**. It remains available, as a record of everything built here together. |
44 | 8 |
|
45 | | -## Theming |
| 9 | +## What this means |
46 | 10 |
|
47 | | -PrimeReact has two theming modes; styled or unstyled. |
| 11 | +**Existing MIT versions remain MIT, forever.** |
| 12 | +Every release published under the MIT license stays exactly as it is. Your existing projects are unaffected. Nothing is taken away. |
48 | 13 |
|
49 | | -**Styled Mode** |
| 14 | +**Development continues at a new home.** |
| 15 | +Active development, new releases, and everything ahead now live under PrimeUI. |
50 | 16 |
|
51 | | -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](https://primereact.org/theming) section for the complete list of available themes to choose from. |
| 17 | +➡️ **Read the announcement:** [primeui.dev/nextchapter](https://primeui.dev/nextchapter) |
52 | 18 |
|
53 | | -```javascript |
54 | | -// theme |
55 | | -import 'primereact/resources/themes/lara-light-cyan/theme.css'; |
56 | | -``` |
| 19 | +➡️ **The journey continues at:** [primereact.dev](https://primereact.dev) |
57 | 20 |
|
58 | | -**Unstyled Mode** |
| 21 | +## Thank you |
59 | 22 |
|
60 | | -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](https://primereact.org/unstyled) documentation for more information and examples. |
| 23 | +To everyone who used PrimeReact, filed an issue, opened a pull request, answered a question, or simply built something with it, thank you. This library reached hundreds of millions of downloads because of you. |
61 | 24 |
|
62 | | -## Contributors |
| 25 | +This archive stays here as a thank you and a milestone. The next chapter is just beginning, and we hope you'll be part of it. |
63 | 26 |
|
64 | | -<a href="https://github.com/primefaces/primereact/graphs/contributors"> |
65 | | - <img src="https://contrib.rocks/image?repo=primefaces/primereact" /> |
66 | | -</a> |
| 27 | +— The PrimeTek Team |
0 commit comments