@instructure/ui-pagination 8.51.0 → 8.51.1-snapshot-6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/es/Pagination/__new-tests__/Pagination.test.js +182 -0
- package/es/Pagination/index.js +137 -13
- package/es/Pagination/props.js +9 -2
- package/lib/Pagination/__new-tests__/Pagination.test.js +184 -0
- package/lib/Pagination/index.js +137 -13
- package/lib/Pagination/props.js +9 -2
- package/package.json +23 -21
- package/src/Pagination/README.md +279 -0
- package/src/Pagination/__new-tests__/Pagination.test.tsx +210 -0
- package/src/Pagination/index.tsx +197 -5
- package/src/Pagination/props.ts +58 -3
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/Pagination/__new-tests__/Pagination.test.d.ts +2 -0
- package/types/Pagination/__new-tests__/Pagination.test.d.ts.map +1 -0
- package/types/Pagination/index.d.ts +28 -2
- package/types/Pagination/index.d.ts.map +1 -1
- package/types/Pagination/props.d.ts +30 -0
- package/types/Pagination/props.d.ts.map +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Pagination.test.d.ts","sourceRoot":"","sources":["../../../src/Pagination/__new-tests__/Pagination.test.tsx"],"names":[],"mappings":"AA2BA,OAAO,2BAA2B,CAAA"}
|
|
@@ -37,6 +37,13 @@ declare class Pagination extends Component<PaginationProps> {
|
|
|
37
37
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
38
38
|
inputRef?: ((inputElement: HTMLInputElement | null) => void) | undefined;
|
|
39
39
|
shouldHandleFocus?: boolean | undefined;
|
|
40
|
+
totalPageNumber?: number | undefined;
|
|
41
|
+
currentPage?: number | undefined;
|
|
42
|
+
siblingCount?: number | undefined;
|
|
43
|
+
boundaryCount?: number | undefined;
|
|
44
|
+
onPageChange?: ((next: number, prev: number) => void) | undefined;
|
|
45
|
+
renderPageIndicator?: ((pageIndex: number, currentPage: number) => React.ReactNode) | undefined;
|
|
46
|
+
ellipsis?: React.ReactNode;
|
|
40
47
|
}>;
|
|
41
48
|
static allowedProps: readonly (keyof {
|
|
42
49
|
children?: ChildPage | ChildPage[] | undefined;
|
|
@@ -56,6 +63,13 @@ declare class Pagination extends Component<PaginationProps> {
|
|
|
56
63
|
elementRef?: ((element: Element | null) => void) | undefined;
|
|
57
64
|
inputRef?: ((inputElement: HTMLInputElement | null) => void) | undefined;
|
|
58
65
|
shouldHandleFocus?: boolean | undefined;
|
|
66
|
+
totalPageNumber?: number | undefined;
|
|
67
|
+
currentPage?: number | undefined;
|
|
68
|
+
siblingCount?: number | undefined;
|
|
69
|
+
boundaryCount?: number | undefined;
|
|
70
|
+
onPageChange?: ((next: number, prev: number) => void) | undefined;
|
|
71
|
+
renderPageIndicator?: ((pageIndex: number, currentPage: number) => React.ReactNode) | undefined;
|
|
72
|
+
ellipsis?: React.ReactNode;
|
|
59
73
|
})[];
|
|
60
74
|
static defaultProps: {
|
|
61
75
|
disabled: boolean;
|
|
@@ -66,6 +80,12 @@ declare class Pagination extends Component<PaginationProps> {
|
|
|
66
80
|
labelNumberInput: (numberOfPages: number) => string;
|
|
67
81
|
screenReaderLabelNumberInput: (currentPage: number, numberOfPages: number) => string;
|
|
68
82
|
shouldHandleFocus: boolean;
|
|
83
|
+
totalPageNumber: number;
|
|
84
|
+
currentPage: number;
|
|
85
|
+
siblingCount: number;
|
|
86
|
+
boundaryCount: number;
|
|
87
|
+
ellipsis: string;
|
|
88
|
+
renderPageIndicator: (page: number) => number;
|
|
69
89
|
};
|
|
70
90
|
static Page: typeof PaginationButton;
|
|
71
91
|
static Navigation: typeof PaginationArrowButton;
|
|
@@ -75,6 +95,7 @@ declare class Pagination extends Component<PaginationProps> {
|
|
|
75
95
|
private _nextButton;
|
|
76
96
|
private _lastButton;
|
|
77
97
|
ref: Element | null;
|
|
98
|
+
currentPageRef: PaginationButton | null;
|
|
78
99
|
constructor(props: PaginationProps);
|
|
79
100
|
get _root(): Element | null;
|
|
80
101
|
get inputMode(): boolean;
|
|
@@ -90,12 +111,17 @@ declare class Pagination extends Component<PaginationProps> {
|
|
|
90
111
|
handleElementRef: (el: Element | null) => void;
|
|
91
112
|
handleInputRef: (el: HTMLInputElement | null) => void;
|
|
92
113
|
renderLabel(): jsx.JSX.Element;
|
|
114
|
+
renderDefaultPageInput: () => jsx.JSX.Element;
|
|
93
115
|
renderPageInput(currentPageIndex: number): jsx.JSX.Element;
|
|
94
116
|
handleInputChange(event: React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLButtonElement> | React.FocusEvent<HTMLInputElement>, pageIndex: number): void;
|
|
95
|
-
|
|
117
|
+
handleNavigation: (nextIndex: number, previousIndex: number) => void;
|
|
118
|
+
renderPagesInInterval: (from: number, to: number, currentPage: number) => jsx.JSX.Element[];
|
|
119
|
+
renderDefaultPages: () => any;
|
|
120
|
+
renderPages(currentPageIndex: number): any;
|
|
96
121
|
getArrowVariant(direction: PaginationArrowDirections, currentPageIndex: number, pagesCount: number): ArrowConfig;
|
|
122
|
+
renderDefaultArrowButton: (direction: PaginationArrowDirections) => jsx.JSX.Element | null;
|
|
97
123
|
renderArrowButton(direction: PaginationArrowDirections, currentPageIndex: number): jsx.JSX.Element | null;
|
|
98
|
-
render(): jsx.JSX.Element
|
|
124
|
+
render(): jsx.JSX.Element;
|
|
99
125
|
}
|
|
100
126
|
export default Pagination;
|
|
101
127
|
export { Pagination, PaginationButton };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Pagination/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAK/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AAG9E,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Pagination/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAK/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AAG9E,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AA0B7E,KAAK,WAAW,GAAG;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,OAAO,CAAA;IACzB,eAAe,EAAE,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC9C,CAAA;AAED;;;;GAIG;AACH,cAGM,UAAW,SAAQ,SAAS,CAAC,eAAe,CAAC;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;0CAMiB,MAAM;oDAEzB,MAAM,iBACJ,MAAM;;;;;;;oCAQK,MAAM;MACnC;IAED,MAAM,CAAC,IAAI,0BAAmB;IAC9B,MAAM,CAAC,UAAU,+BAAwB;IAEzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAAiC;IAEpD,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,cAAc,EAAE,gBAAgB,GAAG,IAAI,CAAO;gBAElC,KAAK,EAAE,eAAe;IAMlC,IAAI,KAAK,mBAMR;IAED,IAAI,SAAS,YAEZ;IAED,IAAI,UAAU,yFAEb;IAED,IAAI,sBAAsB,wBAEzB;IAED,IAAI,mBAAmB,wBAEtB;IAED,uBAAuB,IAAI,kBAAkB;IAe7C,iBAAiB;IAIjB,kBAAkB,CAChB,SAAS,EAAE,eAAe,EAC1B,UAAU,EAAE,OAAO,EACnB,QAAQ,EAAE,kBAAkB;IA0B9B,uBAAuB,CAAC,QAAQ,EAAE,kBAAkB;IAyBpD,IAAI,WAAW,YAEd;IAED,8BAA8B,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC;IAQpE,gBAAgB,OAAQ,OAAO,GAAG,IAAI,UAKrC;IAED,cAAc,OAAQ,gBAAgB,GAAG,IAAI,UAI5C;IAED,WAAW;IAgBX,sBAAsB,wBAerB;IAED,eAAe,CAAC,gBAAgB,EAAE,MAAM;IAexC,iBAAiB,CACf,KAAK,EACD,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,GACrC,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,GACnC,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,EACtC,SAAS,EAAE,MAAM;IAKnB,gBAAgB,cAAe,MAAM,iBAAiB,MAAM,UAK3D;IAED,qBAAqB,SAAU,MAAM,MAAM,MAAM,eAAe,MAAM,uBAiBrE;IAED,kBAAkB,YA6EjB;IAED,WAAW,CAAC,gBAAgB,EAAE,MAAM;IA2CpC,eAAe,CACb,SAAS,EAAE,yBAAyB,EACpC,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,MAAM,GACjB,WAAW;IAyCd,wBAAwB,cAAe,yBAAyB,4BA+C/D;IAED,iBAAiB,CACf,SAAS,EAAE,yBAAyB,EACpC,gBAAgB,EAAE,MAAM;IAqC1B,MAAM;CAoCP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAA"}
|
|
@@ -84,6 +84,36 @@ type PaginationOwnProps = {
|
|
|
84
84
|
* Set this property to `false` to prevent this behavior.
|
|
85
85
|
*/
|
|
86
86
|
shouldHandleFocus?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* The total number of pages
|
|
89
|
+
*/
|
|
90
|
+
totalPageNumber?: number;
|
|
91
|
+
/**
|
|
92
|
+
* The current page number
|
|
93
|
+
*/
|
|
94
|
+
currentPage?: number;
|
|
95
|
+
/**
|
|
96
|
+
* The number of pages to display before and after the current page
|
|
97
|
+
*/
|
|
98
|
+
siblingCount?: number;
|
|
99
|
+
/**
|
|
100
|
+
* The number of always visible pages at the beginning and end
|
|
101
|
+
* of the pagination component
|
|
102
|
+
* */
|
|
103
|
+
boundaryCount?: number;
|
|
104
|
+
/**
|
|
105
|
+
* Called when page number is changed
|
|
106
|
+
*/
|
|
107
|
+
onPageChange?: (next: number, prev: number) => void;
|
|
108
|
+
/**
|
|
109
|
+
* Renders the visible pages
|
|
110
|
+
*/
|
|
111
|
+
renderPageIndicator?: (pageIndex: number, currentPage: number) => React.ReactNode;
|
|
112
|
+
/**
|
|
113
|
+
* The ellipsis
|
|
114
|
+
* (e.g. "...")
|
|
115
|
+
*/
|
|
116
|
+
ellipsis?: React.ReactNode;
|
|
87
117
|
};
|
|
88
118
|
type PropKeys = keyof PaginationOwnProps;
|
|
89
119
|
type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Pagination/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAC3E,KAAK,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAExD,KAAK,kBAAkB,GAAG;IAIxB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IAE7D;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,CAC7B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,KAClB,MAAM,CAAA;IAEX;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,gBAAgB,GAAG,IAAI,KAAK,IAAI,CAAA;IAE1D;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Pagination/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAC3E,KAAK,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAExD,KAAK,kBAAkB,GAAG;IAIxB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAA;IAE7D;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,CAC7B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,KAClB,MAAM,CAAA;IAEX;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,gBAAgB,GAAG,IAAI,KAAK,IAAI,CAAA;IAE1D;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;SAGK;IACL,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAEnD;;OAEG;IACH,mBAAmB,CAAC,EAAE,CACpB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,KAChB,KAAK,CAAC,SAAS,CAAA;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,GACrC,mBAAmB,CAAC,kBAAkB,CAAC,GACvC,wBAAwB,CAAA;AAE1B,KAAK,eAAe,GAAG,cAAc,CAAC,YAAY,GAAG,OAAO,CAAC,CAAA;AAE7D,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAyBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAyBnB,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;CACtC,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAA;AAC/E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|