Skip to content

Commit

Permalink
Documentation updates for the new components
Browse files Browse the repository at this point in the history
  • Loading branch information
cagataycivici committed Dec 2, 2020
1 parent 5a2d290 commit 5323d88
Show file tree
Hide file tree
Showing 7 changed files with 81 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/views/avatar/AvatarDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ import AvatarGroup from 'primevue/avatargroup';
</table>
</div>

<h5>Properties of AvatarGrouo</h5>
<h5>Properties of AvatarGroup</h5>
<p>Any property as style and class are passed to the main container element. There are no additional properties.</p>

<h5>Styling of Avatar</h5>
Expand Down
35 changes: 35 additions & 0 deletions src/views/badge/BadgeDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,41 @@ import Badge from 'primevue/badge';

</code></pre>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>value</td>
<td>any</td>
<td>null</td>
<td>Value to display inside the badge.</td>
</tr>
<tr>
<td>severity</td>
<td>string</td>
<td>null</td>
<td>Severity type of the badge.</td>
</tr>
<tr>
<td>size</td>
<td>string</td>
<td>null</td>
<td>Size of the badge, valid options are "large" and "xlarge".</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>
<div class="doc-tablewrapper">
Expand Down
1 change: 1 addition & 0 deletions src/views/confirmdialog/ConfirmDialogDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ export default {
</div>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
Expand Down
1 change: 1 addition & 0 deletions src/views/confirmpopup/ConfirmPopupDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ export default {
</div>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
Expand Down
1 change: 1 addition & 0 deletions src/views/divider/DividerDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ import Divider from 'primevue/divider';
</code></pre>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
Expand Down
1 change: 1 addition & 0 deletions src/views/scrolltop/ScrollTopDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import ScrollTop from 'primevue/scrolltop';
</code></pre>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
Expand Down
41 changes: 41 additions & 0 deletions src/views/tag/TagDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,47 @@ import Tag from 'primevue/tag';

</code></pre>

<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>value</td>
<td>any</td>
<td>null</td>
<td>Value to display inside the tag.</td>
</tr>
<tr>
<td>severity</td>
<td>string</td>
<td>null</td>
<td>Severity type of the tag.</td>
</tr>
<tr>
<td>rounded</td>
<td>boolean</td>
<td>false</td>
<td>Whether the corners of the tag are rounded.</td>
</tr>
<tr>
<td>icon</td>
<td>string</td>
<td>null</td>
<td>Icon of the tag to display next to the value.</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>
<div class="doc-tablewrapper">
Expand Down

0 comments on commit 5323d88

Please sign in to comment.