分页
Mantine Core 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。
安装
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1
入口引入 @mantine/core/styles.css,并在根组件使用 MantineProvider;通过 forceColorScheme 同步深浅色主题。
使用与验证
在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。
来源
https://github.com/mantinedev/mantine/tree/f0e2bc6d28b0f0b8aaefb5b859937bf77f539df7 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。
版本与兼容性
固定的 Mantine Core 9.7.1 要求 React 和 React DOM 满足 ^19.2.0,并配套 @mantine/hooks@9.7.1。此条件来自实际 npm 包的 peerDependencies。React 18 或其他不兼容版本不能强行安装;先向项目负责人说明升级影响并确认方案,不使用 --force/--legacy-peer-deps 掩盖冲突。入口的原生 Provider 开启 theme.respectReducedMotion,并用 forceColorScheme 控制深浅色。
适用场景
根据已知总页数选择页码。
本地示例使用的原生参数
以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。
| 组件参数 | 说明 |
|---|---|
Pagination.total | 已知总页数,不是条目数或数据请求回调。 |
交互与状态检查
当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。
业务接入边界
示例内容和状态仅保存在本地,不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。
宿主配置
先安装固定版本 @mantine/core 和 @mantine/hooks,在入口引入 @mantine/core/styles.css,并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数,不是所有原生组件都接受的统一 API;通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读,使用 npm 导出,不要单独复制内部实现。此批只覆盖 Core,不包括日期、图表和表单扩展包。上游详细说明保留英文,不宣称全文中文化。
可运行用法
以下代码使用资源原生 API;不是把其他设计系统的同名组件替换进来。
import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';
function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
return <M.Pagination total={10} />;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}
可用状态与示例
默认
示例遵循 Mantine 原生 API。支持多状态的输入组件可将示例中的 variant 改为 Disabled、Invalid 或 Read only;这些只是示例标签,不是新增的组件属性。改造时保留组件要求的数据、受控值、store 和复合子组件结构。
Usage
Example with chunked content
Controlled
To control the component state, provide value and onChange props:
import { useState } from 'react';
import { Pagination } from '@mantine/core';
function Demo() {
const [activePage, setPage] = useState(1);
return (
<Pagination value={activePage} onChange={setPage} total={10} />
);
}
Siblings
Control the number of active item siblings with the siblings prop:
Boundaries
Control the number of items displayed after previous and before next buttons with the boundaries prop:
Responsive layout
Set layout="responsive" to use CSS container queries to show a compact "Page X of Y" label
when the container is narrow. Use formatLabel prop to customize the label text.
Hide pages controls
Set withPages={false} to hide the pages controls:
Compound components
You can use the following compound components to have full control over the Pagination rendering:
Pagination.Root– context providerPagination.Items– items listPagination.Next– next controlPagination.Previous– previous controlPagination.First– first controlPagination.Last– last controlPagination.Label– compact label for responsive layout
Controls as links
Change icons
Controls size
By default, pagination controls have reduced size compared to inputs and buttons.
If you want controls to have the same size as inputs and buttons, you can use input- prefix for the size prop:
Start value
Set startValue to define the starting page number. For example, with startValue={5} and total={15},
the pagination range will be from 5 to 15:
URL synchronization
You can synchronize pagination state with URL query parameters. This pattern is commonly used for list views where you want to share the URL with a specific page selected.
Next.js
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import { Pagination } from '@mantine/core';
function Demo() {
const router = useRouter();
const searchParams = useSearchParams();
const pathname = usePathname();
const page = Number(searchParams.get('page')) || 1;
const handlePageChange = (p: number) => {
const params = new URLSearchParams(searchParams);
params.set('page', p.toString());
router.push(`${pathname}?${params.toString()}`);
};
return <Pagination total={10} value={page} onChange={handlePageChange} />;
}
react-router-dom
import { useSearchParams } from 'react-router-dom';
import { Pagination } from '@mantine/core';
function Demo() {
const [searchParams, setSearchParams] = useSearchParams();
const page = Number(searchParams.get('page')) || 1;
const handlePageChange = (p: number) => {
setSearchParams({ page: p.toString() });
};
return <Pagination total={10} value={page} onChange={handlePageChange} />;
}
nuqs
Example using nuqs:
import { useQueryState, parseAsInteger } from 'nuqs';
import { Pagination } from '@mantine/core';
function Demo() {
const [page, setPage] = useQueryState('page', parseAsInteger.withDefault(1));
return <Pagination total={10} value={page} onChange={setPage} />;
}
use-pagination hook
If you need more flexibility, the @mantine/hooks package exports the use-pagination hook.
You can use it to create custom pagination components.
源码参数参考
以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
Pagination(_props)
export type PaginationStylesNames = PaginationRootStylesNames;
export type PaginationCssVariables = PaginationRootCssVariables;
export interface PaginationProps extends PaginationRootProps {
/** If set, first/last controls are displayed @default false */
withEdges?: boolean;
/** If set, next/previous controls are displayed @default true */
withControls?: boolean;
/** Props passed down to next/previous/first/last controls */
getControlProps?: (control: 'first' | 'previous' | 'last' | 'next') => Record<string, any>;
/** Next control icon component */
nextIcon?: PaginationIcon;
/** Previous control icon component */
previousIcon?: PaginationIcon;
/** Last control icon component */
lastIcon?: PaginationIcon;
/** First control icon component */
firstIcon?: PaginationIcon;
/** Dots icon component */
dotsIcon?: PaginationIcon;
/** Key of `theme.spacing`, gap between controls @default 8 */
gap?: MantineSpacing;
/** If set, the pagination is hidden when only one page is available (`total={1}`) @default false */
hideWithOnePage?: boolean;
/** If set to `false`, page number buttons are hidden, only next/previous controls remain @default `true` */
withPages?: boolean;
/** Function to format the label text displayed in responsive mode */
formatLabel?: PaginationFormatLabel;
}
export type PaginationFactory = Factory<{
props: PaginationProps;
ref: HTMLDivElement;
stylesNames: PaginationStylesNames;
vars: PaginationCssVariables;
staticComponents: {
Root: typeof PaginationRoot;
Control: typeof PaginationControl;
Dots: typeof PaginationDots;
First: typeof PaginationFirst;
Last: typeof PaginationLast;
Next: typeof PaginationNext;
Previous: typeof PaginationPrevious;
Items: typeof PaginationItems;
Label: typeof PaginationLabel;
};
}>;
原生与外部类型
以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。
Factory<{
props: PaginationProps;
ref: HTMLDivElement;
stylesNames: PaginationStylesNames;
vars: PaginationCssVariables;
staticComponents: {
Root: typeof PaginationRoot;
Control: typeof PaginationControl;
Dots: typeof PaginationDots;
First: typeof PaginationFirst;
Last: typeof PaginationLast;
Next: typeof PaginationNext;
Previous: typeof PaginationPrevious;
Items: typeof PaginationItems;
Label: typeof PaginationLabel;
};
}>
PaginationRootProps
Record<string, any>
PaginationIcon
MantineSpacing
PaginationFormatLabel
HTMLDivElement
PaginationRootStylesNames
PaginationRootCssVariables