Skip to content

chore(DataTable.Pagination): Convert DataTable.Pagination to CSS modules #6273

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.

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
merged 9 commits into from
Jul 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/polite-pandas-tie.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": minor
---

chore(DataTable.Pagination): Convert DataTable.Pagination to CSS modules
138 changes: 138 additions & 0 deletions packages/react/src/DataTable/Pagination.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
.TablePagination {
display: flex;
align-items: center;
justify-content: space-between;
column-gap: 1rem;
width: 100%;
grid-area: footer;
padding: var(--base-size-8) var(--base-size-16);
border: var(--borderWidth-thin) solid var(--borderColor-default);
border-top-width: 0;
border-end-start-radius: var(--borderRadius-medium);
border-end-end-radius: var(--borderRadius-medium);
}

@media ((max-width: calc(768px - 0.02px))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely separate from the refactor, would this be something we would ever want a container query for now that we can use them or is this best tied to the viewport range? (Was just curious)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I think this was a bit verbose and would love either media query variables here or container queries.

.TablePaginationSteps[data-hidden-viewport-ranges*='narrow'] > *:not(:first-child):not(:last-child) {
display: none;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='narrow'] > *:first-child {
margin-inline-end: 0;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='narrow'] > *:last-child {
margin-inline-start: 0;
}
}

@media ((min-width: 768px)) {
.TablePaginationSteps[data-hidden-viewport-ranges*='regular'] > *:not(:first-child):not(:last-child) {
display: none;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='regular'] > *:first-child {
margin-inline-end: 0;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='regular'] > *:last-child {
margin-inline-start: 0;
}
}

@media ((min-width: 1400px)) {
.TablePaginationSteps[data-hidden-viewport-ranges*='wide'] > *:not(:first-child):not(:last-child) {
display: none;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='wide'] > *:first-child {
margin-inline-end: 0;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='wide'] > *:last-child {
margin-inline-start: 0;
}
}

.TablePaginationRange {
color: var(--fgColor-muted);
font-size: var(--text-body-size-small);
margin: 0;
}

.TablePaginationSteps {
display: flex;
align-items: center;
flex-wrap: wrap;
list-style: none;
color: var(--fgColor-default);
font-size: var(--text-body-size-medium);
margin: 0;
padding: 0;
}

.TablePaginationStep:first-of-type {
margin-right: var(--base-size-16);
}

.TablePaginationStep:last-of-type {
margin-left: var(--base-size-16);
}

.TablePaginationAction {
display: flex;
align-items: center;
color: var(--fgColor-muted);
font-size: var(--text-body-size-medium);
/* stylelint-disable-next-line primer/typography */
line-height: calc(20 / 14);
user-select: none;
padding: var(--base-size-8);
border-radius: var(--borderRadius-medium);
}

.TablePaginationAction[data-has-page] {
color: var(--fgColor-accent);
}

.TablePaginationPage {
min-width: 2rem;
min-height: 2rem;
display: flex;
align-items: center;
justify-content: center;
font-size: var(--text-body-size-medium);
/* stylelint-disable-next-line primer/typography */
line-height: calc(20 / 14);
user-select: none;
border-radius: var(--borderRadius-medium);
padding: var(--base-size-8) calc((var(--base-size-32) - var(--base-size-20)) / 2); /* primer.control.medium.paddingInline.condensed primer.control.medium.paddingBlock */
}

.TablePaginationAction[data-has-page]:hover,
.TablePaginationAction[data-has-page]:focus,
.TablePaginationPage:hover,
.TablePaginationPage:focus {
background-color: var(--control-transparent-bgColor-hover);
}

.TablePaginationPage[data-active='true'] {
background-color: var(--bgColor-accent-emphasis);
color: var(--fgColor-onEmphasis);
}

.TablePaginationPage[data-active='true']:focus-visible {
outline: 2px solid var(--bgColor-accent-emphasis);
outline-offset: -2px;
/* stylelint-disable-next-line primer/box-shadow */
box-shadow: inset 0 0 0 3px var(--fgColor-onEmphasis);
}

