@primevue/mcp 4.5.5 → 5.0.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/LICENSE.md +45 -21
  2. package/README.md +48 -250
  3. package/data/components.json +47269 -0
  4. package/data/llms/components/accordion.md +629 -0
  5. package/data/llms/components/animateonscroll.md +165 -0
  6. package/data/llms/components/autocomplete.md +995 -0
  7. package/data/llms/components/avatar.md +264 -0
  8. package/data/llms/components/badge.md +200 -0
  9. package/data/llms/components/blockui.md +99 -0
  10. package/data/llms/components/breadcrumb.md +269 -0
  11. package/data/llms/components/button.md +902 -0
  12. package/data/llms/components/card.md +209 -0
  13. package/data/llms/components/carousel.md +506 -0
  14. package/data/llms/components/cascadeselect.md +1207 -0
  15. package/data/llms/components/chart.md +1022 -0
  16. package/data/llms/components/checkbox.md +401 -0
  17. package/data/llms/components/chip.md +206 -0
  18. package/data/llms/components/colorpicker.md +213 -0
  19. package/data/llms/components/commandmenu.md +660 -0
  20. package/data/llms/components/compare.md +407 -0
  21. package/data/llms/components/confirmdialog.md +343 -0
  22. package/data/llms/components/confirmpopup.md +252 -0
  23. package/data/llms/components/contextmenu.md +522 -0
  24. package/data/llms/components/datatable.md +5266 -0
  25. package/data/llms/components/dataview.md +569 -0
  26. package/data/llms/components/datepicker.md +964 -0
  27. package/data/llms/components/deferredcontent.md +96 -0
  28. package/data/llms/components/dialog.md +702 -0
  29. package/data/llms/components/divider.md +152 -0
  30. package/data/llms/components/dock.md +488 -0
  31. package/data/llms/components/drawer.md +469 -0
  32. package/data/llms/components/dynamicdialog.md +214 -0
  33. package/data/llms/components/editor.md +205 -0
  34. package/data/llms/components/fieldset.md +253 -0
  35. package/data/llms/components/fileupload.md +459 -0
  36. package/data/llms/components/floatlabel.md +144 -0
  37. package/data/llms/components/fluid.md +104 -0
  38. package/data/llms/components/focustrap.md +59 -0
  39. package/data/llms/components/forms.md +344 -0
  40. package/data/llms/components/galleria.md +1119 -0
  41. package/data/llms/components/gallery.md +1003 -0
  42. package/data/llms/components/iconfield.md +283 -0
  43. package/data/llms/components/iftalabel.md +96 -0
  44. package/data/llms/components/image.md +179 -0
  45. package/data/llms/components/imagecompare.md +108 -0
  46. package/data/llms/components/inplace.md +183 -0
  47. package/data/llms/components/inputcolor.md +869 -0
  48. package/data/llms/components/inputgroup.md +419 -0
  49. package/data/llms/components/inputmask.md +345 -0
  50. package/data/llms/components/inputnumber.md +551 -0
  51. package/data/llms/components/inputotp.md +345 -0
  52. package/data/llms/components/inputpassword.md +738 -0
  53. package/data/llms/components/inputtags.md +432 -0
  54. package/data/llms/components/inputtext.md +569 -0
  55. package/data/llms/components/installation.md +1 -0
  56. package/data/llms/components/keyfilter.md +116 -0
  57. package/data/llms/components/knob.md +318 -0
  58. package/data/llms/components/label.md +151 -0
  59. package/data/llms/components/laravel.md +53 -0
  60. package/data/llms/components/listbox.md +636 -0
  61. package/data/llms/components/mask.md +203 -0
  62. package/data/llms/components/mcp.md +39 -0
  63. package/data/llms/components/megamenu.md +563 -0
  64. package/data/llms/components/menu.md +651 -0
  65. package/data/llms/components/menubar.md +446 -0
  66. package/data/llms/components/message.md +497 -0
  67. package/data/llms/components/metergroup.md +281 -0
  68. package/data/llms/components/multiselect.md +752 -0
  69. package/data/llms/components/orderlist.md +224 -0
  70. package/data/llms/components/organizationchart.md +418 -0
  71. package/data/llms/components/paginator.md +221 -0
  72. package/data/llms/components/panel.md +321 -0
  73. package/data/llms/components/panelmenu.md +703 -0
  74. package/data/llms/components/password.md +657 -0
  75. package/data/llms/components/picklist.md +286 -0
  76. package/data/llms/components/popover.md +145 -0
  77. package/data/llms/components/progressbar.md +242 -0
  78. package/data/llms/components/progressspinner.md +104 -0
  79. package/data/llms/components/radiobutton.md +427 -0
  80. package/data/llms/components/rating.md +312 -0
  81. package/data/llms/components/ripple.md +91 -0
  82. package/data/llms/components/scrollarea.md +700 -0
  83. package/data/llms/components/scrollpanel.md +131 -0
  84. package/data/llms/components/scrolltop.md +87 -0
  85. package/data/llms/components/select.md +1251 -0
  86. package/data/llms/components/selectbutton.md +268 -0
  87. package/data/llms/components/sidebar.md +2232 -0
  88. package/data/llms/components/skeleton.md +302 -0
  89. package/data/llms/components/slider.md +416 -0
  90. package/data/llms/components/speeddial.md +402 -0
  91. package/data/llms/components/splitbutton.md +840 -0
  92. package/data/llms/components/splitter.md +447 -0
  93. package/data/llms/components/stepper.md +551 -0
  94. package/data/llms/components/styleclass.md +226 -0
  95. package/data/llms/components/tabs.md +609 -0
  96. package/data/llms/components/tag.md +178 -0
  97. package/data/llms/components/terminal.md +123 -0
  98. package/data/llms/components/textarea.md +519 -0
  99. package/data/llms/components/tieredmenu.md +578 -0
  100. package/data/llms/components/timeline.md +494 -0
  101. package/data/llms/components/toast.md +472 -0
  102. package/data/llms/components/togglebutton.md +276 -0
  103. package/data/llms/components/toggleswitch.md +271 -0
  104. package/data/llms/components/toolbar.md +140 -0
  105. package/data/llms/components/tooltip.md +160 -0
  106. package/data/llms/components/tree.md +1076 -0
  107. package/data/llms/components/treeselect.md +660 -0
  108. package/data/llms/components/treetable.md +2493 -0
  109. package/data/llms/components/virtualscroller.md +265 -0
  110. package/data/llms/guides/autoimport.md +28 -0
  111. package/data/llms/guides/cdn.md +72 -0
  112. package/data/llms/guides/configuration.md +158 -0
  113. package/data/llms/guides/customicons.md +67 -0
  114. package/data/llms/guides/guides/accessibility.md +27 -0
  115. package/data/llms/guides/guides/animations.md +119 -0
  116. package/data/llms/guides/guides/rtl.md +7 -0
  117. package/data/llms/guides/icons.md +136 -0
  118. package/data/llms/guides/installation.md +3 -0
  119. package/data/llms/guides/laravel.md +66 -0
  120. package/data/llms/guides/llms.md +15 -0
  121. package/data/llms/guides/mcp.md +104 -0
  122. package/data/llms/guides/migration/v4.md +15 -0
  123. package/data/llms/guides/migration/v5.md +15 -0
  124. package/data/llms/guides/nuxt.md +141 -0
  125. package/data/llms/guides/passthrough.md +137 -0
  126. package/data/llms/guides/primeclt.md +43 -0
  127. package/data/llms/guides/tailwind.md +151 -0
  128. package/data/llms/guides/theming/styled.md +497 -0
  129. package/data/llms/guides/theming/unstyled.md +57 -0
  130. package/data/llms/guides/uikit.md +3 -0
  131. package/data/llms/guides/vite.md +90 -0
  132. package/data/llms/llms-full.txt +54465 -0
  133. package/data/llms/llms.txt +132 -0
  134. package/data/llms/pages/accessibility.md +27 -0
  135. package/data/llms/pages/animations.md +119 -0
  136. package/data/llms/pages/autoimport.md +28 -0
  137. package/data/llms/pages/cdn.md +72 -0
  138. package/data/llms/pages/configuration.md +158 -0
  139. package/data/llms/pages/contribution.md +31 -0
  140. package/data/llms/pages/customicons.md +67 -0
  141. package/data/llms/pages/designer.md +79 -0
  142. package/data/llms/pages/dynamicimports.md +7 -0
  143. package/data/llms/pages/forms.md +63 -0
  144. package/data/llms/pages/guides/accessibility.md +27 -0
  145. package/data/llms/pages/guides/animations.md +119 -0
  146. package/data/llms/pages/guides/rtl.md +7 -0
  147. package/data/llms/pages/icons.md +136 -0
  148. package/data/llms/pages/installation.md +3 -0
  149. package/data/llms/pages/introduction.md +23 -0
  150. package/data/llms/pages/laravel.md +66 -0
  151. package/data/llms/pages/llms.md +15 -0
  152. package/data/llms/pages/mcp.md +104 -0
  153. package/data/llms/pages/migration/v4.md +15 -0
  154. package/data/llms/pages/migration/v5.md +15 -0
  155. package/data/llms/pages/nuxt.md +141 -0
  156. package/data/llms/pages/passthrough.md +137 -0
  157. package/data/llms/pages/primeclt.md +43 -0
  158. package/data/llms/pages/rtl.md +7 -0
  159. package/data/llms/pages/setup.md +3 -0
  160. package/data/llms/pages/styled.md +497 -0
  161. package/data/llms/pages/tailwind.md +151 -0
  162. package/data/llms/pages/theming/styled.md +497 -0
  163. package/data/llms/pages/theming/unstyled.md +57 -0
  164. package/data/llms/pages/uikit.md +3 -0
  165. package/data/llms/pages/unstyled.md +57 -0
  166. package/data/llms/pages/v4.md +15 -0
  167. package/data/llms/pages/v5.md +15 -0
  168. package/data/llms/pages/vite.md +90 -0
  169. package/data/manifest.json +11117 -0
  170. package/data/mcp-data.json +55940 -0
  171. package/dist/index.d.ts +17 -1
  172. package/dist/index.js +66066 -72541
  173. package/package.json +10 -12
