vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

update docs

pull/1361/head
Tuğçe Küçükoğlu 2021-06-14 17:05:13 +03:00
parent 4d1891b47c
commit 3b8bec5f30
15 changed files with 229 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/views/autocomplete/AutoCompleteDoc.vue
View File

@ -218,6 +218,13 @@ export default {
<td>A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body
and "self" for the element itself.</td>
</tr>
<tr>
<td>forceSelection</td>
<td>boolean</td>
<td>false</td>
<td>When present, autocomplete clears the manual input if it does not match of the suggestions to force only
accepting values from the suggestions.</td>
</tr>
<tr>
<td>inputStyle</td>
<td>any</td>
@ -231,11 +238,16 @@ export default {
<td>Style class of the input field.</td>
</tr>
<tr>
<td>forceSelection</td>
<td>boolean</td>
<td>false</td>
<td>When present, autocomplete clears the manual input if it does not match of the suggestions to force only
accepting values from the suggestions.</td>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
<tr>
<td>panelClass</td>

12
src/views/calendar/CalendarDoc.vue
View File

@ -408,6 +408,18 @@ export default {
<td>null</td>
<td>Style class of the input field.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Style class of the component.</td>
</tr>
</tbody>
</table>
</div>

35
src/views/checkbox/CheckboxDoc.vue
View File

@ -67,6 +67,18 @@ export default {
<td>boolean</td>
<td>false</td>
<td>Allows to select a boolean value instead of multiple values.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>
@ -74,6 +86,29 @@ export default {
<h5>Events</h5>
<p>Any valid event such as focus and blur.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Parameters</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>click</td>
<td>event: Browser event</td>
<td>Callback to invoke on value click.</td>
</tr>
<tr>
<td>change</td>
<td>event: Browser event</td>
<td>Callback to invoke on value change.</td>
</tr>
</tbody>
</table>
</div>
<h5>Styling</h5>
<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>

12
src/views/chips/ChipsDoc.vue
View File

@ -69,6 +69,18 @@ import Chips from 'primevue/chips';
<td>boolean</td>
<td>true</td>
<td>Whether to allow duplicate values or not.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>

4
src/views/dialog/DialogDoc.vue
View File

@ -239,12 +239,12 @@ export default {
<tbody>
<tr>
<td>hide</td>
<td>event: Event object</td>
<td>-</td>
<td>Callback to invoke when dialog is hidden.</td>
</tr>
<tr>
<td>show</td>
<td>event: Event object</td>
<td>-</td>
<td>Callback to invoke when dialog is showed.</td>
</tr>
<tr>

12
src/views/inputnumber/InputNumberDoc.vue
View File

@ -272,6 +272,18 @@ Vertical
<td>null</td>
<td>Style class of the input field.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>
</div>

35
src/views/inputswitch/InputSwitchDoc.vue
View File

@ -55,6 +55,18 @@ export default {
<td>boolean</td>
<td>null</td>
<td>Specifies whether a inputswitch should be checked or not.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>
@ -62,6 +74,29 @@ export default {
<h5>Events</h5>
<p>Any valid event such as focus, blur and input are passed to the underlying input element. Following are the additional events to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Parameters</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>click</td>
<td>-</td>
<td>Callback to invoke on click.</td>
</tr>
<tr>
<td>change</td>
<td>-</td>
<td>Callback to invoke on value change.</td>
</tr>
</tbody>
</table>
</div>
<h5>Styling</h5>
<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>

2
src/views/multiselect/MultiSelectDoc.vue
View File

@ -370,7 +370,7 @@ export default {
<td>Shows the overlay.</td>
</tr>
<tr>
<td>Hide</td>
<td>hide</td>
<td>-</td>
<td>Hides the overlay.</td>
</tr>

7
src/views/orderlist/OrderListDoc.vue
View File

@ -137,6 +137,13 @@ import OrderList from 'primevue/orderlist';
event.direction: Direction of the change; "up", "down", "bottom", "top"
</td>
<td>Callback to invoke when the list is reordered.</td>
</tr>
<tr>
<td>selection-change</td>
<td>event.originalEvent: browser event <br />
event.value: Ordered list
</td>
<td>Callback to invoke when selection changes.</td>
</tr>
</tbody>
</table>

32
src/views/password/PasswordDoc.vue
View File

@ -130,6 +130,18 @@ import Password from 'primevue/password';
<td>A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body
and "self" for the element itself.</td>
</tr>
<tr>
<td>hideIcon</td>
<td>string</td>
<td>pi pi-eye-slash</td>
<td>Icon to hide displaying the password as plain text.</td>
</tr>
<tr>
<td>showIcon</td>
<td>string</td>
<td>pi pi-eye</td>
<td>Icon to show displaying the password as plain text.</td>
</tr>
<tr>
<td>inputStyle</td>
<td>any</td>
@ -143,16 +155,22 @@ import Password from 'primevue/password';
<td>Style class of the input field.</td>
</tr>
<tr>
<td>hideIcon</td>
<td>string</td>
<td>pi pi-eye-slash</td>
<td>Icon to hide displaying the password as plain text.</td>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>showIcon</td>
<td>class</td>
<td>string</td>
<td>pi pi-eye</td>
<td>Icon to show displaying the password as plain text.</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
<tr>
<td>panelClass</td>
<td>string</td>
<td>null</td>
<td>Style class of the overlay panel.</td>
</tr>
</tbody>
</table>

12
src/views/picklist/PickListDoc.vue
View File

@ -179,6 +179,12 @@ import PickList from 'primevue/picklist';
event.items: Moved items
</td>
<td>Callback to invoke when all items are moved to the source list.</td>
</tr>
<tr>
<td>selection-change</td>
<td>event.originalEvent: browser event <br />
event.value: Selected item</td>
<td>Callback to invoke when one or more items are moved to the other list.</td>
</tr>
</tbody>
</table>
@ -195,7 +201,7 @@ import PickList from 'primevue/picklist';
</thead>
<tbody>
<tr>
<td>sourceHeader</td>
<td>header</td>
<td>-</td>
</tr>
<tr>
@ -203,6 +209,10 @@ import PickList from 'primevue/picklist';
<td>item: Item of the component<br />
index: Index of the item</td>
</tr>
<tr>
<td>sourceHeader</td>
<td>-</td>
</tr>
<tr>
<td>targetHeader</td>
<td>-</td>

35
src/views/radiobutton/RadioButtonDoc.vue
View File

@ -59,6 +59,18 @@ export default {
<td>any</td>
<td>null</td>
<td>Value binding of the checkbox.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component input field.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>
@ -66,6 +78,29 @@ export default {
<h5>Events</h5>
<p>Any valid event such as focus and blur.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Parameters</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>click</td>
<td>-</td>
<td>Callback to invoke on radio button click.</td>
</tr>
<tr>
<td>change</td>
<td>-</td>
<td>Callback to invoke on radio button value change.</td>
</tr>
</tbody>
</table>
</div>
<h5>Styling</h5>
<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>

12
src/views/splitbutton/SplitButtonDoc.vue
View File

@ -125,6 +125,18 @@ export default {
<td>string</td>
<td>body</td>
<td>A valid query selector or an HTMLElement to specify where the overlay gets attached.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>

2
src/views/treeselect/TreeSelectDoc.vue
View File

@ -411,7 +411,7 @@ data() {
<td>Shows the overlay.</td>
</tr>
<tr>
<td>Hide</td>
<td>hide</td>
<td>-</td>
<td>Hides the overlay.</td>
</tr>

12
src/views/tristatecheckbox/TriStateCheckboxDoc.vue
View File

@ -31,6 +31,18 @@ import TriStateCheckbox from 'primevue/tristatecheckbox';
<td>boolean</td>
<td>null</td>
<td>Value of the component.</td>
</tr>
<tr>
<td>style</td>
<td>any</td>
<td>null</td>
<td>Style class of the component.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Inline style of the component.</td>
</tr>
</tbody>
</table>