Skip to content

Commit d74be70

Browse files
authored
chore(pagination): rename ToggleTemplateProps to PaginationToggleTemplateProps in pagination component (#8134)
1 parent b46769c commit d74be70

File tree

6 files changed

+25
-15
lines changed

6 files changed

+25
-15
lines changed

packages/react-core/src/components/Pagination/OptionsToggle.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import styles from '@patternfly/react-styles/css/components/OptionsMenu/options-
33
import { css } from '@patternfly/react-styles';
44

55
import { fillTemplate } from '../../helpers';
6-
import { ToggleTemplateProps } from './ToggleTemplate';
6+
import { PaginationToggleTemplateProps } from './ToggleTemplate';
77
import { DropdownToggle } from '../Dropdown';
88

99
export interface OptionsToggleProps extends React.HTMLProps<HTMLDivElement> {
@@ -39,7 +39,7 @@ export interface OptionsToggleProps extends React.HTMLProps<HTMLDivElement> {
3939
showToggle?: boolean;
4040
/** This will be shown in pagination toggle span. You can use firstIndex, lastIndex,
4141
* itemCount, and/or itemsTitle props. */
42-
toggleTemplate?: ((props: ToggleTemplateProps) => React.ReactElement) | string;
42+
toggleTemplate?: ((props: PaginationToggleTemplateProps) => React.ReactElement) | string;
4343
/** Id added to the title of the pagination options menu. */
4444
widgetId?: string;
4545
}

packages/react-core/src/components/Pagination/Pagination.tsx

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as React from 'react';
2-
import { ToggleTemplate, ToggleTemplateProps } from './ToggleTemplate';
2+
import { ToggleTemplate, PaginationToggleTemplateProps } from './ToggleTemplate';
33
import styles from '@patternfly/react-styles/css/components/Pagination/pagination';
44
import { css } from '@patternfly/react-styles';
55

@@ -154,7 +154,7 @@ export interface PaginationProps extends React.HTMLProps<HTMLDivElement>, OUIAPr
154154
/** This will be shown in pagination toggle span. You can use firstIndex, lastIndex,
155155
* itemCount, itemsTitle, and/or ofWord props.
156156
*/
157-
toggleTemplate?: ((props: ToggleTemplateProps) => React.ReactElement) | string;
157+
toggleTemplate?: ((props: PaginationToggleTemplateProps) => React.ReactElement) | string;
158158
/** Position where pagination is rendered. */
159159
variant?: 'top' | 'bottom' | PaginationVariant;
160160
/** Id to ideintify widget on page. */
@@ -306,7 +306,13 @@ export class Pagination extends React.Component<PaginationProps, { ouiaStateId:
306306
}
307307
}
308308

309-
const toggleTemplateProps = { firstIndex, lastIndex, itemCount, itemsTitle: titles.items, ofWord: titles.ofWord };
309+
const PaginationToggleTemplateProps = {
310+
firstIndex,
311+
lastIndex,
312+
itemCount,
313+
itemsTitle: titles.items,
314+
ofWord: titles.ofWord
315+
};
310316

311317
return (
312318
<div
@@ -325,10 +331,14 @@ export class Pagination extends React.Component<PaginationProps, { ouiaStateId:
325331
>
326332
{variant === PaginationVariant.top && (
327333
<div className={css(styles.paginationTotalItems)}>
328-
{toggleTemplate && typeof toggleTemplate === 'string' && fillTemplate(toggleTemplate, toggleTemplateProps)}
334+
{toggleTemplate &&
335+
typeof toggleTemplate === 'string' &&
336+
fillTemplate(toggleTemplate, PaginationToggleTemplateProps)}
329337
{toggleTemplate &&
330338
typeof toggleTemplate !== 'string' &&
331-
(toggleTemplate as (props: ToggleTemplateProps) => React.ReactElement)(toggleTemplateProps)}
339+
(toggleTemplate as (props: PaginationToggleTemplateProps) => React.ReactElement)(
340+
PaginationToggleTemplateProps
341+
)}
332342
{!toggleTemplate && (
333343
<ToggleTemplate
334344
firstIndex={firstIndex}

packages/react-core/src/components/Pagination/PaginationOptionsMenu.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { css } from '@patternfly/react-styles';
44
import { DropdownItem, DropdownDirection, DropdownWithContext, DropdownContext } from '../Dropdown';
55
import CheckIcon from '@patternfly/react-icons/dist/esm/icons/check-icon';
66
import { OptionsToggle } from './OptionsToggle';
7-
import { ToggleTemplateProps, ToggleTemplate } from './ToggleTemplate';
7+
import { PaginationToggleTemplateProps, ToggleTemplate } from './ToggleTemplate';
88
import { PerPageOptions, OnPerPageSelect } from './Pagination';
99

1010
export interface PaginationOptionsMenuProps extends React.HTMLProps<HTMLDivElement> {
@@ -45,7 +45,7 @@ export interface PaginationOptionsMenuProps extends React.HTMLProps<HTMLDivEleme
4545
/** This will be shown in pagination toggle span. You can use firstIndex, lastIndex,
4646
* itemCount, and/or itemsTitle props.
4747
*/
48-
toggleTemplate: ((props: ToggleTemplateProps) => React.ReactElement) | string;
48+
toggleTemplate: ((props: PaginationToggleTemplateProps) => React.ReactElement) | string;
4949
/** Function called when user selects number of items per page. */
5050
onPerPageSelect?: OnPerPageSelect;
5151
/** Label for the English word "of". */

packages/react-core/src/components/Pagination/ToggleTemplate.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as React from 'react';
44
* should be passed into the pagination component's toggleTemplate property.
55
*/
66

7-
export interface ToggleTemplateProps {
7+
export interface PaginationToggleTemplateProps {
88
/** The first index of the items being paginated */
99
firstIndex?: number;
1010
/** The last index of the items being paginated */
@@ -17,13 +17,13 @@ export interface ToggleTemplateProps {
1717
ofWord?: React.ReactNode;
1818
}
1919

20-
export const ToggleTemplate: React.FunctionComponent<ToggleTemplateProps> = ({
20+
export const ToggleTemplate: React.FunctionComponent<PaginationToggleTemplateProps> = ({
2121
firstIndex = 0,
2222
lastIndex = 0,
2323
itemCount = 0,
2424
itemsTitle = 'items',
2525
ofWord = 'of'
26-
}: ToggleTemplateProps) => (
26+
}: PaginationToggleTemplateProps) => (
2727
<React.Fragment>
2828
<b>
2929
{firstIndex} - {lastIndex}

packages/react-core/src/components/Pagination/__tests__/Generated/PaginationOptionsMenu.test.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import * as React from 'react';
55
import { render } from '@testing-library/react';
66
import { PaginationOptionsMenu } from '../../PaginationOptionsMenu';
77
// any missing imports can usually be resolved by adding them here
8-
import { ToggleTemplateProps } from '../..';
8+
import { PaginationToggleTemplateProps } from '../..';
99

1010
it('PaginationOptionsMenu should match snapshot (auto-generated)', () => {
1111
const { asFragment } = render(
@@ -26,7 +26,7 @@ it('PaginationOptionsMenu should match snapshot (auto-generated)', () => {
2626
defaultToFullPage={false}
2727
perPage={0}
2828
lastPage={42}
29-
toggleTemplate={({ firstIndex, lastIndex, itemCount, itemsTitle }: ToggleTemplateProps) => (
29+
toggleTemplate={({ firstIndex, lastIndex, itemCount, itemsTitle }: PaginationToggleTemplateProps) => (
3030
<React.Fragment>
3131
<b>
3232
{firstIndex} - {lastIndex}

packages/react-core/src/components/Pagination/examples/Pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: Pagination
33
section: components
44
cssPrefix: null
5-
propComponents: ['Pagination', PaginationTitles, PerPageOptions, ToggleTemplateProps]
5+
propComponents: ['Pagination', PaginationTitles, PerPageOptions, PaginationToggleTemplateProps]
66
ouia: true
77
---
88

0 commit comments

Comments
 (0)