From 4fb92f0caa6805a12b6f134710d6636296c40ea5 Mon Sep 17 00:00:00 2001 From: dxrobot Date: Thu, 10 Oct 2024 11:12:07 +0400 Subject: [PATCH] DocGen 24_2 result (#6706) --- .../GridBase/1 Configuration/pager/pager.md | 2 +- .../40 Common Types/15 grids/Pager/Pager.md | 7 ++ api-reference/40 Common Types/Mode.md | 2 +- .../NewTopics/PagerBase/PagerBase.md | 13 ++++ .../NewTopics/PagerBase/displayMode.md | 11 +++ api-reference/NewTopics/PagerBase/infoText.md | 11 +++ api-reference/NewTopics/PagerBase/label.md | 11 +++ api-reference/NewTopics/PagerBase/showInfo.md | 11 +++ .../PagerBase/showNavigationButtons.md | 11 +++ .../PagerBase/showPageSizeSelector.md | 11 +++ .../1 Configuration/Configuration.md | 5 ++ .../1 Configuration/allowedPageSizes.md | 11 +++ .../dxPagination/1 Configuration/itemCount.md | 11 +++ .../dxPagination/1 Configuration/pageIndex.md | 12 +++ .../dxPagination/1 Configuration/pageSize.md | 12 +++ .../dxPagination/3 Methods/Methods.md | 5 ++ .../dxPagination/3 Methods/getPageCount().md | 12 +++ .../NewTopics/dxPagination/dxPagination.md | 12 +++ api-reference/_hidden/Enums/DisplayMode.md | 12 +++ .../ui/pagination.md | 0 metadata/syntax-data.json | 76 +++++++++++++------ 21 files changed, 233 insertions(+), 25 deletions(-) create mode 100644 api-reference/NewTopics/PagerBase/PagerBase.md create mode 100644 api-reference/NewTopics/PagerBase/displayMode.md create mode 100644 api-reference/NewTopics/PagerBase/infoText.md create mode 100644 api-reference/NewTopics/PagerBase/label.md create mode 100644 api-reference/NewTopics/PagerBase/showInfo.md create mode 100644 api-reference/NewTopics/PagerBase/showNavigationButtons.md create mode 100644 api-reference/NewTopics/PagerBase/showPageSizeSelector.md create mode 100644 api-reference/NewTopics/dxPagination/1 Configuration/Configuration.md create mode 100644 api-reference/NewTopics/dxPagination/1 Configuration/allowedPageSizes.md create mode 100644 api-reference/NewTopics/dxPagination/1 Configuration/itemCount.md create mode 100644 api-reference/NewTopics/dxPagination/1 Configuration/pageIndex.md create mode 100644 api-reference/NewTopics/dxPagination/1 Configuration/pageSize.md create mode 100644 api-reference/NewTopics/dxPagination/3 Methods/Methods.md create mode 100644 api-reference/NewTopics/dxPagination/3 Methods/getPageCount().md create mode 100644 api-reference/NewTopics/dxPagination/dxPagination.md create mode 100644 api-reference/_hidden/Enums/DisplayMode.md create mode 100644 concepts/Common/Modularity/02 DevExtreme Modules Structure/ui/pagination.md diff --git a/api-reference/10 UI Components/GridBase/1 Configuration/pager/pager.md b/api-reference/10 UI Components/GridBase/1 Configuration/pager/pager.md index 133a0cd903..a355f6bbf2 100644 --- a/api-reference/10 UI Components/GridBase/1 Configuration/pager/pager.md +++ b/api-reference/10 UI Components/GridBase/1 Configuration/pager/pager.md @@ -1,6 +1,6 @@ --- id: GridBase.Options.pager -type: common/grids:Pager +type: Pager inheritsType: common/grids:Pager --- --- diff --git a/api-reference/40 Common Types/15 grids/Pager/Pager.md b/api-reference/40 Common Types/15 grids/Pager/Pager.md index 6cca903ba8..96ba551ba5 100644 --- a/api-reference/40 Common Types/15 grids/Pager/Pager.md +++ b/api-reference/40 Common Types/15 grids/Pager/Pager.md @@ -4,9 +4,16 @@ isType: module: common/grids export: Pager generateTypeLink: +inherits: PagerBase --- --- ##### shortDescription Configures the pager. +##### field(allowedPageSizes): Array | Enums.Mode +Specifies the available page sizes in the page size selector. + +##### field(visible): Boolean | Enums.Mode +Specifies whether the pager is visible. + --- diff --git a/api-reference/40 Common Types/Mode.md b/api-reference/40 Common Types/Mode.md index 1b348aa7c8..f3cf9de136 100644 --- a/api-reference/40 Common Types/Mode.md +++ b/api-reference/40 Common Types/Mode.md @@ -2,7 +2,7 @@ id: Enums.Mode acceptValues: 'auto' type: Union -references: ui/data_grid:GroupPanel.visible|dxDataGrid.Options.remoteOperations|dxDropDownEditor.Options.validationMessagePosition|dxForm.Options.colCount|dxPivotGrid.Options.scrolling.useNative|dxTreeList.Options.remoteOperations|GridBase.Options.columnWidth|GridBase.Options.filterSyncEnabled|common/grids:LoadPanel.enabled|common/grids:Pager.allowedPageSizes|common/grids:Pager.visible|common/grids:ScrollingBase.useNative +references: ui/data_grid:GroupPanel.visible|dxDataGrid.Options.remoteOperations|dxDropDownEditor.Options.validationMessagePosition|dxForm.Options.colCount|dxPivotGrid.Options.scrolling.useNative|dxTreeList.Options.remoteOperations|GridBase.Options.columnWidth|GridBase.Options.filterSyncEnabled|common/grids:LoadPanel.enabled|common/grids:ScrollingBase.useNative|common/grids:Pager.allowedPageSizes|common/grids:Pager.visible --- --- ##### shortDescription diff --git a/api-reference/NewTopics/PagerBase/PagerBase.md b/api-reference/NewTopics/PagerBase/PagerBase.md new file mode 100644 index 0000000000..71155355ea --- /dev/null +++ b/api-reference/NewTopics/PagerBase/PagerBase.md @@ -0,0 +1,13 @@ +--- +id: PagerBase +module: common +export: PagerBase +hidden: +type: Object +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/displayMode.md b/api-reference/NewTopics/PagerBase/displayMode.md new file mode 100644 index 0000000000..6a59f1e64c --- /dev/null +++ b/api-reference/NewTopics/PagerBase/displayMode.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.displayMode +type: Enums.DisplayMode +default: 'adaptive' +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/infoText.md b/api-reference/NewTopics/PagerBase/infoText.md new file mode 100644 index 0000000000..3bf4eeb35e --- /dev/null +++ b/api-reference/NewTopics/PagerBase/infoText.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.infoText +type: String +default: 'Page {0} of {1} ({2} items)' +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/label.md b/api-reference/NewTopics/PagerBase/label.md new file mode 100644 index 0000000000..409f15342e --- /dev/null +++ b/api-reference/NewTopics/PagerBase/label.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.label +type: String +default: 'Page Navigation' +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/showInfo.md b/api-reference/NewTopics/PagerBase/showInfo.md new file mode 100644 index 0000000000..11cfac4175 --- /dev/null +++ b/api-reference/NewTopics/PagerBase/showInfo.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.showInfo +type: Boolean +default: false +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/showNavigationButtons.md b/api-reference/NewTopics/PagerBase/showNavigationButtons.md new file mode 100644 index 0000000000..68cd1b0874 --- /dev/null +++ b/api-reference/NewTopics/PagerBase/showNavigationButtons.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.showNavigationButtons +type: Boolean +default: false +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/PagerBase/showPageSizeSelector.md b/api-reference/NewTopics/PagerBase/showPageSizeSelector.md new file mode 100644 index 0000000000..71bc5ba8a0 --- /dev/null +++ b/api-reference/NewTopics/PagerBase/showPageSizeSelector.md @@ -0,0 +1,11 @@ +--- +id: PagerBase.showPageSizeSelector +type: Boolean +default: false +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/1 Configuration/Configuration.md b/api-reference/NewTopics/dxPagination/1 Configuration/Configuration.md new file mode 100644 index 0000000000..34956b59e1 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/1 Configuration/Configuration.md @@ -0,0 +1,5 @@ +--- +##### shortDescription + + +--- diff --git a/api-reference/NewTopics/dxPagination/1 Configuration/allowedPageSizes.md b/api-reference/NewTopics/dxPagination/1 Configuration/allowedPageSizes.md new file mode 100644 index 0000000000..3bb541623e --- /dev/null +++ b/api-reference/NewTopics/dxPagination/1 Configuration/allowedPageSizes.md @@ -0,0 +1,11 @@ +--- +id: dxPagination.Options.allowedPageSizes +type: Array +default: [5, 10] +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/1 Configuration/itemCount.md b/api-reference/NewTopics/dxPagination/1 Configuration/itemCount.md new file mode 100644 index 0000000000..2b8c5a9471 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/1 Configuration/itemCount.md @@ -0,0 +1,11 @@ +--- +id: dxPagination.Options.itemCount +type: Number +default: 1 +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/1 Configuration/pageIndex.md b/api-reference/NewTopics/dxPagination/1 Configuration/pageIndex.md new file mode 100644 index 0000000000..bc0e447f13 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/1 Configuration/pageIndex.md @@ -0,0 +1,12 @@ +--- +id: dxPagination.Options.pageIndex +firedEvents: optionChanged +type: Number +default: 1 +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/1 Configuration/pageSize.md b/api-reference/NewTopics/dxPagination/1 Configuration/pageSize.md new file mode 100644 index 0000000000..ab50d97c13 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/1 Configuration/pageSize.md @@ -0,0 +1,12 @@ +--- +id: dxPagination.Options.pageSize +firedEvents: optionChanged +type: Number +default: 5 +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/3 Methods/Methods.md b/api-reference/NewTopics/dxPagination/3 Methods/Methods.md new file mode 100644 index 0000000000..34956b59e1 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/3 Methods/Methods.md @@ -0,0 +1,5 @@ +--- +##### shortDescription + + +--- diff --git a/api-reference/NewTopics/dxPagination/3 Methods/getPageCount().md b/api-reference/NewTopics/dxPagination/3 Methods/getPageCount().md new file mode 100644 index 0000000000..e0761cebf2 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/3 Methods/getPageCount().md @@ -0,0 +1,12 @@ +--- +id: dxPagination.getPageCount() +--- +--- +##### shortDescription + + +##### return: Number + + +--- + \ No newline at end of file diff --git a/api-reference/NewTopics/dxPagination/dxPagination.md b/api-reference/NewTopics/dxPagination/dxPagination.md new file mode 100644 index 0000000000..8d8a458546 --- /dev/null +++ b/api-reference/NewTopics/dxPagination/dxPagination.md @@ -0,0 +1,12 @@ +--- +id: dxPagination +module: ui/pagination +export: default +inherits: Widget +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/api-reference/_hidden/Enums/DisplayMode.md b/api-reference/_hidden/Enums/DisplayMode.md new file mode 100644 index 0000000000..9cecc05abd --- /dev/null +++ b/api-reference/_hidden/Enums/DisplayMode.md @@ -0,0 +1,12 @@ +--- +id: Enums.DisplayMode +acceptValues: 'adaptive' | 'compact' | 'full' +type: Union +references: PagerBase.displayMode +--- +--- +##### shortDescription + + +--- + \ No newline at end of file diff --git a/concepts/Common/Modularity/02 DevExtreme Modules Structure/ui/pagination.md b/concepts/Common/Modularity/02 DevExtreme Modules Structure/ui/pagination.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/metadata/syntax-data.json b/metadata/syntax-data.json index 4291218e8b..ba0025bea8 100644 --- a/metadata/syntax-data.json +++ b/metadata/syntax-data.json @@ -14074,6 +14074,26 @@ "dxOverlayOptions.wrapperAttr": { "vue": "wrapper-attr" }, + "dxPagination": { + "angular": "dx-pagination", + "react": "Pagination", + "vue": "DxPagination" + }, + "dxPaginationOptions": { + "vue": "dx-pagination-options" + }, + "dxPaginationOptions.allowedPageSizes": { + "vue": "allowed-page-sizes" + }, + "dxPaginationOptions.itemCount": { + "vue": "item-count" + }, + "dxPaginationOptions.pageIndex": { + "vue": "page-index" + }, + "dxPaginationOptions.pageSize": { + "vue": "page-size" + }, "dxPieChart": { "angular": "dx-pie-chart", "react": "PieChart", @@ -19535,6 +19555,9 @@ "enums.DiscreteAxisDivisionMode": { "vue": "discrete-axis-division-mode" }, + "enums.DisplayMode": { + "vue": "display-mode" + }, "enums.Distribution": { "vue": "distribution" }, @@ -19727,9 +19750,6 @@ "enums.PageOrientation": { "vue": "page-orientation" }, - "enums.PagerDisplayMode": { - "vue": "pager-display-mode" - }, "enums.PagerPageSize": { "vue": "pager-page-size" }, @@ -20669,26 +20689,6 @@ "react": "Pager", "vue": "DxPager" }, - "gridBaseOptions.pager.allowedPageSizes": { - "angular": "dxi-allowed-page-size", - "react": "AllowedPageSize", - "vue": "DxAllowedPageSize" - }, - "gridBaseOptions.pager.displayMode": { - "vue": "display-mode" - }, - "gridBaseOptions.pager.infoText": { - "vue": "info-text" - }, - "gridBaseOptions.pager.showInfo": { - "vue": "show-info" - }, - "gridBaseOptions.pager.showNavigationButtons": { - "vue": "show-navigation-buttons" - }, - "gridBaseOptions.pager.showPageSizeSelector": { - "vue": "show-page-size-selector" - }, "gridBaseOptions.paging": { "angular": "dxo-paging", "react": "Paging", @@ -20968,6 +20968,36 @@ "numericRule.ignoreEmptyValue": { "vue": "ignore-empty-value" }, + "pager": { + "angular": "dxo-pager", + "react": "Pager", + "vue": "DxPager" + }, + "pager.allowedPageSizes": { + "angular": "dxi-allowed-page-size", + "react": "AllowedPageSize", + "vue": "DxAllowedPageSize" + }, + "pagerBase": { + "angular": "dxo-pager-base", + "react": "PagerBase", + "vue": "DxPagerBase" + }, + "pagerBase.displayMode": { + "vue": "display-mode" + }, + "pagerBase.infoText": { + "vue": "info-text" + }, + "pagerBase.showInfo": { + "vue": "show-info" + }, + "pagerBase.showNavigationButtons": { + "vue": "show-navigation-buttons" + }, + "pagerBase.showPageSizeSelector": { + "vue": "show-page-size-selector" + }, "patternRule": { "angular": "dxo-pattern-rule", "react": "PatternRule",