Skip to content
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

Update Pagination styling #1828

Merged
merged 6 commits into from
Dec 11, 2024
Merged

Update Pagination styling #1828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
70a1805
Remove background color from non-active pages in Pagination
robertknight Dec 9, 2024
f691edf
Refine styling of elided pages indicator
robertknight Dec 9, 2024
5645c90
Disable text selection in Pagination controls
robertknight Dec 9, 2024
952971c
Remove fixed heights from Prev/Next page buttons
robertknight Dec 9, 2024
70796a6
Hide Prev/Next page buttons when unavailable instead of removing them
robertknight Dec 9, 2024
b802d7a
Remove obsolete JSDoc types
robertknight Dec 9, 2024
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
97 changes: 57 additions & 40 deletions src/components/navigation/Pagination.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,49 @@
import classnames from 'classnames';
import type { JSX } from 'preact';
import type { ComponentChildren } from 'preact';

import type { PresentationalProps } from '../../types';
import { pageNumberOptions } from '../../util/pagination';
import { ArrowLeftIcon, ArrowRightIcon } from '../icons';
import Button from '../input/Button';
import type { ButtonProps } from '../input/Button';

type NavigationButtonProps = PresentationalProps &
ButtonProps &
Omit<JSX.HTMLAttributes<HTMLButtonElement>, 'icon' | 'size'>;
type NavigationButtonProps = {
children: ComponentChildren;
invisible?: boolean;
onClick: (e: MouseEvent) => void;
pressed?: boolean;
title?: string;
};
Copy link
Member Author

@robertknight robertknight Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I changed to explicitly listing all the used props here rather than using forwarding. This makes it easier to understand and constrain the variations in how this component is used. In general I am not a huge fan of using prop forwarding heavily except for components which are primarily intended to be styled wrappers around basic DOM components.


