Pagination
Navigation
stable
Page navigation control with first, previous, next and last buttons.
API
Props
All props accepted by this component, with their type, default value and description.
- startnumber1
- Starting page number (1-based by default).
- modelValuenumber1
- Current page number (v-model).
- disabledbooleanfalse
- Disables all navigation buttons.
- lengthnumber | string1
- Total number of pages.
- totalVisiblenumber | string
- Maximum number of page buttons visible at once (excess replaced with ellipsis).
- firstIconTIcon'mdi-page-first'
- Icon for the "first page" button.
- prevIconTIcon'mdi-chevron-left'
- Icon for the "previous page" button.
- nextIconTIcon'mdi-chevron-right'
- Icon for the "next page" button.
- lastIconTIcon'mdi-page-last'
- Icon for the "last page" button.
- ariaLabelstring'Pagination Navigation'
- aria-label for the navigation element.
- pageAriaLabelstring
- currentPageAriaLabelstring
- firstAriaLabelstring
- previousAriaLabelstring
- nextAriaLabelstring
- lastAriaLabelstring
- ellipsisstring'…'
- Character or string shown in place of hidden page buttons.
- showFirstLastPagebooleanfalse
- Show buttons to jump to the first and last page.
- compactbooleanfalse
- Compact mode replaces the page list with an editable page number input.
- pageTextstring
- ofTextstring
- withInfobooleanfalse
- Renders a left-side "Showing X-Y of Z" range label. Requires total prop.
- totalnumber | string
- Total number of items (not pages). Drives the withInfo label.
- perPagenumber | string10
- Items per page used for the withInfo range calculation.
- infoTextstring
- previousTextstring
- nextTextstring
- pageNumberAriaLabelstring
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- tagstring'div'
- Root HTML element tag.
- colorTColor
- Intent color applied to the active page button.
- bgColorTColor
- borderboolean | number | string | TDirectionBoth | Array<TDirectionBoth>
- borderTopboolean | number | string
- borderLeftboolean | number | string
- borderBottomboolean | number | string
- borderRightboolean | number | string
- borderBlockboolean | number | string
- borderInlineboolean | number | string
- borderInlineStartboolean | number | string
- borderInlineEndboolean | number | string
- borderBlockStartboolean | number | string
- borderBlockEndboolean | number | string
- borderColorstring
- borderStylestring
- borderTopColorTColor
- borderRightColorTColor
- borderBottomColorTColor
- borderLeftColorTColor
- borderInlineStartColorTColor
- borderInlineEndColorTColor
- borderBlockStartColorTColor
- borderBlockEndColorTColor
- paddingboolean | number | string
- paddingTopboolean | number | string
- paddingLeftboolean | number | string
- paddingBottomboolean | number | string
- paddingRightboolean | number | string
- paddingBlockboolean | number | string
- paddingInlineboolean | number | string
- paddingInlineStartboolean | number | string
- paddingInlineEndboolean | number | string
- paddingBlockStartboolean | number | string
- paddingBlockEndboolean | number | string
- marginboolean | number | string
- marginTopboolean | number | string
- marginLeftboolean | number | string
- marginBottomboolean | number | string
- marginRightboolean | number | string
- marginBlockboolean | number | string
- marginInlineboolean | number | string
- marginInlineStartboolean | number | string
- marginInlineEndboolean | number | string
- marginBlockStartboolean | number | string
- marginBlockEndboolean | number | string
- elevationTElevation
- sizeTSize | number'default'
- Size of pagination buttons.
- densityTDensity'default'
- Padding density of the pagination buttons.
- fontSizeTFontSize
- fontWeightTFontWeight
API
Slots
Content slots exposed by this component.
- #info
- #first
- #prev
- #next
- #last
- #item
- Custom render for each page button. Receives page number, active state and key.
API
Emits
Events emitted by this component.
- @firstnumber
- Fired when the user navigates to the first page.
- @prevnumber
- Fired when the user navigates to the previous page.
- @nextnumber
- Fired when the user navigates to the next page.
- @lastnumber
- Fired when the user navigates to the last page.
- @update:modelValueany
- Fired when the current page changes.
Interactive
Playground
Edit props live and see the component update in real time. The generated code snippet updates as you change values.
Rendering the live preview…
Usage
Examples
Ready-to-paste code snippets for your templates.
Basic pagination
With item count info
Compact mode