chore: complete first pass of apply jsdoc annotations to component props

This commit is contained in:
Eric Liu 2020-07-26 17:42:12 -07:00
commit f30755b237
97 changed files with 2327 additions and 259 deletions

View file

@ -1,19 +1,88 @@
<script>
/**
* Specify the current page index
* @type {number} [page=1]
*/
export let page = 1;
/**
* Specify the total number of items
* @type {number} [total=0]
*/
export let totalItems = 0;
/**
* Set to `true` to disable the pagination
* @type {boolean} [disabled=false]
*/
export let disabled = false;
/**
* Specify the forward button text
* @type {string} [forwardText="Next page"]
*/
export let forwardText = "Next page";
/**
* Specify the backward button text
* @type {string} [backwardText="Previous page"]
*/
export let backwardText = "Previous page";
/**
* Specify the items per page text
* @type {string} [itemsPerPageText="Items per page:"]
*/
export let itemsPerPageText = "Items per page:";
/**
* Override the item text
* @type {(min: number, max: number) => string;} [itemText = (min: number, max: number) => string;]
*/
export let itemText = (min, max) => `${min}${max} items`;
/**
* Override the item range text
* @type {(min: number, max: number, total: number) => string;} [itemRangeText = (min: number, max: number, total: number) => string;]
*/
export let itemRangeText = (min, max, total) =>
`${min}${max} of ${total} items`;
export let itemsPerPageText = "Items per page:";
export let itemText = (min, max) => `${min}${max} items`;
export let page = 1;
/**
* Set to `true` to disable the page input
* @type {boolean} [pageInputDisabled=false]
*/
export let pageInputDisabled = false;
export let pageRangeText = (current, total) => `of ${total} pages`;
/**
* Specify the number of items to display in a page
* @type {number} [pageSize=10]
*/
export let pageSize = 10;
/**
* Specify the available page sizes
* @type {number[]} [pageSizes=[10]]
*/
export let pageSizes = [10];
/**
* Set to `true` if the number of pages is unknown
* @type {boolean} [pagesUnknown=false]
*/
export let pagesUnknown = false;
export let pageText = page => `page ${page}`;
/**
* Override the page text
* @type {(page: number) => string;} [pageText = (current: number) => string;]
*/
export let pageText = (page) => `page ${page}`;
/**
* Override the page range text
* @type {(current: number, total: number) => string;} [pageRangeText = (current: number, total: number) => string;]
*/
export let pageRangeText = (current, total) => `of ${total} pages`;
/**
* Set an id for the top-level element