@@ -0,0 +1,132 @@
1
+ # PrimeVue
2
+
3
+ ## Guides
4
+
5
+ - [Auto Import](https://primevue.dev/autoimport): On-demand PrimeVue components with auto imports and tree-shaking.
6
+ - [Install PrimeVue with CDN](https://primevue.dev/cdn): Setting up PrimeVue in a project using CDN.
7
+ - [Configuration](https://primevue.dev/configuration): Application wide configuration for PrimeVue.
8
+ - [Custom Icons](https://primevue.dev/customicons): PrimeVue components can be used with any icon library using the templating features.
9
+ - [Accessibility](https://primevue.dev/guides/accessibility): PrimeVue has WCAG level compliance, refer to the accessibility documentation of each component for detailed information.
10
+ - [Animations](https://primevue.dev/guides/animations): Various PrimeVue Components utilize native CSS animations to provide an enhanced user experience. The default animations are based on the best practices recommended by the usability experts. In case you need to customize the default animations, this documentation covers the entire set of built-in animations.
11
+ - [RTL Support](https://primevue.dev/guides/rtl): Right-to-left direction support of PrimeVue.
12
+ - [Icons](https://primevue.dev/icons): @primeicons/vue is the default icon library of PrimeVue with over 300 icons as standalone Vue components developed by PrimeTek. The library is optional as PrimeVue components can use any icon with templating.
13
+ - [Installation](https://primevue.dev/installation): How to set up PrimeVue in your project. Select your framework to get started.
14
+ - [Install PrimeVue with Laravel](https://primevue.dev/laravel): Setting up PrimeVue in a Laravel project.
15
+ - [LLMs.txt](https://primevue.dev/llms): LLM-optimized documentation endpoints for PrimeVue components.
16
+ - [MCP Server](https://primevue.dev/mcp): Model Context Protocol (MCP) server for PrimeVue component library. Provides AI assistants with comprehensive access to PrimeVue component documentation.
17
+ - [Migration](https://primevue.dev/migration/v4): Migration guide to PrimeVue v4.
18
+ - [Migration to v5](https://primevue.dev/migration/v5): Migration guide to PrimeVue v5.
19
+ - [Install PrimeVue with Nuxt](https://primevue.dev/nuxt): Setting up PrimeVue in a Nuxt project.
20
+ - [Pass Through](https://primevue.dev/passthrough): The Pass Through attributes is an API to access the internal DOM Structure of the components.
21
+ - [Install PrimeVue with CLT](https://primevue.dev/primeclt): PrimeCLT is a command line utility for Prime UI libraries. It is currently in beta state.
22
+ - [Tailwind CSS](https://primevue.dev/tailwind): Integration between PrimeVue and Tailwind CSS both in styled and unstyled modes.
23
+ - [Styled Mode](https://primevue.dev/theming/styled): Choose from a variety of pre-styled themes or develop your own.
24
+ - [Unstyled Mode](https://primevue.dev/theming/unstyled): Theming PrimeVue with alternative styling approaches.
25
+ - [UI Kit](https://primevue.dev/uikit): Design files for PrimeVue Components.
26
+ - [Install PrimeVue with Vite](https://primevue.dev/vite): Setting up PrimeVue in a Vite project.
27
+
28
+ ## Components
29
+
30
+ - [Accordion](https://primevue.dev/accordion): Accordion groups a collection of contents in tabs.
31
+ - [AnimateOnScroll](https://primevue.dev/animateonscroll): AnimateOnScroll is used to apply animations to elements when entering or leaving the viewport during scrolling.
32
+ - [AutoComplete](https://primevue.dev/autocomplete): AutoComplete is an input component that provides real-time suggestions when being typed.
33
+ - [Avatar](https://primevue.dev/avatar): Avatar represents people using icons, labels and images.
34
+ - [Badge](https://primevue.dev/badge): Badge is a small status indicator for another element.
35
+ - [BlockUI](https://primevue.dev/blockui): BlockUI can either block other components or the whole page.
36
+ - [Breadcrumb](https://primevue.dev/breadcrumb): Breadcrumb provides contextual information about page hierarchy.
37
+ - [Button](https://primevue.dev/button): Button is an extension to standard button element with icons and theming.
38
+ - [Card](https://primevue.dev/card): Card is a flexible container component.
39
+ - [Carousel](https://primevue.dev/carousel): Carousel is a content slider featuring various customization options.
40
+ - [CascadeSelect](https://primevue.dev/cascadeselect): CascadeSelect displays a nested structure of options.
41
+ - [Chart](https://primevue.dev/chart): Chart components are based on Chart.js, an open source HTML5 based charting library.
42
+ - [Checkbox](https://primevue.dev/checkbox): Checkbox is an extension to standard checkbox element with theming.
43
+ - [Chip](https://primevue.dev/chip): Chip represents entities using icons, labels and images.
44
+ - [ColorPicker](https://primevue.dev/colorpicker): ColorPicker is an input component to select a color.
45
+ - [CommandMenu](https://primevue.dev/commandmenu): CommandMenu is a search-driven command palette component.
46
+ - [Compare](https://primevue.dev/compare): Compare two items side by side with a slider.
47
+ - [ConfirmDialog](https://primevue.dev/confirmdialog): ConfirmDialog is backed by a service utilizing Observables to display confirmation windows easily that can be shared by multiple actions on the same component.
48
+ - [ConfirmPopup](https://primevue.dev/confirmpopup): ConfirmPopup displays a confirmation overlay displayed relatively to its target.
49
+ - [ContextMenu](https://primevue.dev/contextmenu): ContextMenu displays an overlay menu on right click of its target.
50
+ - [DataTable](https://primevue.dev/datatable): DataTable displays data in tabular format.
51
+ - [DataView](https://primevue.dev/dataview): DataView displays data in grid or list layout with pagination and sorting features.
52
+ - [DatePicker](https://primevue.dev/datepicker): DatePicker is a form component to work with dates.
53
+ - [DeferredContent](https://primevue.dev/deferredcontent): DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.
54
+ - [Dialog](https://primevue.dev/dialog): Dialog is a container to display content in an overlay window.
55
+ - [Divider](https://primevue.dev/divider): Divider is used to separate contents.
56
+ - [Dock](https://primevue.dev/dock): Dock is a navigation component consisting of menuitems.
57
+ - [Drawer](https://primevue.dev/drawer): Drawer is a panel component displayed as an overlay at the edges of the screen.
58
+ - [Dynamic Dialog](https://primevue.dev/dynamicdialog): Dialogs can be created dynamically with any component as the content using a DialogService.
59
+ - [Editor](https://primevue.dev/editor): Editor is rich text editor component based on Quill.
60
+ - [Fieldset](https://primevue.dev/fieldset): Fieldset is a grouping component with a content toggle feature.
61
+ - [FileUpload](https://primevue.dev/fileupload): FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.
62
+ - [FloatLabel](https://primevue.dev/floatlabel): FloatLabel appears on top of the input field when focused.
63
+ - [Fluid](https://primevue.dev/fluid): Fluid is a layout component to make descendant components span full width of their container.
64
+ - [Focus Trap](https://primevue.dev/focustrap): Focus Trap keeps focus within a certain DOM element while tabbing.
65
+ - [Forms](https://primevue.dev/forms): The PrimeVue Forms library provides comprehensive form state management with built-in validation support.
66
+ - [Galleria](https://primevue.dev/galleria): Galleria is a content gallery component.
67
+ - [Gallery](https://primevue.dev/gallery): Gallery is an image viewer with zoom, rotate, flip and download capabilities.
68
+ - [IconField](https://primevue.dev/iconfield): IconField wraps an input and an icon.
69
+ - [IftaLabel](https://primevue.dev/iftalabel): IftaLabel is used to create infield top aligned labels.
70
+ - [Image](https://primevue.dev/image): Displays an image with preview and tranformation options.
71
+ - [ImageCompare](https://primevue.dev/imagecompare): Compare two images side by side with a slider.
72
+ - [Inplace](https://primevue.dev/inplace): Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
73
+ - [InputColor](https://primevue.dev/inputcolor): InputColor is a composable color picker component.
74
+ - [InputGroup](https://primevue.dev/inputgroup): Text, icon, buttons and other content can be grouped next to an input.
75
+ - [InputMask](https://primevue.dev/inputmask): InputMask component is used to enter input in a certain format such as numeric, date, currency and phone.
76
+ - [InputNumber](https://primevue.dev/inputnumber): InputNumber is an input component to provide numerical input.
77
+ - [InputOtp](https://primevue.dev/inputotp): Input Otp is used to enter one time passwords.
78
+ - [InputPassword](https://primevue.dev/inputpassword): InputPassword is an enhanced input for password entry with strength metering, mask toggling, and controlled or uncontrolled usage.
79
+ - [InputTags](https://primevue.dev/inputtags): InputTags is used to enter multiple tags.
80
+ - [InputText](https://primevue.dev/inputtext): InputText is an extension to standard input element with icons and theming.
81
+ - [KeyFilter](https://primevue.dev/keyfilter): KeyFilter is a directive to restrict individual key strokes. In order to restrict the whole input, use InputNumber or InputMask instead.
82
+ - [Knob](https://primevue.dev/knob): Knob is a form component to define number inputs with a dial.
83
+ - [Label](https://primevue.dev/label): Label provides accessible text labels for form controls. Use the for attribute to link the label to a form control by its id.
84
+ - [Listbox](https://primevue.dev/listbox): Listbox is used to select one or more values from a list of items.
85
+ - [Mask](https://primevue.dev/mask): Mask is a directive used to enter input in a certain format such as numeric, date, currency, email and phone.
86
+ - [MegaMenu](https://primevue.dev/megamenu): MegaMenu is navigation component that displays submenus together.
87
+ - [Menu](https://primevue.dev/menu): Menu is a navigation / command component that supports dynamic and static positioning.
88
+ - [Menubar](https://primevue.dev/menubar): Menubar is a horizontal menu component.
89
+ - [Message](https://primevue.dev/message): Message component is used to display inline messages.
90
+ - [MeterGroup](https://primevue.dev/metergroup): MeterGroup displays scalar measurements within a known range.
91
+ - [MultiSelect](https://primevue.dev/multiselect): MultiSelect is used to select multiple items from a collection.
92
+ - [OrderList](https://primevue.dev/orderlist): OrderList is used to sort a collection.
93
+ - [OrganizationChart](https://primevue.dev/organizationchart): OrganizationChart visualizes hierarchical organization data.
94
+ - [Paginator](https://primevue.dev/paginator): Paginator displays data in paged format and provides navigation between pages.
95
+ - [Panel](https://primevue.dev/panel): Panel is a container component with an optional content toggle feature.
96
+ - [PanelMenu](https://primevue.dev/panelmenu): PanelMenu is a hybrid of Accordion and Tree components.
97
+ - [Password](https://primevue.dev/password): Password displays strength indicator for password fields.
98
+ - [PickList](https://primevue.dev/picklist): PickList is used to reorder items between different lists.
99
+ - [Popover](https://primevue.dev/popover): Popover is a container component that can overlay other components on page.
100
+ - [ProgressBar](https://primevue.dev/progressbar): ProgressBar is a process status indicator.
101
+ - [ProgressSpinner](https://primevue.dev/progressspinner): ProgressSpinner is a process status indicator that supports both determinate and indeterminate modes.
102
+ - [RadioButton](https://primevue.dev/radiobutton): RadioButton is an extension to standard radio button element with theming.
103
+ - [Rating](https://primevue.dev/rating): Rating component is a star based selection input.
104
+ - [Ripple](https://primevue.dev/ripple): Ripple directive adds ripple effect to the host element.
105
+ - [ScrollArea](https://primevue.dev/scrollarea): ScrollArea is a cross browser, lightweight and themable alternative to native browser scrollbar.
106
+ - [ScrollPanel](https://primevue.dev/scrollpanel): ScrollPanel is a cross browser, lightweight and skinnable alternative to native browser scrollbar.
107
+ - [ScrollTop](https://primevue.dev/scrolltop): ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
108
+ - [Select](https://primevue.dev/select): Select is used to choose an item from a collection of options.
109
+ - [SelectButton](https://primevue.dev/selectbutton): SelectButton is used to choose single or multiple items from a list using buttons.
110
+ - [Sidebar](https://primevue.dev/sidebar): Sidebar is a compound navigation panel with collapsible icon mode, offcanvas mode, variants and optional overlay.
111
+ - [Skeleton](https://primevue.dev/skeleton): Skeleton is a placeholder to display instead of the actual content.
112
+ - [Slider](https://primevue.dev/slider): Slider is a component to provide input by dragging a handle along a track.
113
+ - [Speed Dial](https://primevue.dev/speeddial): SpeedDial is a floating button with a popup menu.
114
+ - [SplitButton](https://primevue.dev/splitbutton): SplitButton groups a set of commands in an overlay with a default command.
115
+ - [Splitter](https://primevue.dev/splitter): Splitter is utilized to separate and resize panels.
116
+ - [Stepper](https://primevue.dev/stepper): The Stepper component displays a wizard-like workflow by guiding users through the multi-step progression.
117
+ - [StyleClass](https://primevue.dev/styleclass): StyleClass manages CSS classes declaratively to during enter/leave animations or just to toggle classes on an element.
118
+ - [Tabs](https://primevue.dev/tabs): Tabs is a container component to group content with tabs.
119
+ - [Tag](https://primevue.dev/tag): Tag component is used to categorize content.
120
+ - [Terminal](https://primevue.dev/terminal): Terminal is a text-based interface component that emulates a command line experience, enabling users to enter commands and receive responses.
121
+ - [Textarea](https://primevue.dev/textarea): Textarea adds styling and autoResize functionality to standard textarea element.
122
+ - [TieredMenu](https://primevue.dev/tieredmenu): TieredMenu displays submenus in nested overlays.
123
+ - [Timeline](https://primevue.dev/timeline): Timeline visualizes a series of chained events.
124
+ - [Toast](https://primevue.dev/toast): Toast is used to display messages in an overlay.
125
+ - [ToggleButton](https://primevue.dev/togglebutton): ToggleButton is used to select a boolean value using a button.
126
+ - [ToggleSwitch](https://primevue.dev/toggleswitch): ToggleSwitch is used to select a boolean value.
127
+ - [Toolbar](https://primevue.dev/toolbar): Toolbar is a grouping component for buttons and other content.
128
+ - [Tooltip](https://primevue.dev/tooltip): Tooltip directive provides advisory information for a component. Tooltip is integrated within various PrimeVue components.
129
+ - [Tree](https://primevue.dev/tree): Tree is used to display hierarchical data.
130
+ - [TreeSelect](https://primevue.dev/treeselect): TreeSelect is a form component to choose from hierarchical data.
131
+ - [TreeTable](https://primevue.dev/treetable): TreeTable is used to display hierarchical data in tabular format.
132
+ - [VirtualScroller](https://primevue.dev/virtualscroller): VirtualScroller is a performant approach to render large amounts of data efficiently.
@@ -0,0 +1,27 @@
1
+ # Accessibility
2
+
3
+ PrimeVue has WCAG level compliance, refer to the accessibility documentation of each component for detailed information.
4
+
5
+ ## Introduction
6
+
7
+ According to the World Health Organization, 15% of the world population has a disability to some degree. As a result, accessibility features in any context such as a ramp for wheelchair users or a multimedia with captions are crucial to ensure content can be consumed by anyone. Types of disabilities are diverse so you need to know your audience well and how they interact with the content created. There four main categories; Visual Impairments Blindness, low-level vision or color blindness are the common types of visual impairments. Screen magnifiers and the color blind mode are usually built-in features of the browsers whereas for people who rely on screen readers, page developers are required to make sure content is readable by the readers. Popular readers are NVDA , JAWS and ChromeVox . Hearing Impairments Deafness or hearing loss refers to the inability to hear sounds totally or partially. People with hearing impairments use assistive devices however it may not be enough when interacting with a web page. Common implementation is providing textual alternatives, transcripts and captions for content with audio. Mobility Impairments People with mobility impairments have disabilities related to movement due to loss of a limb, paralysis or other varying reasons. Assistive technologies like a head pointer is a device to interact with a screen whereas keyboard or a trackpad remain as solutions for people who are not able to utilize a mouse. Cognitive Impairments Cognitive impairments have a wider range that includes people with learning disabilities, depression and dyslexia. A well designed content also leads to better user experience for people without disabilities so designing for cognitive impairments result in better design for any user.
8
+
9
+ ## WCAG
10
+
11
+ Correct page structure with the aid of assistive technologies are the core ingridients for an accessible web content. HTML is based on an accessible foundation, form controls can be used by keyboard by default and semantic HTML is easier to be processed by a screen reader. WCAG refers to Web Content Accessibility Guideline , a standard managed by the WAI (Web Accessibility Initiative) of W3C (World Wide Web Consortium). WCAG consists of recommendations for making the web content more accessible. PrimeVue components aim high level of WCAG compliancy in the near future. Various countries around the globe have governmental policies regarding web accessibility as well. Most well known of these are Section 508 in the US and Web Accessibility Directive of the European Union.
12
+
13
+ ## Form Controls
14
+
15
+ Native form elements should be preferred instead of elements that are meant for other purposes like presentation. As an example, button below is rendered as a form control by the browser, can receive focus via tabbing and can be used with space key as well to trigger.
16
+
17
+ ## Semantic HTML
18
+
19
+ HTML offers various element to organize content on a web page that screen readers are aware of. Preferring Semantic HTML for good semantics provide out of the box support for reader which is not possible when regular div elements with classes are used. Consider the following example that do not mean too much for readers.
20
+
21
+ ## WAI ARIA
22
+
23
+ ARIA refers to "Accessible Rich Internet Applications" is a suite to fill the gap where semantic HTML is inadequate. These cases are mainly related to rich UI components/widgets. Although browser support for rich UI components such as a datepicker or colorpicker has been improved over the past years many web developers still utilize UI components derived from standard HTML elements created by them or by other projects like PrimeVue. These types of components must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized. ARIA consists of roles, properties and attributes. Roles define what the element is mainly used for e.g. checkbox , dialog , tablist whereas States and Properties define the metadata of the element like aria-checked , aria-disabled . Consider the following case of a native checkbox. It has built-in keyboard and screen reader support.
24
+
25
+ ## Colors
26
+
27
+ Colors on a web page should aim a contrast ratio of at least 4.5:1 and consider a selection of colors that do not cause vibration. Good Contrast Color contrast between the background and the foreground content should be sufficient enough to ensure readability. Example below displays two cases with good and bad samples. GOOD BAD Vibration Color vibration is leads to an illusion of motion due to choosing colors that have low visibility against each other. Color combinations need to be picked with caution to avoid vibration. VIBRATE Dark Mode Highly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred. Indigo 500 Indigo 200
@@ -0,0 +1,119 @@
1
+ # Animations
2
+
3
+ Various PrimeVue Components utilize native CSS animations to provide an enhanced user experience. The default animations are based on the best practices recommended by the usability experts. In case you need to customize the default animations, this documentation covers the entire set of built-in animations.
4
+
5
+ ## Introduction
6
+
7
+ Various PrimeVue Components utilize native CSS animations to provide an enhanced user experience. The default animations are based on the best practices recommended by the usability experts. In case you need to customize the default animations, this documentation covers the entire set of built-in animations. Animations are defined using a combination of style classes and keyframes. The ⁠ .{classname}-enter-active and ⁠ .{classname}-leave-active classes specify the animation name, duration, and easing function. You can customize animations globally by overriding the default animation classes, affecting all components. Alternatively, you can apply scoped classes to individual components to modify their animations independently. For demo purposes, this second approach is used throughout the next sections.
8
+
9
+ ## Anchored Overlays
10
+
11
+ Anchored overlays are the components that have a floating ui positioned relatively to another element such as Select, Popover. The enter and leave animations are defined with the .p-anchored-overlay-enter-active and .p-anchored-overlay-leave-active classes.
12
+
13
+ ```vue
14
+ .p-anchored-overlay-enter-active {
15
+ animation: demo-overlay-in 300ms ease-out;
16
+ }
17
+
18
+ .p-anchored-overlay-leave-active {
19
+ animation: demo-overlay-out 250ms ease-in;
20
+ }
21
+
22
+ @keyframes demo-overlay-in {
23
+ from {
24
+ opacity: 0;
25
+ transform: translateY(10%);
26
+ }
27
+ }
28
+
29
+ @keyframes demo-overlay-out {
30
+ to {
31
+ opacity: 0;
32
+ transform: translateY(10%);
33
+ }
34
+ }
35
+ ```
36
+
37
+ ## Collapsibles
38
+
39
+ Collapsible components have a content that is toggleable including Accordion, Panel, Fieldset, Stepper and PanelMenu. The enter and leave animations are defined with the .p-collapsible-enter-active and .p-collapsible-leave-active classes.
40
+
41
+ ```vue
42
+ .p-collapsible-enter-active {
43
+ animation: demo-collapsible-expand 500ms cubic-bezier(0.65, 0, 0.35, 1);
44
+ }
45
+
46
+ .p-collapsible-leave-active {
47
+ animation: demo-collapsible-collapse 500ms cubic-bezier(0.65, 0, 0.35, 1);
48
+ }
49
+
50
+ @keyframes demo-collapsible-expand {
51
+ from {
52
+ opacity: 0;
53
+ grid-template-rows: 0fr;
54
+ transform: scale(0.93);
55
+ }
56
+ to {
57
+ opacity: 1;
58
+ grid-template-rows: 1fr;
59
+ }
60
+ }
61
+
62
+ @keyframes demo-collapsible-collapse {
63
+ from {
64
+ opacity: 1;
65
+ grid-template-rows: 1fr;
66
+ }
67
+ to {
68
+ opacity: 0;
69
+ grid-template-rows: 0fr;
70
+ transform: scale(0.93);
71
+ }
72
+ }
73
+ ```
74
+
75
+ ## Dialog
76
+
77
+ Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations.
78
+
79
+ ```vue
80
+ .p-dialog-enter-active {
81
+ animation: demo-dialog-in 500ms ease-out;
82
+ }
83
+
84
+ .p-dialog-leave-active {
85
+ animation: demo-dialog-out 500ms ease-in;
86
+ }
87
+
88
+ @keyframes demo-dialog-in {
89
+ from {
90
+ opacity: 0;
91
+ transform: translateY(-10%) scale(1.1);
92
+ filter: blur(10px);
93
+ }
94
+ }
95
+
96
+ @keyframes demo-dialog-out {
97
+ to {
98
+ opacity: 0;
99
+ transform: translateY(200%) rotate(-90deg);
100
+ }
101
+ }
102
+ ```
103
+
104
+ ## Disable
105
+
106
+ Individual animations can be reduced and even disabled completely using the animation duration.
107
+
108
+ ```vue
109
+ @media (prefers-reduced-motion: reduce) {
110
+ .p-anchored-overlay-enter-active,
111
+ .p-anchored-overlay-leave-active {
112
+ animation-duration: 0s !important;
113
+ }
114
+ }
115
+ ```
116
+
117
+ ## Reference
118
+
119
+ List of class names of the CSS animations used by the components. Component Enter Class Leave Class Accordion .p-collapsible-enter-active .p-collapsible-leave-active AutoComplete .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active CascadeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ColorPicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ConfirmPopup .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ContextMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active DatePicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Dialog .p-dialog-enter-active .p-dialog-leave-active Drawer .p-drawer-enter-active .p-drawer-leave-active Fieldset .p-collapsible-enter-active .p-collapsible-leave-active Galleria .p-galleria-enter-active .p-galleria-leave-active Image .p-image-original-enter-active .p-image-original-leave-active Menu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Message .p-message-enter-active .p-message-leave-active Modal Masks .p-overlay-mask-enter-active .p-overlay-mask-leave-active MultiSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Panel .p-collapsible-enter-active .p-collapsible-leave-active PanelMenu .p-collapsible-enter-active .p-collapsible-leave-active Password .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Select .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Stepper .p-collapsible-enter-active .p-collapsible-leave-active TieredMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active TreeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active
@@ -0,0 +1,28 @@
1
+ # Auto Import
2
+
3
+ On-demand PrimeVue components with auto imports and tree-shaking.
4
+
5
+ ## Overview
6
+
7
+ PrimeVue components need to be imported and configured individually. In the next section, we'll cleanup the code using auto imports.
8
+
9
+ ```vue
10
+ import { createApp } from "vue";
11
+ import PrimeVue from "primevue/config";
12
+ import InputText from 'primevue/inputtext';
13
+ import Button from 'primevue/button';
14
+ import App from './App.vue'
15
+ const app = createApp(App);
16
+
17
+ app.use(PrimeVue);
18
+ app.component('InputText', InputText);
19
+ app.component('Button', Button);
20
+ ```
21
+
22
+ ## Unplugin
23
+
24
+ The unplugin-vue-components library can automatically import and register PrimeVue components with the help of @primevue/auto-import-resolver . Begin with installing the packages as dev dependencies. Next step would be adding the PrimeVueResolver at vite.config using the Components plugin. That's it, now the initialization code can be refactored as the following. For configuration like namespacing, visit the official documentation .
25
+
26
+ ## Example
27
+
28
+ A complete example using PrimeVue with auto imports is available at the playground .
@@ -0,0 +1,72 @@
1
+ # Install PrimeVue with CDN
2
+
3
+ Setting up PrimeVue in a project using CDN.
4
+
5
+ ## Script
6
+
7
+ You can use PrimeVue and Vue.js from a CDN with a script tag. This approach does not involve any build step, and is suitable for enhancing static HTML. This guide uses unpkg however other providers such as jsdeliver and cdnjs can also be used.
8
+
9
+ ```vue
10
+ https://unpkg.com/vue@3/dist/vue.global.js
11
+ https://unpkg.com/primevue@5.0.0-rc.2/umd/primevue.min.js
12
+ https://unpkg.com/@primeuix/themes@3.0.0-rc.1/umd/aura.js // see theming for alternatives
13
+ ```
14
+
15
+ ## Theming
16
+
17
+ Include the theme preset via a script element after adding PrimeVue, valid options are Aura, Lara, Nora and Material.
18
+
19
+ ## License
20
+
21
+ Get your PrimeUI license key which is required for the setup process.
22
+
23
+ ## CreateApp
24
+
25
+ A complete example using a PrimeVue DatePicker.
26
+
27
+ ```vue
28
+ <!DOCTYPE html>
29
+ <html lang="en">
30
+ <head>
31
+ <title>PrimeVue + CDN</title>
32
+ <meta charset="UTF-8" />
33
+ <meta name="viewport" content="width=device-width" />
34
+ </head>
35
+ <body>
36
+ <script src="https://unpkg.com/vue@3/dist/vue.global.js"><\/script>
37
+ <script src="https://unpkg.com/primevue/umd/primevue.min.js"><\/script>
38
+ <script src="https://unpkg.com/@primeuix/themes/umd/aura.js"><\/script>
39
+
40
+ <div id="app">
41
+ <p-datepicker v-model="date"></p-datepicker>
42
+ <br /><br />
43
+ {{ date }}
44
+ </div>
45
+
46
+ <script>
47
+ const { createApp, ref } = Vue;
48
+
49
+ const app = createApp({
50
+ setup() {
51
+ const date = ref();
52
+
53
+ return {
54
+ date
55
+ };
56
+ },
57
+ });
58
+
59
+ app.use(PrimeVue.Config, {
60
+ theme: {
61
+ preset: PrimeUIX.Themes.Aura
62
+ },
63
+ license: 'PRIMEUI-LICENSE-KEY'
64
+ });
65
+
66
+ app.component('p-datepicker', PrimeVue.DatePicker);
67
+
68
+ app.mount('#app');
69
+ <\/script>
70
+ </body>
71
+ </html>
72
+ ```
@@ -0,0 +1,158 @@
1
+ # Configuration
2
+
3
+ Application wide configuration for PrimeVue.
4
+
5
+ ## Import
6
+
7
+ Configuration is managed by the PrimeVue instance imported from primevue/config .
8
+
9
+ ```vue
10
+ import PrimeVue from 'primevue/config';
11
+ const app = createApp(App);
12
+
13
+ app.use(PrimeVue, { /* options */ });
14
+ ```
15
+
16
+ ## License
17
+
18
+ The PrimeUI license key , can be either a free community license or a commercial license.
19
+
20
+ ```vue
21
+ import PrimeVue from 'primevue/config';
22
+ import Aura from '@primeuix/themes/aura';
23
+
24
+ const app = createApp(App);
25
+
26
+ app.use(PrimeVue, {
27
+ license: 'PRIMEUI-LICENSE-KEY'
28
+ });
29
+ ```
30
+
31
+ ## Theme
32
+
33
+ Style mode offers theming based on a design token based architecture. See the styled mode documentation for details such as building your own theme.
34
+
35
+ ```vue
36
+ import PrimeVue from 'primevue/config';
37
+ import Aura from '@primeuix/themes/aura';
38
+
39
+ const app = createApp(App);
40
+
41
+ app.use(PrimeVue, {
42
+ theme: {
43
+ preset: Aura,
44
+ options: {
45
+ prefix: 'p',
46
+ darkModeSelector: 'system',
47
+ cssLayer: false,
48
+ cssVariables: true
49
+ }
50
+ }
51
+ });
52
+ ```
53
+
54
+ ## Unstyled
55
+
56
+ Unstyled mode instructs the components not to add any built-in style classes so that they can be styled using custom css or libraries like Tailwind and Bootstrap. Visit Unstyled mode documentation for more information.
57
+
58
+ ```vue
59
+ import { createApp } from "vue";
60
+ import PrimeVue from "primevue/config";
61
+ const app = createApp(App);
62
+
63
+ app.use(PrimeVue, { unstyled: true });
64
+ ```
65
+
66
+ ## Pass Through
67
+
68
+ Defines the shared pass through properties per component type. Visit the Pass Through Props documentation for more information.
69
+
70
+ ```vue
71
+ import { createApp } from "vue";
72
+ import PrimeVue from "primevue/config";
73
+ const app = createApp(App);
74
+
75
+ app.use(PrimeVue, {
76
+ pt: {
77
+ slider: {
78
+ handle: { class: 'bg-primary text-primary-contrast' }
79
+ }
80
+ }
81
+ });
82
+ ```
83
+
84
+ ## Pass Through Options
85
+
86
+ Used to configure the ptOptions properties of components and the usePassThrough method. The mergeSections defines whether the sections from the main configuration gets added and the mergeProps controls whether to override or merge the defined props. Defaults are true for mergeSections and false for mergeProps .
87
+
88
+ ```vue
89
+ import { createApp } from "vue";
90
+ import PrimeVue from "primevue/config";
91
+ const app = createApp(App);
92
+
93
+ app.use(PrimeVue, {
94
+ ptOptions: {
95
+ mergeSections: true,
96
+ mergeProps: false
97
+ }
98
+ });
99
+ ```
100
+
101
+ ## Ripple
102
+
103
+ Ripple is an optional animation for the supported components such as buttons. It is disabled by default and needs to be enabled at your app's entry file (e.g. main.js) during the PrimeVue setup.
104
+
105
+ ```vue
106
+ import { createApp } from "vue";
107
+ import PrimeVue from "primevue/config";
108
+ const app = createApp(App);
109
+
110
+ app.use(PrimeVue, { ripple: true });
111
+ ```
112
+
113
+ ## InputVariant
114
+
115
+ Input fields come in two styles, default is outlined with borders around the field whereas filled alternative adds a background color to the field. Applying p-variant-filled to an ancestor of an input enables the filled style. If you prefer to use filled inputs in the entire application, use a global container such as the document body or the application element to apply the style class. Note that in case you add it to the application element, components that are teleported to the document body such as Dialog will not be able to display filled inputs as they are not a descendant of the application root element in the DOM tree, to resolve this case set inputVariant to filled at PrimeVue configuration as well.
116
+
117
+ ```vue
118
+ import {createApp} from "vue";
119
+ import PrimeVue from "primevue/config";
120
+ const app = createApp(App);
121
+
122
+ app.use(PrimeVue, { inputVariant: "filled" });
123
+ ```
124
+
125
+ ## ZIndex
126
+
127
+ ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. Still there may be cases where you'd like to configure the configure default values such as a custom layout where header section is fixed. In a case like this, dropdown needs to be displayed below the application header but a modal dialog should be displayed above. PrimeVue configuration offers the zIndex property to customize the default values for components categories. Default values are described below and can be customized when setting up PrimeVue.
128
+
129
+ ```vue
130
+ import {createApp} from "vue";
131
+ import PrimeVue from "primevue/config";
132
+ const app = createApp(App);
133
+
134
+ app.use(PrimeVue, {
135
+ zIndex: {
136
+ modal: 1100, //dialog, drawer
137
+ overlay: 1000, //select, popover
138
+ menu: 1000, //overlay menus
139
+ tooltip: 1100 //tooltip
140
+ }
141
+ });
142
+ ```
143
+
144
+ ## Nonce
145
+
146
+ The nonce value to use on dynamically generated style elements in core.
147
+
148
+ ## Set Locale
149
+
150
+ Second parameter of the use function can be used to initiate the locale during PrimeVue installation. The locale configuration is reactive so that any changes are instantly reflected in the UI. Suppose you are doing a multi language application and need to change the language dynamically.
151
+
152
+ ## Repository
153
+
154
+ Ready to use settings for locales are available at the community supported PrimeLocale repository. We'd appreciate if you could contribute to this repository with pull requests and share it with the rest of the community.
155
+
156
+ ## API
157
+
158
+ Configuration is managed by the Locale API imported from primevue/config . Locale Options Key Value startsWith Starts with contains Contains notContains Not contains endsWith Ends with equals Equals notEquals Not equals noFilter No Filter lt Less than lte Less than or equal to gt Greater than gte Greater than or equal to dateIs Date is dateIsNot Date is not dateBefore Date is before dateAfter Date is after clear Clear apply Apply matchAll Match All matchAny Match Any addRule Add Rule removeRule Remove Rule accept Yes reject No choose Choose upload Upload cancel Cancel completed Completed pending Pending fileSizeTypes ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'] dayNames ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday' dayNamesShort ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' dayNamesMin ['Su', 'Mo', 'Tu', 'We', 'Th', 'Fr', 'Sa' monthNames ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December' monthNamesShort ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' chooseYear Choose Year chooseMonth Choose Month chooseDate Choose Date prevDecade Previous Decade nextDecade Next Decade prevYear Previous Year nextYear Next Year prevMonth Previous Month nextMonth Next Month prevHour Previous Hour nextHour Next Hour prevMinute Previous Minute nextMinute Next Minute prevSecond Previous Second nextSecond Next Second am am pm pm today Today weekHeader Wk firstDayOfWeek 0 showMonthAfterYear false dateFormat mm/dd/yy weak Weak medium Medium strong Strong passwordPrompt Enter a password searchMessage {0} results are available selectionMessage {0} items selected emptySelectionMessage No selected item emptySearchMessage No results found fileChosenMessage {0} files noFileChosenMessage No file chosen emptyMessage No available options aria.trueLabel True aria.falseLabel False aria.nullLabel Not Selected aria.star 1 star aria.stars {star} stars aria.selectAll All items selected aria.unselectAll All items unselected aria.close Close aria.previous Previous aria.next Next aria.navigation Navigation aria.scrollTop Scroll Top aria.moveTop Move Top aria.moveUp Move Up aria.moveDown Move Down aria.moveBottom Move Bottom aria.moveToTarget Move to Target aria.moveToSource Move to Source aria.moveAllToTarget Move All to Target aria.moveAllToSource Move All to Source aria.pageLabel Page {page} aria.firstPageLabel First Page aria.lastPageLabel Last Page aria.nextPageLabel Next Page aria.prevPageLabel Previous Page aria.rowsPerPageLabel Rows per page aria.jumpToPageDropdownLabel Jump to Page Dropdown aria.jumpToPageInputLabel Jump to Page Input aria.selectRow Row Selected aria.unselectRow Row Unselected aria.expandRow Row Expanded aria.collapseRow Row Collapsed aria.showFilterMenu Show Filter Menu aria.hideFilterMenu Hide Filter Menu aria.filterOperator Filter Operator aria.filterConstraint Filter Constraint aria.editRow Row Edit aria.saveEdit Save Edit aria.cancelEdit Cancel Edit aria.listView List View aria.gridView Grid View aria.slide Slide aria.slideNumber {slideNumber} aria.zoomImage Zoom Image aria.zoomIn Zoom In aria.zoomOut Zoom Out aria.rotateRight Rotate Right aria.rotateLeft Rotate Left
@@ -0,0 +1,31 @@
1
+ # Contribution Guide
2
+
3
+ Welcome to the PrimeVue Contribution Guide and thank you for considering contributing.
4
+
5
+ ## Benefits
6
+
7
+ Contributing to PrimeVue comes with several benefits. Being part of an open-source project will enhance your career and open up exciting opportunities. Contributors and Committers will be listed on our team page . You'll gain significant visibility in the developer community while improving yourself as a professional. You'll be invited to a private communication channel at Discord to get in touch with PrimeTek. In addition, contributors have access to all PrimeVue add-ons like Premium Templates, Blocks, and UI Kit free of charge.
8
+
9
+ ## CLA
10
+
11
+ When a community member is offered the Contributor role, they are expected to sign a Contributor License Agreement (CLA) for legal purposes. This helps protect both the contributor and PrimeTek.
12
+
13
+ ## Communication
14
+
15
+ Join the Contributors channel on the PrimeLand Discord server to connect with PrimeVue staff and fellow contributors. In this channel, you can discuss the areas you want to contribute to and receive feedback. This channel is open to everyone who'd like to contribute.
16
+
17
+ ## Help Needed
18
+
19
+ PrimeVue is a community-driven project backed by the expertise and sponsorship of PrimeTek, and we appreciate any help you can provide. Here are some areas where you can contribute: Issue Triage Help us manage issues by; Reproducing reported bugs Clarifying issue descriptions Tagging issues with appropriate labels Sending Pull Requests We encourage you to send pull requests, especially for issues tagged with the help-needed label. Community Support Assist other users by participating in the issue tracker, GitHub discussions , and the PrimeLand Discord server. Your expertise can help others solve problems and improve their experience with PrimeVue.
20
+
21
+ ## Introduction
22
+
23
+ PrimeVue is a popular Vue UI library maintained by PrimeTek, a company renowned for its comprehensive set of UI components for various frameworks. PrimeTek is dedicated to providing high-quality, versatile, and accessible UI components that help developers build better applications faster. Development Setup To begin with, clone the PrimeVue repository from GitHub: Then run the showcase in your local environment at http://localhost:3000/ . Project Structure PrimeVue utilizes a monorepo architecture, the libraries are located at packages folder and the website is at apps/showcase .
24
+
25
+ ## Key Points
26
+
27
+ PrimeVue has several add-ons such as UI Kit, Premium Templates, and Blocks that rely on design tokens and styling. Any core structural changes, such as adding new props, events, or updating design tokens, should be communicated with the core team to ensure consistency and compatibility.
28
+
29
+ ## Pathway
30
+
31
+ PrimeTek offers an organization structure involving contributors and the core team: Contributor Role After a certain period of frequent contributions, a community member is offered the Contributor role. On average, it may take about three months, but the exact duration can vary depending on the individual commitment. Committer Role If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the PrimeVue codebase. Employment PrimeTek prefers to hire team members from open source committers, so you may be offered a full-time position when a position becomes available.