function NavigationButton({ ...buttonProps }: NavigationButtonProps) {
function NavigationButton({
children,
invisible = false,
pressed = false,
onClick,
title,
}: NavigationButtonProps) {
return (
<Button
classes={classnames(
'px-3.5 py-2.5 gap-x-1',
'font-semibold rounded',
// These colors are the same as the "dark" variant of IconButton
'text-grey-7 bg-grey-2 enabled:hover:text-grey-9 enabled:hover:bg-grey-3',
'text-grey-7 enabled:hover:text-grey-9 enabled:hover:bg-grey-3',
'disabled:text-grey-5 aria-pressed:bg-grey-3 aria-expanded:bg-grey-3',

// Disabled navigation buttons are rendered as invisible and disabled
// rather than removed so that the overall width of the component and
// positions of child controls doesn't change too much when navigating
// between pages.
Comment on lines +32 to +35
Copy link
Contributor

Choose a reason for hiding this comment

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

I would even consider keeping them visible but disabled, but this should work for now without introducing design changes.

invisible && 'invisible',
Copy link
Contributor

Choose a reason for hiding this comment

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

I reckon this should be equivalent to { invisible }

Suggested change
invisible && 'invisible',
{ invisible },

Copy link
Member Author

Choose a reason for hiding this comment

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

You are right. I find the current version slightly more obvious in its meaning. It also avoids a hazard of silently breaking things if the prop is renamed.

)}
{...buttonProps}
disabled={invisible}
onClick={onClick}
pressed={pressed}
size="custom"
title={title}
variant="custom"
/>
>
{children}
</Button>
);
}

Expand Down Expand Up @@ -58,10 +77,6 @@ export default function Pagination({
const hasPreviousPage = currentPage > 1;
const pageNumbers = pageNumberOptions(currentPage, totalPages);

/**
* @param {number} pageNumber
* @param {HTMLElement} element
*/
const changePageTo = (pageNumber: number, element: HTMLElement) => {
onChangePage(pageNumber);
// Because changing pagination page doesn't reload the page (as it would
Expand All @@ -73,21 +88,18 @@ export default function Pagination({

return (
<div
className="flex items-center text-md"
className="flex items-center text-md select-none"
data-testid="pagination-navigation"
>
<div className="w-28 h-10">
{hasPreviousPage && (
<NavigationButton
title="Go to previous page"
onClick={e =>
changePageTo(currentPage - 1, e.target as HTMLElement)
}
>
<ArrowLeftIcon />
prev
</NavigationButton>
)}
<div className="mr-2">
<NavigationButton
invisible={!hasPreviousPage}
title="Go to previous page"
onClick={e => changePageTo(currentPage - 1, e.target as HTMLElement)}
>
<ArrowLeftIcon />
prev
</NavigationButton>
</div>
<ul
className={classnames(
Expand All @@ -109,7 +121,15 @@ export default function Pagination({
{pageNumbers.map((page, idx) => (
<li key={idx}>
{page === null ? (
<div data-testid="pagination-gap">...</div>
// Indicator for elided pages. Should be approximately the same
// width as a small page number. This reduces the variation of
// the component's width as the current page is advanced.
//
// Navigation buttons have `px-3.5`. This uses `px-3` since
// an ellipsis is slightly wider than a digit.
<div className="px-3 text-center" data-testid="pagination-gap">
…
</div>
) : (
<NavigationButton
key={`page-${idx}`}
Expand All @@ -125,23 +145,20 @@ export default function Pagination({
</ul>
<div
className={classnames(
'w-28 h-10 flex justify-end',
'ml-2 flex justify-end',
// When page buttons are not shown, this element should grow to fill
// available space. But when page buttons are shown, it should not.
'grow md:grow-0',
)}
>
{hasNextPage && (
<NavigationButton
title="Go to next page"
onClick={e =>
changePageTo(currentPage + 1, e.target as HTMLElement)
}
>
next
<ArrowRightIcon />
</NavigationButton>
)}
<NavigationButton
invisible={!hasNextPage}
title="Go to next page"
onClick={e => changePageTo(currentPage + 1, e.target as HTMLElement)}
>
next
<ArrowRightIcon />
</NavigationButton>
</div>
</div>
);
Expand Down
20 changes: 12 additions & 8 deletions src/components/navigation/test/Pagination-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,18 @@ describe('Pagination', () => {
});

describe('prev button', () => {
it('should render a prev button when there are previous pages to show', () => {
it('should render enabled prev button when there are previous pages to show', () => {
const wrapper = createComponent({ currentPage: 2 });
const button = findButton(wrapper, 'Go to previous page');
assert.isTrue(button.exists());
assert.isFalse(button.find('button').hasClass('invisible'));
assert.isFalse(button.prop('disabled'));
});

it('should not render a prev button if there are no previous pages to show', () => {
it('should render disabled prev button if there are no previous pages to show', () => {
const wrapper = createComponent({ currentPage: 1 });
const button = findButton(wrapper, 'Go to previous page');
assert.isFalse(button.exists());
assert.isTrue(button.find('button').hasClass('invisible'));
assert.isTrue(button.prop('disabled'));
});

it('should invoke the onChangePage callback when clicked', () => {
Expand All @@ -66,16 +68,18 @@ describe('Pagination', () => {
});

describe('next button', () => {
it('should render a next button when there are further pages to show', () => {
it('should render enabled button when there are further pages to show', () => {
const wrapper = createComponent({ currentPage: 1 });
const button = findButton(wrapper, 'Go to next page');
assert.isTrue(button.exists());
assert.isFalse(button.find('button').hasClass('invisible'));
assert.isFalse(button.prop('disabled'));
});

it('should not render a next button if there are no further pages to show', () => {
it('should render disabled next button if there are no further pages to show', () => {
const wrapper = createComponent({ currentPage: 10 });
const button = findButton(wrapper, 'Go to next page');
assert.isFalse(button.exists());
assert.isTrue(button.find('button').hasClass('invisible'));
assert.isTrue(button.prop('disabled'));
});

it('should invoke the `onChangePage` callback when clicked', () => {
Expand Down
Loading