.TablePaginationTruncationStep {
display: flex;
align-items: center;
justify-content: center;
min-width: 2rem;
min-height: 2rem;
user-select: none;
}
146 changes: 16 additions & 130 deletions packages/react/src/DataTable/Pagination.tsx
Original file line number Diff line number Diff line change
@@ -1,132 +1,15 @@
import {ChevronLeftIcon, ChevronRightIcon} from '@primer/octicons-react'
import type React from 'react'
import {useCallback, useMemo, useState} from 'react'
import styled from 'styled-components'
import {get} from '../constants'
import {Button} from '../internal/components/ButtonReset'
import {LiveRegion, LiveRegionOutlet, Message} from '../internal/components/LiveRegion'
import {VisuallyHidden} from '../VisuallyHidden'
import {warning} from '../utils/warning'
import type {ResponsiveValue} from '../hooks/useResponsiveValue'
import {viewportRanges} from '../hooks/useResponsiveValue'
import {buildPaginationModel} from '../Pagination/model'

const StyledPagination = styled.nav`
display: flex;
align-items: center;
justify-content: space-between;
column-gap: 1rem;
width: 100%;
grid-area: footer;
padding: 0.5rem 1rem;
border: 1px solid ${get('colors.border.default')};
border-top-width: 0;
border-end-start-radius: 6px;
border-end-end-radius: 6px;

.TablePaginationRange {
color: ${get('colors.fg.muted')};
font-size: 0.75rem;
margin: 0;
}

.TablePaginationSteps {
display: flex;
align-items: center;
flex-wrap: wrap;
list-style: none;
color: ${get('colors.fg.default')};
font-size: 0.875rem;
margin: 0;
padding: 0;
}

.TablePaginationStep:first-of-type {
margin-right: 1rem;
}

.TablePaginationStep:last-of-type {
margin-left: 1rem;
}

.TablePaginationAction {
display: flex;
align-items: center;
color: ${get('colors.fg.muted')};
font-size: 0.875rem;
line-height: calc(20 / 14);
user-select: none;
padding: 0.5rem;
border-radius: 6px;
}

.TablePaginationAction[data-has-page] {
color: ${get('colors.accent.fg')};
}

.TablePaginationPage {
min-width: 2rem;
min-height: 2rem;
display: flex;
align-items: center;
justify-content: center;
font-size: 0.875rem;
line-height: calc(20 / 14);
user-select: none;
border-radius: 6px;
padding: 0.5rem calc((2rem - 1.25rem) / 2); /* primer.control.medium.paddingInline.condensed primer.control.medium.paddingBlock */
}

.TablePaginationAction[data-has-page]:hover,
.TablePaginationAction[data-has-page]:focus,
.TablePaginationPage:hover,
.TablePaginationPage:focus {
background-color: ${get('colors.actionListItem.default.hoverBg')};
}

.TablePaginationPage[data-active='true'] {
background-color: ${get('colors.accent.emphasis')};
color: ${get('colors.fg.onEmphasis')};
}

.TablePaginationPage[data-active='true']:focus-visible {
outline: 2px solid var(--bgColor-accent-emphasis);
outline-offset: -2px;
box-shadow: inset 0 0 0 3px var(--fgColor-onEmphasis);
}

.TablePaginationTruncationStep {
display: flex;
align-items: center;
justify-content: center;
min-width: 2rem;
min-height: 2rem;
user-select: none;
}

${
// Hides pages based on the viewport range passed to `showPages`
Object.keys(viewportRanges)
.map(viewportRangeKey => {
return `
@media (${viewportRanges[viewportRangeKey as keyof typeof viewportRanges]}) {
.TablePaginationSteps[data-hidden-viewport-ranges*='${viewportRangeKey}'] > *:not(:first-child):not(:last-child) {
display: none;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='${viewportRangeKey}'] > *:first-child {
margin-inline-end: 0;
}

.TablePaginationSteps[data-hidden-viewport-ranges*='${viewportRangeKey}'] > *:last-child {
margin-inline-start: 0;
}
}
`
})
.join('')
}
`
import classes from './Pagination.module.css'
import {clsx} from 'clsx'

