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

Cosmetics on Paginator Docs

pull/12/head
cagataycivici 2019-03-20 15:31:32 +03:00
parent 2ca8fab339
commit c13a844d10
3 changed files with 331 additions and 334 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/components/paginator/Paginator.vue
View File

@ -13,15 +13,15 @@
</template> </template>
<script> <script>
import CurrrentPageReport from './CurrentPageReport'; import CurrrentPageReport from './CurrentPageReport';
import FirstPageLink from './FirstPageLink'; import FirstPageLink from './FirstPageLink';
import LastPageLink from './LastPageLink'; import LastPageLink from './LastPageLink';
import NextPageLink from './NextPageLink'; import NextPageLink from './NextPageLink';
import PageLinks from './PageLinks'; import PageLinks from './PageLinks';
import PrevPageLink from './PrevPageLink'; import PrevPageLink from './PrevPageLink';
import RowsPerPageDropdown from './RowsPerPageDropdown'; import RowsPerPageDropdown from './RowsPerPageDropdown';
export default { export default {
props: { props: {
totalRecords: { totalRecords: {
type: Number, type: Number,
@ -44,8 +44,6 @@
type: String, type: String,
default: 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown' default: 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown'
}, },
leftContent: null,
rightContent: null,
currentPageReportTemplate: { currentPageReportTemplate: {
type: null, type: null,
default: '({currentPage} of {totalPages})' default: '({currentPage} of {totalPages})'
@ -154,5 +152,5 @@
this.changePage(0, event.value.code); this.changePage(0, event.value.code);
} }
} }
} }
</script> </script>

11
src/views/paginator/PaginatorDemo.vue
View File

