mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
129 lines
3.1 KiB
TypeScript
129 lines
3.1 KiB
TypeScript
import type { SvelteComponentTyped } from "svelte";
|
||
import type { SvelteHTMLElements } from "svelte/elements";
|
||
|
||
type $RestProps = SvelteHTMLElements["div"];
|
||
|
||
type $Props = {
|
||
/**
|
||
* Specify the current page index
|
||
* @default 1
|
||
*/
|
||
page?: number;
|
||
|
||
/**
|
||
* Specify the total number of items
|
||
* @default 0
|
||
*/
|
||
totalItems?: number;
|
||
|
||
/**
|
||
* If `totalItems` is a large number, it can affect the
|
||
* rendering performance of this component since its value
|
||
* is used to calculate the number of pages in the native
|
||
* select dropdown. This value creates a small window of
|
||
* pages rendered around the current page. By default,
|
||
* a maximum of 1000 select items are rendered.
|
||
* @default 1000
|
||
*/
|
||
pageWindow?: number;
|
||
|
||
/**
|
||
* Set to `true` to disable the pagination
|
||
* @default false
|
||
*/
|
||
disabled?: boolean;
|
||
|
||
/**
|
||
* Specify the forward button text
|
||
* @default "Next page"
|
||
*/
|
||
forwardText?: string;
|
||
|
||
/**
|
||
* Specify the backward button text
|
||
* @default "Previous page"
|
||
*/
|
||
backwardText?: string;
|
||
|
||
/**
|
||
* Specify the items per page text
|
||
* @default "Items per page:"
|
||
*/
|
||
itemsPerPageText?: string;
|
||
|
||
/**
|
||
* Override the item text
|
||
* @default (min, max) => `${min.toLocaleString()}–${max.toLocaleString()} item${max === 1 ? "" : "s"}`
|
||
*/
|
||
itemText?: (min: number, max: number) => string;
|
||
|
||
/**
|
||
* Override the item range text
|
||
* @default (min, max, total) => `${min.toLocaleString()}–${max.toLocaleString()} of ${total.toLocaleString()} item${max === 1 ? "" : "s"}`
|
||
*/
|
||
itemRangeText?: (min: number, max: number, total: number) => string;
|
||
|
||
/**
|
||
* Set to `true` to disable the page input
|
||
* @default false
|
||
*/
|
||
pageInputDisabled?: boolean;
|
||
|
||
/**
|
||
* Set to `true` to disable the page size input
|
||
* @default false
|
||
*/
|
||
pageSizeInputDisabled?: boolean;
|
||
|
||
/**
|
||
* Specify the number of items to display in a page
|
||
* @default 10
|
||
*/
|
||
pageSize?: number;
|
||
|
||
/**
|
||
* Specify the available page sizes
|
||
* @default [10]
|
||
*/
|
||
pageSizes?: ReadonlyArray<number>;
|
||
|
||
/**
|
||
* Set to `true` if the number of pages is unknown
|
||
* @default false
|
||
*/
|
||
pagesUnknown?: boolean;
|
||
|
||
/**
|
||
* Override the page text
|
||
* @default (page) => `page ${page.toLocaleString()}`
|
||
*/
|
||
pageText?: (page: number) => string;
|
||
|
||
/**
|
||
* Override the page range text
|
||
* @default (current, total) => `of ${total.toLocaleString()} page${total === 1 ? "" : "s"}`
|
||
*/
|
||
pageRangeText?: (current: number, total: number) => string;
|
||
|
||
/**
|
||
* Set an id for the top-level element
|
||
* @default "ccs-" + Math.random().toString(36)
|
||
*/
|
||
id?: string;
|
||
|
||
[key: `data-${string}`]: any;
|
||
};
|
||
|
||
export type PaginationProps = Omit<$RestProps, keyof $Props> & $Props;
|
||
|
||
export default class Pagination extends SvelteComponentTyped<
|
||
PaginationProps,
|
||
{
|
||
/** Dispatched after any user interaction */
|
||
change: CustomEvent<{ page?: number; pageSize?: number }>;
|
||
["click:button--previous"]: CustomEvent<{ page: number }>;
|
||
["click:button--next"]: CustomEvent<{ page: number }>;
|
||
update: CustomEvent<{ pageSize: number; page: number }>;
|
||
},
|
||
{}
|
||
> {}
|