@atlaskit/pagination/report.api.md

Pagination allows you to divide large amounts of content into smaller chunks across multiple pages.

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/pagination"

> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
import type { CSSProperties } from 'react';
import { default as React_2 } from 'react';
import type { ReactElement } from 'react';
import type { SyntheticEvent } from 'react';
import { UIAnalyticsEvent } from '@atlaskit/analytics-next';

// @public (undocumented)
const _default: typeof InnerPagination;
export default _default;

// @public (undocumented)
function InnerPagination<T>(
	{
		components,
		defaultSelectedIndex,
		selectedIndex,
		label,
		pageLabel,
		previousLabel,
		nextLabel,
		style,
		max,
		onChange,
		pages,
		getPageLabel,
		renderEllipsis,
		analyticsContext,
		testId,
	}: PaginationPropTypes<T>,
	ref: React_2.Ref<HTMLDivElement>,
): JSX.Element;

// @public (undocumented)
export interface PaginationPropTypes<T = unknown> {
	analyticsContext?: Record<string, any>;
	components?: {
		Page?: React.ElementType;
		Previous?: React.ElementType;
		Next?: React.ElementType;
	};
	defaultSelectedIndex?: number;
	getPageLabel?: (page: T, pageIndex: number) => number | string;
	label?: string;
	max?: number;
	nextLabel?: string;
	onChange?: (event: SyntheticEvent, page: T, analyticsEvent?: UIAnalyticsEvent) => void;
	pageLabel?: string;
	pages: T[];
	previousLabel?: string;
	renderEllipsis?: (arg: { key: string }) => ReactElement;
	selectedIndex?: number;
	style?: CSSProperties;
	testId?: string;
}

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{
	"react": "^16.8.0"
}
```

<!--SECTION END: Peer Dependencies-->