@yamada-ui/pagination
Version:
Yamada UI pagination component
49 lines (46 loc) • 1.27 kB
TypeScript
import * as _yamada_ui_core from '@yamada-ui/core';
import { HTMLUIProps } from '@yamada-ui/core';
interface PaginationItemOptions {
/**
* The type of the page or item assigned to the pagination item.
*/
page: "ellipsis" | "first" | "last" | "next" | "prev" | number;
/**
* If `true`, the pagination item will be activated.
*
* @default false
*/
active?: boolean;
/**
* If `true`, the pagination item will be disabled.
*
* @default false
*/
disabled?: boolean;
/**
* If `true`, disable ripple effects when pressing a element.
*
* @default false
*/
disableRipple?: boolean;
/**
* If `true`, the pagination item will be activated.
*
* @default false
*
* @deprecated Use `active` instead.
*/
isActive?: boolean;
/**
* If `true`, the pagination item will be disabled.
*
* @default false
*
* @deprecated Use `disabled` instead.
*/
isDisabled?: boolean;
}
interface PaginationItemProps extends Omit<HTMLUIProps<"button">, "page">, PaginationItemOptions {
}
declare const PaginationItem: _yamada_ui_core.Component<"button", PaginationItemProps>;
export { PaginationItem, type PaginationItemProps };