-
Notifications
You must be signed in to change notification settings - Fork 62
[WC-3113] Dynamic pagination #1995
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
Open
iobuhov
wants to merge
4
commits into
main
Choose a base branch
from
WC-3113/dynamic-pagination
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
packages/pluggableWidgets/datagrid-web/src/components/Pagination.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
packages/pluggableWidgets/datagrid-web/src/features/pagination/DynamicPagination.feature.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { ComputedAtom, disposeBatch, SetupComponent, SetupComponentHost } from "@mendix/widget-plugin-mobx-kit/main"; | ||
| import { autorun, reaction } from "mobx"; | ||
| import { GridPageControl } from "./GridPageControl"; | ||
|
|
||
| export class DynamicPaginationFeature implements SetupComponent { | ||
| id = "DynamicPaginationFeature"; | ||
| constructor( | ||
| host: SetupComponentHost, | ||
| private config: { dynamicPageSizeEnabled: boolean; dynamicPageEnabled: boolean }, | ||
| private dynamicPage: ComputedAtom<number>, | ||
| private dynamicPageSize: ComputedAtom<number>, | ||
| private totalCount: ComputedAtom<number>, | ||
| private service: GridPageControl | ||
| ) { | ||
| host.add(this); | ||
| } | ||
|
|
||
| setup(): () => void { | ||
| const [add, disposeAll] = disposeBatch(); | ||
|
|
||
| if (this.config.dynamicPageSizeEnabled) { | ||
| add( | ||
| reaction( | ||
| () => this.dynamicPageSize.get(), | ||
| pageSize => { | ||
| if (pageSize < 0) return; | ||
| this.service.setPageSize(pageSize); | ||
| }, | ||
| { delay: 250 } | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| if (this.config.dynamicPageEnabled) { | ||
| add( | ||
| reaction( | ||
| () => this.dynamicPage.get(), | ||
| page => { | ||
| if (page < 0) return; | ||
| this.service.setPage(page); | ||
| }, | ||
| { delay: 250 } | ||
| ) | ||
| ); | ||
| add( | ||
| autorun(() => { | ||
| this.service.setTotalCount(this.totalCount.get()); | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| return disposeAll; | ||
| } | ||
| } |
5 changes: 5 additions & 0 deletions
5
packages/pluggableWidgets/datagrid-web/src/features/pagination/GridPageControl.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export interface GridPageControl { | ||
| setPage(page: number): void; | ||
| setPageSize(pageSize: number): void; | ||
| setTotalCount(totalCount: number): void; | ||
| } |
29 changes: 29 additions & 0 deletions
29
packages/pluggableWidgets/datagrid-web/src/features/pagination/PageControl.service.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { SetPageAction, SetPageSizeAction } from "@mendix/widget-plugin-grid/main"; | ||
| import { DerivedPropsGate } from "@mendix/widget-plugin-mobx-kit/main"; | ||
| import { Big } from "big.js"; | ||
| import { EditableValue } from "mendix"; | ||
| import { GridPageControl } from "./GridPageControl"; | ||
|
|
||
| export class PageControlService implements GridPageControl { | ||
| constructor( | ||
| private gate: DerivedPropsGate<{ | ||
| totalCountValue?: EditableValue<Big>; | ||
| }>, | ||
| private setPageSizeAction: SetPageSizeAction, | ||
| private setPageAction: SetPageAction | ||
| ) {} | ||
|
|
||
| setPageSize(pageSize: number): void { | ||
| this.setPageSizeAction(pageSize); | ||
| } | ||
|
|
||
| setPage(page: number): void { | ||
| this.setPageAction(page); | ||
| } | ||
|
|
||
| setTotalCount(count: number): void { | ||
| const value = this.gate.props.totalCountValue; | ||
| if (!value || value.readOnly) return; | ||
| value.setValue(new Big(count)); | ||
| } | ||
| } |
65 changes: 65 additions & 0 deletions
65
packages/pluggableWidgets/datagrid-web/src/features/pagination/Pagination.viewModel.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { QueryService, SetPageAction } from "@mendix/widget-plugin-grid/main"; | ||
| import { ComputedAtom } from "@mendix/widget-plugin-mobx-kit/main"; | ||
| import { computed, makeObservable } from "mobx"; | ||
| import { PaginationEnum, ShowPagingButtonsEnum } from "../../../typings/DatagridProps"; | ||
| import { PaginationConfig } from "./pagination.config"; | ||
|
|
||
| export class PaginationViewModel { | ||
| readonly pagination: PaginationEnum; | ||
| readonly showPagingButtons: ShowPagingButtonsEnum; | ||
|
|
||
| constructor( | ||
| private config: PaginationConfig, | ||
| private query: QueryService, | ||
| private currentPageAtom: ComputedAtom<number>, | ||
| private pageSizeAtom: ComputedAtom<number>, | ||
| private setPageAction: SetPageAction | ||
| ) { | ||
| this.pagination = config.pagination; | ||
| this.showPagingButtons = config.showPagingButtons; | ||
|
|
||
| makeObservable(this, { | ||
| pageSize: computed, | ||
| currentPage: computed, | ||
| paginationVisible: computed, | ||
| hasMoreItems: computed, | ||
| totalCount: computed | ||
| }); | ||
| } | ||
|
|
||
| get pageSize(): number { | ||
| return this.pageSizeAtom.get(); | ||
| } | ||
|
|
||
| get currentPage(): number { | ||
| return this.currentPageAtom.get(); | ||
| } | ||
|
|
||
| get paginationVisible(): boolean { | ||
| switch (this.config.paginationKind) { | ||
| case "buttons.always": | ||
| return true; | ||
| case "buttons.auto": { | ||
| const { totalCount = -1 } = this.query; | ||
| return totalCount > this.query.limit; | ||
| } | ||
| case "custom": { | ||
| return false; | ||
| } | ||
| default: | ||
| return this.config.showNumberOfRows; | ||
| } | ||
| } | ||
|
|
||
| get hasMoreItems(): boolean { | ||
| return this.query.hasMoreItems; | ||
| } | ||
|
|
||
| get totalCount(): number | undefined { | ||
| return this.query.totalCount; | ||
| } | ||
|
|
||
| setPage: SetPageAction = value => { | ||
| this.setPageAction(value); | ||
| }; | ||
| } |
52 changes: 52 additions & 0 deletions
52
packages/pluggableWidgets/datagrid-web/src/features/pagination/pagination.config.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { PaginationEnum, ShowPagingButtonsEnum } from "../../../typings/DatagridProps"; | ||
| import { MainGateProps } from "../../../typings/MainGateProps"; | ||
|
|
||
| export interface PaginationConfig { | ||
| pagination: PaginationEnum; | ||
| paginationKind: PaginationKind; | ||
| showPagingButtons: ShowPagingButtonsEnum; | ||
| showNumberOfRows: boolean; | ||
| pageSize: number; | ||
| isLimitBased: boolean; | ||
| dynamicPageSizeEnabled: boolean; | ||
| dynamicPageEnabled: boolean; | ||
| customPaginationEnabled: boolean; | ||
| } | ||
|
|
||
| export type PaginationKind = `${PaginationEnum}.${ShowPagingButtonsEnum}` | "custom"; | ||
|
|
||
| export function paginationConfig(props: MainGateProps): PaginationConfig { | ||
| const config: PaginationConfig = { | ||
| pagination: props.pagination, | ||
| showPagingButtons: props.showPagingButtons, | ||
| showNumberOfRows: props.showNumberOfRows, | ||
| pageSize: props.pageSize, | ||
| isLimitBased: isLimitBased(props), | ||
| paginationKind: paginationKind(props), | ||
| dynamicPageSizeEnabled: dynamicPageSizeEnabled(props), | ||
| dynamicPageEnabled: dynamicPageEnabled(props), | ||
| customPaginationEnabled: props.useCustomPagination | ||
| }; | ||
|
|
||
| return Object.freeze(config); | ||
| } | ||
|
|
||
| export function paginationKind(props: MainGateProps): PaginationKind { | ||
| if (props.useCustomPagination) { | ||
| return "custom"; | ||
| } | ||
|
|
||
| return `${props.pagination}.${props.showPagingButtons}`; | ||
| } | ||
|
|
||
| export function dynamicPageSizeEnabled(props: MainGateProps): boolean { | ||
| return props.dynamicPageSize !== undefined && !isLimitBased(props); | ||
| } | ||
|
|
||
| export function dynamicPageEnabled(props: MainGateProps): boolean { | ||
| return props.dynamicPage !== undefined && !isLimitBased(props); | ||
| } | ||
|
|
||
| function isLimitBased(props: MainGateProps): boolean { | ||
| return props.pagination === "virtualScrolling" || props.pagination === "loadMore"; | ||
| } |
32 changes: 32 additions & 0 deletions
32
packages/pluggableWidgets/datagrid-web/src/features/pagination/pagination.model.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { boundPageSize } from "@mendix/widget-plugin-grid/main"; | ||
| import { ComputedAtom, DerivedPropsGate } from "@mendix/widget-plugin-mobx-kit/main"; | ||
| import { computed } from "mobx"; | ||
| import { ReactNode } from "react"; | ||
|
|
||
| /** Atom for the dynamic page index provided by the widget's props. */ | ||
| export function dynamicPageAtom( | ||
| gate: DerivedPropsGate<{ dynamicPage?: { value?: Big } }>, | ||
| config: { isLimitBased: boolean } | ||
| ): ComputedAtom<number> { | ||
| return computed(() => { | ||
| const page = gate.props.dynamicPage?.value?.toNumber() ?? -1; | ||
| if (config.isLimitBased) { | ||
| return Math.max(page, -1); | ||
| } | ||
| // Switch to zero-based index for offset-based pagination | ||
| return Math.max(page - 1, -1); | ||
| }); | ||
| } | ||
|
|
||
| /** Atom for the dynamic page size. */ | ||
| export function dynamicPageSizeAtom( | ||
| gate: DerivedPropsGate<{ dynamicPageSize?: { value?: Big } }> | ||
| ): ComputedAtom<number> { | ||
| return boundPageSize(() => gate.props.dynamicPageSize?.value?.toNumber() ?? -1); | ||
| } | ||
|
|
||
| export function customPaginationAtom( | ||
| gate: DerivedPropsGate<{ customPagination?: ReactNode }> | ||
| ): ComputedAtom<ReactNode> { | ||
| return computed(() => gate.props.customPagination); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to provide the way to set custom pagination position to top/bottom of the grid?