Skip to content

feat(pagination): Support better customization with semantic classNames/styles as function #54957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
meet-student merged 3 commits into from
Sep 24, 2025
Merged

feat(pagination): Support better customization with semantic classNames/styles as function #54957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d341c46
feat(pagination): Support better customization with semantic classNam…
meet-student Sep 21, 2025
db8584f
update demo
meet-student Sep 22, 2025
29fffb9
test: update demo snapshot
zombieJ Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 32 additions & 8 deletions components/pagination/Pagination.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import RcPagination from '@rc-component/pagination';
import enUS from '@rc-component/pagination/lib/locale/en_US';
import classNames from 'classnames';

import useMergeSemantic from '../_util/hooks/useMergeSemantic';
import type { SemanticClassNamesType, SemanticStylesType } from '../_util/hooks/useMergeSemantic';

import { devUseWarning } from '../_util/warning';
import { useComponentConfig } from '../config-provider/context';
import useSize from '../config-provider/hooks/useSize';
Expand All @@ -24,6 +27,14 @@ import BorderedStyle from './style/bordered';
import useShowSizeChanger from './useShowSizeChanger';

export type SemanticName = 'root' | 'item';

export type PaginationSemanticName = SemanticName;
export type PaginationClassNamesType = SemanticClassNamesType<
PaginationProps,
PaginationSemanticName
>;
export type PaginationStylesType = SemanticStylesType<PaginationProps, PaginationSemanticName>;

export interface PaginationProps
extends Omit<RcPaginationProps, 'showSizeChanger' | 'pageSizeOptions' | 'classNames' | 'styles'> {
showQuickJumper?: boolean | { goButton?: React.ReactNode };
Expand All @@ -37,8 +48,8 @@ export interface PaginationProps
selectComponentClass?: any;
/** `string` type will be removed in next major version. */
pageSizeOptions?: (string | number)[];
classNames?: Partial<Record<SemanticName, string>>;
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
classNames?: PaginationClassNamesType;
styles?: PaginationStylesType;
}

export type PaginationPosition = 'top' | 'bottom' | 'both';
Expand Down Expand Up @@ -89,6 +100,21 @@ const Pagination: React.FC<PaginationProps> = (props) => {

const isSmall = mergedSize === 'small' || !!(xs && !mergedSize && responsive);

// =========== Merged Props for Semantic ==========
const mergedProps: PaginationProps = {
...props,
size: mergedSize,
};

// ========================= Style ==========================
const [mergedClassNames, mergedStyles] = useMergeSemantic<
PaginationClassNamesType,
PaginationStylesType,
PaginationProps
>([contextClassNames, paginationClassNames], [contextStyles, styles], undefined, {
props: mergedProps,
});

// ============================= Locale =============================
const [contextLocale] = useLocale('Pagination', enUS);

Expand Down Expand Up @@ -217,15 +243,13 @@ const Pagination: React.FC<PaginationProps> = (props) => {
contextClassName,
className,
rootClassName,
contextClassNames.root,
paginationClassNames?.root,
mergedClassNames.root,
hashId,
cssVarCls,
);

const mergedStyle: React.CSSProperties = {
...contextStyles.root,
...styles?.root,
...mergedStyles.root,
...contextStyle,
...style,
};
Expand All @@ -236,8 +260,8 @@ const Pagination: React.FC<PaginationProps> = (props) => {
<RcPagination
{...iconsProps}
{...restProps}
styles={{ item: { ...contextStyles.item, ...styles?.item } }}
classNames={{ item: classNames(contextClassNames.item, paginationClassNames?.item) }}
styles={{ item: mergedStyles.item }}
classNames={{ item: mergedClassNames.item }}
style={mergedStyle}
prefixCls={prefixCls}
selectPrefixCls={selectPrefixCls}
Expand Down
Loading
Loading