export type PaginationProps = Omit<React.ComponentPropsWithoutRef<'nav'>, 'onChange'> & {
/**
Expand Down Expand Up @@ -218,12 +101,15 @@ export function Pagination({
return (
<LiveRegion>
<LiveRegionOutlet />
<StyledPagination aria-label={label} className="TablePagination" id={id}>
<nav aria-label={label} className={clsx('TablePagination', classes.TablePagination)} id={id}>
<Range pageStart={pageStart} pageEnd={pageEnd} totalCount={totalCount} />
<ol className="TablePaginationSteps" data-hidden-viewport-ranges={getViewportRangesToHidePages().join(' ')}>
<ol
className={clsx('TablePaginationSteps', classes.TablePaginationSteps)}
data-hidden-viewport-ranges={getViewportRangesToHidePages().join(' ')}
>
<Step>
<Button
className="TablePaginationAction"
className={clsx('TablePaginationAction', classes.TablePaginationAction)}
type="button"
data-has-page={hasPreviousPage ? true : undefined}
aria-disabled={!hasPreviousPage ? true : undefined}
Expand All @@ -235,7 +121,7 @@ export function Pagination({
}}
>
{hasPreviousPage ? <ChevronLeftIcon /> : null}
<span className="TablePaginationActionLabel">Previous</span>
<span>Previous</span>
<VisuallyHidden>&nbsp;page</VisuallyHidden>
</Button>
</Step>
Expand All @@ -260,7 +146,7 @@ export function Pagination({
})}
<Step>
<Button
className="TablePaginationAction"
className={clsx('TablePaginationAction', classes.TablePaginationAction)}
type="button"
data-has-page={hasNextPage ? true : undefined}
aria-disabled={!hasNextPage ? true : undefined}
Expand All @@ -271,13 +157,13 @@ export function Pagination({
selectNextPage()
}}
>
<span className="TablePaginationActionLabel">Next</span>
<span>Next</span>
<VisuallyHidden>&nbsp;page</VisuallyHidden>
{hasNextPage ? <ChevronRightIcon /> : null}
</Button>
</Step>
</ol>
</StyledPagination>
</nav>
</LiveRegion>
)
}
Expand All @@ -294,7 +180,7 @@ function Range({pageStart, pageEnd, totalCount}: RangeProps) {
return (
<>
<Message value={`Showing ${start} through ${end} of ${totalCount}`} />
<p className="TablePaginationRange">
<p className={clsx('TablePaginationRange', classes.TablePaginationRange)}>
{start}
<VisuallyHidden>&nbsp;through&nbsp;</VisuallyHidden>
<span aria-hidden="true">‒</span>
Expand All @@ -306,14 +192,14 @@ function Range({pageStart, pageEnd, totalCount}: RangeProps) {

function TruncationStep() {
return (
<li aria-hidden="true" className="TablePaginationTruncationStep">
<li aria-hidden="true" className={clsx('TablePaginationTruncationStep', classes.TablePaginationTruncationStep)}>
</li>
)
}

function Step({children}: React.PropsWithChildren) {
return <li className="TablePaginationStep">{children}</li>
return <li className={clsx('TablePaginationStep', classes.TablePaginationStep)}>{children}</li>
}

type PageProps = React.PropsWithChildren<{
Expand All @@ -324,7 +210,7 @@ type PageProps = React.PropsWithChildren<{
function Page({active, children, onClick}: PageProps) {
return (
<Button
className="TablePaginationPage"
className={clsx('TablePaginationPage', classes.TablePaginationPage)}
type="button"
data-active={active ? true : undefined}
aria-current={active ? true : undefined}
Expand Down
17 changes: 17 additions & 0 deletions packages/react/src/internal/components/ButtonReset.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.ButtonReset {
margin: 0;
display: inline-flex;
padding: 0;
border: 0;
appearance: none;
background: none;
cursor: pointer;
text-align: start;
font: inherit;
color: inherit;
align-items: center;

&::-moz-focus-inner {
border: 0;
}
}
Loading
Loading