Pagination
value type: object
The Pagination
controls user input for pagination purposes.
This block does not paginate requests, it only manage pagination parameters which can be used to control pagination requests.
Settings
Pagination JSON Schema Definition
type: object
properties:
events:
additionalProperties: false
properties:
onChange:
description: Triggered when current page is changed.
type: array
onSizeChange:
description: Triggered when page size is changed.
type: array
type: object
properties:
additionalProperties: false
properties:
disabled:
default: false
description: Disable pager.
type: boolean
hideOnSinglePage:
default: false
description: Hide pager on short list of a single page.
type: boolean
pageSizeOptions:
default:
- 10
- 20
- 30
- 40
description: Specify the page size changer options.
items:
type: number
type: array
showQuickJumper:
default: false
description: Determine whether you can jump to pages directly.
type: boolean
showSizeChanger:
default: false
description: >-
Determine whether to show page size select, it will be true when total >
50.
type: boolean
showTotal:
default: false
description: >-
Show pagination total number and range if boolean, or define a custom
string or function to display.
type:
- boolean
- string
- object
simple:
default: false
description: Use simplified pagination display.
type: boolean
size:
default: default
description: Pagination element size.
enum:
- small
- default
type: string
total:
default: 100
description: Total number of items to be displayed in pagination.
type: integer
type: object