Pagination

Installation

npx shadcn@latest add https://ui.timkit.cn/r/pagination.json

Usage

import { Pagination } from "@/components/ui/pagination"

Examples

Pagination · Disabled State
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Go to first page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Rows per page
Loading preview...
Pagination · Go to first page
Loading preview...
Pagination · Go to page
Loading preview...

Structured API

Component

pagination

Logic

zag / pagination

Runtime Frameworks

ReactVueWeappHTML

Supported Platforms

WebWeChat Mini Program
Configuration
PropTypeDefaultDescription
logic.provider*
enum (zag | native | none)
zagState and interaction provider used by this component.
logic.machine
string
paginationUnderlying state machine identifier when provider is zag.
platforms*
array
Web, WeChat Mini ProgramPlatforms officially supported by this schema.
frameworks*
array
React, Vue, Weapp, HTMLFramework demos/code currently available in registry files.
dependencies
array
@timui/coreRuntime package dependencies required by this registry item.
optionalPeerDependencies
array
lucide-reactOptional peer dependencies used by this registry item.
registryDependencies
array
buttonDependent Timkit registry components/hook entries.
Props
PropTypeDefaultDescription
page
number
1The current active page in controlled mode.
defaultPage
number
1The initial page used in uncontrolled mode.
count
number
-Total number of items used to calculate page count.
pageSize
number
10Number of items rendered per page.
siblingCount
number
1Number of sibling pages shown around the active page.
Events
PropTypeDefaultDescription
onPageChange
event
-Callback fired when the active page changes.
onPageSizeChange
event
-Callback fired when page size changes.
Slots
PropTypeDefaultDescription
default
slot
-The pagination segments
Parts
PropTypeDefaultDescription
root*
root
-The pagination container
content
part
-The parent of items
item
part
-A single item wrapper
link
part
-A link to a page
previous
part
-The previous page button
next
part
-The next page button
ellipsis
part
-The ellipsis indicator
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.

Extended notes are not available for this component yet.

Pagination

Installation

npx shadcn@latest add https://ui.timkit.cn/r/pagination.json

Usage

import { Pagination } from "@/components/ui/pagination"

Examples

Pagination · Disabled State
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Disabled State
Loading preview...
Pagination · Go to first page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Go to previous page
Loading preview...
Pagination · Rows per page
Loading preview...
Pagination · Go to first page
Loading preview...
Pagination · Go to page
Loading preview...

Structured API

Component

pagination

Logic

zag / pagination

Runtime Frameworks

ReactVueWeappHTML

Supported Platforms

WebWeChat Mini Program
Configuration
PropTypeDefaultDescription
logic.provider*
enum (zag | native | none)
zagState and interaction provider used by this component.
logic.machine
string
paginationUnderlying state machine identifier when provider is zag.
platforms*
array
Web, WeChat Mini ProgramPlatforms officially supported by this schema.
frameworks*
array
React, Vue, Weapp, HTMLFramework demos/code currently available in registry files.
dependencies
array
@timui/coreRuntime package dependencies required by this registry item.
optionalPeerDependencies
array
lucide-reactOptional peer dependencies used by this registry item.
registryDependencies
array
buttonDependent Timkit registry components/hook entries.
Props
PropTypeDefaultDescription
page
number
1The current active page in controlled mode.
defaultPage
number
1The initial page used in uncontrolled mode.
count
number
-Total number of items used to calculate page count.
pageSize
number
10Number of items rendered per page.
siblingCount
number
1Number of sibling pages shown around the active page.
Events
PropTypeDefaultDescription
onPageChange
event
-Callback fired when the active page changes.
onPageSizeChange
event
-Callback fired when page size changes.
Slots
PropTypeDefaultDescription
default
slot
-The pagination segments
Parts
PropTypeDefaultDescription
root*
root
-The pagination container
content
part
-The parent of items
item
part
-A single item wrapper
link
part
-A link to a page
previous
part
-The previous page button
next
part
-The next page button
ellipsis
part
-The ellipsis indicator
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.

Extended notes are not available for this component yet.