mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props
This commit is contained in:
parent
d38e6d8be6
commit
75d4b4cf03
219 changed files with 5168 additions and 5259 deletions
196
types/Pagination/Pagination.d.ts
vendored
196
types/Pagination/Pagination.d.ts
vendored
|
@ -1,103 +1,105 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export interface PaginationProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
||||
/**
|
||||
* Specify the current page index
|
||||
* @default 1
|
||||
*/
|
||||
page?: number;
|
||||
|
||||
/**
|
||||
* Specify the total number of items
|
||||
* @default 0
|
||||
*/
|
||||
totalItems?: 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}–${max} items`
|
||||
*/
|
||||
itemText?: (min: number, max: number) => string;
|
||||
|
||||
/**
|
||||
* Override the item range text
|
||||
* @default (min, max, total) => `${min}–${max} of ${total} items`
|
||||
*/
|
||||
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?: number[];
|
||||
|
||||
/**
|
||||
* Set to `true` if the number of pages is unknown
|
||||
* @default false
|
||||
*/
|
||||
pagesUnknown?: boolean;
|
||||
|
||||
/**
|
||||
* Override the page text
|
||||
* @default (page) => `page ${page}`
|
||||
*/
|
||||
pageText?: (page: number) => string;
|
||||
|
||||
/**
|
||||
* Override the page range text
|
||||
* @default (current, total) => `of ${total} 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;
|
||||
}
|
||||
|
||||
export default class Pagination {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
|
||||
/**
|
||||
* Specify the current page index
|
||||
* @default 1
|
||||
*/
|
||||
page?: number;
|
||||
|
||||
/**
|
||||
* Specify the total number of items
|
||||
* @default 0
|
||||
*/
|
||||
totalItems?: 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}–${max} items`
|
||||
*/
|
||||
itemText?: (min: number, max: number) => string;
|
||||
|
||||
/**
|
||||
* Override the item range text
|
||||
* @default (min, max, total) => `${min}–${max} of ${total} items`
|
||||
*/
|
||||
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?: number[];
|
||||
|
||||
/**
|
||||
* Set to `true` if the number of pages is unknown
|
||||
* @default false
|
||||
*/
|
||||
pagesUnknown?: boolean;
|
||||
|
||||
/**
|
||||
* Override the page text
|
||||
* @default (page) => `page ${page}`
|
||||
*/
|
||||
pageText?: (page: number) => string;
|
||||
|
||||
/**
|
||||
* Override the page range text
|
||||
* @default (current, total) => `of ${total} page${total === 1 ? "" : "s"}`
|
||||
*/
|
||||
pageRangeText?: (current: number, total: number) => string;
|
||||
|
||||
/**
|
||||
* Set an id for the top-level element
|
||||
*/
|
||||
id?: string;
|
||||
};
|
||||
|
||||
$$prop_def: PaginationProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "update", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
|
|
5
types/Pagination/PaginationSkeleton.d.ts
vendored
5
types/Pagination/PaginationSkeleton.d.ts
vendored
|
@ -1,8 +1,9 @@
|
|||
/// <reference types="svelte" />
|
||||
|
||||
export default class PaginationSkeleton {
|
||||
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {};
|
||||
export interface PaginationSkeletonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {}
|
||||
|
||||
export default class PaginationSkeleton {
|
||||
$$prop_def: PaginationSkeletonProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue