Skip to content

fix(Pagination): prevented regenerating random id on each render #8175

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
tlabaj merged 4 commits into from
Oct 26, 2022
Merged

fix(Pagination): prevented regenerating random id on each render #8175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
247dfdf
fix(Pagination): prevented regenerating random id on each render
nicolethoen Oct 5, 2022
694d908
fix duplicate ids in existing demos
nicolethoen Oct 6, 2022
c28abfa
fix(Pagination): update column management table demo pagination
nicolethoen Oct 7, 2022
53d111d
add unit test
nicolethoen Oct 25, 2022
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
3 changes: 1 addition & 2 deletions packages/react-core/src/components/Pagination/OptionsToggle.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ export interface OptionsToggleProps extends React.HTMLProps<HTMLDivElement> {
widgetId?: string;
}

let toggleId = 0;
export const OptionsToggle: React.FunctionComponent<OptionsToggleProps> = ({
itemsTitle = 'items',
optionsToggle,
Expand Down Expand Up @@ -95,7 +94,7 @@ export const OptionsToggle: React.FunctionComponent<OptionsToggleProps> = ({
onToggle={onToggle}
isDisabled={isDisabled || (itemCount && itemCount <= 0)}
isOpen={isOpen}
id={`${widgetId}-toggle-${toggleId++}`}
{...(widgetId && { id: `${widgetId}-toggle` })}
className={isDiv ? styles.optionsMenuToggleButton : toggleClasses}
parentRef={parentRef}
aria-haspopup="listbox"
Expand Down
7 changes: 3 additions & 4 deletions packages/react-core/src/components/Pagination/Pagination.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ const handleInputWidth = (lastPage: number, node: HTMLDivElement) => {
}
};

let paginationId = 0;
export class Pagination extends React.Component<PaginationProps, { ouiaStateId: string }> {
static displayName = 'Pagination';
paginationRef = React.createRef<HTMLDivElement>();
Expand Down Expand Up @@ -211,7 +210,7 @@ export class Pagination extends React.Component<PaginationProps, { ouiaStateId:
itemsStart: null,
itemsEnd: null,
perPageOptions: defaultPerPageOptions,
widgetId: 'pagination-options-menu',
widgetId: 'options-menu',
onSetPage: () => undefined,
onPerPageSelect: () => undefined,
onFirstClick: () => undefined,
Expand Down Expand Up @@ -319,7 +318,7 @@ export class Pagination extends React.Component<PaginationProps, { ouiaStateId:
isSticky && styles.modifiers.sticky,
className
)}
id={`${widgetId}-${paginationId++}`}
{...(widgetId && { id: `${widgetId}-${variant}-pagination` })}
{...getOUIAProps(Pagination.displayName, ouiaId !== undefined ? ouiaId : this.state.ouiaStateId, ouiaSafe)}
{...props}
>
Expand Down Expand Up @@ -356,7 +355,7 @@ export class Pagination extends React.Component<PaginationProps, { ouiaStateId:
lastPage={lastPage}
onPerPageSelect={onPerPageSelect}
dropDirection={dropDirection}
widgetId={widgetId}
widgetId={`${widgetId}-${variant}`}
toggleTemplate={toggleTemplate}
isDisabled={isDisabled}
perPageComponent={perPageComponent}
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Pagination/PaginationOptionsMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ export class PaginationOptionsMenu extends React.Component<PaginationOptionsMenu
return (
<DropdownContext.Provider
value={{
id: widgetId,
...(widgetId && { id: widgetId }),
onSelect: this.onSelect,
toggleIndicatorClass:
perPageComponent === 'div' ? styles.optionsMenuToggleButtonIcon : styles.optionsMenuToggleIcon,
Expand Down
2 changes: 1 addition & 1 deletion ...e/src/components/Pagination/__tests__/Generated/__snapshots__/OptionsToggle.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ exports[`OptionsToggle should match snapshot (auto-generated) 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-1"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="''-toggle-0"
id="''-toggle"
type="button"
>
<span
Expand Down
7 changes: 7 additions & 0 deletions packages/react-core/src/components/Pagination/__tests__/Pagination.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ describe('Pagination', () => {
const { asFragment } = render(<Pagination perPageComponent="button" itemCount={20} />);
expect(asFragment()).toMatchSnapshot();
});

test('should not update generated options menu id on rerenders', () => {
Copy link
Contributor

@tlabaj tlabaj Oct 26, 2022

Choose a reason for hiding this comment

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

👍

const { rerender } = render(<Pagination titles={{optionsToggle: "test label"}} perPageComponent="button" itemCount={20}/>);
const id = screen.getByLabelText("test label").getAttribute("id");
rerender(<Pagination titles={{optionsToggle: "test label"}} perPageComponent="button" itemCount={20} />);
expect(screen.getByLabelText("test label")).toHaveAttribute("id", id);
});
});

describe('API', () => {
Expand Down
62 changes: 31 additions & 31 deletions ...ges/react-core/src/components/Pagination/__tests__/__snapshots__/Pagination.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ exports[`Pagination component render custom pagination toggle 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-12"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-13"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -36,7 +36,7 @@ exports[`Pagination component render custom pagination toggle 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-13"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-12"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -206,7 +206,7 @@ exports[`Pagination component render custom perPageOptions 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-8"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-9"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -249,7 +249,7 @@ exports[`Pagination component render custom perPageOptions 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-10"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-9"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -419,7 +419,7 @@ exports[`Pagination component render custom start end 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-10"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-11"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -462,7 +462,7 @@ exports[`Pagination component render custom start end 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-11"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-10"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -630,7 +630,7 @@ exports[`Pagination component render empty per page options 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-9"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-10"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -801,7 +801,7 @@ exports[`Pagination component render last page 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-7"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-8"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -844,7 +844,7 @@ exports[`Pagination component render last page 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-9"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-8"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1014,7 +1014,7 @@ exports[`Pagination component render limited number of pages 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-5"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-6"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -1057,7 +1057,7 @@ exports[`Pagination component render limited number of pages 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-7"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-6"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1230,7 +1230,7 @@ exports[`Pagination component render should render correctly bottom 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-bottom-1"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-1"
id="options-menu-bottom-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -1261,7 +1261,7 @@ exports[`Pagination component render should render correctly bottom 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-2"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-1"
id="options-menu-bottom-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1431,7 +1431,7 @@ exports[`Pagination component render should render correctly bottom sticky 1`] =
data-ouia-component-id="OUIA-Generated-Pagination-bottom-2"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-4"
id="options-menu-bottom-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -1462,7 +1462,7 @@ exports[`Pagination component render should render correctly bottom sticky 1`] =
data-ouia-component-id="OUIA-Generated-DropdownToggle-5"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-4"
id="options-menu-bottom-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1632,7 +1632,7 @@ exports[`Pagination component render should render correctly button variant 1`]
data-ouia-component-id="OUIA-Generated-Pagination-top-17"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-18"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -1660,7 +1660,7 @@ exports[`Pagination component render should render correctly button variant 1`]
data-ouia-component-id="OUIA-Generated-DropdownToggle-18"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-17"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1841,7 +1841,7 @@ exports[`Pagination component render should render correctly compact 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-2"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-2"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -1884,7 +1884,7 @@ exports[`Pagination component render should render correctly compact 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-3"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-2"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -1980,7 +1980,7 @@ exports[`Pagination component render should render correctly disabled 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-4"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-5"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -2024,7 +2024,7 @@ exports[`Pagination component render should render correctly disabled 1`] = `
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
disabled=""
id="pagination-options-menu-toggle-5"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -2197,7 +2197,7 @@ exports[`Pagination component render should render correctly sticky 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-3"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-3"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -2240,7 +2240,7 @@ exports[`Pagination component render should render correctly sticky 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-4"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-3"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -2410,7 +2410,7 @@ exports[`Pagination component render should render correctly top 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-1"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-0"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -2453,7 +2453,7 @@ exports[`Pagination component render should render correctly top 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-1"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-0"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -2623,7 +2623,7 @@ exports[`Pagination component render titles 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-11"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-12"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -2666,7 +2666,7 @@ exports[`Pagination component render titles 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-12"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-11"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -2836,7 +2836,7 @@ exports[`Pagination component render up drop direction 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-13"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-14"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -2879,7 +2879,7 @@ exports[`Pagination component render up drop direction 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-14"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-13"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down Expand Up @@ -3049,7 +3049,7 @@ exports[`Pagination component render zero results 1`] = `
data-ouia-component-id="OUIA-Generated-Pagination-top-6"
data-ouia-component-type="PF4/Pagination"
data-ouia-safe="true"
id="pagination-options-menu-7"
id="options-menu-top-pagination"
style="--pf-c-pagination__nav-page-select--c-form-control--width-chars: 2;"
>
<div
Expand Down Expand Up @@ -3092,7 +3092,7 @@ exports[`Pagination component render zero results 1`] = `
data-ouia-component-id="OUIA-Generated-DropdownToggle-8"
data-ouia-component-type="PF4/DropdownToggle"
data-ouia-safe="true"
id="pagination-options-menu-toggle-7"
id="options-menu-top-toggle"
type="button"
>
<span
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Pagination/examples/PaginationBottom.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const PaginationBottom: React.FunctionComponent = () => {
<Pagination
perPageComponent="button"
itemCount={333}
widgetId="pagination-options-menu-bottom"
widgetId="bottom-example"
perPage={perPage}
page={page}
variant={PaginationVariant.bottom}
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Pagination/examples/PaginationCompact.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const PaginationCompact: React.FunctionComponent = () => {
perPage={perPage}
page={page}
onSetPage={onSetPage}
widgetId="pagination-options-menu-top"
widgetId="compact-example"
onPerPageSelect={onPerPageSelect}
isCompact
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Pagination/examples/PaginationDisabled.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const PaginationDisabled: React.FunctionComponent = () => {
perPage={perPage}
page={page}
onSetPage={onSetPage}
widgetId="pagination-options-menu-top"
widgetId="disabled-example"
onPerPageSelect={onPerPageSelect}
isDisabled
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Pagination/examples/PaginationIndeterminate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export const PaginationIndeterminate: React.FunctionComponent = () => {
<b>many</b>
</React.Fragment>
)}
widgetId="pagination-indeterminate"
widgetId="indeterminate-example"
perPage={perPage}
page={page}
onSetPage={onSetPage}
Expand Down
Loading