mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
60a796ea48* Add `tooltipPosition` to `PaginationNav` per #1656 * Rebuild test * Update description in documentation Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com> * chore: update docs --------- Co-authored-by: Samuel Janda <hi@simpleprogramming.com.au> Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com> Co-authored-by: Enrico Sacchetti <enrico@theetrain.ca>
58 lines
1.2 KiB
TypeScript
58 lines
1.2 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface PaginationNavProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
|
|
/**
|
|
* Specify the current page index
|
|
* @default 1
|
|
*/
|
|
page?: number;
|
|
|
|
/**
|
|
* Specify the total number of pages
|
|
* @default 10
|
|
*/
|
|
total?: number;
|
|
|
|
/**
|
|
* Specify the total number of pages to show
|
|
* @default 10
|
|
*/
|
|
shown?: number;
|
|
|
|
/**
|
|
* Set to `true` to loop the navigation
|
|
* @default false
|
|
*/
|
|
loop?: boolean;
|
|
|
|
/**
|
|
* Specify the forward button text
|
|
* @default "Next page"
|
|
*/
|
|
forwardText?: string;
|
|
|
|
/**
|
|
* Specify the backward button text
|
|
* @default "Previous page"
|
|
*/
|
|
backwardText?: string;
|
|
|
|
/**
|
|
* Set the position of the tooltip relative to the pagination buttons.
|
|
* @default "bottom"
|
|
*/
|
|
tooltipPosition?: "top" | "right" | "bottom" | "left" | "outside" | "inside";
|
|
}
|
|
|
|
export default class PaginationNav extends SvelteComponentTyped<
|
|
PaginationNavProps,
|
|
{
|
|
/** fires after every user interaction */
|
|
change: CustomEvent<{ page: number }>;
|
|
["click:button--previous"]: CustomEvent<{ page: number }>;
|
|
["click:button--next"]: CustomEvent<{ page: number }>;
|
|
},
|
|
{}
|
|
> {}
|