@ -3,7 +3,7 @@
<div class="content-section introduction"> <div class="content-section introduction">
<div class="feature-intro"> <div class="feature-intro">
<h1>Paginator</h1> <h1>Paginator</h1>
<p>Paginator is a generic widget to display content in paged format.</p> <p>Paginator is a generic component to display content in paged format.</p>
</div> </div>
</div> </div>
@ -20,9 +20,9 @@
</template> </template>
<script> <script>
import PaginatorDoc from './PaginatorDoc'; import PaginatorDoc from './PaginatorDoc';
export default { export default {
data() { data() {
return { return {
first: 0, first: 0,
@ -46,8 +46,5 @@
components: { components: {
'PaginatorDoc': PaginatorDoc 'PaginatorDoc': PaginatorDoc
} }
} }
</script> </script>
<style lang="scss">
</style>

66
src/views/paginator/PaginatorDoc.vue
View File

@ -4,24 +4,31 @@
<TabPanel header="Documentation"> <TabPanel header="Documentation">
<h3>Import</h3> <h3>Import</h3>
<CodeHighlight lang="javascript"> <CodeHighlight lang="javascript">
import {Paginator} from 'primereact/paginator'; import Paginator from 'primevue/paginator';
</CodeHighlight> </CodeHighlight>
<h3>Getting Started</h3> <h3>Getting Started</h3>
<p><i>rows</i> and <i>totalRecords</i> define how many pages the paginator should display. Paginator below has 10 pages.</p> <p><i>rows</i> and <i>totalRecords</i> define how many pages the paginator should display. Paginator below has 10 pages.</p>
<CodeHighlight> <CodeHighlight>
&lt;Paginator :rows="10" :totalRecords="100"&gt;&lt;/Paginator&gt; &lt;Paginator :rows="10" :totalRecords="totalItems"&gt;&lt;/Paginator&gt;
</CodeHighlight>
<h3>Start Offset</h3>
<p><i>first</i> property defines the index of the first item displayed by the paginator. This is useful in cases where the paginator needs to be controlled programmatically such as resetting or navigating to a certain page.</p>
<CodeHighlight>
&lt;Paginator :first="offset" :rows="10" :totalRecords="totalItems"&gt;&lt;/Paginator&gt;
</CodeHighlight> </CodeHighlight>
<h3>Rows Per Page</h3> <h3>Rows Per Page</h3>
<p>Number of items per page can be changed by the user using a dropdown if you define rowsPerPageOptions as an array of possible values. In this case, <p>Number of items per page can be changed by the user using a dropdown with the <i>rowsPerPageOptions</i> property which accepts an array of possible values.</p>
rows property should also be updated <CodeHighlight>
</p> &lt;Paginator :first="offset" :rows="10" :totalRecords="totalItems" :rowsPerPageOptions="[10,20,30]"&gt;&lt;/Paginator&gt;
</CodeHighlight>
<h3>Template</h3> <h3>Template</h3>
<p>Paginator elements can be customized using the template property using the predefined keys, default value is <p>Paginator elements can be customized using the template property using the predefined keys, default value is
"FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown". Here are the available elements that "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown". Here are the available elements that
can be placed inside a paginator.</p> can be placed inside a paginator in any order.</p>
<ul> <ul>
<li>FirstPageLink</li> <li>FirstPageLink</li>
@ -33,6 +40,26 @@ import {Paginator} from 'primereact/paginator';
<li>CurrentPageReport</li> <li>CurrentPageReport</li>
</ul> </ul>
<CodeHighlight>
&lt;Paginator :first="offset" :rows="10" :totalRecords="totalItems" template="FirstPageLink PrevPageLink CurrentPageReport NextPageLink LastPageLink"&gt;&lt;/Paginator&gt;
</CodeHighlight>
<h3>Page Change Event</h3>
<p>Paginator provides only one event called <i>page-change</i> along with all the information about the change event</p>
<CodeHighlight>
&lt;Paginator :first="offset" :rows="10" :totalRecords="totalItems" @page-change="onPage($event)"&gt;&lt;/Paginator&gt;
</CodeHighlight>
<CodeHighlight lang="javascript">
onPage(event) {
//event.page: New page number
//event.first: Index of first record
//event.rows: Number of rows to display in new page
//event.page: Index of the new page
//event.pageCount: Total number of pages
}
</CodeHighlight>
<h3>Properties</h3> <h3>Properties</h3>
<div class="doc-tablewrapper"> <div class="doc-tablewrapper">
<table class="doc-table"> <table class="doc-table">
@ -75,36 +102,12 @@ import {Paginator} from 'primereact/paginator';
<td>null</td> <td>null</td>
<td>Array of integer values to display inside rows per page dropdown.</td> <td>Array of integer values to display inside rows per page dropdown.</td>
</tr> </tr>
<tr>
<td>style</td>
<td>string</td>
<td>null</td>
<td>Inline style of the element.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Style class of the element.</td>
</tr>
<tr> <tr>
<td>template</td> <td>template</td>
<td>string</td> <td>string</td>
<td>FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown</td> <td>FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown</td>
<td>Template of the paginator.</td> <td>Template of the paginator.</td>
</tr> </tr>
<tr>
<td>leftContent</td>
<td>any</td>
<td>null</td>
<td>Content to inject into the left side of the paginator.</td>
</tr>
<tr>
<td>rightContent</td>
<td>any</td>
<td>null</td>
<td>Content to inject into the right side of the paginator.</td>
</tr>
<tr> <tr>
<td>currentPageReportTemplate</td> <td>currentPageReportTemplate</td>
<td>string</td> <td>string</td>
@ -127,7 +130,7 @@ import {Paginator} from 'primereact/paginator';
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>onPageChange</td> <td>page-change</td>
<td>event.page: New page number <br/> <td>event.page: New page number <br/>
event.first: Index of first record <br/> event.first: Index of first record <br/>
event.rows: Number of rows to display in new page <br/> event.rows: Number of rows to display in new page <br/>
@ -189,7 +192,6 @@ import {Paginator} from 'primereact/paginator';
<h3>Dependencies</h3> <h3>Dependencies</h3>
<p>None.</p> <p>None.</p>
</div> </div>
</TabPanel> </TabPanel>
<TabPanel header="Source"> <TabPanel header="Source">